Touchstone® Telephony

TS7.5 Firmware Guide

Release 7.5

Standard 1.2

August 2012
ii

© 2009–2012 ARRIS
All rights reserved

Printed in the USA

The information in this document is subject to change without notice. The statements, configurations, technical data,
and recommendations in this document are believed to be accurate and reliable, but are presented without express or
implied warranty. Users must take full responsibility for their applications of any products specified in this document.
The information in this document is proprietar y to ARRIS.

ARRIS, C3™, C4®, and Touchstone® are trademarks or registered trademarks of ARRIS Group, Inc. Cadant® is a
registered trademark of ARRIS Group, Inc. All other trademarks and registered trademarks are the property of their
respective holders.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 Publication history

August 2012 Release 7.5 Standard 1.2 version of this document for TS7.5 MSUP5.

March 2012 Release 7.5 Standard 1.1 version of this document for TS7.5 MSUP4.

January 2012 Release 7.5 Standard 1.0 version of this document for TS7.5.

Firmware Guide Release 7.5 Standard 1.2 August 2012

iv Publication history

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 Contents

Overview 1
About This Manual ............................................................................ 1
Audience ..................................................................................... 1
In This Manual ............................................................................ 2
Suppor ted Hardware ......................................................................... 2
Model 7 ....................................................................................... 2
Model 8 ....................................................................................... 3
Subscriber Interface .................................................................... 3
Load Name Extensions ..................................................................... 4
Examples .................................................................................... 5
Firmware Functionality ...................................................................... 6
Firmware Download Center ........................................................ 6
Standards Compliance ...................................................................... 7
Standard Functionality ................................................................ 7
Optional Functionality ................................................................. 7
DOCSIS Specifications ............................................................... 7
PacketCable Specifications ......................................................... 8
SIP Specifications ....................................................................... 8
CableLabs IPv6 Specifications ................................................. 10
New Features in TS7.5 MSUP5 ...................................................... 10
New Features in TS7.5 .................................................................... 10
Unified SIP Loads ..................................................................... 10
IPv6 CPE Operations ................................................................ 10
New Hardware Support ............................................................ 11
Terminology ..................................................................................... 12

Provisioning 19
General Provisioning Information .................................................... 20
Ser vice Flow Limitations ........................................................... 20
OUI Ranges .............................................................................. 20
Configuring ToD Offset ............................................................. 20
Setting the DST Policy .............................................................. 21
Clearing the CPE List ............................................................... 21

Firmware Guide Release 7.5 Standard 1.2 August 2012

vi Contents

Configuring Caller ID Options ................................................... 22

Provisioning Considerations ............................................................ 23
Upgrading from DOCSIS 2.0 .................................................... 23
CallP Feature Switch Changes ........................................... 23
CPE Count Changes .......................................................... 24
Hardware-Specific Upgrade Limitations .................................... 24
WBM750/WBM760 ............................................................. 24
Model 8 Hardware .............................................................. 25
DG860 ................................................................................ 25
About IPsec ............................................................................... 25
Call Management Servers ........................................................ 25
Cable Modem Interface Mask ................................................... 26
Voice and Signaling Por ts ......................................................... 26
Interface Index Scheme ............................................................ 26
Interface Types ................................................................... 27
Configuration File Provisioning Notes ....................................... 27
Suppor t for TLV-41 (Downstream Channel Lists) ............... 27
Considerations for TLV-39 Support ..................................... 27
Provisioning Considerations for European Loads ..................... 28
Flow MTA15: SNMP Enrollment INFORM .......................... 29
Flow MTA19: SNMPv3 SET ................................................ 29
Flow MTA23: TFTP Configuration File Request ................. 29
Flow MTA25: SNMP INFORM ............................................ 29
IPv6 eRouter Considerations .................................................... 29
DHCP Interactions ........................................................................... 30
CM-side Interactions ................................................................. 30
DHCP Option 51 Support ................................................... 30
DHCP Option 60 Support ................................................... 30
eDVA-side Interactions .............................................................. 30
DHCP Option 43 Support ................................................... 30
DHCP Option 51 Support ................................................... 31
DHCP Option 60 Support ................................................... 31
Gateway Interactions ................................................................ 32
DHCP Option 67 Support ................................................... 32
Disabling Option 122 Sub-Option 3 Enforcement ..................... 32
Provisioning Modes ......................................................................... 33
PacketCable Provisioning Modes .............................................. 33
PacketCable SECURE (Full PacketCable) ......................... 33
PacketCable HYBRID ......................................................... 34
PacketCable BASIC ............................................................ 36
ARRIS-proprietary Provisioning Modes .................................... 37
PacketCable minus KDC .................................................... 38
GUPI Encrypted MAC eDVA ............................................... 38
Setting Up the Provisioning Server Data .................................. 39
Verifying eDVA Provisioning and Endpoint Status .................... 39
DHCP Support by Provisioning Mode ............................................. 39
Options Required in All Provisioning Modes ............................. 39

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents vii

PacketCable Modes .................................................................. 39

Overriding the MDD IPv4/IPv6 Selection ........................................ 41
Displaying the MDD Setting ...................................................... 41
IPv6 Provisioning Notes .................................................................. 42
Provisioning Modes ................................................................... 42
docsIf3CmMdCfgTable Objects ................................................ 42
Selecting an Addressing Mode ................................................. 43
DHCP Behavior for IPv6 Provisioning ....................................... 43
Provisioning File Notes ............................................................. 44
TLV-38 Enhancements .............................................................. 44
Procedure: Upgrading Touchstone Firmware ................................. 45
WBM760 Considerations .......................................................... 45
Upgrading from Earlier NCS Loads to TS7.5 NCS Loads ........ 45
Upgrading from Earlier SIP Loads to TS7.5 SIP Loads ............ 45
Upgrading Between NCS Loads and SIP Loads ...................... 45
Upgrading the Firmware through Provisioning .......................... 45
Upgrading the Firmware through SNMP ................................... 46
Procedure: Using Enhanced Firmware Loading ............................ 47
Upgrade Process ...................................................................... 47
Enhanced Firmware Loading Options ...................................... 49
Software Download Filename Check Override Feature ............ 50
ArrisCmDoc30SwAdminStatus Feature Switch ........................ 50
arrisCmDoc30SwOperStatus Object ........................................ 50
ArrisCmDoc30SwTable MIB ...................................................... 50
arrisCmDoc30SwHwModel Values ..................................... 51
Firmware Download Log Messages .......................................... 52
Example Lineup ........................................................................ 52
Example Configuration File Excerpt ......................................... 52
Rejecting a Download Request ................................................. 53
Setting Up ARRIS Enhanced Firmware Loading ...................... 53
Specifying and Verifying a CVC ................................................ 54
L2VPN Provisioning ........................................................................ 54
Provisioning Details .................................................................. 55
Unknown CPE Traffic Handling ................................................. 55
Procedure: Configuring Channel Bonding Characteristics ............. 56
Provisioning Quality of Service ........................................................ 57
Full DQoS Mode ....................................................................... 57
DSX QoS Mode ........................................................................ 57
Dual-Mode Operation ...................................................................... 58
Forcing Provisioning Mode and Certificates ............................. 58
Configuration Files and Signed Loads ...................................... 58
Cer tificates ................................................................................ 59
DMDM Status ............................................................................ 59
CODECs and Packetization Rates Supported ................................ 60
G.729 CODEC Support ............................................................ 60
G.729 CODEC Negotiation (NCS) ..................................... 61
G.729 CODEC Negotiation (SIP) ....................................... 62

Firmware Guide Release 7.5 Standard 1.2 August 2012

viii Contents

G.729 Fax and Modem Support ......................................... 63

G.729 Bandwidth Considerations ....................................... 63
CODECs and Supported Lines ................................................. 64
Model 7/Model 8 Engineering Rules .................................. 64
Procedure: Provisioning General eDVA and Line Parameters ....... 65
Setting Persistent Line Status ................................................... 65
Controlling LED Behavior .......................................................... 66
Controlling ToS Byte Marking ................................................... 66
Controlling TurboDOX Functionality .......................................... 66
Controlling IPsec Functionality .................................................. 67
Configuring the Ringing Waveform ........................................... 67
Configuring Loop Current ......................................................... 68
Procedure: Setting Loop Voltage Management .............................. 70
Loop Voltage Management Policies .......................................... 70
Policy 1: Constant Loop Voltage ......................................... 70
Policy 2: QAM Carrier Detect ............................................. 70
Policy 3: eDVA In-Ser vice/Manual Reset ............................ 71
Policy 4: eDVA In-Ser vice ................................................... 71
Loop Voltage Management MIB Objects .................................. 72
Mapping ARRIS Loop Voltage Objects to PacketCable
Objects ............................................................................... 73
Feature Switches ............................................................................. 74
CallP Feature Switch ................................................................ 74
Example ............................................................................. 78
Feature Switches Affecting the SDP .................................. 79
eDVA Feature Switch ................................................................ 84
SIP Feature Switch ................................................................... 85
Secondar y SIP Feature Switch ................................................. 89
Echo Cancellation and Analog Fax/Modem Support ....................... 90
Adaptive Jitter Buffers ............................................................... 90
Configuring the Echo Cancellation Tail Length ......................... 91
Provisioning RFC 2833 Support ...................................................... 92
Controlling RFC 2833 Functionality .......................................... 92
Configuring T.38 Fax Relay Suppor t ................................................ 93
SDP Parameter List for T.38 Strict ............................................ 93
CallP Feature Switches Affecting the SDP ......................... 94
SDP Parameter List Considerations ....................................... 100
PacketCable 1.5 Extended Signaling ...................................... 100
T.38 Provisioning Over view ..................................................... 101
Controlling T.38 and Fax-Only Modes ..................................... 102
Configuring T.38 MaxDatagram Size ...................................... 103
Configuring SIP T.38 and Fax-Only Modes ............................. 103
Super G3 FAX Support .................................................................. 104
Procedure: Configuring Jitter Buffers ........................................... 105
Setting Standard Jitter Buffer Parameters .............................. 106
Setting Voice Band Data Jitter Buffer Parameters .................. 106
Configuring Custom Jitter Buffer Settings ............................... 107

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents ix

Procedure: Provisioning European Support ................................. 108

Configuring Power Ring Frequency ........................................ 108
Configuring On-Hook Caller ID ............................................... 108
Configuring Visual Message Waiting Indicator ....................... 109
Configuring Tone Operations .................................................. 110
Configuring Hook Flash Timing .............................................. 110
Procedure: Configuring Call Progress Tones ............................... 111
MIB Tables .............................................................................. 111
Procedure: Gain Compensated Tone Generation ........................ 114
On-Hook vs. Off-Hook Gain .................................................... 114
Configuring Gain Control using SNMP ................................... 114
Configuring Gain using the CLI ............................................... 117
Procedure: Provisioning Preset Downstream Frequencies .......... 118
Preset Frequency MIB Objects ............................................... 118
Provisioning Preset Frequencies using SNMP ....................... 118
Accessing the Scanning Override Screen .............................. 119
Specifying a Downstream Frequency ..................................... 120
Clearing Stored Frequencies .................................................. 120
Procedure: Dial Pulse Support ..................................................... 121
Inband DTMF Transmission .................................................... 121
Gateway Dial Pulse Example .................................................. 122
Procedure: Configuring Hook Flash Timing ................................. 123
Default Timing Settings ........................................................... 123
Provisioning Ring Cadences ......................................................... 124
Procedure: Post-Provisioning ....................................................... 125
NCS Post-Provisioning ............................................................ 125
Procedure: Provisioning a Gateway ............................................. 126
Provisioning Methods .............................................................. 126
Provisioning Precedence ........................................................ 126
WRM Operating Modes .......................................................... 126
Default Settings ....................................................................... 127
About IPv6 Operation .............................................................. 127
Setting the Operating Mode .................................................... 128
Configuring the Wireless Channel .......................................... 128
Configuring DNS Override/Relay ............................................ 128
Configuring IPv6 CPE Addressing .......................................... 129
Configuring DS-Lite Operation ................................................ 129
Procedure: Using XML-based Router Provisioning Files ............. 131
Provisioning Precedence ........................................................ 131
XML File Format ..................................................................... 131
TR-069 Provisioning ...................................................................... 133
Enabling TR-069 Support ....................................................... 133
TLV-43 Based Provisioning ..................................................... 133
Example Configuration ..................................................... 133
TR69AcsInfo Sub-TLV Formal Definitions .............................. 134
Tr69AcsUrl ........................................................................ 134
TR69AcsUserName ......................................................... 134

Firmware Guide Release 7.5 Standard 1.2 August 2012

x Contents

TR69AcsPassword ........................................................... 134

TR69CrUserName ............................................................ 134
TR69CrPassword ............................................................. 135
TR69AcsPerInfEnable ...................................................... 135
TR69AcsPerInfInter val ..................................................... 135
TR69AcsXAllowDocsCfg .................................................. 135
TR69CrURL ...................................................................... 135

Provisioning PacketCable 2.0 SIP Loads 137

PacketCable 2.0 Concepts ............................................................ 137
Terminology ............................................................................ 137
Configuration Concepts .......................................................... 138
Suppor ted Features ................................................................ 140
Over view of SIP Features .............................................................. 140
Barge-In .................................................................................. 140
Loopback ................................................................................ 140
Extended Offhook Processing ................................................ 141
Origination Mode .............................................................. 141
Termination Mode ............................................................. 141
Permanent Sequence ....................................................... 141
Emergency Calls ..................................................................... 142
Distinctive Ringing .................................................................. 143
Procedure: Configuring PacketCable 2.0 SIP .............................. 144
Configuration Over view ........................................................... 144
Configuring Operator Information ........................................... 144
Configuring Users and Features ............................................. 145
Configuring Extended Offhook Processing ............................. 146
Post-Provisioning SIP Lines .................................................... 146
Configuring T.38 and Fax-Only Modes ................................... 147
Procedure: Provisioning PacketCable 2.0 Features ..................... 148
Feature Support ...................................................................... 148
P-CSCF Dialing Features ....................................................... 151
Basic Call Configuration .......................................................... 151
Configuring the Status Change Feature ................................. 152
Configuring No Answer Timeout ............................................. 152
Configuring Caller ID .............................................................. 153
Configuring Emergency Services ........................................... 153
Configuring Distinctive Ring/Aler t Tones ................................. 154
Procedure: Configuring PacketCable 2.0 Digit Maps ................... 155
General Digit Map Structure ................................................... 155
TS7.5 Compliance with PacketCable 2.0 ................................ 158
Specifying a Digit Map ............................................................ 159
Example Digit Map .................................................................. 159
Procedure: Provisioning PacketCable 2.0 Users .......................... 163
Procedure: Provisioning PacketCable 2.0 Application Profiles .... 165
Indexing .................................................................................. 165
Procedure: Provisioning PacketCable 2.0 Application Maps ........ 166

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xi

Prerequisites ........................................................................... 166

Indexing .................................................................................. 166
Procedure: Configuring SIP Failure Response Tones .................. 167
Priority ..................................................................................... 167
Playing Busy Tone for All Errors .............................................. 167
Configuring Individual Response Tones ................................. 168
Procedure: Configuring MWI Support .......................................... 169
Clearing MWI Indicators ......................................................... 169
Provisioning the MWI Subscription ......................................... 169

Provisioning ARRIS SIP Loads 171

Over view of SIP Features .............................................................. 171
Barge-In .................................................................................. 171
Loopback ................................................................................ 171
Extended Offhook Processing ................................................ 172
Origination Mode .............................................................. 172
Termination Mode ............................................................. 172
Permanent Sequence ....................................................... 172
Emergency Calls ..................................................................... 173
Distinctive Ringing .................................................................. 174
SIP Provisioning Considerations ................................................... 175
Information Required for SIP .................................................. 175
SIP Registration Behavior ....................................................... 177
SIP Feature Switch ................................................................. 177
Provisioning Details ................................................................ 178
Digit Map .......................................................................... 178
Proxy Address .................................................................. 178
Registrar Address ............................................................. 178
Loopback .......................................................................... 178
Packetization Rate ............................................................ 179
Provisioned CODEC Array ............................................... 179
Repeat Dialing .................................................................. 179
Call Forwarding Forbidden Numbers ................................ 179
Call Waiting setting Persistent Across Reboot ................. 180
Default G.711 ................................................................... 180
Domain Override .............................................................. 180
Emergency Calls .............................................................. 180
Pulse Dialing .................................................................... 181
Line Specific Features ...................................................... 181
Distinctive Ringing ............................................................ 182
Dialing Features ............................................................... 182
Call Transfer ..................................................................... 183
Feature Capabilities .......................................................... 183
Timers .............................................................................. 184
Minimal Example ..................................................................... 185
Procedure: Provisioning SIP Support ........................................... 187
Per-Line Proxy/Registrar Objects ............................................ 187

Firmware Guide Release 7.5 Standard 1.2 August 2012

xii Contents

T.38 Provisioning Over view ..................................................... 188

Global Call Feature Control .................................................... 188
Per-line Call Feature Control ................................................... 189
CM Configuration File Changes .............................................. 190
eDVA Configuration File Changes .......................................... 190
Setting up Timers .................................................................... 193
Configuring Per-Line Proxy and Registrar .............................. 194
Specifying a SIP Domain Name .............................................. 195
Procedure: Provisioning SIP Features ......................................... 196
Requirements and Limitations ................................................ 196
Call Feature Control ................................................................ 196
Proxy Dialing Features ............................................................ 197
Suppor ted Dialing Features .................................................... 197
Setting up Dialing Features ..................................................... 198
Configuring Warmline or Hotline ............................................. 199
Configuring Repeat Dialing ..................................................... 200
Configuring T.38 and Fax-Only Modes ................................... 201
Configuring Distinctive Ring/Aler t Tones ................................. 202

Operations 205
Batter y Management ..................................................................... 205
Initial Battery Charging ........................................................... 206
Boot from Battery .................................................................... 206
Batter y Telemetr y .................................................................... 206
Power Failure Operation ......................................................... 206
LED Changes .......................................................................... 207
LED Operation Changes During Battery Charging ........... 207
Installer Visual Indication of Foreign Loop Voltage ........... 207
Batter y Mismatch Indication ............................................. 207
Batter y Status Monitoring ....................................................... 207
Highest Charger Temperature Recording ............................... 207
About IPv6 Support ....................................................................... 208
Suppor ted Hardware ............................................................... 208
IPv6 Multicast Support ............................................................ 208
Before Registration ........................................................... 209
During Registration ........................................................... 209
After Registration .............................................................. 209
IPv6 Management ......................................................................... 211
Filtering IPv6 Traffic ................................................................ 211
MLD Snooping .................................................................. 211
Upstream Drop Classifiers ............................................... 211
Coexistence ............................................................................ 212
DHCPv6 MIB Objects ............................................................. 212
SNMP Access ......................................................................... 214
Event Reporting ............................................................................. 215
Collecting Events .................................................................... 215
Event Formats ......................................................................... 215

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xiii

Cable Modem Log Format ................................................ 215

eDVA Log Format ............................................................. 216
Hiding FQDN and IP Information in the Event Log ................. 217
References .............................................................................. 218
Event Summary ............................................................................. 218
Event Handling ........................................................................ 218
eDVA States ............................................................................ 219
eDVA Line States .................................................................... 219
E-UE Battery States ................................................................ 220
eDVA Event Summary ............................................................ 221
ARRIS Events ............................................................................... 222
Voice Line Diag Failed ............................................................ 222
Voice Line Diag Passed .......................................................... 223
Voice Line State Change ........................................................ 223
Voice Line Protection State Change ....................................... 223
Power Supply Telemetr y Log .................................................. 224
MTA TFTP: Successful ........................................................... 224
MTA PROV: Successful! .......................................................... 224
SIP General Failure ................................................................. 224
SIP Network Failure ................................................................ 225
SIP Authentication Failure ....................................................... 225
SIP Registration Timeout ........................................................ 225
SIP Proxy Loss of Communications ........................................ 226
SSH LOGIN ACCEPTED ........................................................ 226
SSH LOGIN REJECTED ........................................................ 226
SSH LOGIN REJECTED - MAX ATTEMPTS REACHED ....... 227
Touchstone Firmware Upgrade Failed Before Download
Attempt .................................................................................... 227
Touchstone Firmware Upgrade Failed .................................... 228
Touchstone Firmware Upgrade Successful ............................ 228
Touchstone SW Upgrade Aborted due to Battery AC-FAIL
condition .................................................................................. 229
Touchstone SW Upgrade Aborted due to Call in Progress ..... 229
Touchstone SW Upgrade Reboot Delayed due to Call in
Progress .................................................................................. 229
MTA DHCP RENEW: Lease Renewal delay; Voice line
offhook .................................................................................... 229
MTA DHCP REBIND: Lease Renewal delay; Voice line
offhook .................................................................................... 230
Power Supply Telemetr y Alarm ............................................... 230
Gateway has reset .................................................................. 230
Unit has been restored to factor y defaults .............................. 231
Speedtest Results ................................................................... 231
PacketCable Events ...................................................................... 232
Batter y Not Low ...................................................................... 232
Batter y Low ............................................................................. 232
Batter y Present ....................................................................... 232

Firmware Guide Release 7.5 Standard 1.2 August 2012

xiv Contents

Batter y Missing ....................................................................... 232

Batter y Good ........................................................................... 232
Replace Battery ...................................................................... 232
AC Restored ........................................................................... 232
AC Fail .................................................................................... 232
Network Failure Recovery ............................................................. 233
Recovery from Extreme Plant Conditions ............................... 233
Procedure: Working with Message Trace Logs ............................ 234
Message Capacity .................................................................. 234
SNMP Over view ...................................................................... 234
Enabling or Disabling Message Tracing .................................. 235
Viewing Logs Using the CLI .................................................... 236
Viewing Logs Using SNMP ..................................................... 236
Viewing Logs Using the Web-based Interface ........................ 237
Controlling Logs Using the Web-Based Interface ................... 238
Clearing Message Trace Logs Using the CLI .......................... 239
Capturing Signaling Traces ........................................................... 240
Controlling Signaling Tracing .................................................. 240
Inter preting the Signaling Trace Output Data .......................... 241
Inter preting the Transmit Data Payload ............................ 242
Inter preting the Receive Data Payload ............................. 242
Signaling Trace Feature Example Output ......................... 243
Procedure: Configuring SNMP Coexistence ................................ 245
Over view ................................................................................. 245
Enabling SNMP Access .................................................... 245
Configuration File Notes ................................................... 246
SNMP Access Mode ........................................................ 246
SNMP Trap Transmission ................................................. 246
snmpCommunityTable Parameters ......................................... 247
vacmSecurityToGroupTable Parameters ................................. 247
vacmAccessTable Parameters ................................................ 248
Adding the snmpCommunityTable .......................................... 249
Adding the vacmSecurityToGroupTable .................................. 252
Adding the vacmAccessTable ................................................. 255
Procedure: Configuring Trap Ser vers ........................................... 258
TR-069 Management .................................................................... 261
Over view ................................................................................. 261
Suppor ted and Unsupported Features ............................. 261
Suppor ted Ser vers ........................................................... 261
Suppor ted TR-098 Objects ..................................................... 262
Baseline Profile Objects ................................................... 262
LAN-side DHCP Controls ................................................. 262
Wi-Fi and Wireless LAN Controls ..................................... 264
TR-098 Objects Recognized but not Supported ..................... 265
References .............................................................................. 266
Procedure: Recovery from Par tial Ser vice ................................... 267
Identifying Par tial Ser vice Issues ............................................ 267

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xv

If the CMTS does not Support CM-STATUS ........................... 268

If the CMTS does not Support REG-ACK ............................... 268
Model 8 Power Management ......................................................... 269
Power Save vs. Synchronous Upstreams ............................... 269
CMTS Considerations ............................................................. 269
ARRIS DOCSIS 3.0 MIB ............................................................... 271
arrisCmDoc30Base ................................................................. 271
arrisCmDoc30Access ............................................................. 271
arrisCmDoc30Setup ............................................................... 272
arrisCmDoc30Dhcp ................................................................ 277
arrisCmDoc30DhcpLeaseParameters Objects ................. 277
arrisCmDoc30DhcpSvrParameters Objects ..................... 277
arrisCmDoc30DhcpCmParameters Objects ..................... 278
arrisCmDoc30DhcpMtaParameters Objects .................... 279
arrisCmDoc30DhcpExtended ................................................. 279
arrisCmDoc30DhcpExtendedLeaseParametersTable
Objects ............................................................................. 279
arrisCmDoc30DhcpExtendedSvrParametersTable .......... 280
arrisCmDoc30DhcpExtendedCmParametersTable
Objects ............................................................................. 281
arrisCmDoc30ResetReasonLog ............................................. 281
arrisCmDoc30ResetReasonLogTable Objects ................. 281
arrisCmDoc30Software ........................................................... 281
DOCSIS 3.0 MIB Object Mapping ........................................... 282
Suppor ted eDVA MIB Objects ....................................................... 283
PACKETPORT-MIB Objects .................................................... 283
ppCfgPor tTable Objects .................................................... 283
ppSur vPor tTable Objects .................................................. 283
ARRIS-MTA-MIB (non-battery) ............................................... 284
arrisMtaDevControl Objects ............................................. 284
arrisMtaDevTrace Objects ................................................ 285
arrisMtaDevCallStatsTable ............................................... 288
arrisMtaDevParameters .................................................... 289
arrisMtaDevLineParameterTable ...................................... 289
arrisMtaDevUpSvcFlowParameterTable ........................... 290
arrisMtaDevVqm Objects .................................................. 291
arrisMtaDevOperationalSetup Objects ............................. 292
arrisMtaDevEndPntTable Objects ..................................... 298
arrisMtaDevGainControl Objects ...................................... 300
arrisMtaDevLevelControl Objects ..................................... 301
arrisMtaDevDiagLoopTable Objects ................................. 301
ARRIS-MTA-MIB (battery telemetr y items) ............................. 302
arrisMtaDevPwrSupplyBase Objects ................................ 302
arrisMtaDevPwrSupplyControl Objects ............................ 303
arrisMtaDevPwrSupplyTimers Objects ............................. 305
arrisMtaDevPwrSupplyStats Objects ................................ 305
arrisMtaDevBatter yStatusTable ........................................ 306

Firmware Guide Release 7.5 Standard 1.2 August 2012

xvi Contents

ARRIS-ROUTER-MIB Objects ...................................................... 308

arrisRouterWanConfig Objects ............................................... 308
arrisRouterWanCurrentTable Entries ................................ 309
arrisRouterWanStaticTable Entries ................................... 310
arrisRouterWanTunnelObjects .......................................... 310
arrisRouterWanDNSObjects ............................................. 311
arrisRouterWanCurrentDNSTable Objects ....................... 311
arrisRouterWanStaticDNSTable Objects .......................... 311
arrisRouterWanDHCPObjects .......................................... 312
arrisRouterDSLiteWanObjects ......................................... 312
arrisRouterLanConfig Objects ................................................ 313
arrisRouterLanSrvTable Entries ....................................... 313
arrisRouterLanDNSTable ................................................. 317
arrisRouterLanEtherPor tTable .......................................... 317
arrisRouterClientObjects .................................................. 318
arrisRouterLanClientTable ................................................ 318
arrisRouterDeviceUpDownTable ...................................... 319
arrisRouterLanCustomTable ............................................. 320
arrisRouterLanCurrentClientTable .................................... 320
arrisRouterLanStaticClientTable ....................................... 322
arrisRouterRIPObjects ..................................................... 323
arrisRouterRIPRoutedSubnetTable .................................. 324
arrisRouterWirelessCfg Objects ............................................. 325
arrisRouterBSSTable Entries ............................................ 329
arrisRouterWEPTable Entries ........................................... 330
arrisRouterWEP64BitKeyTable Entries ............................ 330
arrisRouterWEP128BitKeyTable Entries .......................... 331
arrisRouterWPATable Entries ............................................ 331
arrisRouterRadiusTable Entries ........................................ 332
arrisRouterMACAccessTable Entries ............................... 332
arrisRouterWMMCfg Objects ........................................... 333
arrisRouterWMMEDCAAPTable ....................................... 333
arrisRouterWMMEDCASTATable ...................................... 334
arrisRouterWPSCfg Objects ............................................. 335
arrisRouterWiFi80211NSettings Objects .......................... 336
arrisRouterFWCfg Objects ...................................................... 338
arrisRouterFWVirtSr vTable Entries .................................. 340
arrisRouterFWIPFilterTable .............................................. 341
arrisRouterFWMACFilterTable .......................................... 342
arrisRouterFWPor tTrigTable ............................................. 342
arrisRouterFWFilterRules ................................................. 343
arrisRouterFWDDNSObjs ................................................ 343
arrisRouterFWFeatures .................................................... 344
arrisRouterFWParentalControls ....................................... 345
arrisRouterKeywordBlkTable ............................................ 346
arrisRouterBlackListTable ................................................. 346
arrisRouterWhiteListTable ................................................ 347

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xvii

arrisRouterTrustedDeviceTable ........................................ 348

arrisRouterTrustedDeviceManagedSer vicesTable ........... 348
arrisRouterSysCfg Objects ..................................................... 349
arrisRouterSNTPSettings Sub-group ............................... 350
arrisRouterSNTPServerTable Entries ............................... 351
arrisRouterEmailSettings Sub-group ................................ 351
arrisRouterLogSettings Sub-group ................................... 351
arrisRouterUserLogs Objects ........................................... 351
arrisRouterMSOLogs Objects .......................................... 352
arrisRouterAuthTable Entries ............................................ 353
arrisRouterInboundTrafficLogTable Entries ...................... 353
arrisRouterHostAccess Objects .............................................. 353
arrisRouterWebAccessTable Entries ................................ 353
arrisRouterPingMgmt Objects ................................................. 353
arrisRouterTraceRtMgmt Objects ............................................ 355
ARRIS Speedtest MIB ................................................................... 357
Configuration Objects ............................................................. 357
Download Examples ......................................................... 357
Upload Examples ............................................................. 357
Control Object ......................................................................... 358
Results Table .......................................................................... 358

Administration 359
Administration Objects .................................................................. 360
System Description Objects .................................................... 360
sysDescr Object ............................................................... 360
sysObjectID Object ........................................................... 361
sysORTable Objects ......................................................... 362
Bridging and Routing Objects ................................................. 362
dot1dBridge Objects ......................................................... 362
rip2 Objects ...................................................................... 362
arrisRouterMib Objects ..................................................... 363
End of Call Connection Statistics .................................................. 364
NCS Behavior ......................................................................... 364
SIP Behavior ........................................................................... 365
End-of-Call Statistics MIB Objects .......................................... 365
Clearing Counters ................................................................... 365
Device Level End-of-Call Statistics ......................................... 366
Last Signaling Message Sent ................................................. 367
Line Level Status ..................................................................... 367
Per-Call Syslog Reporting ....................................................... 369
Per Call Syslog Report Example ...................................... 369
Message Trace Example .................................................. 370
Procedure: Managing Voice Quality Monitoring ........................... 371
About Voice Quality Monitoring ............................................... 371
VQM Data ............................................................................... 371
Inter preting Results ................................................................. 377

Firmware Guide Release 7.5 Standard 1.2 August 2012

xviii Contents

Voice Quality Monitoring MIB Objects ..................................... 378

Collecting Remote Metrics ...................................................... 379
Configuring Local VQM Reporting .......................................... 380
Retrieving the Last Call Using SNMP ..................................... 381
Retrieving VQM Data Using SNMP ........................................ 381
Retrieving VQM Data Using the CLI ....................................... 383
Retrieving VQM Data Using the Web-based Interface ............ 384
Setting VQM Thresholds ......................................................... 387
Clearing VQM Data ................................................................. 387
Procedure: Using the Speedtest Application ................................ 389
Requirements and Limitations ................................................ 389
Ser ver Requirements ....................................................... 389
Testing Limitations ............................................................ 390
Running a Speed Test using the Web Pages .......................... 390
Running a Speed Test using SNMP ........................................ 392
Running a Speed Test using the CLI ...................................... 393

Maintenance 397
Over view of Maintenance Interfaces ............................................. 397
CLI Access Levels and Defaults ............................................. 398
WebGUI Access Levels and Defaults ..................................... 398
About TACACS+ Support ........................................................ 399
LED Patterns ................................................................................. 399
Batter y Mismatch .................................................................... 400
Wiring Problems ...................................................................... 400
TM702 Normal Operation ....................................................... 400
TM722/TM802/TM804/TM822 Normal Operation ................... 401
TM702/TM722/TM802/TM804/TM822 Startup Sequence ...... 402
eDVA Star tup Sequence ................................................... 402
Cable Modem Startup Sequence ..................................... 402
TG852G Normal Operation ..................................................... 402
TG852G Startup Sequence .................................................... 404
eDVA Star tup Sequence ................................................... 404
Cable Modem Startup Sequence ..................................... 404
TG852G/CT Normal Operation ............................................... 404
TG852G/CT Startup Sequence .............................................. 405
eDVA Star tup Sequence ................................................... 405
Cable Modem Startup Sequence ..................................... 406
SIP Concepts ................................................................................ 407
Dialogs .................................................................................... 407
Transactions ............................................................................ 407
Authorization ........................................................................... 407
Registration ............................................................................. 408
Subscriptions .......................................................................... 408
Implicit Subscriptions ........................................................ 408
Call Legs ................................................................................. 409
Basic Call Flow ................................................................. 409

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xix

Basic Call Flow with PRACK ............................................ 410

Forking ............................................................................. 412
Call Forking Trace ............................................................. 412
Offer/Answer ........................................................................... 413
PRACK ............................................................................. 413
Session Timer ......................................................................... 413
SRV ......................................................................................... 414
Message Retransmission ........................................................ 415
SIP Message Over view ........................................................... 415
INVITE .............................................................................. 415
CANCEL ........................................................................... 415
BYE .................................................................................. 415
UPDATE ........................................................................... 415
SUBSCRIBE ..................................................................... 416
NOTIFY ............................................................................ 416
REFER ............................................................................. 416
INFO ................................................................................. 416
PRACK ............................................................................. 416
Response Codes .................................................................... 416
1XX - Provisional Responses ........................................... 416
2XX - Successful .............................................................. 417
3XX - Redirection ............................................................. 417
4XX - Request Failure ...................................................... 417
5XX - Server Failure ......................................................... 417
6XX - Global Failures ....................................................... 417
References .............................................................................. 417
Procedure: Running Line Card Diagnostics ................................. 419
About Line Card Diagnostics .................................................. 419
Testing Over view ..................................................................... 419
Procedure: Running Loop Diagnostics ......................................... 420
About Loop Diagnostics .......................................................... 420
Hazardous Potential Test .................................................. 420
Foreign Electromotive Test ............................................... 420
Resistive Faults Test ......................................................... 421
Receiver Off Hook Test ..................................................... 422
Ringers Test ..................................................................... 422
Limitations ............................................................................... 423
Test Results ............................................................................ 423
Running Loop Diagnostics from an SNMP Manager .............. 424
Running Loop Diagnostics from the CLI ................................. 425
Running Loop Diagnostics from the Web-based Interface ...... 426
Loopback Testing .......................................................................... 429
Reset to Factor y Defaults .............................................................. 429
Resetting the Router (TG852) ................................................. 430
Procedure: Using the Password of the Day Tool .......................... 431
About the Password of the Day Tool ....................................... 431
Generating a Single Password ................................................ 432

Firmware Guide Release 7.5 Standard 1.2 August 2012

xx Contents

Generating a List of Passwords .............................................. 432

Changing the Seed ................................................................. 433
Generating an Operator-Defined Password ............................ 434
Procedure: Enabling and Accessing the Troubleshooting CLI ..... 435
SSH Login IDs ........................................................................ 435
Enabling CLI Access Using the Web Pages ........................... 435
Enabling CLI Access Using SNMP ......................................... 436
Setting the CLI Timeout .......................................................... 437
Accessing the CLI through Telnet ........................................... 437
Accessing the CLI through SSH ............................................. 438
Procedure: Using the Web-based Troubleshooting Interface ....... 439
Access Options ....................................................................... 439
Requirements .......................................................................... 439
Controlling Access to the Interface ......................................... 439
Standard Screens ................................................................... 440
Status Screen ................................................................... 440
HW/SW Versions Screen .................................................. 441
Event Log Screen ............................................................. 442
Registration Status Screen ............................................... 444
Wireless Screen ............................................................... 446
Scanning Override Screen ............................................... 446
Advanced Screens .................................................................. 446
Product Details Screen ..................................................... 447
DHCP Parameters ............................................................ 448
QoS Statistics Screen ...................................................... 449
Call Signalling Log ............................................................ 450
Configuration Parameters Screen .................................... 451
Technical Support Screen ................................................ 452
Speedtest Web Page ........................................................ 453
Results Section ................................................................ 454
Configuration Section ....................................................... 455
Accessing the Standard Pages ............................................... 457
Accessing the Advanced Pages .............................................. 457
Procedure: Troubleshooting SIP ................................................... 458
Internal eDVA States ............................................................... 458
Enabling SIP Logging ............................................................. 459
Tracing SIP Messages ............................................................ 459
Procedure: SIP Loopback Testing ................................................ 460
Loopback Suppor t ................................................................... 460

References 461
Suppor ted Calling Features ........................................................... 461
Countr y Code Templates ............................................................... 464
Nor th American Ring Cadences ............................................. 465
Netherlands/Netherlands09 Ring Cadences .......................... 466
Provisioning European Ring Cadences .................................. 466
Austria Ring Cadences ........................................................... 467

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxi

Australia Ring Cadences ........................................................ 468

Belgium Ring Cadences ......................................................... 468
France Ring Cadences ........................................................... 469
Germany/Germany2 Ring Cadences ...................................... 470
Hungar y Ring Cadences ......................................................... 470
Israel Ring Cadences .............................................................. 471
Japan Ring Cadences ............................................................. 472
Mexico Ring Cadences ........................................................... 472
MexicoC Ring Cadences ........................................................ 473
Netherlands/Netherlands09 Ring Cadences .......................... 474
Norway Ring Cadences .......................................................... 475
Panama Ring Cadences ......................................................... 475
Poland/Poland1010/Slovakia Ring Cadences ......................... 476
Switzerland Ring Cadences .................................................... 476
Customizing Default Ring Cadences ...................................... 477
Default Tone Settings .................................................................... 477
XML Configuration File .................................................................. 495
Example .................................................................................. 495

Command-Line Interface Reference 499

Common Top-Level Commands .................................................... 499
status ...................................................................................... 499
!reset ....................................................................................... 500
help ......................................................................................... 500
!logout ..................................................................................... 500
persist ..................................................................................... 500
quit .......................................................................................... 500
Top-level Commands ..................................................................... 500
tech ......................................................................................... 500
system ..................................................................................... 500
nvm ......................................................................................... 500
download ................................................................................. 500
mdiag ...................................................................................... 500
led ........................................................................................... 500
dhcp ........................................................................................ 501
tlm ........................................................................................... 501
database ................................................................................. 501
rf .............................................................................................. 501
gw ........................................................................................... 501
co ............................................................................................ 501
voice ........................................................................................ 501
speedtest ................................................................................ 501
System Menu ................................................................................ 502
sysinfo ..................................................................................... 502
dhcp ........................................................................................ 502
telnet_timer ............................................................................. 503
lastreset .................................................................................. 503

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxii Contents

exception ................................................................................. 504

dpacm ..................................................................................... 504
buffer ....................................................................................... 504
gw_diag ................................................................................... 504
rf_diag ..................................................................................... 505
LED Menu ..................................................................................... 506
all_on ...................................................................................... 506
all_on_green ........................................................................... 506
all_off ...................................................................................... 506
flash ........................................................................................ 506
resume .................................................................................... 506
DHCP Menu .................................................................................. 507
cmEnblLog .............................................................................. 507
cmDispLog .............................................................................. 507
cmClrLog ................................................................................. 507
mtaEnblLog ............................................................................. 507
mtaDispLog ............................................................................. 507
mtaClrLog ............................................................................... 507
mtaSubOpt3Immediate ........................................................... 507
Technician Commands .................................................................. 508
setRouteMode ......................................................................... 508
setWanIp ................................................................................. 508
setWanGateway ...................................................................... 508
setWanDns ............................................................................. 509
showWan ................................................................................ 509
setDhcpEnable ........................................................................ 509
setDhcpPool ............................................................................ 509
setLanIp .................................................................................. 509
setTACACSSer ver ................................................................... 509
setTACACSSecret ................................................................... 509
showTACACS .......................................................................... 510
setRipEnable ........................................................................... 510
setRipIp ................................................................................... 510
setRipAuth .............................................................................. 510
setRipKeyId ............................................................................. 510
setRipDhcpEnable .................................................................. 510
showRip .................................................................................. 510
setRipLogMask ....................................................................... 510
showRipLog ............................................................................ 510
setHttpWanAccess .................................................................. 511
setHttpLanAccess ................................................................... 511
showHttpAccess ..................................................................... 511
setEthernet ............................................................................. 511
showEthernet .......................................................................... 511
showStatus ............................................................................. 511
resetDefaults ........................................................................... 512
commit .................................................................................... 512

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxiii

status ...................................................................................... 512

!reset ....................................................................................... 512
Telemetr y Menu ............................................................................. 512
/ ............................................................................................... 512
chgrStatus ............................................................................... 512
tlmStatus ................................................................................. 512
tapi .......................................................................................... 513
eprom ...................................................................................... 514
resetChrgr ............................................................................... 514
Database Menu ............................................................................. 515
display ..................................................................................... 515
byteget .................................................................................... 516
intget ....................................................................................... 516
RF Menu ........................................................................................ 516
dstatus .................................................................................... 516
ustatus .................................................................................... 517
freqband .................................................................................. 517
tune ......................................................................................... 517
dfreq ........................................................................................ 517
ufreq ........................................................................................ 518
wbdfreq ................................................................................... 518
nbdfreq .................................................................................... 518
clearfreq .................................................................................. 518
sweep ...................................................................................... 518
trr ............................................................................................. 519
trw ........................................................................................... 519
dtune ....................................................................................... 519
dlock ........................................................................................ 519
scanmode ............................................................................... 519
printscan ................................................................................. 519
dump ....................................................................................... 520
read ......................................................................................... 521
write ........................................................................................ 521
macread .................................................................................. 521
macwrite ................................................................................. 521
cache ...................................................................................... 521
clearcw .................................................................................... 522
dsavg ...................................................................................... 522
cer t .......................................................................................... 522
tunerset ................................................................................... 523
channelset ............................................................................... 523
printds ..................................................................................... 523
printus ..................................................................................... 529
!appmode ................................................................................ 530
!ecache ................................................................................... 530
Gateway Commands ..................................................................... 531
get ........................................................................................... 531

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxiv Contents

set ........................................................................................... 531

search ..................................................................................... 531
rc ............................................................................................. 532
reset ........................................................................................ 532
ping ......................................................................................... 532
tr69Star t .................................................................................. 532
tr69Update .............................................................................. 533
tr69Stop .................................................................................. 533
dmz ......................................................................................... 533
commit .................................................................................... 533
!defaults .................................................................................. 533
wrmStatus ............................................................................... 533
xmlStatus ................................................................................ 533
xmlRestar t ............................................................................... 534
xmlLog .................................................................................... 534
Valid Variables ........................................................................ 534
WAN Variables ................................................................. 534
LAN Variables ................................................................... 535
Wireless Settings .............................................................. 538
Firewall Variables ............................................................. 540
System and Management Variables ................................. 544
Cable Modem Variables ................................................... 546
Speedtest CLI ................................................................................ 547
Configure ................................................................................ 547
Mode ....................................................................................... 547
Address ................................................................................... 547
Port ......................................................................................... 547
File .......................................................................................... 548
Username ............................................................................... 548
Password ................................................................................ 548
UpSize .................................................................................... 548
UpScript .................................................................................. 548
UpPostFields ........................................................................... 548
UpFileField .............................................................................. 549
TCPWindow ............................................................................ 549
TCPMSS ................................................................................. 549
TCPTimeStamp ...................................................................... 549
PMTU ...................................................................................... 549
MTU ........................................................................................ 549
CpeAccess .............................................................................. 550
Lro ........................................................................................... 550
Bypass .................................................................................... 550
LED ......................................................................................... 550
ShowConfig ............................................................................. 550
ShowResults ........................................................................... 552
Star t ........................................................................................ 552
Stop ........................................................................................ 552

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxv

MAIN Console Commands 553

General Information ....................................................................... 553
Main Menu Commands ................................................................. 553
Common Commands .................................................................... 554
help ......................................................................................... 554
shor tcuts ................................................................................. 554
exit .......................................................................................... 554
quit .......................................................................................... 554
reboot ...................................................................................... 554
System Submenu Commands ....................................................... 554
network ................................................................................... 554
memor y ................................................................................... 554
timers ...................................................................................... 555
netrxReduce ............................................................................ 555
netrxRestore ........................................................................... 555
pp ............................................................................................ 555
enable ............................................................................... 555
disable .............................................................................. 555
deinit ................................................................................. 555
setTimeout ........................................................................ 555
resetTimeout .................................................................... 555
resetStats ......................................................................... 555
dbg ................................................................................... 555
nodbg ............................................................................... 556
global ................................................................................ 556
stats .................................................................................. 556
pids ................................................................................... 556
vpids ................................................................................. 556
session ............................................................................. 556
devs .................................................................................. 556
brief .................................................................................. 556
psm ................................................................................... 556
nopsm ............................................................................... 556
qos .................................................................................... 557
noqos ................................................................................ 557
setThreshold ..................................................................... 557
thresholdDisable ............................................................... 557
sme ......................................................................................... 557
list ..................................................................................... 557
lshor t ................................................................................ 557
llong .................................................................................. 558
SetModule ........................................................................ 558
SetSeverity ....................................................................... 558
DOCSIS Submenu Commands ..................................................... 559
version .................................................................................... 559
phystatus ................................................................................. 559

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxvi Contents

tuner ........................................................................................ 560

statustuner .............................................................................. 560
scan ........................................................................................ 560
cerreset ................................................................................... 560
cmstatus .................................................................................. 561
listDocsisModules ................................................................... 561
configDocsisModule ................................................................ 561
testDsLoss .............................................................................. 561
Show ....................................................................................... 561
cpe .................................................................................... 562
timeoverversion ................................................................ 562
cmstatusmasks ................................................................. 562
Cer tification ............................................................................. 563
status ................................................................................ 563
accesstime ....................................................................... 563
resetaccesstime ............................................................... 563
cmcer t .............................................................................. 563
mfgcer t ............................................................................. 563
rootpublickey ..................................................................... 563
General ................................................................................... 564
ucd .................................................................................... 564
ipcable .............................................................................. 564
goto .................................................................................. 564
tune .................................................................................. 564
next ................................................................................... 564
rem ................................................................................... 564
macaddr ........................................................................... 565
hwcounters ....................................................................... 565
Atp .......................................................................................... 565
addcpe .............................................................................. 565
triggercmstatus ................................................................. 565
suspendcmstatus ............................................................. 566
printcmstatusevents .......................................................... 566
overdsidholdoffovr ............................................................ 566
deldsidholdoff ................................................................... 566
Fw ........................................................................................... 566
version .............................................................................. 566
mapperStats ..................................................................... 566
isrStats ............................................................................. 567
mbxStats .......................................................................... 567
errStats ............................................................................. 568
sfStats .............................................................................. 568
guardTimeStats ................................................................ 569
rtosStats ........................................................................... 570
clusterSidTable ................................................................. 570
iucEnList ........................................................................... 571
backoffCounters ............................................................... 571

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxvii

cppiStats ........................................................................... 571

printAll .............................................................................. 571
gQosDbFwPrivateArray .................................................... 572
gQosDbHostConfigArray .................................................. 573
gQosDbClusterArray ........................................................ 573
gQosDbPhsInfo ................................................................ 573
gUsChannelPrivateInfo ..................................................... 574
gUsChannelConfigInfo ..................................................... 574
gUpstreamBpiInfo ............................................................. 574
gUgsMaxQueueDepth ...................................................... 574
dsCounters ....................................................................... 574
dsPdsp1Configuration ...................................................... 574
dsPdsp2Configuration ...................................................... 574
dsBpi ................................................................................ 574
dsPhs ............................................................................... 574
dsUnicast .......................................................................... 575
tdoxStats ........................................................................... 575
Qos ......................................................................................... 575
database ........................................................................... 575
debug ............................................................................... 575
atp .................................................................................... 576
Debug ..................................................................................... 578
cerreset ............................................................................ 579
equadump ........................................................................ 579
equthresh ......................................................................... 579
macread ........................................................................... 579
macwrite ........................................................................... 579
setequthresh ..................................................................... 579
temptuner ......................................................................... 580
adcdump ........................................................................... 580
dump ................................................................................ 580
read .................................................................................. 580
tunerstatus ........................................................................ 580
usstatus ............................................................................ 581
dsstatus ............................................................................ 581
write .................................................................................. 582
mml ................................................................................... 582
dml .................................................................................... 582
phystatus .......................................................................... 582
berstatus ........................................................................... 583
isrmask ............................................................................. 583
clearNvramDsUsFreqDb .................................................. 583
clearNvramUsFreqDb ....................................................... 583
printNvramDsUsFreqDb ................................................... 584
initDsUsFreqDb ................................................................ 584
allphystatus ....................................................................... 584
ucdCollectStatus .............................................................. 584

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxviii Contents

SetDebugOption ............................................................... 584

SetAllDebugOptions ......................................................... 584
showDebugOptions .......................................................... 585
ForceT4Multiplier .............................................................. 585
ForceRngRspAbor t ........................................................... 585
ForceRngRspFreq ............................................................ 585
ForceRngRspDRW ........................................................... 586
ForceRngRspPowerOffset ................................................ 586
RebootSimulate ................................................................ 586
SetMimo ........................................................................... 586
SetMdCfgIpProvMode ...................................................... 587
DCC .................................................................................. 587
DBC .................................................................................. 587
ForceUsPSM .................................................................... 588
ForceDsPSM .................................................................... 588
Dsid ......................................................................................... 588
mdfMode .......................................................................... 588
dsidCounters .................................................................... 588
confCode .......................................................................... 588
reseqDsids ....................................................................... 589
mcastDsids ....................................................................... 589
allDsids ............................................................................. 589
printDsidDb ....................................................................... 589
dbridgeMdfDb ................................................................... 589
dbridgeAlt ......................................................................... 589
dbridgeListCpe ................................................................. 589
dbridgeCounters ............................................................... 590
Pp ........................................................................................... 590
enableTdox ....................................................................... 590
disableTdox ...................................................................... 590
tdox ................................................................................... 590
enableL2vpnPromMode ................................................... 590
disableL2vpnPromMode ................................................... 590
stats .................................................................................. 590
if ........................................................................................ 590
tpPor ts .............................................................................. 590
filters ................................................................................. 591
classifiers .......................................................................... 591
all ...................................................................................... 591
Psm ......................................................................................... 591
downstream ...................................................................... 591
upstream .......................................................................... 591
phy-mac ............................................................................ 591
pp ..................................................................................... 592
psm ................................................................................... 592
wb-adc .............................................................................. 592
pompt ............................................................................... 592

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxix

get-pompt ......................................................................... 592

PACM Submenu Commands ......................................................... 592
version .................................................................................... 592
options .................................................................................... 593
provisioning ............................................................................. 593
dhcpSer versConfig ........................................................... 593
sendCMLinkUpEvent ........................................................ 593
sendMSMStar tEvent ........................................................ 593
sendDHCPLeaseFailEvent ............................................... 593
sendDHCPNewIPEvent .................................................... 593
sendCMLinkDownEvent ................................................... 593
sendCMFullScanNoQam .................................................. 593
sendCMQamRegained ..................................................... 593
sendCMResetEvent .......................................................... 593
sendMTAResetEvent ........................................................ 594
sendVoiceRstDoneEvent .................................................. 594
sendVoiceRstFailEvent ..................................................... 594
sendSecRstDoneEvent .................................................... 594
sendSecRstFailEvent ....................................................... 594
configFile .......................................................................... 594
hashBypassSet ................................................................ 594
provDBcontents ................................................................ 594
setVoiceLoopVoltage ........................................................ 594
tftpAlwaysOn .................................................................... 594
provStatus ........................................................................ 595
provFlow ........................................................................... 595
provDebug ........................................................................ 595
security ................................................................................... 595
resetTickets ...................................................................... 595
overrideCmsTtl ................................................................. 595
timersDisplay .................................................................... 595
smDataDisplay ................................................................. 595
mtaDisplay ........................................................................ 596
displayDB ......................................................................... 596
cer tificates ........................................................................ 596
vendorSubMenu ...................................................................... 597
vendorSetDhcpSer verAddr ............................................... 598
vendorModifyDhcpAckParam ........................................... 598
vendorSetTftpData ........................................................... 598
vendorAddSnmpTarget ..................................................... 598
printVendorRegisteredEvents ........................................... 599
VENDOR_STATUS_VENDOR_APP_set ......................... 599
VENDOR_AFTER_MSM_INIT_set .................................. 599
VENDOR_SET_DHCP_SERVER_ADDR_set ................. 599
VENDOR_AFTER_DHCP_ACK_set ................................ 599
VENDOR_SET_TFTP_DATA_set ..................................... 599
VENDOR_ADD_SNMP_TARGET_set ............................. 600

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxx Contents

VENDOR_BEFORE_MTA_RESET_set ........................... 600

VENDOR_ENABLE_EVENTS_set ................................... 600
VENDOR_ENABLE_DHCP_PLUG_IN_set ..................... 600
VENDOR_ENABLE_CFM_PLUG_IN_set ........................ 600
VENDOR_DISABLE_CFM_SPEC_TREE_set ................. 600
restore .............................................................................. 600
save .................................................................................. 601
show ................................................................................. 601
production ............................................................................... 601
prodSet ............................................................................. 601
PACM_CONFIG_EURO_set ............................................ 601
PACM_CONFIG_MTA_NUM_LINES_set ......................... 601
PACM_CONFIG_IP_ADDR_set ....................................... 601
PACM_CONFIG_HW_ADDR_set ..................................... 601
PACM_CONFIG_MTA_TELE_ID_set ............................... 601
PACM_CONFIG_MTA_BBU_set ...................................... 602
save .................................................................................. 602
show ................................................................................. 602
setDefaultMacAddress ..................................................... 602
dynamicConfig ........................................................................ 602
set ..................................................................................... 602
PACM_DYN_CONFIG_LOOPV_POLICY_set .................. 602
PACM_DYN_CONFIG_LOOPV_STATUS_set .................. 602
PACM_DYN_CONFIG_LOOPV_RESET_TIMER_set ...... 602
PACM_DYN_CONFIG_LOOPV_MAINT_TIMER_CD_set . 602
PACM_DYN_CONFIG_SNMP_ENGIN_BOOT_NUM_set 602
restore .............................................................................. 603
save .................................................................................. 603
show ................................................................................. 603
event ....................................................................................... 603
sendEvent ......................................................................... 603
displayEventTable ............................................................. 603
printLogFile ....................................................................... 603
resetLogFile ...................................................................... 603
deleteLogFile .................................................................... 603
resetTables ....................................................................... 604
debugMenu ............................................................................. 604
debugSet .......................................................................... 604
PACM_CONFIG_EURO_HASH_SIZE_20_set ................ 604
PACM_CONFIG_MTA_RESET_WATCH_DOG_set ......... 604
PACM_CONFIG_TICKETS_FLASH_SUPPORT_set ....... 604
PACM_CONFIG_PROV_DHCP_RETRIES_set ............... 604
PACM_CONFIG_IPSEC_ENABLE_set ............................ 604
PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set . 604
PACM_CONFIG_CERTIFICATION_MODE_set ............... 605
PACM_CONFIG_SNMPV2_ACCESS_set ....................... 605
PACM_CONFIG_TLV38_SNMPV1_ENABLE_set ............ 605

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxxi

PACM_CONFIG_CFM_FILE_HASH_BYPASS_set ......... 605

PACM_CONFIG_MAS_ROUTE_TO_LOGGER_set ........ 605
ARRIS_PROVISIONING_set ........................................... 605
restore .............................................................................. 605
save .................................................................................. 605
show ................................................................................. 606
managerMenu ......................................................................... 606
PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set ..... 606
PACM_MANAGER_VOICE_DECT_IF_set ....................... 606
PACM_MANAGER_VOICE_VLM_IF_set ......................... 606
PACM_MANAGER_SNMP_RESTRICT_CON-
FIG_VIEW_set ................................................................. 606
PACM_MANAGER_TOD_DELAY_SEC_PROV_set ........ 606
PACM_MANAGER_HITLESS_SOFTWARE_DOWN-
LOAD_set ......................................................................... 606
PACM_MANAGER_HITLESS_DHCP_set ........................ 606
PACM_MANAGER_RANDOM_USM_SPIN_LOCK_set ... 606
PACM_MANAGER_VENDOR_COMMU-
NITY_NAME_set .............................................................. 607
PACM_MANAGER_VENDOR_CMS_AS_IP_set ............. 607
PACM_MANAGER_VENDOR_ENABLE_EVENTS_set ... 607
PACM_MANAGER_PSM_ENABLE_set ........................... 607
restore .............................................................................. 607
save .................................................................................. 607
show ................................................................................. 607
Logger Submenu Commands ....................................................... 608
ComponentConfig ................................................................... 608
AllComponentsConfig ............................................................. 608
ModuleConfig .......................................................................... 608
AllModulesConfig .................................................................... 608
SeverityConfig ......................................................................... 608
AllSeveritiesConfig .................................................................. 608
SocketConfig ........................................................................... 608
FilenameConfig ....................................................................... 608
QueueLimitConfig ................................................................... 609
DebugModulesConfig ............................................................. 609
AllDebugModulesConfig ......................................................... 609
TimeDisplay ............................................................................ 609
ComponentDisplay .................................................................. 609
ModuleDisplay ........................................................................ 609
FunctionLineDisplay ................................................................ 609
FullDisplay .............................................................................. 609
DefaultDisplay ......................................................................... 610
Shor tDisplay ........................................................................... 610
UserDisplay ............................................................................. 610
TargetConfig ............................................................................ 610
componentsList ....................................................................... 610

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxxii Contents

modulesList ............................................................................. 610

severitiesList ........................................................................... 611
displayConfigList ..................................................................... 612
targetsList ............................................................................... 612
socketShow ............................................................................. 612
filenameShow ......................................................................... 613
queueLimitShow ..................................................................... 613
setDefaults .............................................................................. 613
list ............................................................................................ 613
info .......................................................................................... 613
enable ..................................................................................... 613
disable ..................................................................................... 613
Event Manager Submenu Commands .......................................... 613
SendEvent .............................................................................. 613
SendStdTrap ........................................................................... 614
ResetLog ................................................................................. 614
DefaultEventTables ................................................................. 614
SetEventLevel ......................................................................... 614
SetEventMask ......................................................................... 615
SetEventText ........................................................................... 615
SetPriorityMask ....................................................................... 615
GetEventsList .......................................................................... 615
SetThrotAdmin ........................................................................ 616
SetThrotThresh ....................................................................... 616
SetThrotInter val ...................................................................... 616
GetThrotParams ..................................................................... 616
Star tSyslog ............................................................................. 616
StopSyslog .............................................................................. 617
GetSyslogSer ver ..................................................................... 617
Star tSNMP .............................................................................. 617
StopSNMP .............................................................................. 617
ExitManager ............................................................................ 617

Voice CLI Commands 619

Common Voice Commands ........................................................... 619
!reset ....................................................................................... 619
help ......................................................................................... 619
quit .......................................................................................... 619
Top-Level Commands .................................................................... 619
dsp .......................................................................................... 619
callp_cp ................................................................................... 619
mta .......................................................................................... 620
lc ............................................................................................. 620
Voice DSP Commands .................................................................. 620
dimdbg .................................................................................... 620
dimdbg opt ........................................................................ 620
dimdbg ver ........................................................................ 620

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxxiii

dimdbg stats ..................................................................... 621

dimdbg dump .................................................................... 622
dimdbg silence ................................................................. 622
dimdbg cfg ........................................................................ 622
dimdbg pt .......................................................................... 622
dimdbg tcids ..................................................................... 622
dimdbg poll stats .............................................................. 623
dimdbg set_poll ................................................................ 623
dimdbg set_voice_poll ...................................................... 623
dimdbg gsync ................................................................... 624
dimdbg msg ...................................................................... 624
dimdbg sig ........................................................................ 624
dimdbg ndu_stat ............................................................... 624
dimdbg prof_define ........................................................... 625
dimdbg lo_details ............................................................. 625
dimdbg hpi_details ........................................................... 626
dimdbg test_poll_period ................................................... 627
dimdbg show_reflection_page .......................................... 628
dimdbg power ................................................................... 628
dim mips_stat ................................................................... 628
dim set_status_req ........................................................... 629
dim reset_tdm ................................................................... 629
ccudbg .................................................................................... 629
dadbg ...................................................................................... 629
dadbg usage ..................................................................... 629
dadbg dnld ........................................................................ 629
dadbg image ..................................................................... 629
dadbg base ....................................................................... 629
dadbg chan ....................................................................... 630
dadbg overlay_pcm_lbrc .................................................. 630
dadbg chan_alloc_order ................................................... 630
dadbg sec_alloc ............................................................... 630
dadbg sec_config ............................................................. 630
dadbg sec_show .............................................................. 630
dsimdbg .................................................................................. 631
dsimdbg show .................................................................. 631
dsimdbg select ................................................................. 631
rtcpdbg .................................................................................... 631
spy .......................................................................................... 632
dsp .......................................................................................... 633
download ................................................................................. 633
config ...................................................................................... 633
unconfig .................................................................................. 633
allocChannel ........................................................................... 633
freeChannel ............................................................................ 634
reqCoding ............................................................................... 634
reqNullCoding ......................................................................... 634

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxxiv Contents

state ........................................................................................ 634

tone ......................................................................................... 634
setvp ....................................................................................... 634
jittermode ................................................................................ 635
nomjitter .................................................................................. 635
maxjitter .................................................................................. 636
reconfig ................................................................................... 636
echo ........................................................................................ 636
nlplevel .................................................................................... 636
echotail .................................................................................... 637
looprx ...................................................................................... 637
looptx ...................................................................................... 637
rtcp_info .................................................................................. 637
rxtx_stat .................................................................................. 637
err_stat .................................................................................... 638
level_stat ................................................................................. 639
vp_stat .................................................................................... 640
echo_stat ................................................................................ 640
gain_req .................................................................................. 641
ecpath_coeff ........................................................................... 641
traffic ....................................................................................... 641
restar t ...................................................................................... 641
mft_open ................................................................................. 642
mft_close ................................................................................. 642
detect_tone ............................................................................. 642
dt_setup .................................................................................. 642
dt_cleanup .............................................................................. 642
st_setup .................................................................................. 642
st_cleanup ............................................................................... 642
cps .......................................................................................... 642
vbdbitmap ............................................................................... 643
vbdmin .................................................................................... 643
vbdnom ................................................................................... 643
vbdmax ................................................................................... 643
customjitter .............................................................................. 643
custommin ............................................................................... 643
customnom ............................................................................. 644
custommax .............................................................................. 644
info .......................................................................................... 644
!reset ....................................................................................... 644
jitsim Sub-Mode ...................................................................... 644
/ ........................................................................................ 644
enable ............................................................................... 644
disable .............................................................................. 644
settings ............................................................................. 645
drop .................................................................................. 645
delay ................................................................................. 645

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxxv

loss_off ............................................................................. 646

loss_fixed .......................................................................... 646
loss_random ..................................................................... 647
jit_off ................................................................................. 647
jit_fixed ............................................................................. 648
jit_shift .............................................................................. 648
jit_burst ............................................................................. 649
jit_random ......................................................................... 649
jit_random_win ................................................................. 650
jit_rolling ........................................................................... 650
debug ............................................................................... 651
setvp ................................................................................. 651
vp_stat .............................................................................. 652
Voice Linecard Commands ........................................................... 653
read ......................................................................................... 653
write ........................................................................................ 653
regdump .................................................................................. 653
rread ........................................................................................ 654
objdump .................................................................................. 654
provision .................................................................................. 654
deprovision .............................................................................. 654
diag ......................................................................................... 654
diagForce ................................................................................ 655
dresults ................................................................................... 655
lpdiag ...................................................................................... 656
lpdiagForce ............................................................................. 656
lpresults ................................................................................... 657
ring .......................................................................................... 657
polarity .................................................................................... 658
loopc ....................................................................................... 658
hook ........................................................................................ 659
tone ......................................................................................... 659
idle .......................................................................................... 660
xconnect .................................................................................. 660
errors ....................................................................................... 660
tos ........................................................................................... 661
template .................................................................................. 661
state ........................................................................................ 662
quecp ...................................................................................... 663
vbat ......................................................................................... 663
ringfreq .................................................................................... 663
lcstatus .................................................................................... 664
cal_dump ................................................................................ 665
enableidle ................................................................................ 665
batcal ...................................................................................... 666
polling ...................................................................................... 666
Voice CallP Commands ................................................................. 666

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxxvi Contents

dds .......................................................................................... 666

dlr ............................................................................................ 666
dst ........................................................................................... 667
chst ......................................................................................... 667
callpEnblLog ........................................................................... 668
callpDispLog ........................................................................... 668
callpClrLog .............................................................................. 669
dsxEnblLog ............................................................................. 669
dsxDispLog ............................................................................. 669
dsxClrLog ................................................................................ 669
trace ........................................................................................ 669
mgcp ....................................................................................... 671
dsxtrace .................................................................................. 671
change_ne .............................................................................. 671
setgain .................................................................................... 671
ftrsw ........................................................................................ 672
dtmf ......................................................................................... 673
dmon ....................................................................................... 673
conn_rec ................................................................................. 676
tcid_rec ................................................................................... 678
rtcp_info .................................................................................. 679
chg_template .......................................................................... 680
chg_dialing .............................................................................. 680
sec .......................................................................................... 681
cpq .......................................................................................... 681
ipsec_ready ............................................................................. 682
parser ...................................................................................... 682
lineInfo .................................................................................... 682
ring .......................................................................................... 683
lcquer y .................................................................................... 683
chg_state ................................................................................ 683
chg_polarity ............................................................................ 684
chg_alink ................................................................................. 684
chg_power .............................................................................. 684
set_cadence ............................................................................ 685
scwidTest ................................................................................ 685
cid ........................................................................................... 685
etsi .......................................................................................... 685
vmwi ........................................................................................ 686
dsp_reset ................................................................................ 686
eoc_stats ................................................................................. 686
buf_store ................................................................................. 686
sig_trace ................................................................................. 687
mdfy_r tp .................................................................................. 687
ddly ......................................................................................... 687
tones ....................................................................................... 687
is ............................................................................................. 688

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Contents xxxvii

oos .......................................................................................... 688

rng_cad ................................................................................... 688
auto_osi .................................................................................. 689
SG3FaxRelay .......................................................................... 689
sip_callleg ............................................................................... 689
sip_error .................................................................................. 689
sip_reg .................................................................................... 689
sip_subs .................................................................................. 689
sip_trans ................................................................................. 689
sip_r v ...................................................................................... 689
sip_pub ................................................................................... 689
sip_digitmap ............................................................................ 690
sip_ftr ...................................................................................... 690
sip_ftr2 .................................................................................... 690
sip_stack_ver .......................................................................... 690
penalty_box ............................................................................. 690
checkStackRes ....................................................................... 690
gettimers ................................................................................. 690
ser viceRoutes ......................................................................... 690
dumpdm .................................................................................. 690
cotdump .................................................................................. 690
regevent_timer ........................................................................ 690
sip_display_agpwd .................................................................. 690
sip_dns .................................................................................... 690
sip_impu .................................................................................. 690
spls .......................................................................................... 690
sdqm ....................................................................................... 691
taskwatch ................................................................................ 691
procwatch ................................................................................ 692
dmp_stack ............................................................................... 692
dnsTools .................................................................................. 692
requer y_dns ..................................................................... 692
force_lkup ......................................................................... 692
pne_print .......................................................................... 692
MTA Sub-Mode Commands .......................................................... 693
config ...................................................................................... 693
showconfig .............................................................................. 693
getSig ...................................................................................... 694
provmethod ............................................................................. 695
mtaftrsw .................................................................................. 695
codecs ..................................................................................... 695
resetMTA ................................................................................. 696
Voice VQM Commands ................................................................. 696
vqMetrics ................................................................................ 696
vqClear .................................................................................... 696
vqLocEnable ........................................................................... 696
vqRemEnable ......................................................................... 696

Firmware Guide Release 7.5 Standard 1.2 August 2012

xxxviii Contents

tapi .......................................................................................... 696

Index 697

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 1 Overview

Touchstone Telephony eMTAs provide the subscriber connection to the HFC

IP network.
Touchstone eMTAs running TS7.5 firmware comply to the following stan-
dards:
• DOCSIS 3.0
• PacketCable 2.0
• Euro-DOCSIS 3.0
• PacketCable 1.5 and PacketCable 1.0
• Euro-PacketCable 1.0

About This Manual

This manual describes Touchstone® Telephony TS7.5 firmware.

Some features described in this manual may not be fully tested and supported
in your specific firmware release version. Where possible, features supported
only by specific versions are indicated in this manual. See the Release
Notes/Letter of Operational Considerations accompanying your firmware for
further details.

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

Firmware Guide Release 7.5 Standard 1.2 August 2012

2 Chapter 1

In This Manual This manual contains the following chapters:

• Chapter 1, ‘‘Overview,’’ describes the Touchstone firmware and docu-
mentation, standards compliance, and load variants.
• Chapter 2, ‘‘Provisioning,’’ describes setting up features and services on
Touchstone Telephony eMTAs.
• Chapter 3, ‘‘Provisioning PacketCable 2.0 SIP Loads,’’ describes spe-
cial features and services available for SIP PC20 loads.
• Chapter 4, ‘‘Provisioning ARRIS SIP Loads,’’ describes special features
and services available for ARRIS-proprietary SIP loads.
• Chapter 5, ‘‘Operations,’’ describes monitoring, fault detection, and
alerting mechanisms.
• Chapter 6, ‘‘Administration,’’ describes performance statistics and
maintaining system reliability.
• Chapter 7, ‘‘Maintenance,’’ describes firmware updates, diagnostics,
and troubleshooting features.
• Chapter 8, ‘‘References,’’ describes calling features, default ring
cadences, and tones for each supported country code.
• Chapter 9, ‘‘CLI Reference,’’ describes the CLI commands available in
TS7.5.
• Chapter 10, ‘‘MAIN Console Commands,’’ describes the low-level
cable modem CLI, used for troubleshooting and diagnostics.
• Chapter 11, ‘‘Voice CLI Commands,’’ describes CLI commands to con-
figure and troubleshoot the MTA.

Supported Hardware

This section describes the Touchstone products supported in the current

release of Touchstone firmware.

Model 7 All Model 7 Telephony Modems and Wideband Cable Modems provide
100/1000BaseT Ethernet data connections. Some models also provide USB
data connectivity for Windows-based computers. In addition, Telephony
Modems provide up to two lines of telephone service and optional battery
backup.
Note: TS7.5 disables USB support for WBM750 Wideband Cable Modems
only.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 3

Touchstone Model 7 devices support up to 4 bonded downstream channels

and up to 4 bonded upstream channels.
Supported Model 7 devices include:
• Wideband Cable Modems: WBM750, WBM760
Note: Due to memory limitations, TS7.5 does not support early
WBM750 Rev 1 models.
• Telephony Modems: TM702, TM722
Note: Model 6 and earlier hardware require TS6.x firmware loads.

Model 8 Model 8 Telephony Modems and Telephony Gateways provide:

• Up to 8x4 channel bonding (up to 8 bonded downstream channels and
up to 4 bonded upstream channels)
• 100/1000BaseT Ethernet data connections (one connection on Tele-
phony Modems, up to four connections on Telephony Gateways)
• USB 2.0 data connections (some models)
• up to four lines of telephone service
• 802.11 b/g/n wireless LAN (Telephony Gateways only)
• up to 24 hours of battery backup (some models)
Supported Model 8 devices include:
• Cable Modems: CM820
• Data Gateways: DG860
• Telephony Modems: TM802, TM804, TM822
• Telephony Gateways: TG852, TG862

Subscriber Touchstone Telephony TS7.5 firmware provides:

Interface • Support for LED status indicators
• PacketCable-compatible interfaces to data and telephony ports
• A web-based status monitoring and troubleshooting interface
• (Gateway products) A web-based configuration and management inter-
face

Firmware Guide Release 7.5 Standard 1.2 August 2012

4 Chapter 1

Load Name Extensions

A variety of TS7.5 loads are available to support specific Touchstone hard-

ware, applications, protocols, or regions. Each load has a unique extension to
identify its function.
Load names begin with TSvvvvXX_date_, where vvvv is the firmware ver-
sion, XX is the revision number, and date indicates the date (in YYMMDD
format) that the load was built. The following extensions are used to further
identify the loads. Some loads may have multiple extensions.
NA
North American signed firmware image.
EU
European signed firmware image.
MODEL_7_8
Supports Model 7 and Model 8 Telephony Modems.
MODEL_852
Supports TG852 Telephony Gateways.
MODEL_860
Supports DG860 Data Gateways.
MODEL_862
Supports TG862 Telephony Gateways.
WBM750
Supports WBM750 Wideband Modems.
WBM760_CM820
Suppors WBM760 Wideband Modems and CM820 Cable Modems.
MONO
Monolithic (CM/eDVA/gateway) load for Model 8 Telephony Gate-
ways and Data Gateways.
SIP
Supports SIP signaling.
PC20
Supports PacketCable 2.0 SIP provisioning.
EURO
Supports Euro-PacketCable provisioning changes and IETF MIBs.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 5

Examples The following examples show how load names describe the functionality of
the load.
TS070518_111011_NA.MODEL_702.SIP.PC20.img

TS070518_111011_EU.MODEL_702.SIP.PC20.img
TS7.5 North American and European firmware images for TM702
Telephony Modems, using SIP signaling and PacketCable 2.0 SIP
provisioning.
TS070518_111011_NA.MODEL_852.MONO.SIP.PC20.img
TS7.5 North American firmware image for TG852 Telephony Gate-
ways, using SIP signaling and PacketCable 2.0 SIP provisioning.

Firmware Guide Release 7.5 Standard 1.2 August 2012

6 Chapter 1

Firmware Functionality

Touchstone TS7.5 firmware provides the following functionality:

• Supports Touchstone Model 7 and Model 8 products.
• Compatibility with DOCSIS 3.0 and Euro-DOCSIS 3.0.
• Interoperability with ARRIS and other CMTS products.
• Supports up to eight downstream bonded channels and up to four
upstream bonded channels.
• Supports NCS and SIP telephony.
• Supports Ethernet and USB 2.0 interfaces to personal computers.
• Enhanced web-based troubleshooting interface.
• Dual-mode operation (TM702B/TM722B only); automatic selection of
DOCSIS or Euro-DOCSIS certificates based on downstream carrier
detected.
• IPv4 (CM/eDVA/CPE) and IPv6 (CM/CPE) addressing.
• Enhanced power management (Model 8 products).
TS7.5 supports the following functionality on Data Gateways and Telephony
Gateways:
• IPv6 addressing for CPE devices.
• IPv6 eRouter operations.
• TR-069 provisioning and management.

Firmware Down- ARRIS provides the ability to download firmware updates directly from the
load Center Internet, using the ARRIS Software/Firmware Delivery Tool. Benefits
include an archive of released loads and email notification of updated loads.
To obtain an account, contact ARRIS Technical Support.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 7

Standards Compliance

This section outlines Touchstone Telephony DOCSIS®, Euro-DOCSIS,

PacketCable,™ and Euro-PacketCable compliance, and describes ARRIS-
proprietary extensions to the standards.

Standard Func- Touchstone Telephony Modems running version TS7.5 firmware comply
tionality with the following standards:
• DOCSIS 3.0
• PacketCable 2.0
• Euro-DOCSIS 3.0
• Euro-PacketCable 1.0
• PacketCable 1.5 and PacketCable 1.0

Optional TS7.5 supports the following optional functionality specified by DOCSIS and
Functionality PacketCable standards:
• Support for multiple CODECs (see ‘‘CODECs and Packetization Rates
Supported’’ on page 60)
• Support for 10 ms and 20 ms packetization rates
• Support for up to 32 Upstream Service Flows
• Support for analog Fax/Modems, including automatic tone detection,
echo cancellation disable and switching to the G.711 CODEC
• 802.11b/g/n wireless LANs (Data Gateways and Telephony Gateways
only)

DOCSIS Specifica- All DOCSIS specifications are available at the DOCSIS web site 〈http://
tions www.cablemodem.com/specifications/〉.
• DOCSIS 3.0 Radio Frequency Interface Specification, SP-
RFIv2.0-I11-060206
• DOCSIS 3.0 Operations Support System Interface Specification, CM-
SP-OSSIv3.0-I15-100115
• DOCSIS 1.1 Baseline Privacy Plus Interface Specification, SP-
BPI+-I12-050812
• DOCSIS 1.1 Cable Modem to Customer Premise Equipment Interface
Specification, CM-SP-CMCIv3.0-I01-080320

Firmware Guide Release 7.5 Standard 1.2 August 2012

8 Chapter 1

• eDOCSIS Specification, CM-SP-eDOCSIS-I13-070803

• Layer 2 Virtual Private Networks, CM-SP-L2VPN-I09-100611 +

PacketCable Spec- TS7.5 supports PacketCable 2.0 operation. The following list shows Packet-
ifications Cable 2.0 specifications that apply to Touchstone PC20 loads. All PacketCa-
ble specifications are available at the PacketCable web site 〈http://
www.packetcable.com/specifications/〉.
• PacketCable SIP and SDP Stage 3 Specification, PKT-
SP-24.229-I06-100120
• Organization of Subscriber Data Specification, PKT-
SP-23.008-I03-080425
• Access Security for IP-based Services Specification, PKT-
SP-33.203-I05-090528
• Residential SIP Telephony Feature Specification, PKT-SP-RSTF-
I08-110127
• Residential SIP Telephony E-DVA Specification, PKT-SP-RST-E-DVA-
I-8-110127
• RST E-UE Provisioning Specification, PKT-SP-RST-EUE-PROV-
I06-110127
• UE Provisioning Data Model Specification, PKT-SP-UE-DATA-
I02-100527
• E-UE Provisioning Framework Specification, PKT-SP-EUE-PROV-
I06-110127
• Codec and Media Specification, PKT-SP-CODEC-MEDIA-I09-100527
• Business SIP Services (BSS) Feature Specification, PKT-SP-BSSF-
I03-100527
• PacketCable MTA Device Provisioning Specification, PKT-SP-
PROV1.5-I04-090624
• Quality of Service Specification, PKT-SP-QOS-I02-080425

SIP Specifications In addition to the PacketCable specifications listed above, TS7.5 ARRIS SIP
loads comply or partially comply with the following SIP-related RFCs:
• The SIP INFO Method, RFC 2976
• SIP: Session Initiation Protocol, RFC 3261
• Reliability of Provisional Responses in Session Initiation Protocol
(SIP), RFC 3262

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 9

• Session Initiation Protocol (SIP): Locating SIP Servers, RFC 3263

• An Offer/Answer Model with Session Description Protocol (SDP),
RFC 3264
• Session Initiation Protocol (SIP)-Specific Event Notification, RFC 3265
• The SIP UPDATE Method, RFC 3311
• A Privacy Mechanism for the Session Initiation Protocol (SIP),
RFC 3323
• Private Extensions to the Session Initiation Protocol (SIP) for Asserted
Identity within Trusted Networks, RFC 3325
• SIP "Path" Extension Header Field for Registering Non-Adjacent Con-
tacts, RFC 3327
• Grouping of Media Lines in SDP, RFC 3388
• Internet Media Type message/sipfrag, RFC 3420
• Private Header (P-Header) Extensions to SIP for the 3GPP, RFC 3455
• The Session Initiation Protocol (SIP) Refer Method, RFC 3515
• SIP Extension Header Field for Service Route Discovery during Regis-
tration, RFC 3608
• A Message Summary and Message Waiting Indication Event Package
for the Session Initiation Protocol (SIP), RFC 3842
• The Session Initiation Protocol (SIP) Replaces Header, September
2004, RFC 3891
• The Session Initiation Protocol (SIP) Referred-By Mechanism, RFC
3892
• Session Initiation Protocol (SIP) Extension for Event State Publication,
RFC 3903
• The SIP "Join" Header, RFC 3911
• The Early Session Disposition Type for SIP, RFC 3959
• Early Media and Ringing Tone Generation in SIP, RFC 3960
• The tel URI for Telephone Numbers, RFC 3966
• Session Timers in the Session Initiation Protocol (SIP), RFC 4028
• Request Authorization through Dialog Identification in the Session Initi-
ation Protocol (SIP), June 2006, RFC 4538
• SDP: Session Description Protocol, RFC 4566

Firmware Guide Release 7.5 Standard 1.2 August 2012

10 Chapter 1

• Private Header (P-Header) Extension to the Session Initiation Protocol

(SIP) for Authorization of Early Media, RFC 5009

CableLabs IPv6 • CableLabs Assigned Names and Numbers, CL-SP-CANN-I01-070119

Specifications • CableLabs DHCP Options Registry, CL-SP-CANN-DHCP-Reg-
I01-070119

New Features in TS7.5 MSUP5

+
TS7.5 MSUP5 firmware provides the following new features and functional- +
ity: +
• New hardware support: DG860P2, TM822A, TM822S +
• TR-069 enhancements +
• Support for BSoD (Business Services over DOCSIS); see ‘‘L2VPN +
Provisioning’’ on page 54 for details +
• Updates to the router configuration web pages, including optional +
Brazilian Portuguese display +

New Features in TS7.5

TS7.5 firmware provides the following new features and functionality over
TS7.3 and TS7.4:

Unified SIP Loads TS7.5 provides both ARRIS Legacy SIP and PacketCable 2.0 SIP support in
separate load variants. Previous Touchstone firmware versions supported
only one variant.

IPv6 CPE Opera- TS7.5 now supports IPv6 operation for both the CM and subscriber inter-
tions faces, including the wireless interfaces. Dual Stack Lite (DS-Lite) support
allows simultaneous IPv4 and IPv6 operation.
Touchstone Gateway products support IPv6 operation in the eRouter as well.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 11

New Hardware TS7.5 supports the following new Touchstone products:

Support • DG860A
• TG862A, TG862S
Note: Due to memory constraints, TS7.5 is not supported on early Rev. 1
WBM750 models.

Firmware Guide Release 7.5 Standard 1.2 August 2012

12 Chapter 1

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 con-
tention 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.
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 com-
pares 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 13

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 net-
work.
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 con-
nected to the network. Technically, a cable modem or E-UE 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 pro-
vide 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.
DOCSIS
Data Over Cable Service Interface Specification. The interoperabil-
ity standards used for data communications equipment on an HFC
network.
Downstream
In an HFC network, the direction from the headend to the sub-
scriber. Some older cable documentation may refer to this as the
forward path.
DQoS
Dynamic Quality of Service. The mechanism by which the eDVA
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 compli-
ant networks.

Firmware Guide Release 7.5 Standard 1.2 August 2012

14 Chapter 1

eDVA
Embedded Digital Voice Adapter, the PacketCable 2.0 term for the
portion of an E-UE that contains the network interface, CODECs,
and all signalling and encapsulation functions required for tele-
phony transport, CLASS features signalling, and QoS signalling.
Referred to as an MTA in earlier PacketCable specifications and
Touchstone firmware documentation.
eMTA
See E-UE.
E-UE
Embedded User Equipment, the PacketCable 2.0 term for a cable
modem with an embedded eDVA. Referred to as an eMTA in earlier
PacketCable specifications and Touchstone firmware documenta-
tion.
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 informa-
tion 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 distrib-
uted 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.
IANA
Internet Assigned Numbers Authority. The coordinating body that:
assigns IP addresses to regional Internet registries; recognizes top-
level domains; and assigns protocol numbers for well-known ser-
vices.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 15

Jitter
Variance in packet arrival time. Jitter is a factor in applications such
as telephony, where the originating device sends packets at a con-
stant rate.
KDC
Kerberos Key Distribution Center.
Latency
The time required for a signal element (e.g. packet) to pass through
a device or network.
LCO
Local Connection Options. A structure that describes the character-
istics 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 Home-
PNA.
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.’’ However, the term
‘‘MIB object’’ is more precise and is used in this documentation.
MPI
Micro-Processor Interface. An internal Touchstone Telephony
Modem component.
MSO
Multi-System Operator. A cable company that operates multiple
headend locations, usually in several cities.
MTA
See eDVA.

Firmware Guide Release 7.5 Standard 1.2 August 2012

16 Chapter 1

NCS
Network-based Call Signaling. The PacketCable protocol used to
control calls.
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
eDVAs or be routed through a gateway.
PacketCable
A CableLabs-led initiative aimed at developing interoperable inter-
face specifications for delivering advanced, real-time multimedia
services over two-way cable plant.
PCM
Pulse Code Modulation. A commonly employed algorithm to digi-
tize an analog signal (e.g. voice) into a digital bit stream using sim-
ple analog to digital conversion techniques. PCM is employed in
the popular G.711 codec.
P-CSCF
Proxy-Call Session Control Function. In PacketCable 2.0 networks,
this is the SIP server that provides connectivity between the eDVA
and the PSTN.
PLO
Permanent Lock-Out. A line card may enter this state when left off-
hook with no connection after a certain amount of time.
POS
Point of Sale (terminal). Typically, an electronic cash register.
Proxy
See P-CSCF.
PSTN
Public Switched Telephone Network.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Overview 17

QAM
Quadrature Amplitude Modulation. A method of modulating digital
signals onto an RF carrier, involving both amplitude and phase cod-
ing. 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 limita-
tions 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.
RST
Residential SIP Telephony, the specification for PacketCable 2.0
telephony.
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 con-
ferencing, telephony, presence, events notification and instant mes-
saging.
SNMP
Simple Network Management Protocol.

Firmware Guide Release 7.5 Standard 1.2 August 2012

18 Chapter 1

TFTP
Trivial File Transfer Protocol. Used in DOCSIS networks to trans-
fer firmware and provisioning files to network devices.
TM
Telephony Modem.
Uniform Resource Identifier (URI)
A way to identify a specific phone line for an eDVA. For example
sip:<phone number>@<IP address or domain>.
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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

2 Provisioning

Provisioning involves setting up devices and services.

Touchstone provisioning consists of the following topics:
Topic Page
General Provisioning Information 20
Provisioning Considerations 23
DHCP Interactions 30
Provisioning Modes 33
DHCP Support by Provisioning Mode 39
Overriding the MDD IPv4/IPv6 Selection 41
IPv6 Provisioning Notes 42
Upgrading Touchstone Firmware 45
Using Enhanced Firmware Loading 47
L2VPN Provisioning 54
Configuring Channel Bonding Characteristics 56
Provisioning Quality of Service 57
Dual-Mode Operation 58
CODECs and Packetization Rates Supported 60
Provisioning General eDVA and Line Parameters 65
Setting Loop Voltage Management 70
Feature Switches 74
Echo Cancellation and Analog Fax/Modem Support 90
Provisioning RFC 2833 Support 92
Configuring T.38 Fax Relay Support 93
Super G3 FAX Support 104
Configuring Jitter Buffers 105
Provisioning European Support 108
Configuring Call Progress Tones 111
Gain Compensated Tone Generation 114
Provisioning Preset Downstream Frequencies 118
Dial Pulse Support 121
Configuring Hook Flash Timing 123
Provisioning Ring Cadences 124
Post-Provisioning 125
Provisioning a Gateway 126
Using XML-based Router Provisioning Files 131
TR-069 Provisioning 133

Firmware Guide Release 7.5 Standard 1.2 August 2012

20 Chapter 2

General Provisioning Information

This section provides a general overview of provisioning-related information.

Service Flow Limi- Telephony Modems support up to 32 service flows:

tations • Best Effort: 8
• UGS and UGS-AD: 24

OUI Ranges The following table shows OUI support for various versions of Touchstone
firmware support.
Firmware Version OUI ranges supported
00:00:CA 00:13:11
00:15:96 00:15:CE
00:15:A2 00:15:CF
00:15:A3 00:15:D0
00:15:A4 00:15:D1
TS7.0 and newer
00:1D:CD 00:1D:D2
00:1D:CE 00:1D:D3
00:1D:CF 00:1D:D4
00:1D:D0 00:1D:D5
00:1D:D1 00:1D:D6

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

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

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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 21

Setting the DST DST policies may vary due to national legislation or local preferences.
Policy TS7.1 MSUP2 and newer versions of Touchstone firmware provides control
over local DST policy.
1 To change the DST policy, set the arrisCmDoc30SetupDSTPolicy
object to a string with the following format:
start=month/day/weekday/hour;end=month/day/weekday/hour
where. . . is. . .
month the month: 1 for January, to 12 for December.
day The day: −31 to −1 to count backwards from the
end of the month, 1 to 31 to count forward from
the beginning of the month.
weekday The day of the week that DST begins or ends: 1
for Monday, to 7 for Sunday, or 0 to ignore the
weekday and use the exact date. If not zero,
DST begins or ends on the specified weekday
after the date if the date is positive, or before the
date if negative.
hour The hour at which DST begins or ends: 00 to 23.

Example:
start=3/8/7/02;end=11/1/7/02
Implements the U.S. DST policy in effect since March 2007: DST
begins at 2 a.m. on the second Sunday in March and ends at 2 a.m. on
the first Sunday in November.

Clearing the CPE When the Telephony Modem loses link on all LAN interfaces, the modem
List clears its CPE list. This allows subscribers allowed only one CPE device to
swap computers without resetting the Telephony Modem or calling support.

Firmware Guide Release 7.5 Standard 1.2 August 2012

22 Chapter 2

Configuring Caller Follow these steps to configure optional Caller ID behavior.

ID Options 1 Set the arrisMtaDevDefaultReasonNoCIDName object to specify
what data the eDVA sends to the CPE device when the CID signal
request includes no Caller ID name. Set the MIB object either
directly through a network manager, or in the eDVA configuration file.
Possible values are:
Value Sends Description
unavailable(0) ‘O’ Caller ID displays typically show
‘‘Out of area’’ or ‘‘Unavailable.’’
This is the default for all country
templates except Switzerland.
private(1) ‘P’ Caller ID displays typically show
‘‘Private.’’
sendnothing(2) ’00’ Sends NULL data to the CPE
device.
sdmf(3) number Sends the number in NA SDMF for-
mat.
excludeName(4) (blank) Omits name parameters or any rea-
son for the missing name.

2 To set the delay time, in milliseconds, between receiving the ACK

from the CPE and transmitting the FSK, set the arrisMtaDevOff-
HookFskDelay object to the desired time.

Valid range: 0 to 500 milliseconds. Default: 261 for North America

loads, 100 (T12 timer value) for Euro-PacketCable loads.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 23

Provisioning Considerations

Typically, you provision the network using a PacketCable-compliant provi-

sioning 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
eDVAs.
For upgrade considerations, see ‘‘Upgrading Touchstone Firmware’’ on
page 45.

Upgrading from When re-using a DOCSIS 2.0 configuration file for TS7.0 and newer versions
DOCSIS 2.0 of Touchstone firmware, several settings need to be changed as described
below.

CallP Feature Switch Changes

When re-using a DOCSIS 2.0 configuration file for TS7.0 and newer versions
of Touchstone firmware, several CallP Feature Switch settings must be tog-
gled (i.e. change 1 to 0 and vice versa) to provide equivalent functionality:
Bit Description
0x00000001 NCS piggybacked message support
0x00000002 Lockstep quarantine mode
0x00008000 NCS provisional responses support

To automatically toggle these bits, set the arrisMtaDoc30AdjustCallpFea-

tureSwitch object to enable(1). The default value is disable(0).

The following switches were removed or changed in TS7.0 and newer ver-
sions. Set all removed bits to 0 to prevent accidental enabling of new fea-
tures in future releases.

Firmware Guide Release 7.5 Standard 1.2 August 2012

24 Chapter 2

Bit Version Description

D2.0 Use MGCP error codes
0x00000004 Show OOS rather than IDLE for
D3.0
arrisMtaDevLineCardState
0x00000010 D2.0 Enable SDP compliance
0x00000020 D2.0 Use increased DQoS DS Max Traffic Rate
0x00000200 D2.0 Allow transmission of wild-carded messages
Don’t play local ringback tone
0x00002000 D2.0
when incoming voice is detected
0x00020000 D2.0 Don’t allow multiple connections on a line
0x00040000 D2.0 Use increased DQoS Tolerated Grant Jitter
Simultaneously commit both US and DS
0x00200000 D2.0
for action connection modes
Allow provisioned ring cadences for
0x02000000 D2.0
non NA countries
0x04000000 D2.0 Use hard coded flash timing of 90–800 ms
0x40000000 D2.0 Enable Voice Activity Detection

CPE Count Changes

In TS7.0 and newer versions of Touchstone firmware, when an E-UE is pro-

visioned in CM-only mode, the CM still learns the MAC address of the
eDVA. This differs from previous versions, where the eDVA address was
ignored in CM-only mode.
To account for the eDVA MAC address, either add 1 to the value of the Max-
CpeAllowed TLV, or set the MaxCPEBypass bit (0x00000002) of the
ppCfgMtaFeatureSwitch.

Hardware-Specific Certain hardware models may require special upgrade procedures when
Upgrade Limita- upgrading from earlier versions of Touchstone firmware. TS7.5 disables cer-
tions tain features for specific hardware. These issues are described below.

WBM750/WBM760

TS7.5 does not support USB operation for WBM750 Wideband Cable
Modems. Subscribers using Ethernet connections are not affected.
Note: Due to memory constraints, early Rev 1 versions of the WBM750 can-
not run TS7.5.
The following upgrade considerations apply:
• Upgrading to TS7.5 from TS7.1.95 or WBM3.2.20, or earlier versions
of Touchstone firmware, require an interim upgrade using TS7.1.96.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 25

• Upgrading to TS7.5 from TS7.3.34 and earlier versions of TS7.3

require an interim upgrade using TS7.3.38.

Model 8 Hardware

Model 8 hardware does not support the use of S-CDMA/S-TDMA

upstreams.

DG860

Due to memory constraints, the DG860 Data Gateway stores only one copy
of the gateway firmware. However, the DOCSIS portion of the load is dual-
banked. Therefore, it is possible that a download error could leave the gate-
way with a corrupted image. Forcing the unit to re-download the firmware
should correct this problem.

About IPsec 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 eDVA can communicate with; you can include this object in the
eDVA configuration file. The object is indexed by the CMS FQDN for North
American loads. Set the object to true(1) to enable IPsec between the eDVA
and a particular CMS, and false(2) to disable it.
Note: Touchstone E-UEs use only the IPsec ESP transport mode.

Call Management Touchstone firmware accepts up to 64 call management server IP addresses

Servers identified in the eDVA 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 eDVA
can be redirected to use a CMS with a lighter load.
When IPsec is activated, Touchstone E-UEs store up to 10 security associa-
tions, 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 74), 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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

26 Chapter 2

Cable Modem In- TS7.5 supports the Cable Modem Interface Mask (CMIM). The CMIM is a
terface Mask field in the upstream classifiers that can be used to filter out traffic based on
the CM interface receiving the packet. When this field is present in the US
classifier, a packet matches the classifier only if the traditional fields match
and the source interface of the packet is present in the CMIM of the classifier.
The CMIM is an encoded 2- or 4-byte mask where each bit represents the
interface whose ifIndex matches the bit position. The short form of the mask
omits bits 16 through 31. For example, the RF interface has an ifIndex of 2
which corresponds to bit 2 of the CMIM. For this mask, bit position 0 is the
most significant bit of the most significant word. For example, a CMIM clas-
sifier intended to match all of the CPE ports (external interfaces) of a CM has
a CMIM value setting bits 1 and 5-15, so an encoding of either 0x47FF or
0x47FF0000 is valid. See ‘‘Interface Index Scheme’’ on page 26 for a list of
valid ifIndex values.

Voice and Signal- TS7.5 firmware uses a random selection of ports in the range 49152 through
ing Ports 65535 for RTP- and RTCP-based voice communications. The port numbers
cannot be modified or used for other purposes.
By default, the eDVA 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 eDVA configuration file. You can also change the
transmit port by sending an NCS message from the call server once the
eDVA is operating.

Interface Index Touchstone firmware generally conforms to the eDOCSIS specification, CM-
Scheme SP-eDOCSIS-I13-070803, for ifIndex designations. The following table lists
the specified defaults.
Interface Type
1 Primary CPE interface (Ethernet)
2 CATV MAC interface
3 RF downstream channel
4 RF upstream channel
5–11 Other CPE interfaces (telephony, data)
12 Wireless SSID 0
13 Wireless SSID 1
14 Wireless SSID 2
15 Wireless SSID 3
16 PacketCable E-UE
17 Reserved for eSTB-IP26
18 Reserved for eSTB-DSG27
19–31 Reserved for other eDOCSIS interfaces
32 + Other CPE interfaces

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 27

Telephony interfaces begin with ifIndex 9.

Interface Types

The IANAifType textual convention defines the interface types associated

with entries in the ifTable. Interface types used in Touchstone products
include:
ifType Description
6 Ethernet
127 DOCSIS cable
MAC layer
128 DOCSIS cable downstream
129 DOCSIS cable upstream
160 USB
198 eDVA telephony line (Voice over Cable)

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

Support 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 down-
stream 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 do so by the CMTS. Also, this list overrides the
last operational channel value stored in NVRAM. If the CM (portion of the
E-UE) 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 (SP-
RFIv2.0-I11-060206).

Firmware Guide Release 7.5 Standard 1.2 August 2012

28 Chapter 2

Considerations for TLV-39 Support

TS7.5 supports TLV-39, used to set DOCSIS 2.0 mode when operating with a
DOCSIS 2.0 CMTS or a DOCSIS 3.0 CMTS but not in Multiple Transmit
Channel mode. When operating in Multiple Transmit Channel mode, the
TLV-39 setting is ignored.
When not in Multiple Transmit Channel mode, if the provisioning file sets
TLV-39 to disabled, the E-UE advertises itself as a DOCSIS 2.0 device even
when registering on a DOCSIS 1.1 upstream. The following flowchart shows
the registration process when advertising DOCSIS 2.0 capabilities.

MTA locks
on DS during
initial registration

DHCP (opt 60) and

registration request
to DOCSIS 2.0
device

DHCP (opt 60) and

TLV-39 in
NO Registration Request MTA stays on MTA registers
Configuration file
to DOCSIS 2.0 DOCSIS 2.0 US on D2.0 US
= Disable
device
YES

DHCP (opt 60) and

Is D1.1 US MTA re-reranges
YES registration request MTA registers
available on this on DOCSIS 1.1
to DOCSIS 2.0 on D1.1 US
DS? US
device
NO

Begin scanning
for another
downstream

Provisioning Con- Provisioning changes are necessary to transition from a Touchstone North
siderations for Eu- American load to the EURO load. The basic flow sequence remains the
ropean Loads 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 29

Flow MTA15: SNMP Enrollment INFORM

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

IPv6 eRouter Con- When provisioned for IPv6 addressing, the eRouter expects an IPv6 address
siderations with a /56 prefix, either from DHCPv6 or by static assignment. This is a
requirement for CPE devices to successfully connect to the eRouter.

Firmware Guide Release 7.5 Standard 1.2 August 2012

30 Chapter 2

DHCP Interactions

When a Touchstone E-UE registers, the CM and eDVA make separate DHCP
and TFTP requests.

CM-side Interac- The Telephony Modem CM component sends various information to the pro-
tions visioning server using the DHCP options described below.

DHCP Option 51 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.
Touchstone firmware sends DHCP option 51 in DHCP Request messages
during IP address renew and rebind operations.

DHCP Option 60 Support

TS7.5 uses DHCP option 60 (Vendor Class Identifier) in DHCP Discover

messages to specify the DOCSIS support required. The option contains the
string ‘‘docsis 3.0’’ to indicate DOCSIS 3.0 support.

eDVA-side Interac- The Telephony Modem eDVA component sends various information to the
tions provisioning server using the DHCP options described below.

DHCP Option 43 Support

TS7.5 sends DHCP option 43 (Vendor-Specific Information) in MTA DHCP

Discover messages with the following sub-options:
Sub-opt. Name Value
2 Device Type ‘‘EDVA’’ or ‘‘EMTA’’
4 Serial Number Varies (e.g. ‘‘997BNW87D747320’’)
5 HW Version Hardware version of eDVA (e.g. ‘‘2.0’’)
6 SW Version Firmware version (e.g. ‘‘7.5.18’’)
7 Boot ROM Boot ROM version (e.g. ‘‘1.2.1.44’’)
8 Vendor ID ‘‘0000CA’’
9 Model Number E-UE model number (e.g. ‘‘TG852G’’)
10 Vendor Name ‘‘Arris Interactive, L.L.C.’’
31 MTA MAC Addr. Varies (e.g. ‘‘0015d004153d’’)
32 Correlation ID Varies (must match the value of the
pktcMtaDevCorrelationId object).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 31

DHCP Option 51 Support

Touchstone firmware sends DHCP option 51 in DHCP Request messages

during IP address renew and rebind operations.

DHCP Option 60 Support

TS7.5 uses DHCP option 60 in DHCP Discover messages to advertise Pack-

etCable support. The option contains the string ‘‘pktc2.0’’ to indicate Packet-
Cable 2.0 support.
The following table lists the sub-options sent with DHCP option 60 and their
meanings:
Sub-
Value Description
option
0x01 PacketCable 1.5
1
0x02 PacketCable 2.0
2 0x02 Number of endpoints (2)
3 0x00 TGT support (no)
4 0x00 HTTP download file access method (no)
5 0x01 MTA-24 Event Syslog notification
9 0x01 NVRAM Ticket/Session Key Storage supported
10 0x01 Provisioning Event Reporting supported
Supported CODECs:
01 = other
11 0x0106090f 06 = PCMU
09 = PCMA
0F = telephone-event
13 0x01 Echo Cancellation supported
16 0x09 ifIndex of first phone line
Supported provisioning flows:
18 0x0007
Secure, Hybrid, Basic
19 0x01 T.38 Version support (v0)
20 0x01 T.38 Error Correction support (redundancy)
21 0x01 RFC 2833 DTMF relay supported
22 0x01 Voice Metrics supported
CableLabs MIBs supported:
23 0x02001f EN-SIG, EN-MTA, EVENT-MIB,
SIG-MIB, MTA-MIB
24 0x00 Multiple Grants per Interval (no)
25 0x00 V.152 support (no)

Firmware Guide Release 7.5 Standard 1.2 August 2012

32 Chapter 2

Gateway Interac- The router portion of Touchstone Gateways sends various information to the
tions provisioning server using the DHCP options described below.

DHCP Option 67 Support

If the Gateway receives a URL to the configuration server in DHCP

option 67, the Gateway expects an XML configuration file at the specified
location. The URL may be up to 255 octets in length.
If the DHCP response does not include option 67, the Gateway uses one of
the following options:
If the Gateway has. . . Then the Gateway uses. . .
received a valid XML configuration file the previous configuration

never received a valid XML configuration file default settings

See ‘‘XML Configuration File’’ on page 495 for an example XML configura-
tion file.

Disabling Option Touchstone firmware can be configured to ignore the ‘‘SNMP Entity’’
122 Sub-Option 3 (DHCP Option 122 Sub-Option 3) comparison checks during eDVA DHCP
Enforcement Renew and Rebind processing. This may be necessary if you want to allow
the eDVA to direct Link Up and Link Down traps to an alternate trap server.
To configure this setting, set the arrisMtaDevDhcpSubOpt3Immediate
object to off(1) to disable the override, or on(2) to enable the override.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 33

Provisioning Modes

Touchstone firmware supports PacketCable provisioning modes and several

ARRIS-proprietary provisioning modes.

PacketCable Provi- TS7.5 supports the standard PacketCable provisioning modes.

sioning Modes
PacketCable SECURE (Full PacketCable)

This mode is also called ‘‘Full PacketCable,’’ and is the default provisioning
mode. The data and telephony components have unique IP addresses, MAC
addresses, and configuration files (i.e. two of each per E-UE). When the E-
UE registers, it makes two separate DHCP and TFTP requests.
SNMP communication uses SNMPv3, sending an SNMPv3 INFORM. The
E-UE and provisioning system support Kerberos mutual authentication and
Kerberized SNMPv3 messaging.
IPsec is supported, and may be enabled or disabled using the pktcMtaDev-
CmsIpsecCtrl object (enabled by default). Media encryption (voice secu-
rity) can be enabled on a per-call basis using NCS signaling (the LCO/SDP
options) or disabled per eDVA using a feature switch. The feature switch is
stored in NVRAM.

Firmware Guide Release 7.5 Standard 1.2 August 2012

34 Chapter 2

The following diagram shows the full PacketCable event sequence. All
events are included.
CM/ DOCSIS DOCSIS DOCSIS Prov PKT PKT PKT MSO
Flow CMTS Syslog
eDVA DHCP TFTP ToD Server DHCP DNS TFTP KDC
Begin DOCSIS Initialization/Registration
DHCP Broadcast Discover (Option Code 122)
CM-1
DHCP Offer (Option Code 122 w/telephony service provider’s DHCP server address = [255.255.255.255])
CM-2
DHCP Request
CM-3
DHCP Ack
CM-4
DOCSIS 1.1 CM config file request
CM-5
DOCSIS 1.1 CM config file
CM-6
ToD Request
CM-7
ToD Response
CM-8
CM registration with CMTS
CM-9
CMTS Registration ACK
CM-10
End DOCSIS Initialization/Registration
DHCP Broadcast Discover (opt. code 60 w/MTA device identifier, request opt. 122
MTA-1
DHCP Offer (opt. code 122 w/name of provisioning realm
MTA-2
DHCP Request
MTA-3
DHCP Ack
MTA-4
DNS Request
MTA-5
DNS Srv (KDC host name associated with the provisioning realm)
MTA-6
DNS Request
MTA-7
DNS Response (KDC IP address)
MTA-8
AS Request
MTA-9
AS Reply
MTA-10
TGS Request
MTA-11
TGS Reply
MTA-12
AP Request (Key Mgmt Prot Ver., Protocol ID, KRB_AP_REP, ciphersuites, SHA-1 HMAC
MTA-13
AP Reply (Key Mgmt Prot Ver., Protocol ID, KRB_AP_REP, ciphersuite selected, key lifetime, Ack req., HMAC
MTA-14
SNMP Inform
MTA-15
SNMP Get Request(s) for MTA device capabilities (optional/iterative)
MTA-16
SNMP Get Response(s) containing MTA device capabilities (optional/iterative)
MTA-17
MTA config file
MTA-18
SNMP Set with URL encoded file download access method (TFTP or HTTP), filename, hash, and encryption key (if required)
MTA-19
Resolve TFTP server FQDN
MTA-20
TFTP server IP address
MTA-21
Telephony config file request
MTA-22
Telephony config file
MTA-23
MTA send telephony service provider Syslog a notification of provisioning completed (optional
MTA-24
Notify completion of telephony provisioning (MTA MAC address, ESN, pass/fail)
MTA-25

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 dif-
ference between the two is that HYBRID.2 uses the ‘‘provisioning complete’’
SNMP INFORM. IPsec is disabled.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 35

Media encryption can be controlled on a per-eDVA basis using a feature

switch.
The following diagram shows the PacketCable HYBRID event sequence.
This sequence skips several events in the eDVA provisioning; the shaded
steps below are skipped.
CM/ DOCSIS DOCSIS DOCSIS Prov PKT PKT PKT MSO
Flow CMTS Syslog
eDVA DHCP TFTP ToD Server DHCP DNS TFTP KDC
Begin DOCSIS Initialization/Registration
DHCP Broadcast Discover (Option Code 122)
CM-1
DHCP Offer (Option Code 122 w/telephony service provider’s DHCP server address = [255.255.255.255])
CM-2
DHCP Request
CM-3
DHCP Ack
CM-4
DOCSIS 1.1 CM config file request
CM-5
DOCSIS 1.1 CM config file
CM-6
ToD Request
CM-7
ToD Response
CM-8
CM registration with CMTS
CM-9
CMTS Registration ACK
CM-10
End DOCSIS Initialization/Registration
DHCP Broadcast Discover (opt. code 60 w/MTA device identifier, request opt. 122
MTA-1
DHCP Offer (opt. code 122 w/name of provisioning realm
MTA-2
DHCP Request
MTA-3
DHCP Ack
MTA-4
DNS Request
MTA-5
DNS Srv (KDC host name associated with the provisioning realm)
MTA-6
DNS Request
MTA-7
DNS Response (KDC IP address)
MTA-8
AS Request
MTA-9
AS Reply
MTA-10
TGS Request
MTA-11
TGS Reply
MTA-12
AP Request (Key Mgmt Prot Ver., Protocol ID, KRB_AP_REP, ciphersuites, SHA-1 HMAC
MTA-13
AP Reply (Key Mgmt Prot Ver., Protocol ID, KRB_AP_REP, ciphersuite selected, key lifetime, Ack req., HMAC
MTA-14
SNMP Inform
MTA-15
SNMP Get Request(s) for MTA device capabilities (optional/iterative)
MTA-16
SNMP Get Response(s) containing MTA device capabilities (optional/iterative)
MTA-17
MTA config file
MTA-18
SNMP Set with URL encoded file download access method (TFTP or HTTP), filename, hash, and encryption key (if required)
MTA-19
Resolve TFTP server FQDN
MTA-20
TFTP server IP address
MTA-21
Telephony config file request
MTA-22
Telephony config file
MTA-23
MTA send telephony service provider Syslog a notification of provisioning completed (optional
MTA-24
Notify completion of telephony provisioning (MTA MAC address, ESN, pass/fail)
MTA-25

Note: Only HYBRID.1 skips step MTA-25.

Firmware Guide Release 7.5 Standard 1.2 August 2012

36 Chapter 2

PacketCable BASIC

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 pktcMtaDevProvConfigHash. The eDVA cal-
culates 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.
Note: PacketCable BASIC requires that the eDVA provisioning file contain
the pktcMtaDevProvConfigHash object, with a value equal to the hash of
the provisioning file. The eDVA calculates the hash and compares it to the
value of this object; if the values do not match, provisioning fails.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 37

The following diagram shows the sequence for PacketCable BASIC.1. This
sequence skips several steps in the eDVA provisioning. The PacketCable
BASIC.2 sequence is nearly identical to BASIC.1, but does not skip the last
step in the eDVA provisioning.
CM/ DOCSIS DOCSIS DOCSIS Prov PKT PKT PKT MSO
Flow CMTS Syslog
eDVA DHCP TFTP ToD Server DHCP DNS TFTP KDC
Begin DOCSIS Initialization/Registration
DHCP Broadcast Discover (Option Code 122)
CM-1
DHCP Offer (Option Code 122 w/telephony service provider’s DHCP server address = [255.255.255.255])
CM-2
DHCP Request
CM-3
DHCP Ack
CM-4
DOCSIS 1.1 CM config file request
CM-5
DOCSIS 1.1 CM config file
CM-6
ToD Request
CM-7
ToD Response
CM-8
CM registration with CMTS
CM-9
CMTS Registration ACK
CM-10
End DOCSIS Initialization/Registration
DHCP Broadcast Discover (opt. code 60 w/MTA device identifier, request opt. 122
MTA-1
DHCP Offer (opt. code 122 w/name of provisioning realm
MTA-2
DHCP Request
MTA-3
DHCP Ack
MTA-4
DNS Request
MTA-5
DNS Srv (KDC host name associated with the provisioning realm)
MTA-6
DNS Request
MTA-7
DNS Response (KDC IP address)
MTA-8
AS Request
MTA-9
AS Reply
MTA-10
TGS Request
MTA-11
TGS Reply
MTA-12
AP Request (Key Mgmt Prot Ver., Protocol ID, KRB_AP_REP, ciphersuites, SHA-1 HMAC
MTA-13
AP Reply (Key Mgmt Prot Ver., Protocol ID, KRB_AP_REP, ciphersuite selected, key lifetime, Ack req., HMAC
MTA-14
SNMP Inform
MTA-15
SNMP Get Request(s) for MTA device capabilities (optional/iterative)
MTA-16
SNMP Get Response(s) containing MTA device capabilities (optional/iterative)
MTA-17
MTA config file
MTA-18
SNMP Set with URL encoded file download access method (TFTP or HTTP), filename, hash, and encryption key (if required)
MTA-19
Resolve TFTP server FQDN
MTA-20
TFTP server IP address
MTA-21
Telephony config file request
MTA-22
Telephony config file
MTA-23
MTA send telephony service provider Syslog a notification of provisioning completed (optional
MTA-24
Notify completion of telephony provisioning (MTA MAC address, ESN, pass/fail)
MTA-25

ARRIS-proprietary To improve compatibility with non-compliant equipment, ARRIS supports

Provisioning various provisioning modes for Touchstone E-UEs and firmware; each has
Modes multiple options to enable and disable PacketCable features. To select a pro-
prietary provisioning mode, set the arrisMtaDevProvMethodIndicator to the
desired mode.

Firmware Guide Release 7.5 Standard 1.2 August 2012

38 Chapter 2

PacketCable minus KDC

A PacketCable subset, similar to PacketCable HYBRID.2. SNMPv3 and

IPsec are disabled. The differences between HYBRID.2 and PacketCable
minus KDC are:
• PacketCable minus KDC ignores DHCP sub-option 6 to select the pro-
visioning mode, as the arrisCmDevProvMethodIndicator object forces
this selection.
• Provisioning step MTA25: PacketCable minus KDC sends the Provi-
sioning Status SNMP Inform regardless of DHCP sub-option 6.
• PacketCable minus KDC does not send DHCP Option 60 sub-option 18
(supported provisioning flows).
• PacketCable minus KDC does not require Security Parameters if end-
points are provisioned.

GUPI Encrypted MAC eDVA

(SIP only) Uses separate CM and eDVA offers.

CM DHCP Option 122:
• SubOption 1: Service Provider’s Primary DHCP (required)
• SubOption 2: Service Provider’s Secondary DHCP (optional)
• SubOption 6: Kerberos Realm (FQDN) (ignored)
eDVA DHCP Option 122: ignored
eDVA offer: eDVA FQDN is configured in the eDVA DHCP offer (Options
12 and 15). SubOption 3 must contain the Service Provider’s SNMP Entity.
DNS is optional.
Encrypted provisioning files are supported.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 39

Setting Up the Set up the provisioning data as follows to use a non-PacketCable compliant
Provisioning provisioning server:
Server Data • The eDVA 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: All PacketCable provisioning modes require a PacketCable-com-
pliant provisioning server.

Verifying eDVA The MIB object pktcMtaDevProvisioningState indicates the status of the
Provisioning and eDVA initialization process. The MIB object pktcNcsEndPntStatusError
Endpoint Status indicates whether the endpoint has successfully registered with the call
server.

DHCP Support by Provisioning Mode

The following sections list DHCP parameters used by each provisioning

mode.

Options Required The following DHCP options are required in all CM and eDVA offers. The
in All Provisioning E-UE cannot function without a subnet mask and at least one router, DNS
Modes server, and Syslog server.
Option Description
1 Subnet mask
3 IP address of the gateway router (one or more)
6 IP address of the DNS servers (one or more)
7 IP address of the log servers (one or more)

Note: In addition to the required options listed above, ARRIS strongly rec-
ommends including option 4 (IP address of the ToD server) in all CM and
eDVA offers.

PacketCable These options are valid for Full PacketCable and PacketCable minus KDC
Modes provisioning modes. Note that options 122 and 177 are mutually exclusive
(specify one or the other, not both). Option 177 is the default for PacketCa-
ble minus KDC.
CM DHCP Option 4: ToD Server IP Address

Firmware Guide Release 7.5 Standard 1.2 August 2012

40 Chapter 2

CM DHCP Option 122:

• SubOption 1: Service Provider’s Primary DHCP (required)
• SubOption 2: Service Provider’s Secondary DHCP (optional)
eDVA DHCP Option 122:
• 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)
• SubOption 7: Authorization method (TGT for eDVA) (optional)
• SubOption 8: Provisioning Timer (minutes) (optional)
• SubOption 9: Security Ticket Invalidation (optional)
CM DHCP Option 177:
• SubOption 1: Service Provider’s Primary DHCP (required)
• SubOption 2: Service Provider’s Secondary DHCP (optional)
eDVA 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 eDVA)
• SubOption 8: Provisioning Timer (minutes)
Note 1: By default, the E-UE 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
E-UE to accept a changed SNMP entity. This may be necessary for opera-
tion with certain DHCP servers that re-assign SNMP entities for load-balanc-
ing.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 41

Overriding the MDD IPv4/IPv6 Selection

Use the docsIf3CmMdCfgIpProvMode object to override IPv4 or IPv6

selection in the MDD message. The allowed values are:
• ipv4Only(0) override the MDD setting and use IPv4.
• ipv6Only(1) override the MDD setting and use IPv6.
• honorMdd(4) (default) use the IP mode set in the MDD message.

CAUTION
Potentially service-affecting
Override settings can potentially prevent the eDVA from registering. For
example, setting this object to ipv6(2) when no DHCPv6 server is available
causes the eDVA to attempt to register as IPv6 only, ignoring any DHCPv4
servers. Since this setting is stored in non-volatile memory, you must either
change the value through SNMP or reset the Telephony Modem to factory
defaults to clear the setting.

Note: In TS7.5 and newer loads, the ARRIS-proprietary object arrisCm-

Doc30SetupMddIpModeOverride provides the same functionality as the
DOCSIS 3.0 object. Setting this object to apm(3) or dpm(4) is now equiv-
alent to the default disable (or honorMdd) functionality. ARRIS recom-
mends using only one of the two objects, as setting both objects in the config-
uration file with conflicting values may have unexpected results.
If you set this object with an SNMP browser, and the new setting differs from
the current operation mode, the CM may reset depending on the value of
docsIf3CmMdCfgIpProvModeResetOnChange to apply the new setting. If
the docsIf3CmMdCfgIpProvModeResetOnChange object is set to true(1),
the CM resets after the time (in seconds) defined by the docsIf3CmMdCfgIp-
ProvModeResetOnChangeHoldOffTimer object.

This setting of arrisCmDoc30SetupMddIpModeOverride persists across

reboots, unless the docsIf3CmMdCfgIpProvModeStorageType object is set
to volatile(2). Restoring the Telephony Modem to factory defaults resets the
value of arrisCmDoc30SetupMddIpModeOverride to disable(0).

Displaying the You can view the current MDD setting and override using the ‘‘DHCP
MDD Setting Parameters’’ troubleshooting page (select DHCP in the Advanced pages).
This page displays both the MDD Override setting and the selected MDD
mode.
The CM generates log messages in response to MDD settings or overrides:
• ‘‘MDD IP mode Set’’ — override disabled. The log message shows the
mode set by the MDD message.

Firmware Guide Release 7.5 Standard 1.2 August 2012

42 Chapter 2

• ‘‘MDD IP mode Override’’ — override enabled. The log messages

shows the mode set by the MIB object.

IPv6 Provisioning Notes

This section describes provisioning modes and flows appropriate to IPv6 sup-
port.

Provisioning Touchstone firmware supports the following provisioning modes for IPv6:
Modes • SECURE (full PacketCable)
• BASIC.1/2 (PacketCable and ARRIS versions)
• HYBRID.1/2
• GUPI
• GUPI with Encrypted E-UE config file
• PacketCable Minus KDC
Single MAC provisioning is explicitly not supported.

docsIf3CmMd- TS7.5 supports the docsIf3CmMdCfgTable objects for controlling IPv6 pro-
CfgTable Objects visioning.
docsIf3CmMdCfgIpProvMode
Specifies whether the CM honors or ignores the TLV5.1 message
from the CMTS. See ‘‘Selecting an Addressing Mode’’ below for
details.
Equivalent ARRIS object: arrisCmDoc30SetupMddIpModeOver-
ride. Use only one object in the configuration file; using both
objects may produce unexpected results.
Note: When changing the arrisCmDoc30SetupMddIpModeOver-
ride object, the CM resets immediately regardless of the doc-
sIf3CmMdCfgIpProvModeResetOnChange setting.

docsIf3CmMdCfgIpProvModeResetOnChange
Specifies whether the CM resets when the docsIf3CmMdCfgIp-
ProvMode object changes. The default is false(2).

docsIf3CmMdCfgIpProvModeResetOnChangeHoldOffTimer
When docsIf3CmMdCfgIpProvModeResetOnChange is set to
true(1), this object specifies the time, in seconds, that the CM waits
before resetting. The default value of 0 means the CM resets imme-
diately.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 43

docsIf3CmMdCfgIpProvModeStorageType
Specifies whether the value of docsIf3CmMdCfgIpProvMode per-
sists across reboots. The default nonVolatile(3) causes the value to
persist. If set to volatile(2), the value persists over one reset.

Selecting an Ad- Touchstone firmware supports the DOCSIS 3.0 MAC Domain Descriptor
dressing Mode (MDD) message, defined in the MAC and Upper Layer Protocols Interface
Specification, , for selecting IPv4 or IPv6 addressing. The CM uses TLV 5.1
in the MDD to select the addressing mode as follows:
Value Addressing Mode
0 IPv4
1 IPv6
Alternate Provisioning Mode (APM):
2
try IPv6 first, then IPv4
3 Dual Provisioning Mode (DPM)

If the E-UE does not find an MDD during provisioning, it always selects
IPv4 addressing.
The docsIf3CmMdCfgIpProvMode object can override the MDD and set
IPv4 or IPv6 operation.

CAUTION
Potentially service-affecting
Use this feature carefully. An invalid setting could isolate the Telephony
Modem from the network.

The supported values are:

• ipv4Only(0): force IPv4 addressing
• ipv6Only(1): force IPv6 addressing
• honorMdd(4): Use the MDD to determine the address type
The arrisCmDoc30SetupMddIpModeOverride MIB object can override the
MDD and set IPv4 or IPv6 operation.

DHCP Behavior for When the CM receives an MDD message that specifies IPv6 operation, it
IPv6 Provisioning acquires its IP address according to the MAC and Upper Layer Protocols
Interface Specification, TS7.5 supports both SLAAC and DHCPv6 mecha-
nisms.
TS7.5 supports the DHCPv6 options listed in the following table. For
details, see the DOCSIS 2.0 + IPv6 Cable Modem Technical Report, CM-TR-
DOCSIS2.0-IPv6-V01-080307.

Firmware Guide Release 7.5 Standard 1.2 August 2012

44 Chapter 2

Option # Sub-Option Name

1 Client Identifier option (DUID)
2 Server Identifier Option
3 IA_NA option (IPv6 address)
6 Option Request Option
14 Rapid Commit Option
19 Reconfigure Message option
20 Reconfigure Accept Option
Vendor-specific information option
32 TFTP Server Addresses option
33 Configuration File Name option
34 Syslog Server Addresses option
17
35 TLV5 Encoding
36 DOCSIS Device Identifier option
37 Time Protocol Servers option
38 Time Offset option

TS7.5 supports the DHCP Reconfigure message described in RFC 3315.

Upon receiving a DHCP Reconfigure message, the CM validates the message
then acquires updated DHCP parameters from the server.

Provisioning File The configuration file must be specific to either IPv6 or IPv4. If the plant has
Notes mixed IPv4 and IPv6 CMs, each address type requires separate provisioning
files.
IPv6 addresses must be fully qualified and not compressed. For example, an
IPv6 address of 2001:0200:0000:0000:0000:0000:0000:0022 cannot be
entered as 2001:0200::0022.

TLV-38 Enhance- Touchstone firmware supports TLV-38 (Notification) sub-type 8 (SNMP noti-
ments fication IPv6 address). Specify this sub-TLV to send SNMP traps and
informs to an IPv6-configured receiver.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 45

Upgrading Touchstone Firmware

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

WBM760 Consid- Upgrading WBM760 models from loads earlier than TS7.1.95, or TS7.3
erations loads earlier than TS7.3.38, requires in interim upgrade to TS7.3.38 and then
to TS7.5.

Upgrading from Customers upgrading Telephony Modems or Telephony Gateways from NCS
Earlier NCS Loads loads TS7.1.98 or newer can upgrade directly to TS7.5 NCS loads. Earlier
to TS7.5 NCS loads require an interim upgrade to TS7.1.98. You may need to review the
Loads contents of configuration files to take advantage of new features.

Upgrading from Customers upgrading from TS7.1 or TS7.3 SIP loads can upgrade directly to
Earlier SIP Loads TS7.5 ARRIS SIP loads.
to TS7.5 SIP Customers upgrading from TS7.2 or TS7.4 can upgrade directly to TS7.5
Loads ARRIS PC20 loads.
You may need to review the contents of configuration files to take advantage
of new features.

Upgrading Be- Customers upgrading from earlier TS7.x NCS loads to a TS7.5 SIP load, or
tween NCS Loads vice versa, must replace eDVA configuration files with MIB objects appropri-
and SIP Loads ate to the load.

Action Perform any of the following tasks as necessary.

Task Page
Upgrading the Firmware through Provisioning 45
Upgrading the Firmware through SNMP 46

Upgrading the Follow these steps to upgrade the Touchstone firmware load using a provi-
Firmware through sioning server.
Provisioning 1 Install the new firmware on the TFTP server.
2 Use the provisioning server to add or verify the following items in the
cable modem configuration file:

Firmware Guide Release 7.5 Standard 1.2 August 2012

46 Chapter 2

• ManufacturerCVC (the CVC, needed only for secure downloading)

• UpgradeFileName (file name of the firmware load)
• UpgradeServer (IP address of the server containing the load)
• SnmpMib = docsDevSwAdminStatus.0 2 (allowProvisioningUp-
grade)
3 During the maintenance window, use your provisioning server or ele-
ment manager to reset each Touchstone E-UE.
The E-UEs download the new firmware, then reset.
4 Verify that the E-UE has the new load by checking the value of the
docsDevSwOperStatus object (using an SNMP server).

The value should read completeFromProvisioning(2).

Upgrading the Follow these steps to upgrade the Touchstone firmware load using an SNMP
Firmware through manager. See ‘‘Using Enhanced Firmware Loading’’ on page 47 for infor-
SNMP mation about the Touchstone Firmware Upgrade System.
1 Using the provisioning server, add the ManufacturerCVC to the con-
figuration file.
2 Using the SNMP manager, set the following docsDevSoftware
objects:
docsDevSwServerAddressType
Set to 1 for IPv4 server addressing or 2 for IPv6 addressing.
docsDevSwServerAddress
The IP address of the server containing the load.
docsDevSwFilename
The file name of the load.
docsDevSwAdminStatus
Set to upgradeFromMgt(1).
The E-UE downloads the new firmware, then resets.
3 Verify that the E-UE has the new load by checking the value of the
docsDevSwOperStatus object.

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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 47

Using Enhanced Firmware Loading

The ARRIS Enhanced Firmware Loading feature (patent pending) provides
the ability to embed a common firmware load lineup table in configuration
files that matches firmware loads to Touchstone E-UEs. It supports a multi-
ple-vendor common configuration file that works with multiple Touchstone
E-UEs, while still being backward compatible with non-ARRIS equipment.
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: Touchstone firmware can download and store new firmware while a
call is in progress, then apply the new load once all lines are idle. Alterna-
tively, the E-UE can reject a request to start downloading firmware if any line
is off-hook.
When a Touchstone E-UE ranges and registers with the headend and receives
the arrisCmDoc30SwTable object (see ‘‘Enhanced Firmware Loading
Options’’ on page 49 for a listing of relevant MIB objects) in its configura-
tion file, it proceeds as follows:
Download Acceptance
1 If the E-UE is running on battery power, the E-UE rejects the
download and the process stops. Otherwise, it proceeds to
step 2.
2 The E-UE checks the docsDevSwAdminStatus object.
If the value is allowProvisioningUpgrade, proceed to step 3.
Otherwise, the device uses the standard docsDevSoftware MIB
objects for its upgrade decision-making.
A setting of upgradeFromMgt is not allowed in the configura-
tion file and returns an error condition.
3 The E-UE checks the arrisCmDoc30SwAdminStatus object.
• If the value is allowArrisProvisioningUpgrade, proceed to
step 4.
• If its value is ignoreArrisProvisioningUpgrade, the device
uses the standard docsDevSoftware MIB objects for its
upgrade decision-making.

Firmware Guide Release 7.5 Standard 1.2 August 2012

48 Chapter 2

A setting of upgradeFromArrisMgt is not allowed in the con-

figuration file and returns an error condition.
4 The E-UE scans the arrisCmDoc30SwTable, looking for
matches between arrisCmDoc30SwHwModel and its known
model type.
• If it finds a match, it checks the optional arrisCmDoc30Sw-
HwRev for a match to its known hardware revision. A blank
entry for arrisCmDoc30SwHwRev is a match only if there is
no entry with an explicit match to the E-UE’s hardware revi-
sion. 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 and aborts to the standard DOC-
SIS upgrade process.
5 The E-UE checks the value of arrisCmDoc30SwServerAd-
dressType to determine whether the CM uses IPv4 or IPv6
addressing (the eDVA always uses IPv4).
6 The modem reads arrisCmDoc30SwServerAddress to obtain
the IPv4 or IPv6 address of the TFTP server, and the arrisCm-
Doc30SwFilename for the firmware file name to download.

7 The E-UE checks the arrisMtaDevSwDnldNoSvcImpact

object.
If the value is strictEnable(2), and one or more lines are off-
hook, it delays firmware downloading until all lines are on-hook.
Otherwise, it immediately begins downloading the firmware.
Download Application
After downloading the firmware:
1 The E-UE checks the arrisMtaDevSwDnldNoSvcImpact
object.
If the value is disable(0), the E-UE immediately applies the
firmware and resets. Otherwise, proceed to step 2.
2 The E-UE checks for calls in process and applies the new
firmware load only if all eDVA lines are idle. Any of the follow-
ing 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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 49

• Ringing a line
3 If an active connection exists, the eDVA waits for all lines to go
idle then starts a 30-second timer.
4 If the timer expires with no lines becoming active, the E-UE
applies the firmware and resets; otherwise, it returns to step 3.
Touchstone firmware disables Enhanced Firmware Loading if docsDevSw-
AdminStatus is set to either upgradeFromMgt(1) or ignoreProvi-
sioningUpgrade(3). This allows deployment of provisioning files where the
docsDevSwAdminStatus object is not specified, or set to the default value
of allowProvisioningUpgrade(2), and both the Enhanced Firmware Loading
and the standard DOCSIS upgrade mechanisms are defined. This configura-
tion behaves as follows:
• Non-ARRIS devices upgrade using the DOCSIS upgrade objects.
• ARRIS devices automatically use Enhanced Firmware Loading to load
the correct firmware version.
• When an E-UE is manually upgraded using SNMP, it automatically sets
the docsDevSwAdminStatus object to ignoreProvisioningUp-
grade(3); this disables Enhanced Firmware Loading on ARRIS devices
and standard DOCSIS upgrading on all devices. To restore the ARRIS
firmware load specified in the load lineup, change docsDevSwAdmin-
Status to allowProvisioningUpgrade and reset the modem using
docsDevResetNow.

During the server communication and firmware image file download, there is
no interruption to E-UE 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 E-UE, 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 Enhanced Firmware Loading is controlled by several MIB objects, described

Firmware Loading below. These objects are all ARRIS-specific and do not interfere with non-
Options ARRIS E-UEs. All of these objects can be added to the vendor-specific sec-
tion of configuration files. The ARRIS DOCSIS 3.0 PacketACE software
(version 2.4 and higher) also supports these objects for easy addition to con-
figuration files. Each object can also be controlled remotely using 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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

50 Chapter 2

Software Down- TS7.3 MSUP7 introduces a new MIB object, arrisCmDoc30SetupSWDL-

load Filename FilenameCheckOverride. When enabled, SNMP-initiated downloads dupli-
Check Override cate the behavior of TS6.x loads when the filename is unchanged. This
Feature allows the MSO to use symbolic links for consistency in firmware filenames
included in the CM configuration file. This feature is disabled by default.

ArrisCmDoc30Sw- Enhanced Firmware Loading has a feature switch named arrisCm-

AdminStatus Fea- Doc30SwAdminStatus that parallels the standard DOCSIS docsDevSw-
ture Switch AdminStatus 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.

arrisCmDoc30Sw- The arrisCmDoc30SwOperStatus object provides the current firmware

OperStatus Object upgrade status:
• InProgress(1): A TFTP download is currently underway.
• CompleteFromProvisioning(2): The last firmware upgrade was a
result of version mismatch at provisioning.
• CompleteFromArrisMgt(3): The last firmware upgrade was a result of
setting arrisCmDoc30SwAdminStatus to upgradeFromMgt.
• Failed(4): The last attempted download failed.

ArrisCmDoc30- The arrisCmDoc30SwTable drives the main decision-making algorithm of

SwTable MIB 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 E-UE generates an ille-
gal SNMP SET during the ranging and registering process. Per DOCSIS
specifications, the E-UE does not range and register until this problem is cor-
rected. Each row of the table contains the following MIB objects:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 51

MIB object Description Valid Setting Req/Opt

arrisCmDoc30Sw- A customer-defined string that can 1–64 byte ASCII string* Optional
CustomerLoadId be added to identify load lineups.
This string is unused by the
firmware upgrade mechanism.
arrisCmDoc30- Defines which Touchstone hard- 1–16 byte ASCII string* Required
SwHwModel ware model type this row applies
to.
arrisCmDoc30- Defines the Touchstone hardware Integer, 0 to 255 Optional
SwHwRev revision of the currently defined
model.
arrisCmDoc30Sw- Specifies the IP address type used 0–2 Required
ServerAddressType for the firmware upgrade server
address: 0 (null), 1 (IPv4), or 2
(IPv6).
arrisCmDoc30Sw- Specifies the IPv4 or IPv6 address Any valid IP Required
ServerAddress of the TFTP server to use for
firmware upgrades.
arrisCmDoc30- Defines what file name the device 1–64 byte ASCII string* Required
SwFilename should request from TFTP server.
* – 1 byte reserved for null terminator

arrisCmDoc30SwHwModel Values

The following list shows common arrisCmDoc30SwHwModel ASCII

strings for hardware supported by TS7.5:
• WBM750A • WBM760C • TM722B • DG860A
• WBM750B • TM702A • TM722G • TG862G
• WBM750C • TM702B • TM722S
• WBM760A • TM702G • TG802G
• WBM760B • TM722A • TG852G

Firmware Guide Release 7.5 Standard 1.2 August 2012

52 Chapter 2

Firmware Down- Touchstone firmware may generate the following log messages in response to
load Log Mes- a firmware download request.
sages Event ID Context Severity Message
2417164299 CM Error Touchstone SW Upgrade
Aborted due to Battery AC-
FAIL Condition
2417164304 CM Error Touchstone SW Upgrade
Aborted due to Call in
Progress
2417164305 CM Notice Touchstone SW Upgrade
Reboot Delayed due to Call
in Progress

Example Lineup 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
arrisCmDoc30SwAdminStatus to allowArrisProvisioningUpgrade(2).

Customer Load Id HW Model HW Revision TFTP IP Address Upgrade Filename

Lab NA TM802 Rev. 1 TM802G 1 10.1.50.21 TS070107_112006.bin
Node 1 TM822 TM822G blank (see note 1) 10.1.52.21 TS070518_111011.bin
Note 1: Not specifying a hardware revision makes that entry a wildcard for any unspecified hardware revisions.

Example Configu- The following configuration file excerpt implements the firmware lineup
ration File Excerpt 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 TM802 Rev. 1"
SnmpMib = arrisCmDevSwHwModel.1 "TM802G"
SnmpMib = arrisCmDevSwHwRev.1 1
SnmpMib = arrisCmDevSwServer.1 10.1.50.21
SnmpMib = arrisCmDevSwFilename.1 "TS0701_07112006.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.2 "Node 1 TM822"
SnmpMib = arrisCmDevSwHwModel.2 "TM822G"
SnmpMib = arrisCmDevSwServer.2 10.1.50.21
SnmpMib = arrisCmDevSwFilename.2 "TS0701_07112006.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.3 "Euro TM802 Rev. 1"

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 53

Rejecting a Down- TS7.5 can reject a firmware upgrade while a call is in progress, complying
load Request with a PacketCable 1.5 requirement to minimize service impacts.

Action Perform the following tasks as needed.

Task Page
Setting Up ARRIS Enhanced Firmware Loading 53
Specifying and Verifying a CVC 54

Setting Up ARRIS Follow these steps to set up Enhanced Firmware Loading in a configuration
Enhanced file.
Firmware Loading 1 Use a provisioning server, or PacketACE version 5.8 or newer, to cre-
ate an entry in the arrisCmDoc30SwTable with the following set-
tings:
• arrisCmDoc30SwCustomerLoadId (optional): name of the load
lineup.
• arrisCmDoc30SwHwModel: the Touchstone E-UE model (see
‘‘arrisCmDoc30SwHwModel Values’’ on page 51 for a list of valid
model names).
• arrisCmDoc30SwHwRev (optional): the hardware revision of the
E-UE. Leave blank for this entry to apply to all revisions of the
same model.
• arrisCmDoc30SwServerAddressType: The CM addressing type
(the eDVA always uses IPv4 addressing). Either 1 to use IPv4, or 2
for IPv6.
• arrisCmDoc30SwServerAddress: the IP address of the TFTP
server containing the firmware load for E-UEs matching the model
and revision.
• arrisCmDoc30SwFilename: the file name of the firmware load for
E-UEs matching the model and revision.
2 In the configuration file, set the arrisCmDoc30SwAdminStatus
object to allowArrisProvisioningUpgrade.
Note: The E-UE uses Enhanced Firmware Loading to download its
firmware during the next reboot, unless the E-UE is running on bat-
tery power.
3 Do one of the following to force the E-UE to immediately download
its firmware file, if desired:
• Reboot the E-UE, either directly or by setting the docsDevReset-
Now object to true(1) from the network manager.

Firmware Guide Release 7.5 Standard 1.2 August 2012

54 Chapter 2

• In the network manager, set the E-UE’s arrisCmDoc30SwAdmin-

Status object to upgradeFromArrisMgt(1).

Note: If the E-UE is running on battery power, it disables firmware

upgrades until AC power is restored.

Specifying and Follow these steps to specify a CVC for a firmware load.
Verifying a CVC Note: If you specify a CVC using these steps, any manufacturer or co-signer
CVC specified in standard DOCSIS TLVs is used only for a standard DOC-
SIS download.
1 To specify a CVC to use with the firmware load:
a Break the CVC into segments of 255 octets or less.
b Populate the arrisCmDoc30SwCvc1, arrisCmDoc30SwCvc2,
arrisCmDoc30SwCvc3, and arrisCmDoc30SwCvc4 objects in
the configuration file with the segmented CVC.
2 To verify the CVC value after firmware loading, check the arrisCm-
Doc30SwCvcStatus object.

This object has one of the following values:

• cvcNotIncluded(1): The Telephony Modem did not receive a CVC
through Enhanced Firmware Loading, and is using the standard
manufacturing CVC.
• cvcNotValidated(2): The Telephony Modem received an invalid
CVC through Enhanced Firmware Loading.
• cvcValidated(3): The Telephony Modem received a valid CVC
through Enhanced Firmware Loading.
3 To display the current CVC, read any of the arrisCmDoc30SwCvcn
objects. Reading one of these objects returns the entire CVC.

L2VPN Provisioning
+
TS7.5 MSUP5 introduces Business Services over DOCSIS (BSoD) support +
as described in CM-SP-L2VPN-I09-100611. The following services are sup- +
ported: +
Transparent LAN Service (TLS) +
TLS is intended for commercial enterprise customers. It intercon- +
nects subscriber enterprise LANs using Layer 2 Virtual Private Net- +
work (L2VPN) forwarding. A cable operator offers TLS by provid- +
ing one L2VPN for each commercial enterprise. +

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 55

Multiple ISP L2VPNs +

This feature allows cable operators to support multiple Internet Ser- +
vice Providers (ISPs) by providing a separate L2VPN for each ISP. +
The cable operator controls CM provisioning, and the CM configu- +
ration file specifies an L2VPN associated with the ISP. The ISP +
must provide DHCP servers and IP addressing for all CPEs attached +
to their L2VPN. +
Management L2VPNs +
This feature provides an L2VPN dedicated to provisioning and man- +
aging embedded Cable Modems (eCMs) and embedded Ser- +
vice/Application Functional Entities (eSAFEs). An eSAFE may be +
an embedded Multimedia Terminal Adapter (eMTA), or an embed- +
ded CableHome® Portal Services (ePS) function. A Management +
L2VPN isolates those devices from the Internet and from the sub- +
scriber, enhancing security. +
+

Provisioning De- To provision L2VPN, include configuration settings in the CM configuration +

tails file. The settings are subtypes of TLV-43 (Vendor Specific Information), +
using vendor ID 0xFFFFFF (DOCSIS RFI). These are encoded as General +
Extension Information (GEI) parameters. +
Location is significant. For example, as sub-TLVs of TLV-24 (Upstream Ser- +
vice Flow Encoding), the L2VPN encodings define a VPN associated with +
that Service Flow. Configuring multiple groups is necessary to completely +
define an L2VPN. Section 6.2 of CM-SP-L2VPN-I09-100611 describes how +
location affects the L2VPN configuration. +
+

Unknown CPE Touchstone firmware complies with CM-SP-L2VPN-I09-100611, and for- +

Traffic Handling wards all downstream L2VPN multicast traffic. regardless of whether the +
destination CPE address has been learned. +
Touchstone firmware extends this requirement to forward all L2VPN traffic, +
both upstream and downstream, whether or not the destination CPE MAC +
addresses have been learned. +

Firmware Guide Release 7.5 Standard 1.2 August 2012

56 Chapter 2

Configuring Channel Bonding Characteris-

tics
Channel bonding is set up in the CM configuration file. The MIB objects in
this procedure provide some extra control over, and monitoring of, channel
bonding.

Action Follow these steps to configure channel bonding characteristics.

1 To disable downstream channel bonding (effectively forcing DOC-
SIS 2.0 behavior), set the arrisCmDoc30SetupDsBonding object to
disable(0).

Note: The object setting takes effect at the next reboot, and persists
across reboots. If this object is set to disable(0), the modem disables
DOCSIS 3.0 operation until re-enabled.
2 To configure how the Telephony Modem handles partial service situa-
tions, proceed to ‘‘Recovery from Partial Service’’ on page 267.
3 To display the current bonding mode, query the arrisCmDoc30Bond-
ingMode object. This object contains a string showing the current
DOCSIS operating mode and the number of bonded downstream and
upstream channels.
Examples:
DOCSIS3.0 4x1
DOCSIS2.0 1x1

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 57

Provisioning Quality of Service

DOCSIS and PacketCable standards specify the use of service flows to sepa-
rate and prioritize voice and data traffic. Touchstone firmware provides two
QoS modes.
See CM-SP-MULPIv3.0-I12-100115 for detailed descriptions of Service
Flow types.

Full DQoS Mode Touchstone firmware defaults to Dynamic Quality of Service (DQoS) provi-
sioning. Full DQoS simplifies provisioning tasks by only requiring 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 net-
works, as needed. The CMS controls the bandwidth authorization as speci-
fied in the PacketCable Dynamic Quality of Service Specification, PKT-SP-
DQOS1.5-I03-070412.
Full DQoS provides an added layer of security by authenticating eDVAs that
contact the CMS 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 eDVA using an NCS message, to match requests
with authorizations. Upon receiving call-signaling information, the eDVA
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 mes-
saging. 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. When acti-
vated, the firmware sends the appropriate DSx messages needed to
Add/Modify/Delete the UGS service flows. DSx messages flow only
between the CMTS and the eDVA, and do not involve the CMS in any valida-
tion or requests for setting up or monitoring the UGS flows.
Note: When using this functionality with the ARRIS C4 CMTS, PacketCable
authorization needs to be disabled. Contact your next level of support for
instructions.

Firmware Guide Release 7.5 Standard 1.2 August 2012

58 Chapter 2

Dual-Mode Operation

TM702B and TM722B Telephony Modems are available in a dual-mode ver-

sion that can configure its CM component for either DOCSIS or Euro-DOC-
SIS operation based on the type of downstream first detected.
When a dual-mode Telephony Modem ranges and registers for the first time,
it stores the detected signal type in non-volatile memory. During subsequent
reboots, it automatically scans for the stored signal type.
If a dual-mode Telephony Modem is moved to a plant with a different signal
type, it uses several methods to detect and lock to a new signal. For example,
if a dual-mode Telephony Modem had originally ranged and registered on a
North American DOCSIS plant, and then was moved to a Euro-DOCSIS
plant, it would use the following procedure:
1 Scan all cached frequencies, attempting to detect (in order):
a QAM256 carrier using Annex A
b QAM64 carrier using Annex A
c QAM256 carrier using Annex B
d QAM64 carrier using Annex B
2 Scan all preset frequencies, checking for carriers as above.
3 Perform up to three general scans, checking for carriers as above.
4 Reboot.

Forcing Provision- To force North American PacketCable provisioning on a TM702B or

ing Mode and Cer- TM722B that would otherwise default to Euro-PacketCable provisioning, set
tificates the arrisCmDoc30SetupPacketCableRegion object to northAmerican(0).
When overridden, the Telephony Modem continues to use the European root
certificate.
To force selection of North American or European certificates, use the
setCertRootType CLI command. This command is found under main →
pacm → security → certificates. A second command in this menu, dis-
playCertsDir, shows the current certificate settings.

Configuration Use European CVCs in configuration files for Dual Mode units. This allows
Files and Signed configuration files for a normal European unit to work for Dual Mode Tele-
Loads phony Modems as well. If the firmware load for a Dual Mode unit is signed,
it should be European signed.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 59

Certificates Dual Mode Telephony Modems are programmed with four certificates, a
European and North American certificate each for the CM and eDVA.
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.

DMDM Status Use the arrisCmDevDualModeDiscoveredMarket MIB object to retrieve

the current DMDM value. Non-Dual Mode Telephony Modems always
return 0 for this object.

Firmware Guide Release 7.5 Standard 1.2 August 2012

60 Chapter 2

CODECs and Packetization Rates Supported

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.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 eDVA to negotiate a different CODEC with other
eDVAs. Call agents offering G.726 or G.729 should also offer ‘‘telephone-
event’’ so the eDVA can successfully transmit DTMF tones when using a
compressed voice CODEC.
Touchstone SIP firmware loads offer CODECs based on the contents of the
pktcEUERSTBCallPrefCodecList MIB object. If you choose to offer G.729
in this array, you should also offer DTMF relay (telephone-event) as com-
pressed CODECs can distort DTMF tones sent through the network. The fol-
lowing is an example array string:
G729,PCMU,PCMA

This CODEC array would set G.729 as the default with DTMF relay enabled.
If ‘‘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.
If the pktcEDVADtmfRelay object is set to true(1), the eDVA also specifies
‘‘telephone-event’’ in the list of supported CODECs.
Implementation of CODECs is defined by the Codec and Media Specifica-
tion, PKT-SP-CODEC-MEDIA-I09-100527.
The supported packetization rates in TS7.5 are 10 and 20 ms.

G.729 CODEC Touchstone firmware supports the G.729 CODEC to perform toll-quality
Support voice compression. 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 61

G.729 CODEC Negotiation (NCS)

By IANA definition and PacketCable specification, compliant Call Agents

use ‘‘G729’’ in the NCS Local Connection Options (LCO) to instruct an end-
point 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
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

The Call Agent may also specify a backup CODEC in a CRCX such as the
following:

Firmware Guide Release 7.5 Standard 1.2 August 2012

62 Chapter 2

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 neces-
sary.

G.729 CODEC Negotiation (SIP)

For outbound calls, SIP loads send the CODECs specified in either the
pktcEUERSTBCallPrefCodecList object (PC20 loads) or the sipCfgProvi-
sionedCodecArray object (ARRIS SIP loads) object in the initial INVITE.
To include G.729, add ‘‘G729’’ to the list. A typical configuration might
include one of the following settings:
{SnmpMib pktcEUERSTBCallPrefCodecList.0 "PCMU,PCMA,G729"}

{SnmpMib sipCfgProvisionedCodecArray.0 "PCMU;PCMA;G729;telephone-event"}

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 63

The CODECs are listed in order of preference.

Incoming calls include the list of supported CODECs in the INVITE. The
eDVA responds with the CODECs it supports in the list. SIP loads support
PCMU, PCMA, G728, G729, G729E, G726-16, G726-24, G726-32,
G726-40, and telephone-event.
If the pktcEDVADtmfRelay object is set to true(1), the eDVA also specifies
‘‘telephone-event’’ in the list of supported CODECs.

G.729 Fax and Modem Support

Since the G.729 CODEC highly compresses audio, it can not adequately sup-
port 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 automati-
cally 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 follow-
ing 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 band-
width for PCMA or PCMU even when G.729 is being used. This extra band-
width is wasted during normal voice calls, but may be used for Best Effort
data traffic.

Firmware Guide Release 7.5 Standard 1.2 August 2012

64 Chapter 2

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 avail-
able if a switch to PCMU or PCMA became necessary, which would result in
a failed fax or modem call.

CODECs and Sup- This section describes how low bit-rate CODECs and T.38/SuperG3 FAX
ported Lines relay interact.

Model 7/Model 8 Engineering Rules

The following rules apply to Model 7 and Model 8 Telephony Modems and
Telephony Gateways:
• 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 2
Leg 1 2 1 2
T.38/SG3 T.38/SG3
LBR G.711 LBR G.711
G.711 G.711 G.711 G.711
T.38/SG3 LBR G.711

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 65

Provisioning General eDVA and Line Param-

eters
Touchstone firmware provides a great deal of flexibility in configuring the
eDVA and individual lines. This procedure covers general and miscellaneous
parameters; other procedures in this chapter provide detailed information
about more complex features.

Action Perform any of the following tasks as necessary.

Task Page
Setting Persistent Line Status 65
Controlling LED Behavior 66
Controlling ToS Byte Marking 66
Controlling TurboDOX Functionality 66
Controlling IPsec Functionality 67
Configuring the Ringing Waveform 67
Configuring Loop Current 68

Setting Persistent Follow these steps to set persistent line status.

Line Status 1 To set line status using SNMP, set the arrisMtaDevPersistentLine-
Status 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 eDVA ignores the setting.
2 To set line status using the CLI, enter the following commands:
Console> voice ↵
Voice> callp ↵
Call Processing> spls {line} {state} ↵

Where:
line
is the line number: 1 to the number of lines supported by the
Telephony Modem.
state
is either 0 to use normal state processing, or 1 to force-disable
the line.

Firmware Guide Release 7.5 Standard 1.2 August 2012

66 Chapter 2

Controlling LED WBM760, TM722, and Model 8 modems provide multi-colored DS, US, and
Behavior Link LEDs. If desired, follow these steps to control the behavior of the
multi-color LEDs:
1 To enable multi-color functionality, use the arrisCmDoc30SetupMul-
tiColorLedBitmap object. Set a bit to 1 to enable multi-color func-
tionality (green for high-speed connections, amber for normal speed);
or 0 to use green for all connection speeds. The valid bits are:
• 0x1: Link LED
• 0x2: US LED
• 0x4: DS LED
Default: 7.
This setting persists across reboots.
2 To invert the color display (amber for high-speed connections, green
for normal speed), set the arrisCmDoc30SetupInvertMulticol-
orLEDs object to enable(1). The following table shows the DS, US,
and Link LED colors for each setting and condition.
DS US Link
Value
Bonded Non-bonded Bonded Non-bonded GigE 10/100BaseT
disable Green Amber Green Amber Green Amber
enable Amber Green Amber Green Amber Green

Controlling ToS Touchstone firmware sets the ToS byte in RTCP packets to a value of 0. Fol-
Byte Marking low these steps to change the value of the RTCP ToS byte.
1 Using an SNMP network manager, change the arrisMtaDevRtcpTos-
Value object to the desired value. Valid range: 0 to 63.

The ToS marking changes immediately for all RTCP packets.

Note 1: The value of this object is shifted two bits before being loaded
into the ToS byte.
Note 2: A common setting for ToS is 46 (expedited forwarding).
2 To make the change permanent, add the arrisMtaDevRtcpTosValue
MIB object (with the desired value) to the eDVA provisioning file.

Controlling Turbo- TurboDOX is a TI-proprietary protocol, supported in hardware. Enabling

DOX Functionality TurboDOX increases performance of TCP-based protocols such as FTP and
HTTP.
TurboDOX is enabled by default. You may need to disable TurboDOX dur-
ing customer traffic testing and lab evaluations. ARRIS recommends that
TurboDOX remained enabled in field deployments.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 67

Follow these steps to control TurobDOX functionality.

1 To provision TurboDOX functionality, add the arrisCmDoc30Setup-
TurboDoxEnable object to the CM configuration file. Set this object
to true(1) to enable TurboDOX (the default), or false(2) to disable it.
2 To display or control TurboDOX functionality using the CLI:
a Enter the Packet Processor sub-mode:
Console> co ↵
mainMenu> docsis ↵
docsis> pp ↵
Pp>

b To enable TurboDOX, enter the command enableTdox.

c to disable TurboDOX, enter the command disableTdox.
d To show the internal TurboDOX database, enter the command
tdox.

e To show TurboDOX statistics, enter the command stats.

3 Use the exit command as needed to return to a higher-level CLI mode.

Controlling IPsec IPsec (Internet Protocol Security) is a collection of Internet standards used to
Functionality 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).
Note: Touchstone E-UEs use only the IPsec ESP transport mode.
IPsec is enabled by default. Follow these steps to provision IPsec functional-
ity.
1 For each CMS that the eDVA can communicate with, set the pktcMta-
DevCmsIpsecCtrl object in the eDVA configuration file. The object
is indexed by the CMS FQDN. Set the object to true(1) to enable
IPsec between the eDVA and a particular CMS, and false(2) to dis-
able it.
2 Reboot the eDVA to allow the new provisioning to take effect.

Configuring the Telephony Modems support both trapezoidal and sinusoidal ringing
Ringing Waveform waveforms when used with North American country templates. You may
need to change the waveform if certain non-EIA compliant subscriber equip-
ment does not recognize the trapezoidal waveform (in short, the phone does
not ring).

Firmware Guide Release 7.5 Standard 1.2 August 2012

68 Chapter 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. Use of this feature with other templates may
result in loss of service.

1 Set the arrisMtaDevEndPntRingingWaveform object using one of

the following methods:
a In the eDVA configuration file, add the arrisMtaDevEndPntRing-
ingWaveform object and set it to sinusoidal or normal as
desired. Then reset the eDVA to allow the change to take effect.
b Use an SNMP manager to access the eDVA and set the arrisMta-
DevEndPntRingingWaveform object to sinusoidal or normal as
desired.
Note: Setting this object in the configuration file does not write the
setting to NVRAM; therefore, if you remove the object from the con-
figuration file and reset the eDVA, it reverts to using the trapezoidal
waveform. Setting the object through SNMP does write the setting to
NVRAM.

Configuring Loop Touchstone Telephony Modems support a ‘‘boost,’’ or high loop current
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 fail-
ing 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
• Boost mode (North American templates): 40 mA
• Boost mode (other templates): 33 mA
eDVAs 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 nor-
mal loop current.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 69

Note: If you set the loop current through SNMP, the eDVA 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: High loop current reduces battery hold-up times.

Firmware Guide Release 7.5 Standard 1.2 August 2012

70 Chapter 2

Setting Loop Voltage Management

Touchstone firmware supports Loop Voltage Management as defined in Pack-
etCable specification PKT-SP-MIB-EXSIG-I03-070412. Loop Voltage Man-
agement provides four management policies used to control loop voltage
behavior during outages or cable cuts.
The Advanced ‘‘Product Details’’ web page shows the current loop voltage
management settings under the ‘‘Optional Features’’ heading. If Policy 3 is
set, the web page displays the reset timer setting.
Note: Touchstone firmware supports both PacketCable and ARRIS-propri-
etary MIB objects for provisioning Loop Voltage Management. See ‘‘Map-
ping ARRIS Loop Voltage Objects to PacketCable Objects’’ on page 73 for
details.

Loop Voltage Man- Use the pktcEnNcsEndPntLVMgmtPolicy to set the Loop Voltage Manage-
agement Policies ment policy. The following policies are supported:
• voltageAtAllTimes(1)
• voltageUnlessRFQAMabsent(2)
• voltageBasedOnServiceOrTimers(3)
• voltageBasedOnService(4) (default)

Policy 1: Constant Loop Voltage

When this option is selected, the eDVA maintains loop voltage at all times
with the following two exceptions:
• During firmware initialization of the line card. Touchstone eDVAs
remove loop voltage for up to 1 second during firmware initialization,
although typically this time is shorter.
• When the unit has no power.

Policy 2: QAM Carrier Detect

When this option is selected, the eDVA maintains loop voltage when it can
lock onto a QAM carrier, including digital video QAM carriers. The
assumption is that if the Telephony Modem can recognize a carrier, the con-
nection is intact (has not been cut by a burglar).
When the Telephony Modem loses its carrier, after the T4 timeout expires
(20–30 seconds), the modem scans cached and preset frequencies, then scans
the entire spectrum. If the cable is truly cut, the scan takes 1 to 2 minutes to
complete. If the modem lost its carrier, but can detect other RF energy (such
as analog carriers), the scan can take up to 30 minutes to complete. If the
modem does not detect any QAM carriers after scanning the STD and LRC

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 71

frequencies, it removes loop voltage then continues with slow scanning.

Once the Telephony Modem removes loop voltage, it does not re-apply loop
voltage until it re-registers with eDVA provisioning.

Policy 3: eDVA In-Service/Manual Reset

When this option is selected, the Telephony Modem maintains loop voltage
when in-service or during manually-initiated resets and T4 timeouts. The
Telephony Modem is considered in-service when eDVA TFTP is complete.
Both subscriber resets (pushing the Reset button) and headend-initiated resets
(SNMP, firmware upgrade) are considered manually-initiated.
Two timers govern the behavior of the eDVA during resets or outages:
pktcEnNcsEndPntLVMgmtResetTimer
The reset timer determines how long the eDVA maintains loop volt-
age during a reset.
Note: If the reset timer is set to a period longer than the scanning
time between resets (typically 7 minutes), the eDVA never drops
loop voltage.
pktcEnNcsEndPntLVMgmtMaintTimer
The plant maintenance timer (PMT) determines how long the eDVA
maintains loop voltage when the E-UE loses its downstream signal.
This timer may be used to maintain loop voltage during extended
plant maintenance intervals.
When both timers expire without the eDVA completing provisioning, or the
T4 timer expires as well, the eDVA drops loop voltage.

Policy 4: eDVA In-Service

This is the default policy. Using this option, the eDVA goes through the fol-
lowing steps:
1 When applying initial AC power, Telephony Modems do not apply
loop voltage.
2 When the eDVA completes TFTP and the lines are provisioned, it
applies loop voltage only if the eDVA completes provisioning and the
pktcMtaDevProvisioningState MIB object has one of the following
values:
• pass(1)
• passWithWarnings(4)
• passWithIncompleteParsing(5)

Firmware Guide Release 7.5 Standard 1.2 August 2012

72 Chapter 2

If provisioning succeeds, the eDVA applies loop voltage to provi-

sioned lines. If a provisioned line goes off-hook before the eDVA has
contacted the call server, the modem immediately attempts to contact
the call server and allows the call to continue. Loop voltage is applied
even if the call server cannot be reached.
3 After the eDVA device is in service and there is an interruption to the
RF, loop voltage remains present on the lines until a T4 timeout
occurs (generally 20 to 30 seconds).

Loop Voltage Man- The pktcEnNcsEndPntLVMgmtTable table contains the loop voltage policy
agement MIB Ob- and timers. This table is indexed by ifIndex; an index value of 1 applies the
jects policy settings to all eDVA lines.
The objects in the pktcEnNcsEndPntLVMgmtTable are:
pktcEnNcsEndPntLVMgmtPolicy
Defines the policy; one of:
• voltageAtAllTimes(1)
• voltageUnlessRFQAMabsent(2)
• voltageBasedOnServiceOrTimers(3)
• voltageBasedOnService(4)
See ‘‘Loop Voltage Management Policies’’ above for descriptions of
each policy.
pktcEnNcsEndPntLVMgmtResetTimer
The time, in minutes, allowed for an eDVA to successfully provision
after a reset. This timer applies only when pktcEnNcsEndPnt-
LVMgmtPolicy is set to a value of voltageBasedOnServiceOr-
Timers(3). In all other cases, reading this object returns a value of
zero.
The eDVA starts the timer upon a hard reboot, a soft reset or a T4
timeout. The timer value persists the last configured value (i.e., not
the countdown value) of this MIB Object across hard reboots and
soft resets.
Valid range: 0 to 1440 (minutes). Default: 5.
pktcEnNcsEndPntLVMgmtMaintTimer
The time, in minutes, that the eDVA maintains loop voltage regard-
less of the eDVA’s connection or provisioning status. This timer
applies only when pktcEnNcsEndPntLVMgmtPolicy is set to a
value of voltageBasedOnServiceOrTimers(3). In all other cases,
reading this object returns a value of zero. The current timer value
persists across soft resets, but resets to zero for a hard reset or
power-cycle.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 73

The eDVA starts the timer when it is set to a value greater than zero.
The eDVA maintains loop voltage until the timer expires.
Valid range: 0 to 1440 (minutes). Default: 0.

Mapping ARRIS Loop Voltage Objects to PacketCable Objects

Some earlier versions of Touchstone firmware provided an ARRIS-propri-

etary version of Loop Voltage Management that is very similar to the Packet-
Cable-standard version. For backward compatibility, both ARRIS and Pack-
etCable MIB objects are supported in TS7.5.
The following table defines how ARRIS objects map to PacketCable objects.
ARRIS Object PacketCable Object Notes
arrisMtaDevLoopVoltageKey (none) Not needed
arrisMtaDevLoopVoltagePolicy pktcEnNcsEndPntLVMgmtPolicy Roughly equivalent
always-voltage-present(1) voltageAtAllTimes(1)
rf-carrier-voltage-present(2) voltageUnlessRFQAMAbsent(2)
in-service-voltage-present(3) voltageBasedOnServiceOrTimers(3)
default-operation(4) voltageBasedOnService(4)
arrisMtaDevLoopVoltageResetTimeout pktcEnNcsEndPntLVMgmtResetTimer Adjust ranges as shown
Valid range: 8–1800 Valid range: 0–1400
arrisMtaDevLoopVoltageMaintTimeout pktcEnNcsEndPntLVMgmtMaintTimer Adjust ranges as shown
Valid range: integer Valid range: 0–1440

Action Follow these steps to configure loop voltage management.

1 Set the pktcEnNcsEndPntLVMgmtPolicy object to the appropriate
policy value:
• voltageAtAllTimes(1)
• voltageUnlessRFQAMabsent(2)
• voltageBasedOnServiceOrTimers(3)
• voltageBasedOnService(4) (default)
Note: For this and other LVM objects, use an index of .1 to apply the
same policy to all lines. If you want to specify different policies for
each line, use the ifIndex of each line instead.
2 For eDVAs using policy 3, modify the reset timer (if necessary) by
setting the pktcEnNcsEndPntLVMgmtResetTimer object. Valid
range: 0 to 1440 minutes. Default: 5 minutes.
The line card drops loop voltage after a CM reset, if the eDVA has not
been successfully provisioned before the Reset Timeout timer expires.

Firmware Guide Release 7.5 Standard 1.2 August 2012

74 Chapter 2

Note: This object is only used with policy option 3 and is ignored if a
policy setting of other than 3 is used.
3 For eDVAs using policy 3, modify the plant maintenance timer (if
necessary) by setting the pktcEnNcsEndPntLVMgmtMaintTimer
object. Valid range: 0 to 1440 minutes (24 hours).
4 Reset the eDVA to enable the new loop voltage policy on the eDVA.

Feature Switches

Touchstone firmware provides various feature switches to enable or disable

various functionality. Some feature switches provide improved interoperabil-
ity with non-PacketCable compliant equipment, while others provide features
that may violate DOCSIS or PacketCable standards.

CallP Feature Touchstone firmware provides an ARRIS-specific MIB, ppCfgMtaCallpFea-

Switch tureSwitch, 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 Pack-
etCable compatibility.
The feature switch is a 32-bit value, where each bit enables or disables a cer-
tain 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 0x0.
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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 75

Bit Description

0x00000001 Disable NCS Piggyback Messages (NCS only)

Set this bit to disable transmission of NCS piggybacked mes-
sages (that is, sending more than one NCS message in a
UDP packet). This may be required by Call Agents that do
not properly handle piggybacked NCS messages.
Note: NCS redirection may not function properly when pig-
gybacked messages are disabled.
0x00000002 Prevent Endpoint Lockstep Quarantine Mode (NCS only)
Set this bit to prevent endpoints from entering the lockstep
quarantine mode. This may be required by Call Agents that
leave the endpoint in lockstep mode.
When this bit is clear, the gateway must receive a new Notifi-
cation 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.
0x00000004 Show OOS instead of Idle for unprovisioned lines
Set this bit to return oos(0) instead of idle(1) in the arrisM-
taDevLineCardState object for unprovisioned lines.
0x00000008 T.38 Capability Descriptor (NCS only)
Set this bit to reduce the SDP capability descriptor to only
send T.38-related information.
0x00000040 Automatic OSI (NCS only)
Set this bit to automatically apply OSI to both the originating
and terminating sides of a call. To fully enable this function-
ality, set bit 0x20000000 as well.
0x00000080 Omit MPTIME parameter in returned SDP (NCS only)
Set this bit to omit the ‘‘a=mptime’’ and ‘‘a=ptime’’ parame-
ters in the eDVA’s SDP message.
0x00000100 Enable DOCSIS 2.0 backward compatibility for DQoS (NCS
and SIP)
Set this bit to enable DOCSIS 3.0 Telephony Modems to
properly interoperate with a DOCSIS 2.0 CMTS.
0x00000400 Ignore payloads not listed in media description
Set this bit to ignore format-specific SDP attribute lines
referring to payload types not listed in the media description
(the m=) line.
0x00000800 Force use of DQoS (NCS only)
Set this bit to force the Telephony Modem to require
Dynamic Quality of Service, rejecting service otherwise.
The default behavior allows non-DQoS service.

Firmware Guide Release 7.5 Standard 1.2 August 2012

76 Chapter 2

Bit Description
0x00001000 Nuera RFC 2833 messaging without request using payload
127 (NCS only)
Set this bit to instruct the eDVA 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-only DQoS only between the
CM and CMTS.
0x00008000 Disable endpoint from sending provisional responses (NCS
only)
Set this bit to disable sending provisional responses to the
CMS if execution of the CRCX or MDCX commands takes
additional time to execute. The ARRIS eDVA 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 eDVA has completed the transaction, it transmits a
‘‘final’’ response back to the CMS. This ‘‘final’’ response
must be acknowledged by the CMS; otherwise, the eDVA
retransmits it until it is acknowledged.
The default is to send provisional responses in accordance
with PacketCable ECN MGCP-N-02218. Set this bit to pro-
vide compatibility with CMS vendors that are not capable of
supporting provisional responses.
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.
0x00080000 LUCENT RFC-2833 messaging without request using pay-
load 94 (NCS only)
Some CMS vendors use RFC 2833 to have the eDVA pass
detected telephony events (e.g. offhook, onhook, digits) to a
PSTN gateway in-band, similar to ABCD robbed-bit signal-
ing. For compatibility with Lucent iMerge, set this bit to
instruct the eDVA to generate RFC 2833 events with a pay-
load 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 77

Bit Description
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 eDVA’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 eDVA on whether to use encryption or not on a
per-call basis.
0x00400000 NCS Redirect without IPsec (NCS only)
Set this bit to allow a CMS to redirect the eDVA to another
CMS that is not provisioned in the eDVA CMS table, allow-
ing the eDVA to communicate with the CMS without
attempting to establish an IPsec association first. Setting this
bit is for redirect cases only; the eDVA does not respond to
call servers not provisioned in the eDVA’s CMS table.
0x00800000 Add brackets around IP for eDVA FQDN (NCS only)
Set this bit to enable the eDVA to send an NCS message with
a bracketed IP address as part of the eDVA 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 manda-
tory.
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 operator-specified
payload without request (NCS only)
Set this bit to instruct the eDVA to generate RFC 2833
DTMF events using a payload type defined in the ppCfg-
Rfc2833DigitPayloadType MIB object without being
instructed to do so by the CMS. The default payload type
value is 101.
0x08000000 Use alternate (non-sequential) Caller ID delivery order (NCS
and SIP)
Set this bit to have the eDVA present Caller ID in an alter-
nate (non-sequential) order. This may be required for com-
pliance with some CPE devices that expect Caller ID infor-
mation to be presented in a non-standard format. Clear this
bit (the default) to use a sequential order based on the param-
eter type (date/time, then number, then name).

Firmware Guide Release 7.5 Standard 1.2 August 2012

78 Chapter 2

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 mes-
sage 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 (NCS only)
Set this bit to have the eDVA automatically generate OSI
(Open Switch Interval) to the CPE upon far end termination
of a call (i.e. the eDVA 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
eDVA 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).

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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 79

Feature Switches Affecting the SDP

The following feature switches affect the SDP, returned in response to a Cre-
ate (CRCX) or Modify (MDCX) Connection command.
Bit Description
0x00000008 Reduce the capability descriptor in the SDP to T38 only
(default = 0, no reduction).
0x00000080 Omit mptime parameter in returned SDP (default = 0,
mptime included).
0x00001000 NUERA RFC 2833 messaging without request using pay-
load 127 (default = 0, telephone-event is negotiated nor-
mally).
0x00080000 LUCENT RFC 2833 messaging without request using pay-
load 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 an operator-defined
payload without request (default = 0, telephone-event is
negotiated normally).

The following CRCX message 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 are (0x0 for NCS loads, and 0x0020 for
SIP loads) 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
a=cpar: a=fmtp:18 annexb=no
a=cpar: a=rtpmap:101 telephone-event/8000/1

Firmware Guide Release 7.5 Standard 1.2 August 2012

80 Chapter 2

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 ‘‘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 speci-
fication.
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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 81

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: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, 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: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
s=-
c=IN IP4 10.1.36.219
t=0 0
m=audio 65496 RTP/AVP 0
b=AS:81

Firmware Guide Release 7.5 Standard 1.2 August 2012

82 Chapter 2

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: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: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 Capabil-
ity Descriptor slightly. Payload type 127 is used for RFC 2833 support.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 83

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: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.
Note: The three feature switches that affect RFC 2833 negotiation are mutu-
ally 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

Firmware Guide Release 7.5 Standard 1.2 August 2012

84 Chapter 2

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=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.
the payload type specified by ppCfgRfc2833DigitPayloadType is added to
the m= line (the default value is ‘‘101’’) and two new attributes indicate that
the endpoint is prepared to receive RFC 2833 digits.

eDVA Feature Touchstone firmware supports an eDVA feature switch that allows you to
Switch 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
eDVA MAC addresses are not counted against the Max-
CpeAllowed TLV. This is required to enable telephony
if policy requires this TLV to have a value of 1. Without
this switch setting, you must set the MaxCpeAllowed
TLV to 2 or higher to enable telephony. D11PLUS loads
ignore this setting, and always ignore the eDVA in the
CPE count.
0x00000004 mtaFilterBypass
eDVA packets bypass the CM CPE filters (interface 0).
This switch has no effect on filters applied against inter-
face 16 (eDVA). D11PLUS loads ignore this setting, and
always bypass the CPE filters.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 85

Bit Value Description

0x00000008 proprietaryCoex
Enables ARRIS-proprietary eDVA coexistence and noti-
fication features. See the Touchstone Telephony Man-
agement Guide for details.
0x00000010 kdcLoadBalancerSkip
The eDVA 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 eDVA bypasses the final SNMP INFORM check.
The eDVA provisioning status will be ‘‘pass with warn-
ings.’’
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 net-
work congestion by preventing eDVAs from continu-
ously retrying the provisioning sequence when the ToD
server is unreachable.

The default eDVA feature switch value is 0, except for D11PLUS loads
which have a default value of 0x06.
Note: If you include eDVA feature switch settings in the configuration, set
the object in the CM configuration file, not the eDVA configuration file.

SIP Feature Switch 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
0x00000001 Restrict Incoming Offers
Set this bit to restrict incoming OFFERs to only the
CODECs listed in the pktcEUERSTBCallPrefCode-
cList object.

Firmware Guide Release 7.5 Standard 1.2 August 2012

86 Chapter 2

Bit Value Description

0x00000002 Call Hold local processing
Set this bit to process held calls locally instead of send-
ing out a reINVITE.
0x00000004 Use TEL-URI for CID if present
Set this bit to have TEL-URI take precedence over SIP-
URI for Caller ID display.
0x00000008 Subscribe Reg Event
Set this bit to subscribe to the Registration Event pack-
age, application XML.
0x00000010 Subscribe UA Profile Event
Set this bit to subscribe to the UA Profile Event package,
application XML, including Call Forward count.
0x00000020 Signal hook flash events with a SIP INFO message using
the standard method
Set this bit to instruct the eDVA to signal a hook flash
event using a standard SIP INFO message:
Content-Type: application/hook-flash
signal=hf
Note: If this bit is set, do not set bit 0x00080000.
0x00000040 Stutter dialtone on hook flash
Set this bit to force the eDVA to play stutter dialtone
when the subscriber performs a hook flash. The default
behavior is to use the dialing feature configuration.
0x00000080 Do not use SIP Session Timers (RFC 4028)
Set this bit to disable the SIP session timers defined in
RFC 4028.
0x00000100 Send BYE message after an emergency call goes on-
hook
Set this bit to force the eDVA to send a SIP BYE mes-
sage when the subscriber hangs up on an emergency call
(e.g. 911).
0x00000200 Use reINVITE instead of UPDATE for session timer
refresh
Set this bit to force the eDVA to use reINVITE messages
to refresh the session timer. The default behavior is to
use UPDATE messages.
0x00000400 Play busy on call rejection
Set this bit to force the eDVA to play local busy tone
when an outbound call is rejected.
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).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 87

Bit Value Description

0x00004000 Use Inactive media attribute when holding media
When putting an endpoint on hold, the eDVA sends a
session description with media attribute ‘‘inactive’’
instead of ‘‘sendonly.’’
0x00008000 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 P-CSCFs that support only
one authorization header in a message.
0x00010000 Play local ringtone upon receipt of 180 without SDP
Set this bit to play ringtone if the eDVA receives a 180
response without an SDP. If the eDVA receives media
and an SDP, it silences local ringtone.
0x00020000 Generate remote ringtone
Set this bit to play ringtone over the connection to the
originating party. When set, the eDVA 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 P-CSCFs that expect SIP endpoints to sup-
port remote ringback if they support PRACK and
UPDATE.
Bit 0x00800000 must be cleared (100rel support
enabled) as well, to enable remote ringback; the eDVA
plays ringback tone when instructed.
0x00040000 Limit SDP Origin number updates
Set this bit to leave the SDP version number unchanged
when the SDP does not change.
0x00080000 Signal hookflash events with a SIP INFO message
Set this bit to inform the P-CSCF of a hookflash event
with an INFO message. Use this feature only in environ-
ments where the P-CSCF expects to handle a hookflash.
The P-CSCF also informs the eDVA 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.
0x00100000 Ignore early media prior to remote SDP obtained
Set this bit to disable the ability to communicate with the
far-end before obtaining the SDP from the far-end.

Firmware Guide Release 7.5 Standard 1.2 August 2012

88 Chapter 2

Bit Value Description

0x00200000 Send silent packets over held connection
Set this bit to transmit silent RTP (keepalive) packets, if
the eDVA was previously sending media.
0x00400000 Enable SRV lookup for servers
Set this bit to use SRV lookups for the server addresses
(must be set in the eDVA configuration file).
The DNS server must be be configured to provide SRV
records, or it falls back to normal A records. Use SRV to
load balance P-CSCFs or to specify a backup P-CSCF to
use in case of failure to communicate with the primary.
0x00800000 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.
0x01000000 Uses an IP Address of 0.0.0.0 for held SDP creation.
0x02000000 Disable CW-CID
Set this bit to disable CallerID over Call Waiting
(CW−CID). This may be required for certain subscriber
equipment.
0x04000000 Domain Override
Set this bit to use the provisioned P-CSCF FQDN or IP
address specified in the configuration file, instead of the
eDVA FQDN, in To/From headers and the Request URI.
The default behavior is to use the domain setting from
eDVA DHCP Option 15.
0x08000000 RFC 3323 Privacy Header Usage
Set this bit to enable the RFC 3323 privacy header
instead of using PacketCable 2.0 methods.
0x10000000 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 123 for
a detailed description. The normal mode of operation
handles flash using North American standards.
0x20000000 RFC 3842 handshake
Set this bit to enable an RFC 3842-compliant Subscribe-
Notify handshake for message waiting indicator
(VMWI) support. The normal VMWI scheme uses
unsolicited Notify messages.
0x40000000 eDVA FQDN
Set this bit to use the eDVA FQDN instead of the IP
address in the contact header field of SIP messages.
0x80000000 Telephony URI Scheme (currently not supported).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 89

The default value is 0x24c1e188 for .TW loads, and 0 for all other SIP loads.

Secondary SIP The sipCfgSipFeatureSwitch2 object provides extended SIP features in

Feature Switch Touchstone firmware. The supported flags are:
Bit Value Description
0x00200000 suppressTIASInSDP
Set this bit to suppress the Transport Independent Appli-
cation Specific Maximum (TIAS) bandwidth modifier in
the SDP.
0x00400000 perLineProxySelection
Set this bit to have each line on the eDVA contact prox-
ies using its own order.
0x00800000 rejectInviteWith480
Set this bit to reject an incoming INVITE with 480
instead of 486, if the line is disconnected from a call but
remains off-hook,
0x01000000 optDstTimezone
Set this bit to use the CM learned timezone if no time-
zone is provided, and to make the timezone part of the
pktcEUERSTCIDDisDSTInfo object optional.
0x02000000 dnsCache
Set this bit to use cached DNS records when receiving
negative response or no response.
0x04000000 perLineImpi
Set this bit to generate per-line IMPIs during SIP pass-
word auto-generation.
0x08000000 noRegOffhook
Set this bit to disable registration attempts if the sub-
scriber goes off-hook when initial registration is not
completed.
0x20000000 commonNonce
Set this bit to cache the latest nonce for all outgoing
messsages.
0x40000000 sipFailover
Set this bit to allow the eDVA to failover to the sec-
ondary P-CSCF when it detects a message failure.
0x80000000 pwdAutoGen
Set this bit to auto-generate the SIP password.

Firmware Guide Release 7.5 Standard 1.2 August 2012

90 Chapter 2

Echo Cancellation and Analog Fax/Modem Support

Touchstone eDVAs support:

• echo cancellation per ITU G.168/G, with a 28 dB echo return loss
• Group I-III compliant facsimile devices
• analog voice band modems up to v.92
Echo cancellation provides a 32 ms echo cancellation tail.
Echo cancellation operates in one of three modes:
• enabled
• enabled with non-linear processor (NLP) disabled
• disabled
The echo cancellation feature is always enabled for normal voice calls. How-
ever, for analog fax/modem calls, the ARRIS eDVA sets the echo cancella-
tion mode depending on detected tones:
Tones Detected Mode
Calling (CNG),
V.21 preamble, or
NLP disabled
‘‘slow’’ speed CED
(14.4k or lower)
‘‘high’’ speed CED
completely disabled
(28.8k and higher)

If the eDVA detects fax/modem tones, and a CODEC other than G.711 is
active, the eDVA automatically switches to the G.711 CODEC if G.711 was
negotiated as a backup CODEC when the call was set up. Upon completion
of a fax call, the eDVA automatically re-enables echo cancellation. but does
not switch back to the original CODEC unless instructed to switch by the
Call Agent. After a modem call completes, the eDVA re-enables echo can-
cellation when instructed by the Call Agent.

Adaptive Jitter Touchstone firmware supports jitter buffers for fax/modem calls. These
Buffers buffers automatically adapt their size to accommodate the required jitter. See
‘‘Configuring Jitter Buffers’’ on page 105 for configuring jitter buffer sizes.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 91

Configuring the The default echo cancellation tail length is 32 ms. Follow these steps to con-
Echo Cancellation figure the desired echo cancellation tail length.
Tail Length 1 In the eDVA configuration file, add the arrisMtaDevEchoCanceller-
TailLength object and set it to eightMs or thirtyTwoMs (default) as
desired.
2 Reset the eDVA.
The eDVA sets the echo cancellation tail as configured, then marks the
MIB read-only.

Firmware Guide Release 7.5 Standard 1.2 August 2012

92 Chapter 2

Provisioning RFC 2833 Support

RFC 2833 (also called DTMF Relay) specifies a method for carrying DTMF
and other telephony signals and events in RTP packets, instead of sending
audio tones over the network. This functionality is especially important
when using highly-compressed CODECs such as G.729, which may distort
DTMF tones.
The eDVA signals RFC 2833 support by specifying ‘‘telephone-event’’ in its
list of available CODECs during negotiation. By default, the CMS instructs
the eDVA to enable or disable RFC 2833 and selects the payload type to use.
Touchstone firmware provides feature switches to override the CMS and
enable RFC 2833 support with a specific payload type.

Controlling Touchstone firmware can enable RFC 2833 functionality regardless of

RFC 2833 Func- whether the CMS instructs the eDVA to use it. Two MIB objects control the
tionality functionality:
ppCfgMtaCallpFeatureSwitch
The following CallP Feature Switch bits control RFC 2833 func-
tionality:
Bit Description
0x00001000 Nuera RFC 2833 messaging without request
using payload 127 (NCS only)
Set this bit to instruct the eDVA to generate
RFC 2833 events with a payload type of 127
without specifically being instructed to do so
(for compatibility with the Nuera RDT).
0x00080000 LUCENT RFC 2833 messaging without request
using payload 94 (NCS only)
Set this bit to instruct the eDVA to generate
RFC 2833 events with a payload type of 94 dur-
ing call setup, without specifically being
instructed to do so.
0x01000000 Send DTMF digits via RFC 2833 with operator-
specified payload without request (NCS only)
Set this bit to instruct the eDVA to generate
RFC 2833 DTMF events using a payload type
defined in the ppCfgRfc2833DigitPayloadType
MIB object without being instructed to do so by
the CMS. The default payload type value is 101.

ppCfgRfc2833DigitPayloadType
When bit 0x01000000 is enabled in the CallP Feature Switch, the
eDVA sends RFC 2833 events with the payload type specified by
this object.
Valid range: 97 to 127. Default: 101.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 93

Configuring T.38 Fax Relay Support

Touchstone firmware supports T.38 fax relay, version 0. T.38 fax relay pro-
vides higher reliability of fax transmissions using redundancy to tolerate
packet loss. Touchstone firmware supports call agent-controlled T.38 as
defined in PKT-SP-NCS1.5-I03-070412, Appendix A.
T.38 support requires that SDP capability reporting be enabled (the default
setting).

SDP Parameter When T.38 Strict mode is enabled, the eDVA sends an SDP list as shown
List for T.38 Strict below. The bolded portion indicates the capability descriptor.
v=0
o=- 48186 48188 IN IP4 10.1.36.218
s=-
c=IN IP4 10.1.36.218
t=0 0
m=audio 61304 RTP/AVP 0 8 101
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
a=sendrecv
a=ptime:20
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:2 G726-32/8000/1
a=cpar:a=rtpmap:99 G726-40/8000/1
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
a=cpar:a=T38MaxBitRate:14400
m=image 0 udptl t38

If the capability descriptor causes interoperability issues, set bit 0x00000008

of the CallP Feature Switch. See ‘‘CallP Feature Switch’’ on page 74 for
more information about the feature switch.

Firmware Guide Release 7.5 Standard 1.2 August 2012

94 Chapter 2

CallP Feature Switches Affecting the SDP

The following feature switches affect the SDP, returned in response to a Cre-
ate (CRCX) or Modify (MDCX) Connection command.
Bit Description
0x00000008 Reduce the capability descriptor in the SDP to T38 only
(default = 0, no reduction).
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 pay-
load 127 (default = 0, telephone-event is negotiated nor-
mally).
0x00080000 LUCENT RFC 2833 messaging without request using pay-
load 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
a=cpar: a=fmtp:18 annexb=no
a=cpar: a=rtpmap:96 G729E/8000/1

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 95

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

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

Firmware Guide Release 7.5 Standard 1.2 August 2012

96 Chapter 2

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 speci-
fication.
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
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, 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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 97

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 ‘‘Disable RTP/RTCP Authentication/Encryption’’ switch

(0x00100000) is set, 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=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

Firmware Guide Release 7.5 Standard 1.2 August 2012

98 Chapter 2

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
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 Capabil-
ity 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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 99

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.
Note: The three feature switches that affect RFC 2833 negotiation are mutu-
ally 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

Firmware Guide Release 7.5 Standard 1.2 August 2012

100 Chapter 2

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 end-
point is prepared to receive RFC 2833 digits.

SDP Parameter The complete list of Call Processing features (including T.38 Fax Relay)
List Considera- requires a Session Description Protocol (SDP) parameter list longer than 512
tions bytes. Some CMSs or P-CSCFs do not support a parameter list longer than
512 bytes. To reduce the SDP parameter list size, set the ‘‘Suppress SDP
Capability Attribute Parameters’’ CallP Feature Switch (bit 0x00000100) to
1.

Setting this bit disables T.38 strict mode functionality; T.38 loose mode is
still available.
For more SDP-related options, see the CallP Feature Switch details in ‘‘CallP
Feature Switch’’ on page 74.

PacketCable 1.5 Touchstone firmware supports the PacketCable 1.5 NCS Extended Signaling
Extended Signal- MIB fax detection objects for T.38 signaling. The following objects are sup-
ing ported:
pktcEnNcsMinimumDtmfPlayout
The minimum time a digit is played when the eDVA receives an
RFC 2833 digit event.
pktcEnNcsEndPntQuarantineState
The endpoint state, based on the NCS quarantine states (for exam-
ple, notification or lockstep).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 101

pktcEnNcsEndPntHookState
The hook state (on-hook or off-hook) of the endpoint.
pktcEnNcsEndPntFaxDetection
(NCS only) Configures whether the eDVA uses T.38 when detecting
a CNG (calling) tone. The default is disabled, which prevents using
T.38.

T.38 Provisioning The following MIB objects control T.38 behavior.

Overview sipCfgPortT38Mode
(SIP only) Sets the T.38 operating mode. It allows the following
values:
Value Description
t38Off(1) (default) Disables T.38.
t38Loose(2) Enables T.38 Loose mode. In loose mode, the
eDVA can use T.38 for fax transmission whether
or not the remote endpoint has indicated T.38
support.
t38Strict(3) Enables T.38 Strict mode. In strict mode, the
eDVA can use T.38 for fax transmission only if
the far end indicated support for T.38 during ses-
sion negotiation.

arrisMtaDevEndPntFaxOnlyLineTimeout
(NCS only) Configures fax-only mode for a line. 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 eDVA drops the call. Valid range: 0 to 600.
sipCfgPortFaxOnlyTimeout
(SIP only) Configures fax-only mode for a line. 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 eDVA drops the call. Valid range: 0 to 600.
sipCfgPortMaxT38HSRedLevel
(SIP only) Sets the maximum high-speed 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.
arrisMtaDevT38Timeout
(NCS only) The time, in seconds, that the eDVA waits for the Call
Agent to modify the connection to T.38. The far end receives
silence until the Call Agent modifies the connection.

Firmware Guide Release 7.5 Standard 1.2 August 2012

102 Chapter 2

Valid range: 1 to 30 seconds. Default: 10.

Action Perform the following tasks as necessary.

Task Page
Controlling T.38 and Fax-Only Modes 102
Configuring T.38 MaxDatagram Size 103
Configuring SIP T.38 and Fax-Only Modes 103

Controlling T.38 Follow these steps to configure T.38 fax detection and fax-only mode. See
and Fax-Only ‘‘Configuring SIP T.38 and Fax-Only Modes’’ on page 103 for SIP-specific
Modes alternative configuration instructions.
1 Set the pktcEnNcsEndPntFaxDetection object (use the line number
as an index, starting with 1) to configure whether the eDVA 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 eDVA 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 set-
ting takes effect on the next connection.
2 If needed, set the pktcEnNcsMinimumDtmfPlayout object to specify
the minimum time, in milliseconds, that the eDVA plays out a digit
tone when receiving an RFC 2833 digit event on the specified end-
point. 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 arrisMtaDevEndPntFaxOnlyLine-
Timeout (NCS) or sipCfgPortFaxOnlyTimeout (SIP) MIB object to
the eDVA configuration file. This MIB object is specific to a line, so
it must be specified with the line number; for example, arrisMtaDev-
EndPntFaxOnlyLineTimeout.1 for line 1. The value specifies the
timeout, in seconds, after which the eDVA drops the call if it does not
detect fax or modem tones.
Valid range (either object): 0 (disabled) to 600 seconds. The default is
0.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 103

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

Configuring SIP Follow these steps to configure T.38 and fax-only modes for a line. Each
T.38 and Fax-Only MIB object specified must be set in the eDVA configuration file.
Modes 1 Set the T.38 mode by adding the sipCfgPortT38Mode MIB object to
the eDVA configuration file. This MIB object is specific to a line, so
it must be specified with the line number; for example, sipCfg-
PortT38Mode.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 sipCfgPortFaxOnlyTimeout MIB
object to the eDVA configuration file. This MIB object is specific to a
line, so it must be specified with the line number; for example,
sipCfgPortFaxOnlyTimeout.1 for line 1. The value specifies the
timeout, in seconds, after which the eDVA 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 sipCfgPort-
FaxOnlyTimeout object. This object is still supported for backwards
compatibility.

Firmware Guide Release 7.5 Standard 1.2 August 2012

104 Chapter 2

Super G3 FAX Support

TS7.1 MSUP2 and newer versions of Touchstone firmware support SuperG3

FAX transmission, including V.8 data exchange detection.
When the eDVA detects the V.8 signal, fax transmission proceeds depending
on the setting of the arrisMtaDevSuperG3FaxRelay MIB object:
• When set to disable(0) (the default), the eDVA uses the V.8 detection
as a trigger to set up the endpoint for FAX transmission (adjust the jitter
buffer, turn off echo cancellation) and allow the FAX machines to han-
dle the negotiation and transmit the fax using G.711.
• When set to enable(1), the eDVA uses the V.8 detection as a trigger to
start T.38.
To switch the FAX call from SuperG3 to T.38, the Telephony Modem
mutes audio to prevent the FAX machine from negotiating to SuperG3
before switching to T.38. Depending on the T.38 negotiation, this
switch either forces the FAX machines to downshift to G3 speeds (<=
14.4) which is the current maximum rate supported for T.38 version 0,
or initiate the T.38 over RTP.
If the connection is negotiated for T.38 version 0, the audio remains
muted until the CMS transitions the connection to T.38. During the
muted period, the terminating fax machine receives silence. The maxi-
mum amount of this silence period can be controlled by the arrisMta-
DevT38Timeout MIB object. This object defaults to 30 seconds, which
is consistent with existing behavior. Alter this value only if FAX trans-
missions are consistently failing due T.38 not re-trying.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 105

Configuring Jitter Buffers

Touchstone firmware provides three sets of MIB objects to adjust the eDVA
jitter buffer:
• Standard—used for typical voice calls. Associated MIB objects are:
– The arrisMtaDevVPJitterBufferMode object controls the jitter
buffer behavior (adaptive or fixed modes).
– The arrisMtaDevVPNomJitterBuffer object sets the nominal jitter
buffer size (in packets).
– The arrisMtaDevVPMaxJitterBuffer object sets the maximum jitter
buffer size (in packets).
• Voice Band Data (VBD)—used for calls involving data transfer, includ-
ing fax, modem, and POS terminals. The following MIB objects allow
the eDVA to automatically override the normal jitter buffer settings
when it detects a Voice Band Data call:
– The arrisMtaDevVbdOverwriteLineBitmap object allows per-line
control of jitter buffer override.
– The arrisMtaDevVbdOverwriteMinJitterBuffer object specifies the
minimum Voice Band Data call jitter buffer setting.
– The arrisMtaDevVbdOverwriteNomJitterBuffer object specifies the
nominal Voice Band Data call jitter buffer setting.
– The arrisMtaDevVbdOverwriteMaxJitterBuffer object specifies the
maximum Voice Band Data call jitter buffer setting.
If you change these parameters with an SNMP manager, the new set-
tings take effect starting with the next phone call.
• Custom—provides more precise control over jitter buffer settings. Cus-
tom settings may be useful under certain network conditions or applica-
tions.
– The arrisMtaDevCustomJitterBufferEnabled object enables cus-
tomer jitter buffer settings.
– The arrisMtaDevCustomMinJitterBuffer object controls the mini-
mum custom jitter buffer duration.
– The arrisMtaDevCustomNomJitterBuffer object controls the nomi-
nal custom jitter buffer duration.
– The arrisMtaDevCustomMaxJitterBuffer object controls the maxi-
mum custom jitter buffer duration.

Firmware Guide Release 7.5 Standard 1.2 August 2012

106 Chapter 2

If you change these MIB objects with an SNMP manager, the new settings
take effect starting with the next phone call.

Action Perform any of the following tasks as necessary.

Task Page
Setting Standard Jitter Buffer Parameters 106
Setting Voice Band Data Jitter Buffer Parameters 106
Configuring Custom Jitter Buffer Settings 107

Setting Standard Follow these steps to set standard jitter buffer parameters.
Jitter Buffer Pa- 1 Set the arrisMtaDevVPJitterBufferMode object to either 1 (adaptive,
rameters the default) or 2 (fixed).
2 Configure the nominal voice call jitter buffer size by setting the
arrisMtaDevVPNomJitterBuffer object. The value represents a mul-
tiple of the packetization rate. Valid range: 1 to 4. Default: 1.
3 Configure the maximum voice call jitter buffer size by setting the
arrisMtaDevVPMaxJitterBuffer object. The value represents a multi-
ple of the packetization rate. Valid range: 1 to 4. Default: 3.
Note: The nominal jitter buffer setting must be less than the maximum
jitter buffer setting.

Setting Voice Follow these steps to enable and configure jitter buffer and override settings
Band Data Jitter for Voice Band Data (fax, modem, POS terminal) calls.
Buffer Parameters 1 Set the arrisMtaDevVbdOverwriteLineBitmap to control jitter buffer
override on each line. The least significant bit controls line 1, so a
value of 3 enables override on lines 1 and 2.
2 Configure the minimum, nominal, and maximum jitter buffer settings
for Voice Band Data calls by setting the following objects. The valid
range for all three objects is 10 to 135; the following table shows the
default value for each object.
Default
Object Description
Value
arrisMtaDevVbdOver- 25 Minimum fax/modem call
writeMinJitterBuffer jitter buffer setting.
arrisMtaDevVbdOver- 25 Nominal fax/modem call
writeNomJitterBuffer jitter buffer setting.
arrisMtaDevVbdOver- 135 Maximum fax/modem
writeMaxJitterBuffer call jitter buffer setting.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 107

Note: The minimum jitter buffer setting must be less than the nominal
setting, which in turn must be less than the maximum jitter buffer set-
ting.

Configuring Cus- Follow these steps to configure custom jitter buffer settings.
tom Jitter Buffer Note: Custom jitter buffer settings use units of milliseconds, rather than
Settings packet multiples used by the standard and VBD methods.
1 Enable custom jitter buffer settings by setting the arrisMtaDevCus-
tomJitterBufferEnabled object to on(1). The default is off(0).

When custom jitter buffer settings are enabled, the default settings
are:
• Minimum: 5 milliseconds
• Nominal: 10 milliseconds
• Maximum: 60 milliseconds
2 Configure the minimum, nominal, and maximum custom jitter buffer
settings by setting the following objects. The valid range for all three
objects is 5 to 135 (milliseconds).
arrisMtaDevCustomMinJitterBuffer
Minimum custom jitter buffer duration.
arrisMtaDevCustomNomJitterBuffer
Nominal custom jitter buffer duration.
arrisMtaDevCustomMaxJitterBuffer
Maximum custom jitter buffer duration.

Firmware Guide Release 7.5 Standard 1.2 August 2012

108 Chapter 2

Provisioning European Support

The TS7.5 .EURO load provides support for full Euro-PacketCable provi-
sioning. This requires that new features be configured and existing MIBs be
modified. This feature requires a specialized firmware load.

Action Perform the following tasks as necessary:

Task Page
Configuring Power Ring Frequency 108
Configuring On-Hook Caller ID 108
Configuring Visual Message Waiting Indicator 109
Configuring Tone Operations 110
Configuring Hook Flash Timing 110

Configuring Power Follow these steps to configure the power ring frequency.
Ring Frequency 1 Select the pktcSigPowerRingFrequency object and input the appro-
priate frequency for your network. The following frequencies are
valid:
• 20 Hz (1)
• 25 Hz (2) (default for Belgium, Germany, Netherlands, Nether-
lands09, 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 On- Follow these steps to configure the on-hook Caller ID functionality.
Hook Caller ID 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 fol-
lowing modes:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 109

• duringRingingETS—The FSK containing the Caller ID informa-

tion is sent between the first and second ringing pattern. The delay
between the end of the first ringing pattern and the start of the trans-
mission for of the FSK containing the Caller ID information is con-
figurable using the pktcSigDevCIDFskAfterRing object.
• dtAsETS (default for Austria, Belgium, France, Germany, Nether-
lands, Netherlands09, Norway, Spain, and Switzerland)—The FSK
is sent after the Dual Tone Alert Signal but before the first ring pat-
tern.
• 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 pktcSigDevCID-
DTASAfterLR 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 Follow these steps to configure visual message waiting indicator.
Message Waiting 1 Select the pktcSigDevVmwiMode object and select from one of the
Indicator following modes:
• dtAsETS (default for Austria, Belgium, France, Germany, Nether-
lands, Netherlands09, Norway, Spain, and Switzerland)—The FSK
is sent after the Dual Tone Alert Signal but before the first ring pat-
tern.
• 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 pktcSigDevVmwiFskAfter-
RPAS 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

Firmware Guide Release 7.5 Standard 1.2 August 2012

110 Chapter 2

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 Touchstone firmware allows configuration of call progress tones for North
Operations American and European templates. See ‘‘Configuring Call Progress Tones’’
on page 111 for instructions.

Configuring Hook Touchstone firmware allows configuration of hook flash timing for North
Flash Timing American and European templates. See ‘‘Configuring Hook Flash Timing’’
on page 123 for instructions.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 111

Configuring Call Progress Tones

Use this procedure to configure call progress tones. Touchstone .EURO
loads support provisioning of call progress tones through the pktcSigDev-
ToneTable. North American loads support this table only when the country
code setting (set by ppCfgMtaCountryTemplate) is one of the North Ameri-
can country codes.

MIB Tables Touchstone firmware uses two MIB tables to define call progress tones. See
‘‘Default Tone Settings’’ on page 477 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 ta-
ble. 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, pktcSigDevToneSecondFre-
quency, pktcSigDevToneThirdFrequency, pktcSigDevTone-
FourthFrequency: 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.
• pktcSigDevToneFreqAmpModePrtg: The percentage of ampli-
tude modulation to apply when using the firstModulatedBySec-
ond setting.

Firmware Guide Release 7.5 Standard 1.2 August 2012

112 Chapter 2

• 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 sup-
ported line package:
• alertingSignal (13)
• specialDial(14)
• specialInfo (15)
• release (16)
• congestion (17)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 113

• 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 frequen-
cies 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 config-
ure the delay between repeated Call Waiting tones.

Firmware Guide Release 7.5 Standard 1.2 August 2012

114 Chapter 2

Gain Compensated Tone Generation

Touchstone firmware provides a patent-pending feature to automatically
adjust FSK and CAS tone generation to compensate for MSO-selected loss
value settings.
Touchstone firmware automatically adjusts FSK and tone levels to compen-
sate for the loss plan values so that generated FSK and CAS tones are always
within applicable specifications. You can make changes to the default levels
as needed.

On-Hook vs. Off- Touchstone firmware allows separate gain control for on-hook and off-hook
Hook Gain levels. By default, the standard gain control MIB objects control levels for
both conditions, but setting the "arrisMtaDevLevelControlOffHookEnable"
to enable(1) allows off-hook gain to be configured separately using the arris-
MtaDevLevelControlOffHookCAS and arrisMtaDevLevelControlOffHook-
FSK objects.

arrisMtaDev. . .
LevelControl GainControl
OffHookEnable OffHookFSK OffHookCAS FSK CAS
Controls both Controls both
Disabled Not used Not used on and off on and off
hook gains hook gains
Controls Controls Controls only Controls only
Enabled
off-hook gain off-hook gain on-hook gain on-hook gain

Action Perform the following tasks as necessary to adjust gain controls.

Task Page
Configuring Gain Control using SNMP 114
Configuring Gain using the CLI 117

Configuring Gain Follow these steps as necessary to configure gain control settings.
Control using 1 Adjust eDVA-generated on-hook and default off-hook FSK tones
SNMP (CID and VMWI) by setting the arrisMtaDevGainControlFSK
object. Valid range: −10 to 2 (dBm). Default: 0.
2 Adjust the transmit digital gain adjustment for eDVA-generated on-
hook and default off-hook CAS tone by setting the arrisMtaDevGain-
ControlCAS 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:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 115

a Set the off-hook FSK tone level by setting the arrisMtaDevLevel-

ControlOffHookFSK MIB object.

Valid range: −32 to −10 (dBm). Default: −15.

b Set the off-hook CAS tone level by setting the arrisMtaDevLevel-
ControlOffHookCAS MIB object.

Valid range: −32 to −10 (dBm). Default: −15.

c Enable the off-hook gain settings by setting the arrisMtaDev-
LevelControlOffHookEnable MIB object to enable(1). The
default is disable(0), which uses the established arrisMtaDev-
GainControlFSK and arrisMtaDevGainControlCAS objects for
both on-hook and off-hook levels.
4 Adjust the transmit digital gain adjustment for eDVA-generated Call
Progress tones (dial tone, busy tone, ringback, etc.) to the CPE by set-
ting the arrisMtaDevGainControlLocalTone object. Valid range: −2
to 2 (dBm). Default: 0.
5 Adjust the transmit digital gain adjustment for eDVA-generated Call
Progress tones (ringback) to the network by setting the arrisMtaDev-
GainControlNetworkTone object. Valid range: −2 to 2 (dBm).
Default: 0.
6 Adjust the transmit digital gain adjustment for eDVA-generated
DTMF tones to the CPE by setting the arrisMtaDevGainControl-
LocalDTMF object. Valid range: −15 to 9 (dBm). Default: 0.

7 Adjust the transmit digital gain adjustment for eDVA-generated

DTMF tones to the network by setting the arrisMtaDevGainControl-
NetworkDTMF object. Valid range: −9 to 9 (dBm). Default: 0.

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.

8 Adjust the transmit digital gain adjustment for voice by setting the
arrisMtaDevGainControlTxVoice object. Valid range: −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: −16 to 16
(dBm), or −128 (the default) to use the eDVA-wide setting.

Firmware Guide Release 7.5 Standard 1.2 August 2012

116 Chapter 2

Note: Even though the deltaRx/Tx Gain MIB objects are defined to be
line-based, setting the object for any valid line sets the delta gain for
all lines. Also, if the same delta Rx/Tx Gain object appears multiple
times in the CM configuration file using different indexes, the eDVA
uses the last instance to set the gain.

CAUTION
Potentially service-affecting
Setting endpoint gain too high or too low may disable the voice path. Lower
settings beyond recommended levels may impact voice quality or fax or
modem transmission.

10 Adjust the transmit digital gain adjustment for individual lines by

setting the arrisMtaDevEndPntGainControlTxVoice object. Valid
range: −16 to 16 (dBm), or −128 (the default) to use the eDVA-wide
setting.
11 Adjust the receive digital gain adjustment for individual lines by set-
ting the arrisMtaDevEndPntGainControlRxVoice object. Valid
range: −16 to 16 (dBm), or −128 (the default) to use the eDVA-wide
setting.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 117

Configuring Gain Follow these steps to adjust gain controls using the CLI.
using the CLI
CAUTION
Service affecting
Changing the Rx/Tx gain from the default value 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 intro-
duced.

1 If necessary, access the CLI using the instructions in ‘‘Accessing the

CLI through Telnet’’ on page 437.
2 Enter the Call Processing sub-menu:
[ 1]Console> voice ↵
[ 2]Voice> callp ↵
[ 3]Call Processing>

3 Enter the following command as needed to adjust the gain:

setgain tone value

where tone is one of the following:

Range
Tone Description
Min Max
lt Local tones −2 2
nt Network tones (ringback, etc.) −2 2
fsk CID and VMWI tones −10 2
cas CAS tones −2 2
ldtmf DTMF tones toward the CPE −15 9
ndtmf DTMF tones toward the network −9 9
rx Receive audio −2 2
tx Transmitted audio −2 2

value is the gain adjustment, in dBm. The valid range depends on the
tone being adjusted, as shown in the table above.

Firmware Guide Release 7.5 Standard 1.2 August 2012

118 Chapter 2

Provisioning Preset Downstream Frequen-

cies
Use this procedure to provision one or more preset frequencies. This feature
allows Touchstone E-UEs to quickly lock onto a known downstream during
initial registration, reducing the initial time required for ranging and register-
ing after installation. You can also clear the list of frequencies.
Touchstone firmware provides two ways to provision preset downstream fre-
quencies: through the web-based interface, using the Scanning Override
screen; and through SNMP using MIB objects.

Preset Frequency The following MIB objects control preset frequencies. You can make
MIB Objects changes to these objects using an SNMP manager or through the configura-
tion 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 Perform any of the following tasks as needed.

Task Page
Provisioning Preset Frequencies using SNMP 118
Accessing the Scanning Override Screen 119
Specifying a Downstream Frequency 120
Clearing Stored Frequencies 120

Provisioning Pre- Follow these steps to provision the preset frequency table using an SNMP
set Frequencies manager or in the provisioning file.
using SNMP 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 arrisCmDevClear-

PresetFrequencies object to true(1).

3 To clear cached frequencies, set the arrisCmDevClearCachedFre-

quencies object to true(1).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 119

4 If you make any changes in the configuration file, reboot the E-UE to
load the changes.

Accessing the Follow these steps to gain access to the Scanning Override screen.
Scanning Override Note: The Scanning Override screen may be accessed only from a LAN
Screen interface before the Telephony Modem has registered (WAN access is not
allowed). If the modem has registered, it redirects attempts to access the
Scanning Override screen to the Status screen.
1 Connect a computer with a web browser to the E-UE, as described in
‘‘Using the Web-based Troubleshooting Interface’’ on page 439.
2 In the browser’s address bar, enter the URL:
http://192.168.100.1/scanover.htm

The browser displays the Scanning Override screen.

3 Proceed to one of the other tasks as necessary.

Firmware Guide Release 7.5 Standard 1.2 August 2012

120 Chapter 2

Specifying a Follow these steps to specify a primary downstream frequency and optional
Downstream Upstream Channel Descriptor (UCD). You can specify up to five frequencies
Frequency to search; if the E-UE does not find a carrier on one of those frequencies, it
begins the normal scanning process at 861 MHz.
1 Use ‘‘Accessing the Scanning Override Screen’’ on page 119 to dis-
play the Scanning Override screen.
2 Type a frequency, in MHz, in the ‘‘Downstream Frequency’’ field.
For example, enter 581 to specify 581 MHz.
3 (optional) Enter a UCD identifier in the Upstream Channel ID field.
4 Click the Save Freq button.
The E-UE stores the specified frequency and UCD (if specified).
The Save Freq action stores the frequency in the cache of the E-UE.
This can be used to pre-provision the cable modem to a specific fre-
quency.

Clearing Stored Follow these steps to clear all stored frequencies. The E-UE returns to the
Frequencies default behavior of scanning the downstream spectrum for a data signal.
1 Use ‘‘Accessing the Scanning Override Screen’’ on page 119 to dis-
play the Scanning Override screen.
2 Click the Clear Now button.
The E-UE clears the stored frequencies.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 121

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:
• Direct relay—Touchstone eDVAs relay dial pulses to the CMS or P-
CSCF.
• In-band tone relay (patent pending)—Touchstone E-UEs 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.
TS7.5 supports 20 pps dialing.
The support method used depends on the network configuration, and is
selected by setting the ARRIS-proprietary arrisMtaDevEndPntDialing-
Method MIB object as follows:

Value Method Description

1 Tone (default) Enables DTMF detection only.
2 Pulse Enables pulse dialing detection.
3 Tone & Pulse Enables both DTMF and pulse dialing
detection.
4 Pulse with DTMF Relay Pulse dialing detection with DTMF in-
band relay (gateway dial pulse, patent
pending).
5 Tone & Pulse with Both DTMF and pulse dialing detection
DTMF Relay with DTMF in-band relay enabled
(gateway dial pulse).

Note: Setting the arrisMtaDevEndPntDialingMethod object using an SNMP

browser stores the value in non-volatile memory.
The Call Processing chg_dialing command provides the same control from
the CLI.

Inband DTMF Touchstone firmware provides a feature to allow inband transmission of

Transmission DTMF tones, even if a line is configured for pulse-only dialing. Once a call
is established, Touchstone eDVAs pass all DTMF tones received from a CPE
through the upstream voice path. eDVAs configured for pulse-only dialing
operation drop any DTMF tones received before the call is fully established.
This feature allows a subscriber, provided with pulse-only dialing capabili-
ties, to send DTMF tones to the far end. This might be used for calling card
number entry, bank card data entry, automated service responses, and similar
services.

Firmware Guide Release 7.5 Standard 1.2 August 2012

122 Chapter 2

Inband DTMF transmission is automatically enabled after a call has been

established. No special configuration or changes to the dialing method are
needed to enable this feature.
Note: If a line is provisioned as pulse-dialing only, the eDVA does not
process received DTMF digits beyond treating them as audio to pass to the
upstream voice path. If the CMS requests that the eDVA notify the CMS of
any collected digits, the received DTMF tones are not reported.

Action Follow these steps to configure dial pulse support on Touchstone eDVAs.
Note: The arrisMtaDevEndPntDialingMethod object setting is stored in
non-volatile memory when set through SNMP after the eDVA has completed
registration.
1 To enable Gateway (IPDT) dial pulse support, set the arrisMtaDev-
EndPntDialingMethod object to 5 (pulse and DTMF detection).

2 To enable softswitch dial pulse support, set the arrisMtaDevEndPnt-

DialingMethod object to 3 (pulse and DTMF detection).

3 To disable dial pulse detection, set the arrisMtaDevEndPntDialing-

Method object to 1. This may be necessary in certain situations
where internal house wiring problems cause occasional ‘‘phantom’’
dial pulse digits.

Gateway Dial The following configuration file provides an example of how to configure
Pulse Example 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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 123

Configuring Hook Flash Timing

Follow these steps to configure hook flash timing.
Note: These settings must be made in the eDVA configuration file.

Default Timing The country code template determines the default minimum and maximum
Settings flash timings, overriding the defaults specified by the PacketCable MIB. See
‘‘Country Code Templates’’ on page 464 for a list of default hook flash tim-
ings for each supported country code.

Action Follow these steps to set hook flash timings.

1 In the eDVA configuration file, set the pktcNcsEndPntConfigMin-
HookFlash MIB object to the minimum time a line needs to be on
hook for a valid hook flash. Use the ifIndex to specify the line; for
example, pktcNcsEndPntConfigMinHookFlash.9 specifies line 1.
Valid range: 20 to 1550 milliseconds.
2 In the eDVA configuration file, set the pktcNcsEndPntConfigMax-
HookFlash MIB object to the maximum time the line needs to be on
hook for a valid hook flash. Valid range: 20 to 1550 milliseconds.

Firmware Guide Release 7.5 Standard 1.2 August 2012

124 Chapter 2

Provisioning Ring Cadences

Ring cadence and ring splash may be provisioned through the PKTC-IETF-
MTA-MIB objects pktcSigDevRgCadence (standard ring), pktcSigDev-
R0Cadence through pktcSigDevR7Cadence (distinctive ringing), and pktc-
SigDevRsCadence (ring splash). These objects consist of the following
fields:
0 59 60 63

cadence (60 bits)

repeat
(4 bits)

The fields are:

length
60 bits representing the ring cadence. Each bit represents 100 ms; 1
represents tone and 0 represents silence. The pattern can be up to 6
seconds long; to specify a shorter pattern, begin the pattern with
zeroes (for example, 15 zero bits at the beginning of the pattern
would shorten the cadence to 4.5 seconds).
repeat
Specify either 0000 for a repeatable cadence, or 1000 for a non-
repeatable cadence.
For example, a value of 00.00.0F.FF.FF.00.00.00 specifies a repeating ring
cadence of 2 seconds on, 2 seconds off (the first two seconds of silence is dis-
carded).
Note: The pktcSigDevRsCadence (ring splash) object must always be non-
repeatable. The eDVA rejects any attempt to make the ring splash repeatable.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 125

Post-Provisioning
Touchstone firmware provides the ability to post-provision lines and other
device definitions, allowing you to add or remove service without restarting
the eDVA.

NCS Post-Provi- Touchstone NCS loads are fully compliant with PacketCable eDVA Post-Pro-
sioning visioning functionality, described in section 7.6 of the PacketCable MTA
Device Provisioning Specification , PKT-SP-PROV1.5-I04-090624. You can
post-provision:
• CMS entries
• KDC realms
• Endpoints (lines)

Action Follow these steps to post-provision a line on a Touchstone NCS load.

1 To add or remove a CMS, modify the pktcMtaDevCmsTable as
required. You can add or remove entries in the table.
2 To add or remove a KDC realm, modify the pktcMtaDevRealmTable
as required. You can add or remove entries in the table.
3 To add or remove an endpoint, modify the pktcNcsEndPntCon-
figTable as required. You can add or remove entries in the table.

Firmware Guide Release 7.5 Standard 1.2 August 2012

126 Chapter 2

Provisioning a Gateway
Use this procedure to provision a Model 8 Touchstone gateway product.
Gateways provide a built-in Wireless Router Module (WRM) with up to four
Ethernet connections and 802.11b/g/n wireless (wifi) service. The wireless
interface supports up to four SSIDs, one of which is provisionable by the
subscriber.
Model 8 Touchstone Gateway products conform to the eRouter specification,
CM-SP-eRouter-I06-110623.
For detailed business services configuration instructions, see the Business
Service Configuration Feature Sheet for your Touchstone Gateway model.

Provisioning Meth- You can provision the WRM using any of the following methods:
ods • web pages (webGUI) — for details, see the ARRIS Router Setup Web
GUI User Guide.
• SNMP (using the ARRIS-ROUTER-MIB)
• CLI (using the Gateway sub-mode)
• XML (provisioning file using ARRIS-ROUTER-MIB objects)
This procedure focuses on SNMP provisioning.
There is no order of preference among the provisioning methods; the last
change before a commit is the change applied.

Provisioning Gateway provisioning uses the following order of precedence, highest to low-
Precedence est priority:
1 SNMP management
2 web-based interface (subscriber login) — changes persist until the
gateway is reset to factory defaults
3 CM or XML configuration file
If a technician makes a change in the web-based interface, the change applies
only until the gateway restarts.

WRM Operating The WRM operates in one of the following modes.

Modes Router (NAT mode)
This is the default mode. The WRM provides NAT connectivity to
devices connecting on the LAN.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 127

In Router mode, the WRM is treated as a CPE device. This requires

setting the MaxCPE TLV to 2 or higher.
Bridge (AP mode)
In Bridge mode, the WRM simply forwards packets between the
LAN and WAN interfaces. The wireless interface and web interface
function as normal.
In Bridge mode, the WRM is not treated as a CPE device.
Shutdown mode
The WRM is disabled.
Any of the operating modes can be selected through provisioning.

Default Settings The following table shows default WRM settings.

Setting Value
Operating Mode Router
WRM IP address 192.168.0.1

About IPv6 Opera- IPv6 support is available in TS7.5 and newer versions of Touchstone
tion firmware. The default gateway configuration automatically provides dual-
stack operation, assigning both IPv4 and IPv6 addresses to CPE devices con-
necting through both Ethernet and wifi. Furthermore, the gateway supports
DS-Lite (Dual-Stack lite), allowing customers provisioned with IPv6-only
addresses to access IPv4-only resources over the Internet. DS-Lite encapsu-
lates IPv4 traffic in an IPv6 tunnel, and sends it to an operator’s NAT device.
See below for configuration details.
The gateway can assign IPv6 addresses to CPE devices using either of the
following methods:
• DHCPv6
• Stateless Address Auto-Configuration (SLAAC)
Note: When provisioned for IPv6, the gateway requires an IPv6 address with
a 56-bit prefix, either from DHCPv6 or by static assignment. This is required
for proper CPE device connection.
See below for configuration details.

Action Perform the following tasks as required.

Task Page
Setting the Operating Mode 128
Configuring the Wireless Channel 128
Configuring DNS Override/Relay 128
Configuring IPv6 CPE Addressing 129

Firmware Guide Release 7.5 Standard 1.2 August 2012

128 Chapter 2

Configuring DS-Lite Operation 129

Setting the Oper- Follow these steps to configure the WRM operating mode.
ating Mode 1 To change pass-through mode, set the arrisRouterLanPassThru
object to true(1) to enable pass-through (bridging) mode or false(2)
for routing mode. Change this object from the CM IP address.
2 To shut down wireless operation, set the arrisRouterWiFiEnableRa-
dio object to false(2).

3 Set the arrisRouterApplyAllSettings object to applySettings(1) to

instruct the WRM to save the setting and reset.
4 If you make this change in the configuration file, restart the modem.

Configuring the Follow these steps to set a specific channel, or allow the WRM to auto-detect
Wireless Channel and select an unused wireless channel.
1 To set channel auto-detect, set the arrisRouterWiFiChannel object to
0.

2 To set a particular channel, set the arrisRouterWiFiChannel object to

the desired channel.
The valid range depends on the mode and region:
Mode Region Range
802.11g NA 1–11 (channel number)
802.11g EU 1–13 (channel number)
802.11n all 34–216 (control channel)

Configuring DNS The gateway supports overriding and settting DNS relay. Follow these steps
Override/Relay to configure DNS Override and DNS Relay from SNMP.
1 For routers using IPv4 addressing, set the following MIB objects:
arrisRouterLanRelayDNS
Set to true(1) to enable DNS Relay, or false(2) to disable (the
default). DNS Relay allows the gateway to act as a DNS server,
forwarding DNS requests to actual servers and caching the
results for later use. CPE devices attached to the gateway
receive the gateway address for DNS services, regardless of any
DNS server addresses furnished through DHCP.
arrisRouterLanOverrideDNS
Set to true(1) to enable DNS Override, or false(2) to disable
(the default). DNS Override replaces any DNS information sent
by the DHCP server with the IPv4 addresses in the arrisRouter-
LanDNSTable.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 129

Note: If DNS Relay is enabled, this object has no effect.

2 For routers using IPv6 addressing, set the following MIB objects:
arrisRouterLanDNSRelayV6
Sets DNS Relay for IPv6 addressing.
arrisRouterLanDNSOverrideV6
Sets DNS Override for IPv6 addressing. Only the IPv6
addresses in the arrisRouterLanDNSTable are sent.

Configuring IPv6 By default, the Gateway uses SLAAC to provide IPv6 addresses to CPE
CPE Addressing devices. If local practices require DHCP, follow these steps to configure the
gateway IPv6 DHCPv6 server.
1 Enable or disable the local DHCPv6 server using the arrisRouter-
LanUseDHCPV6 object. The default value of false(2) disables
DHCPv6 services, using SLAAC to assign IPv6 addresses.
2 If using DHCPv6, configure the service using the following objects:
arrisRouterLanPrefixLengthV6
The length, in bits, of the subnet prefix. The valid range for
IPv6 addressing is 64 to 128.
arrisRouterLanStartDHCPV6
The start of the IP address range provided by the DHCPv6
server.
arrisRouterLanEndDHCPV6
The end of the IP address range provided by the DHCPv6
server.
arrisRouterLanLeaseTimeV6
The lease time, in seconds.

Configuring DS- Follow these steps to configure DS-Lite operation on a gateway.

Lite Operation 1 To enable DS-Lite, set the arrisRouterDSLiteWanEnable object to
true(1). The default setting is false(2).

When DS-Lite is enabled, the gateway:

• operates in IPv6-only mode.
• obtains an IPv6 address from the WAN interface as usual, and
learns the address of the operator’s NAT router through DHCPv6
Option 64.
2 To override the NAT server address received in DHCPv6 Option 64,
set the following objects as required:

Firmware Guide Release 7.5 Standard 1.2 August 2012

130 Chapter 2

arrisRouterDSLiteWanLSNATAddrType
The address type of the LSNAT router; either ipv6(2) to specify
an IPv6 address, or dns(16) to specify the FQDN.
arrisRouterDSLiteWanLSNATAddr
The IPv6 address, or FQDN, of the LSNAT server.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 131

Using XML-based Router Provisioning Files

Touchstone firmware allows generic router provisioning through a simple
XML file. This feature allows router configuration using most writable
objects in the arrisRouterMib.

Provisioning Gateway provisioning uses the following order of precedence, highest to low-
Precedence est priority:
1 SNMP management
2 web-based interface (subscriber login) — changes persist until the
gateway is reset to factory defaults
3 CM or XML configuration file
If a technician makes a change in the web-based interface, the change applies
only until the gateway restarts.

XML File Format An XML provisioning file has a top-level element named <mib>, that con-
tains any number of elements using the name of MIB objects in the arris-
RouterMib. The index attribute may be used to configure multiple table
entries. The default index value is 0.
The following is a very simple example, that changes only the timeout for
logins to the WebGUI.
<?xml version="1.0" encoding="us-ascii" ?>
<mib>
<arrisRouterAdminTimeout index="0">900</arrisRouterAdminTimeout>
</mib>

Action Follow these steps to provision the router using an XML file.
1 To activate XML router provisioning, set the arrisRouterXmlProvi-
sioningFile object to the URL describing the location and name of
the provisioning file. The protocol may be either tftp:// or
http:// as needed.
If the file name is omitted, the default file name is the gateway MAC
address with a .xml extension. The gateway downloads the configu-
ration file after completing the DHCP sequence.
2 To check the result of XML provisioning, read the arrisRouterXml-
ProvisioningStatus object. Possible values returned include:

Firmware Guide Release 7.5 Standard 1.2 August 2012

132 Chapter 2

notSpecified(1)
XML provisioning was not enabled or has not begun.
inProgress(2)
The gateway is downloading the XML provisioning file.
downloadSuccess(3)
The gateway has successfully downloaded the XML provision-
ing file.
serverError(4)
The TFTP or HTTP server returned an error.
fileNotFound(5)
The TFTP or HTTP server returned a ‘‘file not found’’ error.
fileFormatError(6)
The gateway detected an error in the XML provisioning file.
Note: If the gateway successfully performs XML provisioning, it
stores a copy of the provisioning file. If a later provisioning attempt
fails, the gateway uses the copy to apply provisioning.
3 To manually start XML provisioning, set the arrisRouterXmlProvi-
sioningStatus object to downloadFromMgt(7).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 133

TR-069 Provisioning

Touchstone firmware supports basic gateway provisioning through TR-069.

Other provisioning methods — including SNMP, XML, CLI, and the web-
based interface — are also supported.

Enabling TR-069 To enable TR-069 support, set the arrisTR69EnableCWMP object to true(1)
Support in the CM configuration file. The default is false(2).
TS7.5 supports most objects in the InternetGatewayDevice group. See
‘‘Supported TR-098 Objects’’ on page 262 for a list. See the TR-098 specifi-
cation for available objects and their descriptions.

TLV-43 Based Pro- Several parameters in the InternetGatewayDevice.ManagementServer

visioning group can be configured using TLV-43, or by setting ARRIS TR-069 MIB
objects in the CM configuration file. The following table maps parameters to
the sub-TLV names and equivalent MIB objects.
Parameter Name sub-TLV Name ARRIS MIB Object
InternetGatewayDevice.ManagementServer.URL Tr69AcsUrl arrisTR69AcsUrl
InternetGatewayDevice.ManagementServer.Username Tr69AcsUserName arrisTR69AcsUserName
InternetGatewayDevice.ManagementServer.Password Tr69AcsPassword arrisTR69AcsPassword
InternetGatewayDevice.ManagementServer.PeriodicInformEnable Tr69AcsPerInfEnable arrisTR69PeriodicInformEnable
InternetGatewayDevice.ManagementServer.PeriodicInformInterval Tr69AcsPerInfInterval arrisTR69PeriodicInformInterval
InternetGatewayDevice.ManagementServer.PeriodicInformTime [none] arrisTR69PeriodicInformTime
InternetGatewayDevice.ManagementServer.ConnectionRequestURL Tr69AcsCrURL arrisTR69ConnectionRequestUrl
InternetGatewayDevice.ManagementServer.ConnectionRequestUsername Tr69AcsCrUserName arrisTR69ConnectionRequestUserName
InternetGatewayDevice.ManagementServer.ConnectionRequestPassword Tr69AcsCrPassword arrisTR69ConnectionRequestPassword

The Tr69AcsXAllowDocsCfg sub-TLV is recognized, but not supported.

The equivalent ARRIS MIB object is arrisTR69PersistEnable.

Example Configuration
The following is an example configuration file segment.

Firmware Guide Release 7.5 Standard 1.2 August 2012

134 Chapter 2

{VendorSpecific
{VendorID 0000ca}
{TR69AcsInfo
{Tr69AcsUrl https://ttmacs.example.net:8048/service/cwmp}
{Tr69AcsUserName incognito}
{Tr69AcsPassword incognitoo}
{Tr69CrURL http://10.1.38.9:15627/acscall}
{Tr69CrUserName username}
{Tr69CrPassword password}
{Tr69AcsPerInfEnable 1}
{Tr69AcsPerInfInterval 180}
{Tr69AcsXAllowDocsCfg 0}
}
}

TR69AcsInfo Sub- The following define the sub-TLVs in the TR69AcsInfo group.
TLV Formal Defini-
tions
Tr69AcsUrl

Type Length Value

43.9.1 variable string

The string defines the URL of the ACS server.

TR69AcsUserName

Type Length Value

43.9.2 variable string

The string defines the user ID for logging into the ACS server.

TR69AcsPassword

Type Length Value

43.9.3 variable string

The string defines the password for logging into the ACS server.

TR69CrUserName

Type Length Value

43.9.4 variable string

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning 135

The string defines the user name for the ACS when using the Connection
Request mechanism to the Gateway.

TR69CrPassword

Type Length Value

43.9.5 variable string

The string defines the password for the ACS when using the Connection
Request mechanism to the Gateway.

TR69AcsPerInfEnable

Type Length Value

43.9.6 1 boolean

Enables or disables Periodic Inform. When enabled, the CPE sends periodic
status information to the ACS using an inform method.

TR69AcsPerInfInterval

Type Length Value

43.9.7 1 integer

The time, in seconds, that the CPE must attempt to connect to the ACS to
send a Periodic Inform.

TR69AcsXAllowDocsCfg

Type Length Value

43.9.8 1 boolean

Ignored. Enables or disables storage of ACS parameters to non-volatile

memory.

TR69CrURL

Type Length Value

43.9.9 variable string

The URL to the Gateway that the ACS uses for a Connection Request. The
URL must be specified as: http://gatewayIP:15627/acscall

Firmware Guide Release 7.5 Standard 1.2 August 2012

136 Chapter 2

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 3 Provisioning Packet-
Cable 2.0 SIP Loads

This chapter applies only to SIP PC20 loads.

Touchstone SIP provisioning consists of the following topics:
Topic Page
PacketCable 2.0 Concepts 137
Overview of SIP Features 171
Configuring PacketCable 2.0 SIP 144
Provisioning PacketCable 2.0 Features 148
Configuring PacketCable 2.0 Digit Maps 155
Provisioning PacketCable 2.0 Users 163
Provisioning PacketCable 2.0 Application Profiles 165
Provisioning PacketCable 2.0 Application Maps 166
Configuring SIP Failure Response Tones 167
Configuring MWI Support 169

PacketCable 2.0 Concepts

This section describes PacketCable 2.0 terminology and concepts.

Terminology PacketCable 2.0 introduces new terminology and abbreviations for telephony
components within a network. The following table shows PacketCable 1.x
terms with their equivalent PacketCable 2.0 terms.

Firmware Guide Release 7.5 Standard 1.2 August 2012

138 Chapter 3

PC1.x PC2.0 Description

eMTA E-UE, E-DVA A device consisting of a com-
bined DOCSIS CM and a Pack-
etCable eDVA (MTA).
MTA eUE, eDVA The logical PacketCable device.
Proxy P-CSCF Proxy-Call Session Control
Function. In PacketCable 2.0,
the P-CSCF communicates
with the registrar, so it is no
longer necessary to specify a
registrar in eDVA configura-
tion.

This document uses the terms E-UE for the entire Telephony Modem, eDVA
for the telephony portion, and CM for the cable modem portion.

Configuration Provisioning an eDVA conforms to the following model. Note that TS7.5
Concepts uses a simplified version of the PacketCable 2.0 model, and the simplified
version is shown as follows:

P-CSCF.1 Operator.1 IMPU.n

IMPI.2

IMPU.1 Line 1 IMPU.2 Line 2

IMPI.1

AppMap.1 AppMap.2
OrgID: 4491 OrgID: 4491
AppID: 1 (RST) AppID: 1 (RST)

Profile 1 ••• Profile N

Feature 1 Feature 2 ••• Feature N

The PacketCable 2.0 Residential SIP Telephony (RST) model is an abstract

representation of the capabilities and features available on a phone line. The
intent is to provide flexibility for future services. The RST specification
introduces the following terms:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 139

Operator
The operator indirectly associates users with a P-CSCF. Multiple
operators could be associated with various third-party telephony
providers or with remote locations in the MSO’s network. TS7.5
supports one operator definition.
User
A user consists of two components:
• IMPU (IP Multimedia Public User) — the public identity of the
user. This could be the phone number assigned to the user, or
some other unique user name. The IMPU associates a user with a
phone line through the pktcEUEUsrIMPUAdditionalInfo object.
Multiple users may share a line, implementing a Teen Line ser-
vice or as part of a transition to a new area code or exchange.
• IMPI (IP Multimedia Private Identity) — the private identity of
the user. Primarily, the IMPI defines the credentials for the
IMPU.
Application
Defines the service(s) to be provided to a user. TS7.5 supports only
the Residential SIP Telephony (RST) application. The application
map defines the application and selects a profile.
Profile
Selects a digit map and an associated collection of features. A pro-
file may be applied to one or more users.
Feature
Defines capabilities and dialing features available to a profile. Fea-
tures include basic call functionality (including timer durations),
announcements, Caller ID display, and common dialing features.
Each feature is defined as an entry in one or more tables, allowing
profiles to contain different feature configurations. User-based fea-
tures are indexed normally; network-based features (or network-
based components of features) use the Operator index.
The following restrictions apply:
• Touchstone firmware supports only one P-CSCF (but can fail over to a
second P-CSCF) and only one operator per E-UE.
• Touchstone firmware supports only the PacketCable Residential SIP
Telephony (RST) application.
• Multiple users can be assigned to a line, but a user can be associated
only with one line.
Each box in the above figure is associated with a table in the PacketCable 2.0
MIBs. Arrows represent an index to a row in each table, connected with
another table. The boxes labeled IMPU and IMPI are contiguous since
TS7.5 requires them to be permanently associated.

Firmware Guide Release 7.5 Standard 1.2 August 2012

140 Chapter 3

Supported Fea- The following table shows which RST feature MIB tables are supported in
tures TS7.5.
MIB Table Support
RST Feature
Network User
Basic Call Partial Partial
Announcement Partial No
Activation Status n/a Partial
No Answer Timeout n/a Partial
CallerID n/a Partial
CallerID Display n/a Partial
CallerID Block n/a No
CallerID Delivery n/a No
Call Forward No Partial
Call Hold n/a No
Call Transfer n/a No
Do Not Disturb n/a No
MWI Partial n/a
Auto Recall n/a No
Auto Callback n/a No
Busy Line Verify No n/a
Emergency Services Partial n/a
Selective Call Forward n/a No

For details about partially supported feature tables, see the ‘‘Compliance’’
chapter of the Touchstone Telephony Feature Guide.

Overview of SIP Features

This section describes some important features of the SIP loads.

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 eDVA 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 eDVA has a 2 call per line
resource limitation. The user may make a call or receive a call while a loop-
back call is in progress. If another call is placed, either by an incoming call
or a new outbound call, the loopback call is disconnected.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 141

Packet Loopback is analogous to NETWLOOP, and controlled by the

sipCfgPacketLoopbackNumber object. Media Loopback is analogous to
NETWTEST, and controlled by the sipCfgMediaLoopbackNumber object.
The Loopback Draft 〈http://www.ietf.org/internet-drafts/
draft-ietf-mmusic-media-loopback-16.txt〉 specifies the
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 eDVA receives a call from one of these provisioned numbers.

Extended Offhook Touchstone firmware partially implements extended offhook processing as

Processing defined in PKT-SP-RSTF-I08-110127, section 7.1.4.4. Touchstone firmware
implements extended offhook processing as shown below.

Origination Mode

Origination mode typically involves the subscriber picking up the phone,

then either not dialing a number or pausing too long between digits. Packet-
Cable defines an Origination Mode Dial Time timer and a Long Interdigit
Timer (typically 16 seconds each); either timer expiring invokes the ‘‘perma-
nent sequence.’’
Use the pktcEUERSTNfBCallOrigDTTimer object to set the Dial Time timer.
The default time is 16 seconds.
Use the pktcEUERSTNfBCallOrigModLongIntDig object to set the Long
Interdigit timer. The default time is 16 seconds.

Termination Mode

When the eDVA receives the BYE signal, it starts a 20-second timer. If the
timer expires before the subscriber hangs up, the eDVA invokes the ‘‘perma-
nent sequence.’’

Permanent Sequence

A series of MIB objects, defined in the CL-PKTC-EUE-RST-MIB, specify

the permanent sequence played in response to an extended offhook. The
default behavior is:
TW loads:
1 Reorder tone for 30 seconds
2 OSI for 1 second

Firmware Guide Release 7.5 Standard 1.2 August 2012

142 Chapter 3

3 Silence for 4 seconds

4 Howler tone for 60 seconds
Other loads:
1 OSI for 1 second
2 Silence for 10 seconds
3 Howler tone for 60 seconds
If the subscriber has not hung up the phone by the time the sequence ends,
the line enters a lockout state until the subscriber hangs up.
The following table shows the MIB objects used to provision the permanent
sequence and the default values for each object.
Object TW Loads Other Loads
pktcEUERSTNfBCallPermSeqTone1 "file:///PacketCableRST/ro" "file:///PacketCableRST/osi"
pktcEUERSTNfBCallPermSeqTimer1 30 1
pktcEUERSTNfBCallPermSeqTone2 "file:///PacketCableRST/osi" "file:///PacketCableRST/nt"
pktcEUERSTNfBCallPermSeqTimer2 1 10
pktcEUERSTNfBCallPermSeqTone3 "file:///PacketCableRST/nt" "file:///PacketCableRST/ot"
pktcEUERSTNfBCallPermSeqTimer3 4 60
pktcEUERSTNfBCallPermSeqTone4 "file:///PacketCableRST/ot" ""
pktcEUERSTNfBCallPermSeqTimer4 60 0

Emergency Calls Any number matching the pattern associated with the digit map action
EMERGENCY-CALL is treated as an emergency call. Emergency calls have
special treatment. The subscriber is, by default, not allowed to terminate an
emergency call(this can be overridden by setting the sipCfgSipFea-
tureSwitch bit 0x00000100). If the user goes on hook, and the default
behavior is in effect, the eDVA does not send a BYE message. Instead, the
call is put on ‘‘Network Hold’’ as follows:
1 When the subscriber goes on-hook during an emergency call, the
Touchstone eDVA sends an INVITE (priority:emergency SDP:a=inac-
tive). 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 (priority:emergency
SDP:a=sendrecv) that causes the eDVA to ring. If the user goes off-
hook 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 emer-
gency 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 eDVA sends a BYE message to finally terminate the call.
The default value for the Network Hold Timer is 45 minutes.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 143

Emergency calls have the following restrictions:

• Outgoing emergency calls offer only the G.711 CODEC in the SDP.
• Caller ID blocking is overridden on outgoing emergency calls.
• In the INVITE, the eDVA does not include the route received in the
Service-Route header that was received in the registration
response.
• Incoming emergency calls cannot be transferred.
Incoming calls are treated as emergency calls under either of the following
conditions:
• The P-Asserted-Identity header value matches the value of the
sipCfgEmergencyServiceURN object (the default is ‘‘URN:ser-
vice:sos’’). If you change this value, always begin the string with the
URN: prefix to comply with RFC 5031.

• The Priority header value is ‘‘emergency.’’

To disconnect any active call when originating or receiving an emergency
call, set bit 0x00001000 in the sipCfgSipFeatureSwitch.

Distinctive Ring- Several distinctive ringing types, corresponding to R0 through R7, are
ing 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 sipCfgAlertInfoR0 through sipCfgAlertInfoR7. If the header
matches one of these, the eDVA plays the corresponding R0–R7 tone. TS7.5
also supports tones WT1 through WT4 for use with Call Waiting, and maps
R1 through R4 to WT1 through WT4 for a Call Waiting alert.
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 >"}

Touchstone firmware supports both the Bellcore-defined tones shown in the

listing above, and the equivalent PacketCable 2.0-defined tones
file:///PacketCableRST/rn, where n is 0 through 7.

Firmware Guide Release 7.5 Standard 1.2 August 2012

144 Chapter 3

Configuring PacketCable 2.0 SIP

Use this procedure to configure PacketCable 2.0 SIP for Touchstone prod-
ucts.

Configuration The most efficient way to configure PacketCable 2.0 SIP is to use a ‘‘top-
Overview down/bottom-up’’ approach, building and interlinking the MIB tables in the
following order:
1 Operator table
2 P-CSCF table
3 Feature and Digit Map tables
4 Profile to Feature tables
5 Application Map tables
6 IMPI table
7 IMPU table
See ‘‘PacketCable 2.0 Concepts’’ on page 137 for an overview of how the
tables interconnect.

Action Perform the following tasks in the order shown.

Task Page
Configuring Operator Information 144
Configuring Users and Features 145
Configuring Extended Offhook Processing 146
Post-Provisioning SIP Lines 146
Configuring T.38 and Fax-Only Modes 147

Configuring Oper- Operator information includes the Operator and P-CSCF tables. Follow
ator Information these steps:
1 Configure the Operator table. The index for each object is typically 1;
this index is used in other tables to refer to this Operator table.
a Set the pktcEUEDevOpDomain object to the domain name; for
example, atl.ga.example.com.
b Set the pktcEUERSTKeepAlive object to set the in-service/out-
of-service status:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 145

• Set to true(1) to use the keep-alive mechanism to determine the

status.
• Set to false(2) to use the RSTF in-service state requirements.
c Set the pktcEUEDevOpRowStatus object to createAndGo.
2 Configure the P-CSCF table. The index for each object is .oper.1,
where oper is the index of the operator table (usually 1).
a Configure the P-CSCF address:
pktcEUEDevPCSCFAddrType
Either ipv4 to specify an IP address, or dns to specify a
fully-qualified domain name.
pktcEUEDevPCSCFAddr
The address of the P-CSCF associated with the operator.
pktcEUEDevPCSCFSipPort
(optional) The SIP port. Default: 5060.
b (optional) If desired, modify the following SIP timers:
pktcEUEDevPCSCFTimerT1
SIP Timer T1. Default: 500 ms.
pktcEUEDevPCSCFTimerT2
SIP Timer T2. Default: 4000 ms.
pktcEUEDevPCSCFTimerT4
SIP Timer T4. Default: 5000 ms.
pktcEUEDevPCSCFTimerTD
SIP Timer TD. Default: 32000 ms.
3 Set the pktcEUEDevPCSCFRowStatus object to createAndGo.

Configuring Users Follow these steps to configure user and feature tables:
and Features 1 To configure features, proceed to ‘‘Provisioning PacketCable 2.0 Fea-
tures’’ on page 148.
2 To configure user information, proceed to ‘‘Provisioning PacketCable
2.0 Users’’ on page 163.
3 To configure application profiles, proceed to ‘‘Provisioning PacketCa-
ble 2.0 Application Profiles’’ on page 165. Digit map configuration is
described in ‘‘Configuring PacketCable 2.0 Digit Maps’’ on page 155.
4 To configure the Application Map, proceed to ‘‘Provisioning Packet-
Cable 2.0 Application Maps’’ on page 166.

Firmware Guide Release 7.5 Standard 1.2 August 2012

146 Chapter 3

Configuring Ex- Follow these steps to provision extended offhook processing.

tended Offhook 1 Provision the origination mode timers (Origination Mode Dial Time
Processing and Long Interdigit Timer) in one of the two following ways:
a In the digit map, configure the T (Dial Time) and L (Long Inter-
digit Timer) timers.
b Configure the following two MIB objects:
• pktcEUERSTNfBCallOrigDTTimer
• pktcEUERSTNFBCallOrigModLongIntDig
The default value for both timers is 16 seconds.
Note: Use either the digit map or the MIB objects to configure these
timers; do not use both.
2 To set the sequence of tones played, and the duration of each, set the
following MIB objects:
pktcEUERSTNfBCallPermSeqTone1
The URI of tone 1. Example: file:///PacketCa-
bleRST/ro
pktcEUERSTNfBCallPermSeqTimer1
The duration, in seconds, for tone 1.
pktcEUERSTNfBCallPermSeqTone2
The URI of tone 2.
pktcEUERSTNfBCallPermSeqTimer2
The duration, in seconds, for tone 2.
pktcEUERSTNfBCallPermSeqTone3
The URI of tone 3.
pktcEUERSTNfBCallPermSeqTimer3
The duration, in seconds, for tone 3.
Note: The pktcEUERSTNfBCallPermSeqTone4 and pktcEUERST-
NfBCallPermSeqTimer4s objects are not supported.

Post-Provisioning Follow these steps to change the provisioning status of one or more lines
SIP Lines without rebooting the eDVA.
Note: This task applies only to line-level parameters.
The following MIB objects require a restart of the SIP stack and are not
updated by this feature:
• sipCfgGenLinger

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 147

• sipCfgTimerF
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 arrisMtaDevSipConfig-
FileURL object to the URL of the configuration file.

3 Using an SNMP network manager, set the arrisMtaDevSipDwnld-

Config object to on(2).

The eDVA downloads the configuration file and applies the line-level
changes. Touchstone firmware does not take lines out of service or
interrupt calls in process.
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 eDVA loses those changes when re-initialized.

Configuring T.38 Configuring T.38 and fax operation is identical for both PC20 and ARRIS
and Fax-Only SIP loads. See ‘‘Configuring T.38 and Fax-Only Modes’’ on page 201 for
Modes details.

Firmware Guide Release 7.5 Standard 1.2 August 2012

148 Chapter 3

Provisioning PacketCable 2.0 Features

Use this procedure to provision individual PacketCable 2.0 features.

Feature Support In PacketCable 2.0, a ‘‘feature’’ includes anything that can be enabled or con-
figured. If all features are disabled, the eDVA can receive incoming calls and
make only emergency outgoing calls. By default, all features are disabled.
All features are defined and enabled in the pktcEUERSTAppProfileToFeat-
Table. Some features may be further configured as follows:

digit map
In addition to defining valid phone numbers, the digit map defines
Vertical Service Codes used to invoke or control dialing features.
Network table
Network tables are associated with an operator table, and control
provisioning associated with all users. Not all features have net-
work tables.
User table
User tables are associated with individual users, and control provi-
sioning for that user. Not all features have user tables.
The pktcEUERSTAppFeatID object specifies a feature type. The following
are valid features:
• digitMap(2) — A digit map that enables the supported features.
• basicCall(3) — Basic Call capabilities. The user-side table defines the
CODECs available; the network-side table defines timers and the off-
hook alert sequence.
• announcement(4) — Announcements. The Announcement Map table
defines tones to play when the eDVA receives various response codes
(such as ‘‘486 Busy’’).
• statusChange(5) — UE Status Change. This feature defines the mini-
mum registration expiration interval.
• noAnsTimeout(6) — Defines how long the eDVA rings a line before
sending a ‘‘480 Temporarily Unavailable’’ response to the originator.
• callerId(7) — Sets the preferred presentation status (anonymous or
public) on Caller ID for outgoing calls.
• callerIdDisplay(8) — Controls the display of Caller ID information for
incoming calls.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 149

• callerIdBlocking(9) — Controls per-call Caller ID Blocking. This fea-

ture is configured entirely through the digit map. No other provisioning
is supported.
• callerIdDelivery(10) — Controls per-call Caller ID Delivery. This fea-
ture is configured entirely through the digit map. No other provisioning
is supported.
• callForwarding(11) — Controls audible indicators for Call Forwarding
(CFV). The network table controls the reminder dialtone when CFV is
active; the user table controls Ring Reminder.
• callWaiting(12) — The Call Waiting feature is configured through the
digit map. Beyond enabling and disabling the feature, only the Call
Waiting tone is configurable.
• callHold(13) — The Call Hold feature is configured entirely through
the digit map. Beyond enabling and disabling the feature, no other pro-
visioning is supported.
• callTransfer(14) — Call Transfer is supported in the digit map.
Beyond enabling and disabling the feature, no other provisioning is
supported.
• threeWayCalling(15) — 3-Way Calling is enabled in the digit map.
and in the ARRIS-proprietary arrisSipMib.
• doNotDisturb(16) — Do Not Disturb is enabled in the digit map. The
pktcEUERSTDnDTable configures confirmation tones for enabling and
disabling the feature.
• subscrProgPin(17) — Not supported.
• msgWaitIndicator(18) — Message Waiting Indicator (MWI) subscrip-
tion duration is configured through a network table. If the MWI Appli-
cation Server (MWI AS) is different from the P-CSCF, the ARRIS-pro-
prietary arrisSipMib can be used to specify the address of the MWI AS,
and to control the behavior of MWI.
• autoRecall(19) — Auto Recall is supported through the digit map. The
pktcEUERSTAutoRclTable is not supported in TS7.5.

• autoCallback(20) — Auto Callback is supported through the digit map.

The pktcEUERSTAutoCbTable is not supported in TS7.5.
• busyLineVerify(21) — Not supported.
• emergencySvc(22) — Emergency Service timers are configured
through the pktcEUERSTNfEmSvcTable. The eDVA fills emergency
service-related arrisSipMib objects with provisioned or server-provided
information.
• scf(23) — Selective Call Forwarding is not supported.

Firmware Guide Release 7.5 Standard 1.2 August 2012

150 Chapter 3

• acr(24) — Anonymous Call Rejection is configured entirely through

the digit map. No other provisioning is supported.
• solicitorBlocking(25) — Solicitor Blocking is configured entirely
through the digit map. No other provisioning is supported.
• distinctAlerting(26) — Distinctive Alerting is configured entirely
through the digit map. No other provisioning is supported.
• speedDialing(27) — Not supported.
• cot(28) — Customer Originated Call Trace (COT) is configured
entirely through the digit map. No other provisioning is supported.
Use the CallP cotdump CLI command to display information captured
by the eDVA in response to the subscriber using the COT dialing code.
• heldMedia(29) — Held Media. Enables an active bi-directional media
stream to be held. No configuration is required or supported for this
feature.
• hotline(31) — Hotline/Warmline. When the subscriber goes off-hook
and does not dial a digit before the pktcEUERSTHotlineOffhookTimer
timer expires, the eDVA automatically dials a number. By setting the
timeout to 0, this feature acts as a hotline, automatically dialing the des-
ignated number as soon as the subscriber goes off-hook.
Note: The ARRIS-proprietary MIB objects sipCfgWarmOrHotli-
neNumber, sipCfgWarmLineTimeout, and sipCfgPortWarmOrHotli-
neEnable may also be used to provision hotline or warmline. If the
pktcEUERSTHotlineDestAddress object is not provisioned, the eDVA
uses the ARRIS SIP objects.
In addition to the PacketCable 2.0 features described above, Touchstone
firmware provides the following ARRIS-specific features.
• Warmline/Hotline — when the subscriber goes off-hook and does not
dial a digit before the sipCfgPortWarmLineTimeout timer expires, the
eDVA automatically dials the number specified by the sipCfgPortWar-
mOrHotlineNumber object. By setting the timeout to 0, this feature
acts as a hotline, automatically dialing the designated number as soon
as the subscriber goes off-hook.
Note: TS7.5 does not support dialing codes for subscriber control over
the Warmline/Hotline feature.
• 3-way Calling — An ARRIS extension to the PacketCable 2.0 digit
map provides subscriber control over 3-way calling. Two actions,
3WC-ENABLE and 3WC-DISABLE, allow provisioning dialing codes
for use with 3-way calling.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 151

P-CSCF Dialing In TS7.5, any dialing features not supported by the digit map are treated as P-
Features CSCF dialing features. To enable a P-CSCF dialing feature, map the P-
CSCF-defined dialing code to the MAKE-CALL action, passing the dialing
code to the P-CSCF.
Example:
"*99" : MAKE-CALL ( "sip:" #0 =domain =dialString )

The P-CSCF must instruct the eDVA to play stutter tone or provide other
confirmation, if necessary.

Action Configure the following features as required.

Task Page
Basic Call Configuration 151
Configuring the Status Change Feature 152
Configuring No Answer Timeout 152
Configuring Caller ID 153
Configuring Emergency Services 153
Configuring Distinctive Ring/Alert Tones 154

Basic Call Config- Follow these steps to configure a basic call feature.
uration 1 Configure the user-side table, pktcEUERSTBasicCallTable, as fol-
lows:
pktcEUERSTBCallPrefCodecList
(optional) A comma-delimited list of the CODECs sent in the
SDP. If left unconfigured, the eDVA offers G.711.
Note: For backward-compatibility with earlier versions of
Touchstone firmware, this object also accepts a semicolon-
delimited list supported by the now-deprecated sipCfgProvi-
sionedCodecArray object.

pktcEUERSTBCallStatus
Set to createAndGo(4).
2 (optional) Configure the network-side table, pktcEUERSTNfBasic-
CallTable, as follows. The index is .oper.x, where oper is the index
of the entry in the Operator table. All the values in this table have rea-
sonable defaults.
pktcEUERSTNfBCallByeDelay
The Bye delay, in seconds. When set to a non-zero value, a
called party can hang up the phone then pick up before the timer
expires without ending the call.

Firmware Guide Release 7.5 Standard 1.2 August 2012

152 Chapter 3

pktcEUERSTNfBCallPermSeqTone1
The URI specifying the first tone in the permanent sequence.
See ‘‘Permanent Sequence’’ on page 172 for details and
defaults.
pktcEUERSTNfBCallPermSeqTimer1
The duration of the first tone in the permanent sequence.
pktcEUERSTNfBCallPermSeqTone2
The URI specifying the second tone in the permanent sequence.
pktcEUERSTNfBCallPermSeqTimer2
The duration of the second tone in the permanent sequence.
pktcEUERSTNfBCallPermSeqTone3
The URI specifying the third tone in the permanent sequence.
pktcEUERSTNfBCallPermSeqTimer3
The duration of the third tone in the permanent sequence.
pktcEUERSTNfBCallPermSeqTone4
The URI specifying the last tone in the permanent sequence.
pktcEUERSTNfBCallPermSeqTimer4
The duration of the last tone in the permanent sequence.
pktcEUERSTNFBCallOrigModLongIntDig
The long interdigit timer, in seconds. If you configure the ‘‘L’’
timer in the digit map, do not set this object.
pktcEUERSTNfBCallStatus
Set to createAndGo(4). Setting only this object creates an
entry with reasonable default values.

Configuring the In TS7.5, Status Change is used to periodically re-register with the network.
Status Change One entry in the pktcEUERSTUEActStatChgTable is supported in TS7.5
Feature and applies to the entire eDVA.
Follow these steps to configure the Status Change entry.
1 Set the pktcEUERSTUEActStatChgRegExp object to the desired
registration expiration time, in seconds.
2 Set the pktcEUERSTUEActStatChgStatus object to create-
AndGo(4).

Configuring No Follow these steps to configure the No Answer timeout feature. This feature
Answer Timeout allows the eDVA to disconnect a call if the called party does not answer
before the timer expires.
1 Set the pktcEUERSTNoAnsTODuration object to the desired No
Answer timeout, in seconds.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 153

2 Set the pktcEUERSTNoAnsTOStatus object to createAndGo(4).

Configuring Caller Configuring Caller ID requires setup of several tables. Follow these steps to
ID configure Caller ID.
1 Set up the user’s presentation by creating an entry in the pktcEUER-
STCIDTable with the following values:

pktcEUERSTCIDPPS
Set the presentation status to public(2).
pktcEUERSTCIDStatus
Set to createAndGo(4).
2 Set up the display feature by creating an entry in the pktcEUERST-
CIDDisTable with the following values:

pktcEUERSTCIDDisDefCountry
Enter the country code data, to be stripped from the display
information sent to the subscriber’s CPE. For example, the US
country code is 1.
pktcEUERSTCIDDisTimeAdj
The adjustment, in minutes, from UTC.
pktcEUERSTCIDDisDSTFlag
Set to 1 to adjust for Daylight Savings Time, or 0 to ignore DST.
pktcEUERSTCIDDisDSTInfo
To use the above two objects for adjusting the time, set this to an
empty string. Otherwise, set to a POSIX timezone string as
defined in RFC 4833. If you set this object, the eDVA ignores
the above two objects.
pktcEUERSTCIDDisCIDCWActStat
Set to true(1) to disable CID-CW.
Note: You can disable CID-CW for the entire eDVA by setting
bit 0x02000000 of the SIP Feature Switch sipCfgSipFea-
tureSwitch.

pktcEUERSTCIDDisStatus
Set to createAndGo(4).

Configuring Emer- Follow these steps to configure emergency services. See ‘‘Emergency Calls’’
gency Services on page 173 for an overview of emergency call processing.
1 Add a rule to the digit map to associate a dial string with emergency
calls. For example:
"911" : EMERGENCY-CALL ("sip:" "911" =domain =Emergencytg )

Firmware Guide Release 7.5 Standard 1.2 August 2012

154 Chapter 3

2 To configure PacketCable 2.0 emergency service features, provision

the following objects in the pktcEUERSTNfEmSvcTable. The index
is .oper.x, where oper is the index of the entry in the Operator table.
pktcEUERSTNfEmSvcNwHoldTimer
(non-TW loads only) The emergency services network hold
timer value, in minutes. Default: 45.
pktcEUERSTNfEmSvcHowlTimer
The emergency services howler timer, in seconds. Default: 3.
pktcEUERSTNfEmSvcDSCPValMedia
The DSCP value for network media (RTP) packets associated
with emergency calls.
pktcEUERSTNfEmSvcDSCPValSig
The DSCP value for network signaling packets associated with
emergency calls.
pktcEUERSTNfEmSvcStatus
Set to createAndGo(4) to write the entry and put it in service.
3 To change the URN used to identify incoming emergency calls, set the
sipCfgEmergencyServiceURN object to the desired URN. The
default setting is ‘‘URN:service:sos.’’
4 To disconnect active calls when originating or receiving an emergency
call, set bit 0x00001000 in the sipCfgSipFeatureSwitch object.
Note: The eDVA does not notify the subscriber when disconnecting an
active call in response to an incoming emergency call.

Configuring Dis- Setting Alert-Info strings for distinctive ringing and alert (Call Waiting) tones
tinctive Ring/Alert is identical for both PC20 and ARRIS SIP loads. See ‘‘Configuring Distinc-
Tones tive Ring/Alert Tones’’ on page 202 for details.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 155

Configuring PacketCable 2.0 Digit Maps

The PacketCable Residential SIP Telephony Feature Specification, PKT-SP-
RSTF-I08-110127, describes digit maps and provides an example map. The
PacketCable 2.0 digit map specification is radically different from that
defined in earlier specifications: earlier maps simply defined valid dialing
sequences and left their interpretation to the Call Server (NCS) or vendor-
defined methods (previous ARRIS SIP firmware versions use the sipCfgDi-
alFeat* MIB objects); the new digit maps both define valid dialing sequences
and associate actions with them.

General Digit Map A digit map consists of:

Structure timer definitions
The following timers are defined by PacketCable 2.0 specifications.
All are specified in seconds, and can be defined in 0.1 second incre-
ments.
• S (Short Interdigit Timer): when a subscriber’s dialing string
matches a pattern, but subsequent digits could match a longer pat-
tern, pausing long enough for the ‘‘S’’ timer to expire selects the
shorter pattern.
Default: 4 seconds.
• Z (Long Duration Timer): used in patterns to indicate that the fol-
lowing key is held down for a minimum amount of time.
Default: 2 seconds.
The following timers are supported in TS7.5 digit maps, but are
deprecated. Use the appropriate MIB objects to set these timer val-
ues.
• T (Start Timer): the length of time allowed, after beginning to
play dialtone, for the subscriber to dial the first digit. Typically, if
this timer expires without the subscriber dialing anything, the UE
plays reorder tone. Use the pktcEUERSTNfBCallOrigDTTimer
object to specify this timer.
Default: 16 seconds.
• L (Long Interdigit Timer): the allowable time between digits if the
‘‘S’’ timer is not specified. Use the pktcEUERSTNFBCallOrig-
ModLongIntDig object to specify this timer.

Default: 16 seconds.
symbol definitions
A symbol is a string constant, used to define common pattern or
action strings and to make rules more human-readable. An example
symbol definition is:

Firmware Guide Release 7.5 Standard 1.2 August 2012

156 Chapter 3

LocalNumber = [2-9]x{6}
map definitions
maps consist of a series of rules defined as:
pattern : action
Patterns are completely defined in the Residential SIP Telephony
Feature Specification. The following list describes the more com-
mon components of a pattern.
• Numbers 0 through 9, and the * and # symbols, represent standard
keypad keys. The characters ‘‘x’’ and ‘‘X’’ represent a single
numeric keypress.
• S, T, L, and Z represent the defined timers. Of these, the Z timer
must precede a keypress.
• An = sign followed by a name represents a defined symbol.
Example: =LocalNumber
• Square brackets enclosing a series of keys, such as [2345],
match any single keypress in that series. A range of numeric keys
may be represented using a hyphen, so [2-5] is equivalent to
[2345]. The character ‘‘x’’ or ‘‘X’’ is equivalent to [0-9]. If
the first character in the series is a caret (ˆ), then the series
matches a keypress not represented — for example, [ˆ01*#] is
equivalent to [2-9].
• A keypress (or a series enclosed in square brackets) followed by a
number or range in curly brackets, such as x{6}, matches when
the specified number (or some number within the range) of
matching keys are pressed. For example, 1x{2-4}# matches
1xx#, 1xxx#, or 1xxxx#.
• All or part of a pattern may be enclosed in parentheses to specify
a sub-pattern. A sub-pattern may be used in an action, as
described below.
• Two slashes (//) indicate that the rest of the line is a comment.
Actions, like patterns, are completely defined in the Residential SIP Tele-
phony Feature Specification. An action consists of a command, followed by
a parameter string enclosed in parentheses. Multiple actions can be specified,
and are separated by a semicolon (;). TS7.5 supports the following com-
mands in actions:
• MAKE-CALL (uri) — URI representing the specified destination (usu-
ally a phone, but could include dialing codes handled in the network)
• CID-DELIVER (string) — send the specified Caller ID information
• CID-SUPPRESS (string) — do not send Caller ID information

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 157

• CW-TOGGLE — toggle Call Waiting

• EMERGENCY-CALL (uri) — call the specified emergency number
• HOLD-ACTIVATE — hold the active call
• COT-ACTIVATE — perform a Customer-Originated Trace of the last
call
• RECALL — play Recall tone
• REORDER — play Reorder tone
• RETURN (string) — specifies the actual value returned by the map
• SB-MAINT (string) — solicitor blocking
• SD-PROGRAM (vsc, string) — adds a number to the Speed Dial list
• 3WC-ENABLE — enables 3-way calling (ARRIS extension).
• 3WC-DISABLE — disables 3-way calling (ARRIS extension).
• USEMAP (=map-name) — applies the specified map to input received
after matching this rule
• CNDB-TOGGLE — toggles the Caller ID privacy setting for the next
outgoing call.
• ACR-ACTIVATE — activates rejection of incoming calls with blocked
Caller ID information.
• ACR-DEACTIVATE — allows incoming calls with blocked Caller ID
information.
• FEATURE-CHECK (featureID, [failureURI]) — if the feature fea-
tureID is not enabled, the eDVA plays the specified failureURI (or
reorder tone if not specified).
• DND-ACTIVATE — activates Do Not Disturb (ARRIS extension).
• DND-DEACTIVATE — deactivates Do Not Disturb (ARRIS exten-
sion).
The following is a subset of the more common components of parameters to
action commands.
• A string enclosed in quotes, such as "@telco.example.net", is a
literal string.
• An = sign followed by a name represents a defined symbol. Example:
=LocalNumber
• A pound sign (#) followed by a number represents a sub-pattern within
a matched pattern. For example, if the defined pattern was
([2-9]xx)(555(xxxx)) and the dial string matched was
6785551212, then #2 returns the value ‘‘5551212.’’ The pattern #0
represents the entire matched dial string.

Firmware Guide Release 7.5 Standard 1.2 August 2012

158 Chapter 3

• A pound sign, followed by a number and a ‘‘v’’ specifies a sub-pattern

returned by a map.
A series of components are concatenated; for example,
"sip:" #0 "@example.net" =dialstring
constructs a single parameter string.

TS7.5 Compliance TS7.5 generally conforms to PacketCable 2.0 specifications for digit maps,
with PacketCa- with the following exceptions:
ble 2.0 • The Start Timer ‘‘T’’ is supported, with a default value of 16 seconds,
and can be changed in the digit map. However, its behavior is hard-
coded to play reorder tone, equivalent to defining the rule ‘‘T’’ :
REORDER in the digit map. Configuring this timer in the digit map is
deprecated; use the pktcEUERSTNfBCallOrigDTTimer object to set
this timer.
• The Long Interdigit Timer ‘‘L’’ can be defined but is not supported in
rules. However, if the Short Interdigit Timer ‘‘S’’ is not defined, the
‘‘L’’ timer definition is applied to rules where ‘‘S’’ is specified. Config-
uring this timer in the digit map is deprecated; use the pktcEUERSTNF-
BCallOrigModLongIntDig object to set this timer.

• The keys ‘‘A’’ through ‘‘D’’ are not supported.

• Symbols are supported, but the definition of a symbol must be a con-
stant string. Thus, the following symbol definition is supported:
localNumber = "[2-9]x{6}"
but this is not:
ldNumber = "1" =AreaCode =localNumber
• TS7.5 digit maps are not case-sensitive.
• The following action commands are not supported:
– AC-ACTIVATE, AC-DEACTIVATE
– AR-ACTIVATE, AR-DEACTIVATE
– CFV-PROGRAM, CFV-DEACTIVATE
– DA-MAINT
– DND-PROGRAM
– SCF-PROGRAM
– SPP-PROGRAM

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 159

Specifying a Digit Follow these steps to specify a digit map.

Map 1 Use a text editor to create a digit map. Note the restrictions above.
2 In the configuration file, set the pktcEUERSTDMValue.1 MIB object
to the text of the digit map. Note that you will need to use the
LongSnmpMib TLV to accommodate the size of the map.

Note: In TS7.5, a single digit map applies to all lines in the E-UE.

Example Digit Map The following is an example digit map.

// Timer values
TIMER T=16 // Start timer. The length of time allowed to dial the
// first digit from the time dial tone is applied
TIMER S=4 // Short interdigit timer. Used when critical timing should
// be performed, such as when the dialed digits constitute
// a complete address, but additional digits may
// constitute a different complete address

TIMER L=16 // Long interdigit timer. The allowable time between digits
// the digit map.
TIMER Z=2.0 // Long duration timer. The duration a particular digit is
// Symbols
domain = "@tel.example.com"
areaCode = "303"
dialString = ";user=dialstring" // Just to shorten things
homeEmergencyNumber = "911"
localEmergencyNumber = "911" // alternate emergency number
lcltg = ";tgid=Local_trunk-group-id"
ldtg = ";tgid=Long_Distance_trunk-group-id"
intltg = ";tgid=International-trunk-group-id"
Emergencytg = ";tgid=911PSAP-trunk-group-id"
Opertg = ";tgid=Local_Operator-trunk-group-id"
ldcic = ";cic=0333"
intlcic = ";cic=8937"
TollFreecic = ";cic=0110"
// Maps
MAP MainTable = // This is where processing starts
"T" : REORDER // Reorder Tone or Annc.
"0S" : MAKE-CALL ("sip:0" =domain =Opertg)
"0#" : MAKE-CALL ("sip:0" =domain =Opertg)
"00" : MAKE-CALL ("sip:0" =ldcic =domain =ldtg)
"(=Emergency)" : EMERGENCY-CALL ("sip:" "911" =domain =Emergencytg )
// map N11 to routing number or reorder if not assigned
"211" : MAKE-CALL ("sip:" "+13035551111" =domain =lcltg)
"311" : MAKE-CALL ("sip:" "+13035552222" =domain =lcltg)
"411" : MAKE-CALL ("sip:" "411" =domain =Opertg)
"511" : REORDER // Reorder Tone
"611" : MAKE-CALL ("sip:" "+13035552224" =domain =lcltg)
"711" : MAKE-CALL ("sip:" "+18885552225" =TollFreecic =domain =lcltg)

Firmware Guide Release 7.5 Standard 1.2 August 2012

160 Chapter 3

"811" : MAKE-CALL ("sip:" "+19035552226" =ldcic =domain =ldtg)

"( =Speedcall)" : MAKE-CALL ( "sip:" #1v)
"(=PhoneNumber)" : MAKE-CALL (#1v)
"(=ImmediateVSCs)" : RETURN
"(=DelayedVSCs)" : RETURN
// Press # for 2 seconds & get recall dial tone
"Z#" : RECALL; USEMAP(=MainTable)
// Any other digit strings
"(x{1-15})S" : REORDER
"(x{1-15})#" : REORDER
MAP PhoneNumber =
"(=LocalPhoneNumbers)" : RETURN ("+1" #1v =domain =lcltg)
"0(=LocalPhoneNumbers)" : RETURN ("0" #1v =domain =Opertg)
"1{0-1}([579]00[2-9]x{6})" : RETURN ("+1" #1 =domain =lcltg)
// 500, 700, & 900 numbers
"1{0-1} (=TollFreeNumbers)" : RETURN ("+1" #1v =TollFreecic =domain =lcltg)
"101(=DialAround)" : RETURN ( "sip:" #1v ";dai=no-presub" =domain =lcltg)
"1(=WZ1InternationalNumbers)" : RETURN ("+1" #1v =intlcic =domain =intltg)
"0(=WZ1InternationalNumbers)" : RETURN ("0" #1v =intlcic =domain =intltg)
"011(=InternationalNumbers)" : RETURN ("+" #1v =intlcic =domain =intltg)
"01(=InternationalNumbers)" : RETURN ("01" #1v =intlcic =domain =intltg)
"1{0-1} (=LDPhoneNumbers)" : RETURN ("+1" #1v =ldcic =domain =ldtg)
"0(=LDPhoneNumbers)" : RETURN ("0" #1v =ldcic =domain =ldtg)

MAP Emergency = // Matches emergency dial strings

"(=localEmergencyNumber)" : RETURN
"(=homeEmergencyNumber)" : RETURN
"[01](=homeEmergencyNumber)" : RETURN
MAP Speedcall = // Matches Speed Call list (either one or two digit)
// two-digit speed dialing
"21S" : RETURN ( "sip:" "+19137654321" =ldcic =domain =ldtg)
"22S" : RETURN ( "sip:" "+13037654321" =domain =lcltg)
"23S" : RETURN ( "sip:" "+18007654321" =TollFreecic =domain =lcltg)
"24S" : RETURN ( "sip:" "+529137654321" =intlcic =domain =intltg)
"21#" : RETURN ( "sip:" "+19137654321" =ldcic =domain =ldtg)
"22#" : RETURN ( "sip:" "+13037654321" =domain =lcltg)
"23#" : RETURN ( "sip:" "+18007654321" =TollFreecic =domain =lcltg)
"24#" : RETURN ( "sip:" "+529137654321" =intlcic =domain =intltg)
MAP LocalPhoneNumbers = // Matches local phone numbers
"(=areaCode)(=Local7DigitNumbers)" : RETURN( =areaCode #2v )
"( =Local7DigitNumbers )" : RETURN( =areaCode #1v )
MAP Local7DigitNumbers = // Matches local 7 digit numbers
"(212x{4})" : RETURN( #1 )
"(213x{4})" : RETURN( #1 )
"(222[1-3]x{3})" : RETURN( #1 )
"(2267x{3})" : RETURN( #1 )
// could be 100+ entries for local digit map
MAP WZ1InternationalNumbers = // Matches international WZ1 numbers
"(204x{7})" : RETURN( #1 )
// 42 more entries for area codes of Canada & Caribbean

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 161

MAP TollFreeNumbers = // 800 and friends

"(800[2-9]x{6})" : RETURN( #1 )
"(866[2-9]x{6})" : RETURN( #1 )
"(877[2-9]x{6})" : RETURN( #1 )
"(888[2-9]x{6})" : RETURN( #1 )
MAP LDPhoneNumbers = // Matches Long Distance phone#
// Local, 500, 700, 800, 900 & WZ1 International
// eliminated by prior matches
"([2-9]x{6})S" : RETURN( =areaCode #1 )
"([2-9]x{6})#" : RETURN( =areaCode #1 )
"([2-9]x{9})" : RETURN( #1 )
MAP InternationalNumbers = // Matches international non-WZ1 numbers
"([2-9]x{1-14})S" : RETURN( #1 )
"([2-9]x{1-14})#" : RETURN( #1 )
MAP DialAround = // Matches dial around phone#
"0([2-9]x{2})(=daiPhoneNumbers)" : RETURN( #2v ";cic=0" #1 )
// (3 digit CIC dialed by user)
"1(x{4})(=daiPhoneNumbers)" : RETURN( #2v ";cic=1" #1 )
// (4 digit CIC dialed by user)
MAP daiPhoneNumbers = // valid dai phone numbers
"[5789]00" : REORDER
"S" : RETURN
"#" : RETURN
"866" : REORDER
"877" : REORDER
"888" : REORDER
"(=LocalPhoneNumbers)" : RETURN ("+1" #1)
"0(=LocalPhoneNumbers)" : RETURN ("0" #1)
"1{0-1} (=WZ1InternationalNumbers)" : RETURN ("+1" #1)
"0(=WZ1InternationalNumbers)" : RETURN ("0" #1)
"011(=InternationalNumbers)" : RETURN ("+" #1)
"01(=InternationalNumbers)" : RETURN ("01" #1)
"1{0-1}(=LDPhoneNumbers)" : RETURN ("+1" #1)
"0(=LDPhoneNumbers)" : RETURN ("0" #1)
MAP ImmediateVSCs = // Matches and executes immediate VSCs.
// Returns nothing.
"*74" // (SD8)
: RECALL; USEMAP (=SD8)
"*75" // (SD30)
: RECALL; USEMAP (=SD30)
"*[78]7" // (ACR-ACTIVATE/ACR-DEACTIVATE)
: MAKE-CALL ( "sip:" #0 =domain =dialString)
"*9[01]" // (DND-ACTIVATE/DND-DEACTIVATE)
: MAKE-CALL ( "sip:" #0 =domain =dialString)
"*96" // (SB-MAINT)
: SB-MAINT (#0) // solicitor blocking maintenance
"*72" // (CFV-ACTIVATE)
// Play Recall Dial Tone
// Collect digits using subset digitmap
// Prepend "*72." onto dialed address using SIP URI

Firmware Guide Release 7.5 Standard 1.2 August 2012

162 Chapter 3

// The following is an example implementation:

: RECALL; USEMAP(=ForwardingNumber)
"*73" // (CFV-DEACTIVATE) (reuse *72 for this)
: MAKE-CALL ( "sip:*72." =domain =dialString)
MAP DelayedVSCs = // Make some state change, then continue processing dialing
"*92" : HOLD-ACTIVATE; RECALL; USEMAP(=MainTable)
"*67" : CID-SUPPRESS
"*82" : CID-DELIVER
"*70" : CW-TOGGLE; RECALL; USEMAP(=MainTable)
// The CALL-WAITING action must give the right tone.
MAP SD8 = // Program one-digit speed dial number
"[2-9]" : SD-PROGRAM ( "sip:*74." #0 =domain =dialString)
"[ˆ2-9]" : REORDER
"S" : REORDER
"#" : REORDER
MAP SD30 = // Program two-digit speed dial number
"[2-4]x" : SD-PROGRAM ( "sip:*75." #0 =domain =dialString)
"[ˆ2-4]" : REORDER
"S" : REORDER
"#" : REORDER
"[2-4]S" : REORDER
MAP ForwardingNumber = // Just for programming CFV
"(=PhoneNumber)" : MAKE-CALL ( "sip:*72." #1 =domain =dialString)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 163

Provisioning PacketCable 2.0 Users

Use this procedure to set up users and associate them with credentials and
lines.

Action Follow these steps:

1 Configure an IMPI table entry in the eDVA configuration file. The
index is usually 1. Set the objects in this entry as follows:
pktcEUEUsrIMPIIdType
The identification type for the private identity. Only private-
Identity(4) is supported in TS7.5 and is the default.

pktcEUEUsrIMPIId
The user’s login information used to authenticate the eDVA to
the headend.
pktcEUEUsrIMPICredsType
The type of credentials used to confirm the private identity.
Only password(3) is supported in TS7.5 and is the default.
pktcEUEUsrIMPICredentials
The user’s password. Reading this object always returns an
empty string.
pktcEUEUsrIMPIRowStatus
Set to createAndGo(4).
Note: In most cases, a single IMPI table entry is associated with all
public users.
2 Configure an IMPU table entry in the eDVA configuration file. Set
the objects in this entry as follows:
pktcEUEUsrIMPUIdType
(optional) The public user identification type. Both publicIden-
tity(3) (the default) and userName(6) are supported in TS7.5.

pktcEUEUsrIMPUId
The public user identification. The content of this object
depends on the value of pktcEUEUsrIMPUIdType:
• publicIdentity(3): phonenumber@domain
• userName(6): phonenumber (Touchstone firmware adds the
default domain to the phone number to create the full public
identity)

Firmware Guide Release 7.5 Standard 1.2 August 2012

164 Chapter 3

pktcEUEUsrIMPUIMPIIndexRef
The index into the pktcEUEUsrIMPITable, specifying the IMPI
entry associated with the public user.
pktcEUEUsrIMPUDispInfo
The display name in SIP messages, associated with Caller ID
name delivery.
pktcEUEUsrIMPUOpIndexRefs
The index into the pktcEUEDevOpTable, specifying the opera-
tor entry associated with the public user. In TS7.5, this is usu-
ally 1 since only one operator entry is supported.
pktcEUEUsrIMPUAdminStat
(optional) Accept the default of active(1) to enable the line.
pktcEUEUsrIMPUAdditionalInfo
If only one public user is associated with a phone line, the eDVA
automatically maps the first user to line 1 and the second user to
line 2. For multiple phone numbers associated with a line, as is
the case with a Teen Line service or an NPA or exchange transi-
tion, set this object as follows:
IEP#line;OEP#line

The line is the ifIndex for the line (usually 9 for line 1 and so
on), and must be same for both IEP (Input EndPoint) and OEP
(Output EndPoint).
pktcEUEUsrIMPURowStatus
Set to createAndGo(4).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 165

Provisioning PacketCable 2.0 Application

Profiles
Use this procedure to provision the Application Profile. The profile collects
feature sets to associate with a user.
Before you can provision the Application Profile, you must configure the fea-
tures as described in ‘‘Provisioning PacketCable 2.0 Features’’ on page 148.

Indexing The pktcEUERSTAppProfileToFeatTable uses a dual index for each entry:

.profile.feature.

Action Follow these steps to provision an Application Profile. The profile must be
provisioned in the eDVA configuration file.
1 Set the pktcEUERSTAppFeatID to the feature type being specified.
See ‘‘Provisioning PacketCable 2.0 Features’’ on page 148 for a list of
valid feature types.
2 Set the pktcEUERSTAppFeatIndexRef object to the index of an entry
in the pktcEUERSTAppProfileToFeatTable. This specifies the fea-
ture definition to use.
3 (optional) Set the pktcEUERSTAppAdminStat object to active (the
default) to activate this feature, or inactive to disable this feature.
4 Set the pktcEUERSTAppStatus to createAndGo(4).

Firmware Guide Release 7.5 Standard 1.2 August 2012

166 Chapter 3

Provisioning PacketCable 2.0 Application

Maps
Use this procedure to associate an application and an application profile with
a user.

Prerequisites Before provisioning an application map, perform the following procedures:

1 ‘‘Provisioning PacketCable 2.0 Features’’ on page 148
2 ‘‘Provisioning PacketCable 2.0 Application Profiles’’ on page 165
3 ‘‘Provisioning PacketCable 2.0 Users’’ on page 163

Indexing The pktcEUEUsrAppMapTable uses a dual index for each entry: .user.map,
where user index is the index of the IMPU entry that this map is associated
with; the map is the application index (usually 1 since TS7.5 supports only
the PacketCable RST application).

Action Follow these steps to provision an application map. You must add these
objects to the eDVA configuration file.
1 Set the pktcEUEUsrAppMapAppOrgID object to the enterprise num-
ber of the organization defining the application: always 4491 for
PacketCable.
2 Set the pktcEUEUsrAppMapAppIdentifier object to the application:
always 1 for Residential SIP Telephony (RST).
3 Set the pktcEUEUsrAppMapAppIndexRef object to the index of the
entry in the pktcEUERSTAppProfileToFeatTable corresponding to
the profile associated with this map.
4 (optional) Set the pktcEUEUsrAppMapAppAdminStat object to
active (default) to enable the application for this user, or inactive to
disable the application.
5 Set the pktcEUEUsrAppMapRowStatus object to createAndGo(4).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 167

Configuring SIP Failure Response Tones

Touchstone firmware complies with PacketCable 2.0 specifications for play-
ing tones in response to various SIP failure messages. Use this procedure to
override the default behavior.

Priority The eDVA follows these steps to determine which tone to play when receiv-
ing a failure response.
1 If the (sipCfgSipFeatureSwitch) object has the playBusyToneOn-
Reject(0x00000400) bit set, the eDVA always plays busy tone.

2 If the playBusyToneOnReject(0x00000400) bit is not set, and the P-

CSCF specifies a tone in the Error-Info header of the failure
response, the eDVA plays the specified tone.
3 If the pktcEUERSTNfAncMapURI.code object corresponding to the
response code is set, the eDVA plays the configured tone.
4 The eDVA plays the default response tone as defined in the table
below:
Response Code Tone
486 Busy
487 Silence
600 Busy
Other (except
Reorder
401 or 407)

Action Perform either of the following tasks as desired.

Task Page
Playing Busy Tone for All Errors 167
Configuring Individual Response Tones 168

Playing Busy Tone To override PacketCable 2.0 behavior and play busy tone for all failure
for All Errors responses, follow these steps.
1 Set the 0x00000400 bit of the sipCfgSipFeatureSwitch in the eDVA
configuration file.
2 Restart the eDVA to make the change take effect.

Firmware Guide Release 7.5 Standard 1.2 August 2012

168 Chapter 3

Configuring Indi- Follow these steps to configure a tone to play for a specific failure response.
vidual Response 1 For each response code, set the pktcEUERSTNfAncMapURI object,
Tones either in an SNMP manager or in the eDVA configuration file. This
object must be indexed by both the domain entry (TS7.5 allows only
one domain per E-UE) and the response code; for example,
pktcEUERSTNfAncMapRspCode.1.404, and contain the URI of the
PacketCable-defined tone to play. For example:
{pktcEUERSTNfAncMapRspCode.1.404 "file:///PacketCableRST/bz"}
The following failure codes are supported:
• 404, 406, 408
• 480, 484, 486, 487
• 500, 503, 504
• 600, 603
Note: A URI sent in the Error-Info header of the failure response
takes precedence over these settings.
2 If using an SNMP manager, set the pktcEUERSTNfAncMapStatus
object, indexed by the same domain and response code, to create-
AndGo(4). Otherwise, restart the eDVA to make the change take
effect.
3 To remove an entry, set the pktcEUERSTNfAncMapStatus object,
indexed by the same domain and response code, to destroy(6).
Note: Attempting to remove the entry for response codes 486, 487, or
600 resets the entry to its default value.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning PacketCable 2.0 SIP Loads 169

Configuring MWI Support

Touchstone firmware provides improved control over both visual and audible
MWI (Message Waiting Indication) indicators.
Note: The tasks in this procedure apply only to PacketCable 2.0 SIP deploy-
ments. ARRIS-proprietary legacy SIP deployments are not supported.

Action Perform each of the following tasks as needed.

Task Page
Clearing MWI Indicators 169
Provisioning the MWI Subscription 169

Clearing MWI Indi- It may be necessary to clear MWI indicators in response to a subscriber trou-
cators ble call. Follow these steps to clear the indicators.
1 Set the sipCfgPortMWIClear.line object to true(1). The line is the
line number for which the indicators should be cleared; use 1 for
line 1, and so on.
2 Repeat step 1 for each line that needs to be cleared.

Provisioning the By default, the eDVA subscribes to the P-CSCF MWI package (message-
MWI Subscription summary). Follow these steps to provision the eDVA to subscribe to a differ-
ent server’s MWI package.
1 Set the sipCfgMWITargetAddrType object to ipv4(1). TS7.5 sup-
ports only IPv4 for the E-UE.
2 Set the sipCfgMWITargetAddr object to the IP address of the device
that the eDVA should subscribe the MWI package to.
3 (optional) Set the sipCfgMWITargetPort object to the port number of
the MWI service. The default is 5060.
4 To recommend a subscription duration, set the pktcEUERST-
NfMWISubDuration object to the recommended time before the sub-
scription expires.
Valid range: 0 to 4000000 seconds. Default: 3600.

Firmware Guide Release 7.5 Standard 1.2 August 2012

170 Chapter 3

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 4 Provisioning ARRISLoads
SIP

This chapter applies only to ARRIS SIP loads.

Touchstone SIP provisioning consists of the following topics:
Topic Page
Overview of SIP Features 171
SIP Provisioning Considerations 175
Provisioning SIP Support 187
Provisioning SIP Features 196

Overview of SIP Features

This section describes some important features of the SIP loads.

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 eDVA 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 eDVA has a 2 call per line
resource limitation. The user may make a call or receive a call while a loop-
back 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, and controlled by the
sipCfgPacketLoopbackNumber object. Media Loopback is analogous to
NETWTEST, and controlled by the sipCfgMediaLoopbackNumber object.

Firmware Guide Release 7.5 Standard 1.2 August 2012

172 Chapter 4

The Loopback Draft 〈http://www.ietf.org/internet-drafts/

draft-ietf-mmusic-media-loopback-16.txt〉 specifies the
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 eDVA receives a call from one of these provisioned numbers.

Extended Offhook Touchstone firmware partially implements extended offhook processing as

Processing defined in PKT-SP-RSTF-I08-110127, section 7.1.4.4. Touchstone firmware
implements extended offhook processing as shown below.

Origination Mode

Origination mode typically involves the subscriber picking up the phone,

then either not dialing a number or pausing too long between digits. Packet-
Cable defines an Origination Mode Dial Time timer and a Long Interdigit
Timer (typically 16 seconds each); either timer expiring invokes the ‘‘perma-
nent sequence.’’
Use the pktcEUERSTNfBCallOrigDTTimer object to set the Dial Time timer.
The default time is 16 seconds.
Use the pktcEUERSTNfBCallOrigModLongIntDig object to set the Long
Interdigit timer. The default time is 16 seconds.

Termination Mode

When the eDVA receives the BYE signal, it starts a 20-second timer. If the
timer expires before the subscriber hangs up, the eDVA invokes the ‘‘perma-
nent sequence.’’

Permanent Sequence

A series of MIB objects, defined in the CL-PKTC-EUE-RST-MIB, specify

the permanent sequence played in response to an extended offhook. The
default behavior is:
TW loads:
1 Reorder tone for 30 seconds
2 OSI for 1 second
3 Silence for 4 seconds
4 Howler tone for 60 seconds

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 173

Other loads:
1 OSI for 1 second
2 Silence for 10 seconds
3 Howler tone for 60 seconds
If the subscriber has not hung up the phone by the time the sequence ends,
the line enters a lockout state until the subscriber hangs up.
The following table shows the MIB objects used to provision the permanent
sequence and the default values for each object.
Object TW Loads Other Loads
pktcEUERSTNfBCallPermSeqTone1 "file:///PacketCableRST/ro" "file:///PacketCableRST/osi"
pktcEUERSTNfBCallPermSeqTimer1 30 1
pktcEUERSTNfBCallPermSeqTone2 "file:///PacketCableRST/osi" "file:///PacketCableRST/nt"
pktcEUERSTNfBCallPermSeqTimer2 1 10
pktcEUERSTNfBCallPermSeqTone3 "file:///PacketCableRST/nt" "file:///PacketCableRST/ot"
pktcEUERSTNfBCallPermSeqTimer3 4 60
pktcEUERSTNfBCallPermSeqTone4 "file:///PacketCableRST/ot" ""
pktcEUERSTNfBCallPermSeqTimer4 60 0

Emergency Calls Any number matching the pattern associated with the digit map action
EMERGENCY-CALL is treated as an emergency call. Emergency calls have
special treatment. The subscriber is, by default, not allowed to terminate an
emergency call(this can be overridden by setting the sipCfgSipFea-
tureSwitch bit 0x00000100). If the user goes on hook, and the default
behavior is in effect, the eDVA does not send a BYE message. Instead, the
call is put on ‘‘Network Hold’’ as follows:
1 When the subscriber goes on-hook during an emergency call, the
Touchstone eDVA sends an INVITE (priority:emergency SDP:a=inac-
tive). 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 (priority:emergency
SDP:a=sendrecv) that causes the eDVA to ring. If the user goes off-
hook 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 emer-
gency 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 eDVA sends a BYE message to finally terminate the call.
The default value for the Network Hold Timer is 45 minutes.

Firmware Guide Release 7.5 Standard 1.2 August 2012

174 Chapter 4

Emergency calls have the following restrictions:

• Outgoing emergency calls offer only the G.711 CODEC in the SDP.
• Caller ID blocking is overridden on outgoing emergency calls.
• In the INVITE, the eDVA does not include the route received in the
Service-Route header that was received in the registration
response.
• Incoming emergency calls cannot be transferred.
Incoming calls are treated as emergency calls under either of the following
conditions:
• The P-Asserted-Identity header value matches the value of the
sipCfgEmergencyServiceURN object (the default is ‘‘URN:ser-
vice:sos’’). If you change this value, always begin the string with the
URN: prefix to comply with RFC 5031.

• The Priority header value is ‘‘emergency.’’

To disconnect any active call when originating or receiving an emergency
call, set bit 0x00001000 in the sipCfgSipFeatureSwitch.

Distinctive Ring- Several distinctive ringing types, corresponding to R0 through R7, are
ing 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 sipCfgAlertInfoR0 through sipCfgAlertInfoR7. If the header
matches one of these, the eDVA plays the corresponding R0–R7 tone. TS7.5
also supports tones WT1 through WT4 for use with Call Waiting, and maps
R1 through R4 to WT1 through WT4 for a Call Waiting alert.
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 >"}

Touchstone firmware supports both the Bellcore-defined tones shown in the

listing above, and the equivalent PacketCable 2.0-defined tones
file:///PacketCableRST/rn, where n is 0 through 7.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 175

SIP Provisioning Considerations

This section describes SIP provisioning considerations.

Information Re- The SIP load requires three pieces of information to function properly:
quired for SIP Outbound P-CSCF
The destination device for all outbound messages. The setting is
used as the domain in the Request-URI for all outgoing INVITE
messages. The E-UE supports a ‘‘global’’ proxy that applies to all
lines, and a per-line proxy that applies to a single line. See ‘‘Con-
figuring Per-Line Proxy and Registrar’’ on page 194 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 set-
ting. The E-UE supports a ‘‘global’’ registrar that applies to all
lines, and a per-line registrar that applies to a single line. See ‘‘Con-
figuring Per-Line Proxy and Registrar’’ on page 194 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"<sip:[email protected]>;
tag=94b73228-a013d16-13c4-20-21829ddd-20
To: "SIP1 Line1"<sip:[email protected]>
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"<sip:[email protected]:5060>
Content-Length: 0
INVITE sip:[email protected]:5060 SIP/2.0
From: "SIP1 Line1"<sip:[email protected]>;
tag=94b73808-a013d16-13c4-62-4e4a1883-62
To: <sip:[email protected]>

Firmware Guide Release 7.5 Standard 1.2 August 2012

176 Chapter 4

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: <sip:[email protected]:5060>
Content-Type: application/SDP
Content-Length: 168
<SDP REMOVED>

Here are examples of REGISTER and INVITE with IP address-based provi-

sioning with bit 0x04000000 set (bit value = 1):
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"<sip:[email protected]:5060>;
tag=94b73228-a013d16-13c4-20-21829ddd-20
To: "SIP1 Line1"<sip:[email protected]:5060>
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"<sip:[email protected]:5060>
Content-Length: 0
INVITE sip:[email protected]:5060 SIP/2.0
From: "SIP1 Line1"<sip:[email protected]:5060>;
tag=94b73808-a013d16-13c4-62-4e4a1883-62
To: <sip:[email protected]:5060>
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: <sip:[email protected]:5060>
Content-Type: application/SDP
Content-Length: 168
<SDP REMOVED>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 177

SIP Registration All SIP Touchstone firmware loads use the same algorithm for normal regis-
Behavior tration and re-registration:
• Registration begins after a randomized wait time between 1 and
(MaxWaitDelay) seconds. The default for MaxWaitDelay is 10 min-
utes; the pktcNcsEndPntConfigMWD object controls the delay time
(in seconds). Note that line 1 uses index 9, line 2 uses index 10, and so
on.
• By default, the registrar sends the registration 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 eDVA 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.
• After registration, the eDVA attempts to re-register after a random time
between 50% and 75% of the expiration time.
• If registration is unsuccessful (for example, the eDVA receives no
response or a 401 response), the eDVA retries registration using a back-
off algorithm at intervals specified by RFC 3261.
The 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. The eDVA
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 specify-
ing new values in the eDVA configuration file.
Each REGISTER attempt is not a single message. The eDVA will retry
REGISTER messages based on the retransmission algorithm specified in
RFC 3261. By default, the eDVA retries 7 times over a 32-second interval.
The retransmission algorithm is also exponential. The basis interval is speci-
fied by T1 (sipCfgT1). The total time to retransmit is specified by TimerF
(sipCfgTimerF).

SIP Feature Switch The SIP feature switch enables or disables extended features in the SIP load.
See ‘‘SIP Feature Switch’’ on page 85 for a detailed description of each
switch.

Firmware Guide Release 7.5 Standard 1.2 August 2012

178 Chapter 4

Provisioning This section describes various SIP features that can be configured in the pro-
Details visioning 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"}

Proxy Address

The proxy address specifies the destination where the eDVA 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"}

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 179

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 eDVA attempts to negotiate the CODECs in the list. CODECs are
listed in order of preference and used only on initial outbound INVITE mes-
sages. 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.

sipCfgRepeatDialingInterval
Specifies the time between attempts to connect to other party.
sipCfgRepeatDialingTimeout
A timer value that specifies how long the eDVA should keep trying
to connect to the other party.
sipCfgRepeatDialingSessionProgressTimer
Specifies the length of time after a 183 is received before consider-
ing 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.0 30}
{SnmpMib sipCfgRepeatDialingTimeout.0 1800}
{SnmpMib sipCfgRepeatDialingSessionProgressTimer.0 2}

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"}

Firmware Guide Release 7.5 Standard 1.2 August 2012

180 Chapter 4

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 eDVA 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 sipCfgResetCall-
WaitingStarCode 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 indi-
cate which lines should be reset.
# reset lines 1 and 2
{SnmpMib sipCfgResetCallWaitingStarCode.0 0x00000003}

Default G.711

When using G.729 as the primary voice CODEC, the eDVA 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}

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 181

The end user is never allowed to terminate an emergency call. If the user
goes on hook, the eDVA 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 eDVA sends an INVITE (priority:emergency SDP:a=inac-
tive). 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 eDVA to ring. If the user goes off-
hook 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 emer-
gency 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 eDVA sends a BYE message to finally terminate the call.
The default value for the Network Hold Timer is 45 minutes.
See PKT-SP-RSTF-I08-110127 section 8.5.5.8 for more details on
Network Hold for Emergency Calls, including call flows for various
Network Hold scenarios.

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 Caller ID disabled
0x20 Anonymous call rejection
0x10 Call Waiting disabled
0x08 Disable Three-Way Calling
0x04 Disable Caller ID display
0x02 Enable Call Transfer

Firmware Guide Release 7.5 Standard 1.2 August 2012

182 Chapter 4

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, Touch-
stone firmware compares the header to the strings specified in the MIB
objects sipCfgAlertInfoR0 through sipCfgAlertInfoR7. If the header
matches one of these, the eDVA 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 >"}

Dialing Features

The sipCfgDialFeatTable specifies dialing features that are handled by the

eDVA. 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}

See ‘‘Supported Dialing Features’’ on page 197 for a list of eDVA-supported

dialing features.
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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 183

# 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 con-
figuration is necessary to handle these features. The proxy itself defines what
feature is associated with a particular dialing code.

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 refer-
enced 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.

Feature Capabilities

Ten MIB objects allow control of certain features on a per-line basis. The
objects follow a naming convention of sipCfgfeatCapability, 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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

184 Chapter 4

The following table lists the controllable features and the corresponding MIB
object controlling its capability:
Feature MIB Object
Caller ID Display sipCfgCallerIdDisplayCapability
Caller ID Send sipCfgCallerIdSendCapability
Anonymous Call Rejection sipCfgAnonCallRejectionCapability
Call Waiting sipCfgCallWaitingCapability
Three Way Calling sipCfgThreeWayCallCapability
Call Transfer sipCfgCallTransferCapability
Call Forwarding sipCfgCallForwardCapability
Call Return sipCfgCallReturnCapability
Call Redial sipCfgCallRedialCapability
Call Holding sipCfgCallHoldCapability

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 sipCfgThree-
WayCallCapability from the configuration file and reset the modem.

For any of these changes to take effect, the modem needs to be reset to down-
load the updated configuration file.

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.
• 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 non-

INVITE messages.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 185

• Timers D and H — sipCfgInviteLinger

• Timer K — sipCfgGenLinger

Minimal Example The following configuration file fragment provides a minimal example of SIP
configuration.
set mcns_config_params {
{TelephonyConfigFileBeginEnd 1}

# eDVA 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 }

# 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"}

Firmware Guide Release 7.5 Standard 1.2 August 2012

186 Chapter 4

# 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}
}

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 187

Provisioning SIP Support

TS7.5 provides SIP support for eDVAs. This feature requires modifications
to the CM configuration file and a new eDVA configuration file. This feature
requires a specialized firmware load.

Per-Line The following table describes MIB objects for per-line proxy/registrar sup-
Proxy/Registrar port. These objects must be set in the configuration file to be effective. For
Objects details about the SIP registration process, see ‘‘SIP Registration Behavior’’
on page 177.
MIB Object
Description (Per-line)
Global Per-line
sipCfgRegistrarAdr sipCfgPortRegistrarAdr Registrar Server
sipCfgPortRegistrarPort Registrar Server port. The per-line set-
ting 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 sipCfgPort-
ProxyAdr.
sipCfgProxyType sipCfgPortProxyType The type of address specified by the
sipCfgPortProxyAdr object. It is only
valid if paired with a setting for sipCfg-
PortProxyAdr. When both objects are
defined in the configuration file, this
value overrides the setting in sipCfg-
ProxyType 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, sipCfgPort-
ProxyAdr.2 specifies the proxy IP address for line 2.

Note: Per-line proxy/registrar is a device-only change; it cannot be changed

using post-provisioning.

Firmware Guide Release 7.5 Standard 1.2 August 2012

188 Chapter 4

T.38 Provisioning The MIB object sipCfgPortT38Mode controls T.38 behavior. It allows the
Overview following values:
Value Description
t38Off(1) (default) Disables T.38.
t38Loose(2) Enables T.38 Loose mode. In loose mode, the
eDVA can use T.38 for fax transmission whether
or not the remote endpoint has indicated T.38
support.
t38Strict(3) Enables T.38 Strict mode. In strict mode, the
eDVA can use T.38 for fax transmission only if
the far end indicated support for T.38 during ses-
sion negotiation.

The MIB object arrisMtaDevEndPntFaxOnlyLineTimeout configures fax-

only 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 end-
point. If the time expires before detecting fax or modem tones, the eDVA
drops the call. Valid range: 0 to 600.
The MIB object sipCfgPortMaxT38HSRedLevel sets the maximum high-
speed 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 Fea- The sipCfgPortFeatureSettings object allows you to control operation of
ture Control 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 189

Bit Description
0x40 callerIdPermanentDisable
Set this bit to set the default outbound Caller ID method to
‘‘restrictive.’’ The default setting presents Caller ID.
0x20 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.
0x10 callWaitingPermanentDisable
Set this bit to disable Call Waiting. The subscriber can use a
‘‘star’’ code to enable Call Waiting if desired. The default set-
ting is to enable Call Waiting.
0x08 threeWayCallingDisable
Set this bit to disable hook flash processing during an active call.
The default setting is to allow hook flash processing.
0x04 callIdReceiptDisable
Set this bit to disable local CallerID display.
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 Per-
manent 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 reis-
sued 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 Fea- Ten MIB objects provide per-line control over common calling features,
ture Control 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 eDVA configuration file, and are not
persistent across reboots. The default value for all these objects is
0xFFFFFFFF (feature enabled on all lines).

Firmware Guide Release 7.5 Standard 1.2 August 2012

190 Chapter 4

Feature MIB Object

Caller ID Display sipCfgCallerIdDisplayCapability
Caller ID Send sipCfgCallerIdSendCapability
Anonymous Call Rejection sipCfgAnonCallRejectionCapability
Call Waiting sipCfgCallWaitingCapability
Three-way Calling sipCfgThreeWayCallCapability
Call Transfer sipCfgCallTransferCapability
Call Forwarding sipCfgCallForwardCapability
Call Return sipCfgCallReturnCapability
Call Redial sipCfgCallRedialCapability
Call Hold sipCfgCallHoldCapability

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

Action Perform the following tasks as necessary:

Task Page
CM Configuration File Changes 190
eDVA Configuration File Changes 190
Setting up Timers 193
Configuring Per-Line Proxy and Registrar 194
Specifying a SIP Domain Name 195

CM Configuration Follow these steps to modify the cable modem configuration file for SIP sup-
File Changes port.
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). PcIpSource-
PortStart and PcIpSourcePortEnd should be set to 5060 in both
UpstreamPacketClassification and DownstreamPacketClassifi-
cation.

2 (optional) Set the arrisMtaCfgRTPDynPortStart and arrisMtaCfg-

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

eDVA Configura- Follow these steps to enable SIP support in the eDVA configuration file.
tion File Changes 1 Modify the ppCfgMtaCallpFeatureSwitch object. To use QoS for a
SIP eDVA 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
eDVA transmits RTP packets using Best Effort. Other QoS-specific
settings may be needed depending on the CMTS (and its firmware
load) used.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 191

2 Enable the eDVA device by modifying the pktcMtaDevEnabled

object. The object is used to control the eDVA device; it is not line
specific. The value must be set to true to provide dial tone on individ-
ual lines.
3 To enable individual lines, set the ifAdminStatus object for the line to
1. The object ifAdminStatus.9 corresponds to line 1, ifAdminSta-
tus.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
object for each line. The user name should be the phone number asso-
ciated with the line. This will be used in the Caller ID string at a later
date.
For line specific provisioning, sipCfgPortUserName.1 and .2 (and so
on) represent the 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.
6 Enter the display name by modifying the sipCfgPortDisplayName
object. This is the display name in the SIP messages that will be used
for 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.
7 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. To provide login name privacy, this
setting when read displays as "XXXXXXX" (255 Max).
8 Enter the password by modifying the sipCfgPortPassword object.
The password is the paired requirement for the HTTP authentication
on SIP messages. In order to provide password privacy, this setting
when read displays as "XXXXXXX" (255 Max).
9 Enter the digit map specification by modifying the sipCfgDigitMap
object. The digit map support on ARRIS SIP eDVA 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 (see
‘‘Digit Map’’ on page 178 for details). The maximum length for the
digit map is 2048 characters.
Note 1: This digit map applies only to initial dialing. See ‘‘Configur-
ing Repeat Dialing’’ on page 200 to set up busy indication dialing.
Note 2: TS7.1 does not support TLV-43; therefore, you cannot use
TLV-43 and sub-TLV69 as in previous Touchstone firmware versions.
If the digit map is less than 255 octets, you can use TLV-11.

Firmware Guide Release 7.5 Standard 1.2 August 2012

192 Chapter 4

10 To define a ‘‘busy’’ digit map (that is, in effect when busy tone is
playing), specify the map using the sipCfgBusyDigitMap object. The
digit map format is the same as for the default digit map, and can be
set only in the configuration file.
11 If desired, modify the digit map timers:
• Tpar (partial dial time-out)—modify the pktcNcsEndPntConfigPar-
tialDialTO object. The default is 16 seconds.

• Tcrit (critical dial timeout)—modify the pktcNcsEndPntConfig-

CriticalDialTO object. The default is 4 seconds.

Note: SIP loads support the NCS digit map timers.

12 Set the SIP call feature switch by modifying the sipCfgSipFea-
tureSwitch object. Each bit corresponds to a supported SIP call fea-
ture. See ‘‘SIP Feature Switch’’ on page 85 for valid settings. The
default value is 0.
13 Enter the SIP provisioned CODEC by modifying the sipCfgProvi-
sionedCodecArray 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 (’;’). The
default string is ‘‘PCMU;PCMA.’’
14 Enter the packetization rate by modifying the sipCfgPacketization-
Rate object. The supported packetization rate is 20 milliseconds.

15 (optional) Set the arrisMtaCfgRTPDynPortStart and arrisMtaCfg-

RTPDynPortEnd 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.
16 (optional) Modify the sipCfgMaxUDPSize object to set the maximum
UDP packet size. SIP packets larger than this threshold are sent using
TCP.
Default: 0
17 Globally enable or disable calling features, if desired, by adding the
sipCfgPortFeatureSettings object. See ‘‘Call Feature Control’’ on
page 196 for a list of calling features this this object controls.
18 Enable or disable calling features on a per-line basis, if desired, by
adding the sipCfgfeatureCapability object for the specific features.
See ‘‘Per-line Call Feature Control’’ on page 189 for a list of calling
features that can be enabled or disabled on each line.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 193

Setting up Timers Touchstone firmware provides MIB objects for controlling the registration
and retransmission (T1) timers. These objects must be set in the eDVA con-
figuration file.
Note: The default values for these objects correspond to RFC 3261 guide-
lines.
1 To configure the registration wait time, set the sipCfgRegTimerMin
and sipCfgRegTimerMax objects to the desired minimum and maxi-
mum wait times.
The defaults for these objects are 0 and 1800 seconds, respectively.
At startup, an eDVA waits for a random amount of time (bounded by
these objects) before beginning registration.
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 INVITE Behavior
0 No Session-Expires header included.
1–89 The Session-Expires header includes a value of
1800.
90+ The Session-Expires header includes the value speci-
fied in the object.

Firmware Guide Release 7.5 Standard 1.2 August 2012

194 Chapter 4

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 sipCfg-
RegExpires 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 REGIS-
TER request.

Configuring Per- Follow these steps to provision per-line proxy and registrar. Each MIB
Line Proxy and object specified must be set in the eDVA configuration file. These objects
Registrar 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 sipCfgPort-
ProxyType objects in the eDVA 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 (1 to the number of lines
supported by the eDVA);
• 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 set-
ting the sipCfgPortRegistrarAdr, sipCfgPortRegistrarPort, and
sipCfgPortRegistrarType objects in the eDVA 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;

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 195

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

Specifying a SIP Follow these steps to specify a SIP domain name other than the domain spec-
Domain Name ified 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 eDVA ignores the ‘‘Domain Over-
ride" SIP Feature Switch setting.
2 Restart the eDVA to download and apply the updated configuration.

Firmware Guide Release 7.5 Standard 1.2 August 2012

196 Chapter 4

Provisioning SIP Features

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

Requirements and To provision SIP features, you must first modify the CM and eDVA configu-
Limitations ration files as described in ‘‘Provisioning SIP Support’’ on page 187.
You can provision up to 50 dialing features and up to 50 proxy dialing fea-
tures in the eDVA configuration file.

Call Feature The sipCfgPortFeatureSettings object allows you to control operation of

Control 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.
0x20 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.
0x10 callWaitingPermanentDisable
Set this bit to disable Call Waiting. The subscriber can use a
‘‘star’’ code to enable Call Waiting if desired. The default set-
ting is to enable Call Waiting.
0x08 threeWayCallingDisable
Set this bit to disable hook flash processing during an active call.
The default setting is to allow hook flash processing.
0x04 callIdReceiptDisable
Set this bit to disable local CallerID display.
0x02 callTransferEnable
Set this bit to enable Call Transfer. The bit can only be set in the
configuration file.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 197

Proxy Dialing Some dialing features require the eDVA to handle the tones, but the proxy
Features 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 Supported dialing features are:

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

Firmware Guide Release 7.5 Standard 1.2 August 2012

198 Chapter 4

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

Action Perform the following tasks as necessary:

Task Page
Setting up Dialing Features 198
Configuring Warmline or Hotline 199
Configuring Repeat Dialing 200
Configuring T.38 and Fax-Only Modes 201
Configuring Distinctive Ring/Alert Tones 202

Setting up Dialing Add the MIB objects described below to the eDVA configuration file to set
Features 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 exam-
ple, sipCfgDialFeatName.1 and sipCfgDialFeatName.2 are two different
features.
Note: Certain dialing features, including Hotline, Warmline, and Repeat Dial-
ing, require further configuration. See the appropriate task for any extended
configuration required.
1 Add the sipCfgDialFeatName object to enable particular dialing fea-
tures. See ‘‘Supported Dialing Features’’ on page 197 for a list of
supported 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 199

4 Add the sipCfgDialFeatActive object to assign a feature to one or

more lines on the eDVA. 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 Busy
0x01 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 eDVA handles the
tones, but the proxy handles the actual messaging—add the objects
described in ‘‘Proxy Dialing Features’’ on page 197.

Configuring The SIP load includes support for specifying a hotline or warmline number in
Warmline or the configuration file. A hotline automatically dials the specified number as
Hotline 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 eDVA configuration file to set up a
hotline or warmline for a specific line.
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 and *54 as the feature codes to enable and dis-
able 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

Firmware Guide Release 7.5 Standard 1.2 August 2012

200 Chapter 4

SnmpMib = sipCfgDialFeatName.16 warmlineDisable

SnmpMib = sipCfgDialFeatCode.16 "*54"
SnmpMib = sipCfgDialFeatTone.16 stutterTone
SnmpMib = sipCfgDialFeatActive.16 hexstr: 0.0.0.3

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 sipCfg-
PortWarmLineTimeout MIB object for the timeout. If the object is
not set for a line in the configuration file, the default is 5 seconds.
• A subscriber-specified warmline number replaces the value for
sipCfgPortWarmOrHotlineNumber that was specified in the con-
figuration file.
• The sipCfgPortWarmOrHotlineNumber MIB object, whether set
in the configuration file or by the subscriber, shows the currently-
configured warmline number. If the subscriber disables warmline,
This object contains a 0-length string.
• If you do not configure warmline feature codes, the number speci-
fied in sipCfgPortWarmOrHotlineNumber is permanent and can-
not be changed or disabled by the subscriber.

Configuring Follow these steps to configure the Repeat Dialing feature. Configuring any
Repeat Dialing busy indication dialing feature uses the same steps.
1 Add two entries to the sipCfgDialFeatTable in the eDVA configura-
tion 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 Repeat Dialing */
{SnmpMib sipCfgDialFeatName.1 Integer 62}
{SnmpMib sipCfgDialFeatCode.1 String "*5"}
{SnmpMib sipCfgDialFeatTone.1 Integer 1} /* stutter */
{SnmpMib sipCfgDialFeatActive.1 HexString 0x00000003}
{SnmpMib sipCfgDialFeatMode.1 Integer 2} /* busy mode only */

/* cancel Repeat Dialing */

{SnmpMib sipCfgDialFeatName.2 Integer 63}
{SnmpMib sipCfgDialFeatCode.2 String "#5"}
{SnmpMib sipCfgDialFeatTone.2 Integer 1} /* stutter */
{SnmpMib sipCfgDialFeatActive.2 HexString 0x00000003}

/* Repeat Dialing timer settings */

{SnmpMib sipCfgRepeatDialingInterval.0 10}
{SnmpMib sipCfgRepeatDialingTimeout.0 30}
{SnmpMib sipCfgRepeatDialingSessionProgressTimer.0 60}

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 201

2 Add the sipCfgBusyDigitMap MIB object to the eDVA configuration

file, specifying the strings that can be matched while the eDVA is
playing a busy tone:
SnmpMib = sipCfgBusyDigitMap.0 String "*x|#x";
3 Add the following MIB objects to the eDVA 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 unsuc-
cessful) before the eDVA cancels the feature. Default: 1800 sec-
onds.
sipCfgRepeatDialingSessionProgressTimer
The time, in seconds, the eDVA waits after receiving a ‘‘183
Session Progress’’ provisional response before alerting the sub-
scriber. This delay is needed because many PSTN calls receive
this response before receiving a negative INVITE. Default: 2
seconds.
Note: This object must be set in the configuration file. Changes
made to this object persist across reboots.
4 Reset the eDVA to enable the feature.

Configuring T.38 Follow these steps to configure T.38 and fax-only modes for a line. Each
and Fax-Only MIB object specified must be set in the eDVA configuration file.
Modes 1 Set the T.38 mode by adding the sipCfgPortT38Mode MIB object to
the eDVA configuration file. This MIB object is specific to a line, so
it must be specified with the line number; for example, sipCfg-
PortT38Mode.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 sipCfgPortFaxOnlyTimeout MIB
object to the eDVA configuration file. This MIB object is specific to a
line, so it must be specified with the line number; for example,
sipCfgPortFaxOnlyTimeout.1 for line 1. The value specifies the
timeout, in seconds, after which the eDVA drops the call if it does not
detect fax or modem tones.
Valid range: 0 (disabled) to 600 seconds. The default is 0.

Firmware Guide Release 7.5 Standard 1.2 August 2012

202 Chapter 4

Configuring Dis- Follow these steps to set the expected Alert-Info strings for distinctive ring-
tinctive Ring/Alert ing and alert (Call Waiting) tones. Each MIB object specified must be set in
Tones the eDVA configuration file. For more information, see ‘‘Distinctive Ring-
ing’’ on page 174.
1 In the eDVA configuration file, set the following MIB objects:
MIB Object Description
sipCfgAlertInfoR0 The value of the Alert-Info header field to
instruct the eDVA to play the R0 ring
cadence.
sipCfgAlertInfoR1 The value of the Alert-Info header field to
instruct the eDVA to play either the R1 ring
cadence (call not active) or the WT1 call
waiting tone (call active).
sipCfgAlertInfoR2 The value of the Alert-Info header field to
instruct the eDVA to play either the R2 ring
cadence (call not active) or the WT2 call
waiting tone (call active).
sipCfgAlertInfoR3 The value of the Alert-Info header field to
instruct the eDVA to play either the R3 ring
cadence (call not active) or the WT3 call
waiting tone (call active).
sipCfgAlertInfoR4 The value of the Alert-Info header field to
instruct the eDVA to play either the R4 ring
cadence (call not active) or the WT4 call
waiting tone (call active).
sipCfgAlertInfoR5 The value of the Alert-Info header field to
instruct the eDVA to play the R5 ring
cadence.
sipCfgAlertInfoR6 The value of the Alert-Info header field to
instruct the eDVA to play the R6 ring
cadence.
sipCfgAlertInfoR7 The value of the Alert-Info header field to
instruct the eDVA to play the R7 ring
cadence.

The default value for each MIB object is <file://Bellcore-

drx>, where x is the ring cadence (0 through 7). You may need to
change these if the P-CSCF sends different Alert-Info strings.
2 To configure distinctive ringing to alert the subscriber to a call on hold
when the line is on hook, set the sipCfgDistinctiveRingingForCall-
Hold object. The allowed values are:

• standard(0) (default) — use the standard ring cadence.

• r0(1) — use the R0 ring cadence.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Provisioning ARRIS SIP Loads 203

• r1(2) — use the R1 ring cadence.

• r2(3) — use the R2 ring cadence.
• r3(4) — use the R3 ring cadence.
• r4(5) — use the R4 ring cadence.
• r5(6) — use the R5 ring cadence.
• r6(7) — use the R6 ring cadence.
• r7(8) — use the R7 ring cadence.

Firmware Guide Release 7.5 Standard 1.2 August 2012

204 Chapter 4

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 5 Operations

Operations encompass automatic monitoring of environment, detecting and

determining faults and alerting admins.
Operation includes the following topics:
Topic Page
Battery Management 205
About IPv6 Support 208
IPv6 Management 211
Event Reporting 215
Event Summary 218
Network Failure Recovery 233
Working with Message Trace Logs 234
Capturing Signaling Traces 240
Configuring SNMP Coexistence 245
Configuring Trap Servers 258
TR-069 Management 261
Recovery from Partial Service 267
Model 8 Power Management 269
ARRIS DOCSIS 3.0 MIB 271
Supported eDVA MIB Objects 283
ARRIS-ROUTER-MIB Objects 308
ARRIS Speedtest MIB 357

Battery Management

Touchstone firmware provides a sophisticated management and monitoring

scheme to maximize battery hold times and extend the useful life of backup
batteries.

Firmware Guide Release 7.5 Standard 1.2 August 2012

206 Chapter 5

Initial Battery When the E-UE is powered up, whether for the first time or after replacing a
Charging battery, it begins a battery charging and testing sequence. See the Touchstone
Battery Reference Manual for details about the charging and testing
sequence.

Boot from Battery Touchstone E-UEs support a Boot from Battery feature, allowing an E-UE to
begin service without AC power.
To start an E-UE from a battery, follow these steps:
1 If a battery is installed in the E-UE, remove it.
2 Install the battery into the E-UE.
3 Press the Reset button on the back of the E-UE using a pointed, non-
metallic object.

Battery Telemetry Touchstone firmware provides battery telemetry through the following man-
agement interfaces:
• LED display
• Web-based interface
• CLI
• SNMP

Power Failure When an E-UE with battery backup capabilities loses AC power, it immedi-
Operation ately takes the following actions:
1 Shuts off some LEDs to conserve battery power.
2 Disables the ability to download new firmware until the AC power is
restored. This prevents corrupting the E-UE’s firmware load in case
the battery fails before the E-UE could complete the download.
3 Shuts down the data services running over all LAN ports after the
time specified by the arrisMtaDevPwrSupplyDataShutdownTime
object. The default time is 5 minutes for TG852 Telephony Gateways,
and 15 minutes for other models. To disable data shutdown alto-
gether, set the arrisMtaDevPwrSupplyEnableDataShutdown object
to disabled(2).
4 After the shutdown timer expires, Model 8 E-UEs disable bonded
mode, switching to 1x1 unbonded (see ‘‘Model 8 Power Manage-
ment’’ on page 269 for details).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 207

LED Changes LED Operation Changes During Battery Charging

The Battery LED only flashes when AC power is not present and the battery
is low, or else when the battery needs to be replaced. The Battery LED does
not flash during normal charging.

Installer Visual Indication of Foreign Loop Voltage

LEDs flash any time the line card transitions to the Line Card Over-current
Protection State. This indicates foreign voltage is present on the loop. This
condition occurs most often at installation time.

Battery Mismatch Indication

When an unsupported battery is inserted in a E-UE, it repeats the following

sequence:
• Battery LED on, all others off
• Battery LED off, all others on
The E-UE also sets a ‘‘Battery Mismatch’’ alarm. To clear this issue, replace
the battery with one of the proper type.

Battery Status Touchstone firmware provides battery status monitoring through SNMP. Bat-
Monitoring tery MIB objects provide an estimate of remaining battery charge as a per-
centage of full charge, and in minutes remaining to depletion.
E-UEs have battery charger hardware that reports an accurate estimate of bat-
tery capacity within 5 minutes of initialization.
The ‘‘Power Supply Telemetry’’ alarms and logs provide a report of any sta-
tus changes to the power system, including the battery and the charger.

Highest Charger Touchstone firmware provides a feature to record and report the historic high
Temperature charger temperature. These MIB objects are available only when the arris-
Recording MtaDevPwrSupplyOverTempAlarmControl object is enabled.

arrisMtaDevPwrSupplyHighestTemperature
Provides the highest temperature, in degrees C, recorded by the bat-
tery charger.
arrisMtaDevPwrSupplyHighestTemperatureTime
Provides the date and time that the E-UE recorded the high tempera-
ture.
arrisMtaDevPwrSupplyHighestTemperatureClear
Resets the highest temperature and time data.

Firmware Guide Release 7.5 Standard 1.2 August 2012

208 Chapter 5

About IPv6 Support

IPv6 allows cable operators to expand their IP address ranges for cable
modems, allowing reclamation of traditional IPv4 addresses for use with
eDVAs. TS7.5 supports the following IPv6-related protocols:
• DHCPv6
• DNSv6
• TFTPv6
• TODv6
• SNMPv6
• TELNETv6
• HTTPv6
• SSHv6
Note: Touchstone firmware does not support Early Authentication and
Encryption (EAE) functionality.

Supported Hard- Touchstone firmware supports single- and dual-stack CPE traffic on all
ware Model 8 Touchstone devices as follows:
CM provisioned and managed in IPv6 mode:
• supports single stack IPv4 traffic to and from CPEs.
• supports single stack IPv6 traffic to and from CPEs.
• supports IPv4 and IPv6 traffic simultaneously to and from CPEs.
CM provisioned and managed in IPv4 mode:
supports IPv4 and IPv6 traffic simultaneously to and from CPEs.
TS7.5 and newer versions of Touchstone firmware support IPv6 operation on
all Model 8 Data Gateway and Telephony Gateway products.
Note: IPv6 operation is supported only on the cable modem (CM) and
eRouter components of Touchstone products. The eDVA component sup-
ports only IPv4 operation.

IPv6 Multicast TS7.5 supports multicast forwarding as described below.

Support

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 209

Before Registration

The CM:
• filters multicast traffic not addressed to the IPv6 Link Local Scope All
Nodes Address or the Solicited Node Addresses.
• learns the pre-registration DSID from the MDD message.
• forwards pre-registration multicast traffic to its IP stack based on the
pre-registration DSID as defined in the ‘‘DSID based Filtering and For-
warding by a Cable Modem’’ section of CM-SP-
MULPIv3.0-I12-100115.

During Registration

The CM reports the following IPv6 multicast capabilities in DHCP Option

125:
Sub-
Description Value
Option
32 Multicast DSID support 24
Multicast DSID forwarding
33 2
(GMAC promiscuous)
34 Frame Control Type forwarding 1

After Registration

The CM:
• stops forwarding multicast traffic labeled with the Pre-Registration
DSID, after receiving the REG-RSP message.
• forwards multicast traffic based on the DSIDs and Group MAC
Addresses received in the REG-RSP message, as specified by the
‘‘DSID based Filtering and Forwarding by a Cable Modem’’ section of
CM-SP-MULPIv3.0-I12-100115.
• filters multicast traffic based on DSIDs and Group MAC Addresses
received in the REG-RSP message. The CMTS always includes the
IPv6 Link Local Scope All Nodes Address, and the CMâs Solicited
Node Addresses, in the REG-RSP message.
• supports Multicast DSID Encodings (TLV 50.4) described in the ‘‘Mul-
ticast Encodings’’ section of CM-SP-MULPIv3.0-I12-100115, as well
as Security Association Encodings (TLV 51) described in the ‘‘Security
Association Encoding’’ section of CM-SP-MULPIv3.0-I12-100115,
received in the REG-RSP message.

Firmware Guide Release 7.5 Standard 1.2 August 2012

210 Chapter 5

• uses the Dynamic Bonding Change mechanism defined in CM-SP-

MULPIv3.0-I12-100115, to maintain and learn new DSID values and
Security Associations for IPv6 multicast.
The CM also forwards Neighbor Discovery packets sent to:
• The CPEs’ Solicited Node multicast IPv6 addresses
• The All Nodes multicast address onto CPE ports
Neighbor Discovery forwarding can be controlled by configuring filters to
allow or prohibit forwarding.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 211

IPv6 Management

Managing Touchstone E-UEs using IPv6 addressing in the CM and IPv4

addressing in the eDVA require SNMP management software capable of
handing both IPv4 & IPv6, or separate tools for CM and eDVAs.

Filtering IPv6 TS7.5 supports the following filtering-related features:

Traffic • MLD Snooping
• Upstream Drop Classifiers
Each of these features is described below.

MLD Snooping

MLD Snooping allows CPE devices using either MLDv1 or MLDv2 to

acquire IPv6 addresses, and to register and receive multicast IPv6 down-
stream traffic. Unless filters specifically prohibit it, MLD Snooping allows
all multicast IPv4 and IPv6 traffic to pass.
Note 1: BPI treats IPv6 multicast traffic like normal traffic (IPv4 multicast
traffic is treated as multicast).
Note 2: In TS7.5, MLDv2 Source Filtering is ignored.
When the CM receives a DOCSIS Reinit-MAC command, it clears the MLD
database and downstream IPv6 multicast filtering records.

Upstream Drop Classifiers

An Upstream Drop Classifier is a Classifier created by the CM to filter

upstream traffic. The CM performs IP protocol filtering using either
Upstream Drop Classifiers or IP filters.
If a packet matches the specified packet-matching criteria of an Upstream
Drop Classifier, it is dropped. Unlike QoS Classifiers, Upstream Drop Clas-
sifiers do not refer to a Service Flow.
TCP/UDP Packet Classification Encodings are defined for IPv4 or IPv6 and
may be present in a Service Flow Classifier of either type. If those classifiers
are present in combination with IPv6 classifier encodings, they apply to the
IPv6 classifiers.
The CM reports the number of Upstream Drop Classifiers supported, using
the Upstream Drop Classification Support capability (TLV 5.38) in the Regis-
tration Request message.

Firmware Guide Release 7.5 Standard 1.2 August 2012

212 Chapter 5

Coexistence TS7.5 supports SNMPv6 co-existence for both the ARRIS version of coexis-
tence and coexistence using the coexistence MIBs.
The following is an example provisioning file fragment for setting up co-
existence.
SnmpMib = snmpCommunityStatus.rocablelabs createAndGo
SnmpMib = snmpCommunityName.rocablelabs "ro_cm"
SnmpMib = snmpCommunitySecurityName.rocablelabs "rotesting1"
SnmpMib = snmpCommunityStorageType.rocablelabs volatile
SnmpMib = snmpCommunityStatus.rwcablelabs createAndGo
SnmpMib = snmpCommunityName.rwcablelabs "rw_cm"
SnmpMib = snmpCommunitySecurityName.rwcablelabs "rwtesting1"
SnmpMib = snmpCommunityStorageType.rwcablelabs volatile
SnmpMib = vacmSecurityToGroupStatus.1 rotesting1 createAndGo
SnmpMib = vacmGroupName.1 rotesting1 "rotesting2"
SnmpMib = vacmSecurityToGroupStorageType.1 rotesting1 volatile
SnmpMib = vacmSecurityToGroupStatus.1 rwtesting1 createAndGo
SnmpMib = vacmGroupName.1 rwtesting1 "rwtesting2"
SnmpMib = vacmSecurityToGroupStorageType.1 rwtesting1 volatile
SnmpMib = vacmSecurityToGroupStatus.2 rotesting1 createAndGo
SnmpMib = vacmGroupName.2 rotesting1 "rotesting2"
SnmpMib = vacmSecurityToGroupStorageType.2 rotesting1 volatile
SnmpMib = vacmSecurityToGroupStatus.2 rwtesting1 createAndGo
SnmpMib = vacmGroupName.2 rwtesting1 "rwtesting2"
SnmpMib = vacmSecurityToGroupStorageType.2 rwtesting1 volatile
SnmpMib = vacmAccessStatus.rotesting2 1 1 createAndGo
SnmpMib = vacmAccessContextMatch.rotesting2 1 1 exact
SnmpMib = vacmAccessReadViewName.rotesting2 1 1 "docsisManagerView"
SnmpMib = vacmAccessStorageType.rotesting2 1 1 volatile
SnmpMib = vacmAccessStatus.rwtesting2 1 1 createAndGo
SnmpMib = vacmAccessContextMatch.rwtesting2 1 1 exact
SnmpMib = vacmAccessReadViewName.rwtesting2 1 1 "docsisManagerView"
SnmpMib = vacmAccessWriteViewName.rwtesting2 1 1 "docsisManagerView"
SnmpMib = vacmAccessStorageType.rwtesting2 1 1 volatile
SnmpMib = vacmAccessStatus.rotesting2 2 1 createAndGo
SnmpMib = vacmAccessContextMatch.rotesting2 2 1 exact
SnmpMib = vacmAccessReadViewName.rotesting2 2 1 "docsisManagerView"
SnmpMib = vacmAccessStorageType.rotesting2 2 1 volatile
SnmpMib = vacmAccessStatus.rwtesting2 2 1 createAndGo
SnmpMib = vacmAccessContextMatch.rwtesting2 2 1 exact
SnmpMib = vacmAccessReadViewName.rwtesting2 2 1 "docsisManagerView"
SnmpMib = vacmAccessWriteViewName.rwtesting2 2 1 "docsisManagerView"
SnmpMib = vacmAccessStorageType.rwtesting2 2 1 volatile
SNMPV3Kickstart =
SNMPV3SecurityName = "docsisManager"
SNMPV3PublicNumber = hexstr: C1.FC.52.36.97.06.C0.22.99.61.D5.CA.C5.
4F.C6.68.51.71.A8.DC.69.AB.EB.D6.21.AC.AC.1D.FC.A6.0A.3A.8E.77.B5.15.AB.
AC.60.7C.5F.EB.AF.5F.86.B8.3F.2B.A1.DB.3D.ED.51.E2.EB.5D.E0.6A.EB.2D.AE.
E3.A4.DA.AC.DA.30.42.DC.A2.3C.5B.FE.65.83.B8.B8.9E.48.02.FB.70.A5.E9.97.
0C.95.9F.96.44.B4.BA.B4.2C.71.97.D1.1A.96.99.C9.4F.9C.53.3F.00.24.3E.1A.
12.AB.23.CF.DB.05.6C.97.62.4B.B2.A3.FC.7D.91.F4.90.C7.7C

DHCPv6 MIB The following MIB objects indicate the DHCP mode (v4 or v6) and assigned
Objects IP address. The address type for each object is one of the following:
ipv4(1):
DHCPv4

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 213

ipv6(2):
DHCPv6
ipv4z(3):
IPv4 non-global address with a zone index
ipv6z(4):
IPv6 non-global address with a zone index
dns(16):
DNS domain name
The objects are:
docsDevServerDhcpAddressType
The IP address type of the assigned address, or unknown(0) if the
IP address was statically assigned.
docsDevServerDhcpAddress
The IP address assigned to the CM, or an empty string if the IP
address was statically assigned.
The following MIB objects indicate the IP address and type of the assigned
time and TFTP servers:
docsDevServerTimeAddressType
The IP address type for the time server.
docsDevServerTimeAddress
The IP address of the time server.
docsDevServerConfigTftpAddressType
The IP address type of the TFTP server.
docsDevServerConfigTftpAddress
The IP address of the TFTP server.
The Syslog server address must be configured manually, either through an
SNMP manager or the configuration file. In either case, the following two
objects must be set in the order shown:
docsDevEvSyslogAddressType
The IP address type; either 1 (IPv4) or 2 (IPv6).
docsDevEvSyslogAddress
The IP address of the Syslog server, or a blank string to disable Sys-
log transmission.
The following read-only MIB objects are part of arrisCmDoc30DhcpCmPa-
rameters, and provide DHCP information.

arrisCmDoc30DhcpCmIpAddrType
(read-only) The type of the currently leased IP address.

Firmware Guide Release 7.5 Standard 1.2 August 2012

214 Chapter 5

arrisCmDoc30DhcpCmIpAddr
(read-only) The currently leased IP address.
arrisCmDoc30DhcpCmSubNetMask
(read-only) The current IP subnet mask in use.
arrisCmDoc30DhcpCmGatewayIpAddr
(read-only) The current IP gateway address in use.
arrisCmDoc30DhcpCmConfigFile
(read-only) The CM configuration file name.

SNMP Access The CM expects SNMP access to use the same IP mode (IPv4 or IPv6) that it
is provisioned with.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 215

Event Reporting

TS7.5 supports PacketCable 1.0 event reporting functionality and a number

of proprietary ARRIS events. The following enterprise numbers may appear
in events generated by Touchstone E-UEs:
Number Source
4115 ARRIS
4491 PacketCable

Collecting Events Events may be collected by:

• The docsDevEventTable MIB (part of the DOCS-CABLE-DEVICE-
MIB) in the E-UE keeps CM events until the E-UE is rebooted or pow-
ered down.
• The pktcDevEventTable MIB (part of the PKTC-EVENT-MIB) in the
E-UE keeps eDVA events until the E-UE is rebooted or powered down.
The default configuration stores events only in the local event tables.
• A specified Syslog server (specify a Syslog server using the pktcDev-
EvSyslogAddress object).

• SNMP servers (the E-UE sends the events in a pktcDevEventNotify

message). See ‘‘Event Formats’’ below for details.

Event Formats TS7.5 firmware provides log messages for both the cable modem and eDVA
sections of the Touchstone E-UE.

Cable Modem Log Format

Cable modem logs require the DOCS-CABLE-DEVICE-MIB. Cable

modem log messages consist of the following information:
• EventIndex—Provides relative ordering of the objects in the event log.
The value of this object always increases except when:
– the log is reset using the docsDevEvControl object
– the device reboots and does not implement non-volatile storage for
this log
– the value reaches 231 (the index is a 32-bit counter that rolls over to
zero at this limit)
The next value for all the above cases is 1.

Firmware Guide Release 7.5 Standard 1.2 August 2012

216 Chapter 5

• EventFirstTime—The time that this entry was created.

• EventLastTime—If multiple events are reported via the same entry, the
time that the last event for this entry occurred, otherwise this should
have the same value as EventFirstTime.
• EventCounts—The number of consecutive event instances reported by
this entry. This starts at 1 with the creation of this row and increments
by 1 for each subsequent duplicate event.
• EventLevel—The priority level of this event as defined by the vendor.
These are ordered from most serious (emergency) to least serious
(debug).
• EventId—For this product, uniquely identifies the type of event that is
reported by this entry.
• EventText—Provides a human-readable description of the event,
including all relevant context.

eDVA Log Format

eDVA logs function within the context of the PKTC-EVENT-MIB. eDVA

log messages consist of the following information:
• Event Index—Provides relative ordering of the objects in the event log.
This also serves as a indicator of event sequence. The object value
always increases except when:
– the log is reset using the pktcDevEvControl object
– the device reboots and does not implement non-volatile storage for
this log
– the value reaches 231 (the index is a 32-bit counter that rolls over to
zero at this limit)
The next entry for all the above cases is 1.
• Event Time—Provides a human-readable description of the time at
which the event occurred.
• Event Level—The priority level of this event as defined by the vendor.
• Event Enterprise number—The IANA enterprise number: 4115 for
ARRIS events, 4491 for PacketCable events.
• Event ID—ID for a specific event to which the priority and display
string are matched. Event IDs are vendor specific.
• Event Text—The text message associated with the event. Corresponds
to the pktcDevEvFixedText or pktcDevEvProgrammableText MIB
objects.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 217

• Mac Address—Provides the MAC address of the device generating the

event.
• FQDN/Endpoint ID—The FQDN or IP address of the device, with an
endpoint identifier. If the event is not specific to an endpoint, the identi-
fier is simply the FQDN or IP address. If the event is specific to an end-
point, the format is AALN/X:FQDN/IP address. If the event is battery
related, the format is FQDN/IP address:BATT_PORT:X.
Note: If the arrisMtaDevEventHideMacFQDNandIPAddress is set to
enable(1), the endpoint FQDN and IP address are masked with asterisk
(*) characters as described below.

Hiding FQDN and The Event Log web page, described in ‘‘Using the Web-based Troubleshoot-
IP Information in ing Interface’’ on page 439, displays the FQDN (or IP address) of the eDVA
the Event Log for eDVA-related events in the Endpoint Name field. TS7.5 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 arrisMtaDevEvent-
HideMacFQDNandIPAddress MIB object to enabled(1) in the CM
or eDVA configuration file and reboot the eDVA.
For basic users, the Event Log page replaces FQDN and IP informa-
tion 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 arrisMtaDevEventHideMacFQDNand-
IPAddress object.

2 To display FQDN and IP information to all users, set the arrisMta-

DevEventHideMacFQDNandIPAddress object to disabled(0) in the
CM or eDVA configuration file and reboot the eDVA. This is the
default setting.

Firmware Guide Release 7.5 Standard 1.2 August 2012

218 Chapter 5

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

References The following CableLabs® specifications define the PacketCable 1.0 event
reporting mechanism:
PKT-SP-MEM1.5-I03-070412
PacketCable Management Event Mechanism
PKT-SP-EVEMIB1.5-I02-050812
PacketCable Management Event MIB Specification
PKT-TR-MEMEVENT-ID-V01-0000929
PacketCable Management Event Identifiers

Event Summary

Touchstone firmware generates events (alarms and log messages) from both
the CM and eDVA components. This manual documents only ARRIS-spe-
cific events; for DOCSIS CM events, see the DOCSIS 3.0 Operations Sup-
port System Interface Specification, CM-SP-OSSIv3.0-I15-100115.

Event Handling Events may be collected at:

• The docsDevEventTable (part of the DOCS-CABLE-DEVICE-MIB)
in the E-UE keeps CM logs until the E-UE is rebooted or powered
down.
• The pktcDevEventTable (part of the PKTC-EVENT-MIB) in the E-UE
keeps eDVA logs until the E-UE is rebooted or powered down. The
default configuration stores logs only in the local event tables.
• A specified Syslog server (specify a Syslog server using the pktcDev-
EvSyslogAddress object).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 219

• SNMP servers (the E-UE sends the log in a pktcDevEventNotify mes-

sage).

eDVA States The following is a list of valid eDVA states and their meanings. The
ppSurvMtaMaintState object contains the current state.

• In Service, Normal—the eDVA is operating normally.

• In Service, Trouble—the eDVA is providing service, but a problem has
been detected (typically loss of AC power).
• Out of Service—the eDVA is out of service due to a detected problem.
Both voice and data services may be affected.

eDVA Line States The following is a list of valid eDVA line states and their meanings. The
value of the ppSurvPortMaintState object provides the current line state.
• In Service, Normal—the line is operating normally.
• In Service, Trouble, Family Equipment Failure—a problem with the
eDVA subsystem is preventing the line from functioning properly. All
lines in this state may indicate that the eDVA failed to download its
firmware image.
• In Service, Trouble, Test Failed—the line failed diagnostics. The
‘‘Voice Line Diag Failed’’ log provides more details.
• In Service, Trouble, Diagnostics—the line is running diagnostics; if no
problems are discovered, the line will be placed in service when diag-
nostics are finished.
• In Service, Trouble, Line Card Protection—the line card is in an over-
current protection state. This state usually indicates either a short
between tip and ring, or a foreign voltage being applied to tip and ring.
• Out of Service, Normal, Unprovisioned—the line is not provisioned but
has no known problems.
• Out of Service, Normal—the line card is out of service and provisioned,
but has no known problems.
• Out of Service, Trouble—the line is out of service due to a detected
problem.
• Out of Service, Trouble, Diagnostics—the line is out of service, and is
running diagnostics.
• Out of Service, Trouble, Line Card Protection—the line card is in an
overcurrent protection state. This state usually indicates either a short
between tip and ring, or a foreign voltage being applied to tip and ring.

Firmware Guide Release 7.5 Standard 1.2 August 2012

220 Chapter 5

E-UE Battery The following is a list of valid battery states for E-UEs with battery backup.
States The value of the arrisMtaDevBatteryOperState object provides the current
battery state.
• The E-UE is operating on AC power. The battery is charged and in
good condition.
• The E-UE is operating on battery power.
• The E-UE is operating on AC power, but during a power outage has
drawn down the battery to the capacity indicated by the arrisMtaDev-
PwrSupplyLowBatteryThresh object.

• The E-UE is operating on AC power. However, in addition to the Bat-

tery Low condition described above, the battery has deteriorated and
should be replaced.
• The E-UE has nearly exhausted its battery power, and will lose power if
AC power is not restored within a few minutes.
• The battery has been removed or has failed in such a way to appear to
be removed.
• The E-UE does not support battery telemetry.
• Indicates a possible problem with the E-UE or the battery system.
• Shorted (Touchstone Telephony Modem only) The battery has either
been installed backwards or the terminals have been shorted.
• The E-UE is operating from battery power, and has entered the ‘‘Bat-
tery Low’’ condition described above.
• The E-UE is operating from battery power. In addition, the battery has
deteriorated as described in ‘‘Battery Replace’’ above and should be
replaced.
• The E-UE is operating from battery power, and has entered the ‘‘Bat-
tery Low’’ condition described above. In addition, the battery has dete-
riorated as described in ‘‘Battery Replace’’ above and should be
replaced.
• The E-UE is testing the battery and charger system.
• The E-UE has twice failed (initial attempt and one retry) to download
charger firmware. This indicates a hardware problem with the E-UE.
The battery charger is disabled and backup battery power is not avail-
able.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 221

eDVA Event The following is a list of ARRIS and PacketCable eDVA events that the
Summary TS7.5 firmware can generate. Go to the indicated page for further details on
each event.
Ent. ID Severity Log Text Page
4115 1 information(5) Voice Line Diag Failed 222
4115 2 information(5) Voice Line Diag Passed 223
4115 3 information(5) Voice Line State Change 223
4115 6 information(5) Voice Line Protection State Change 223
4115 14 information(5) Power Supply Telemetry Log 224
4115 16 information(5) MTA TFTP: Successful 224
4115 26 information(5) MTA PROV: Successful! 224
4115 65523 information(5) SIP General Failure 224
4115 65524 information(5) SIP Network Failure 225
4115 65526 information(5) SIP Authentication Failure 225
4115 65527 information(5) SIP Registration Timeout 225
4115 65528 information(5) SIP Proxy Loss of Communications 226
4115 1065562 information(5) MTA DHCP RENEW: Lease Renewal delay; Voice line offhook 229
4115 1065563 information(5) MTA DHCP REBIND: Lease Renewal delay; Voice line offhook 230
4115 65529 major(2) Power Supply Telemetry Alarm 230
4115 2417164301 information(5) SSH LOGIN ACCEPTED 226
4115 2417164302 information(5) SSH LOGIN REJECTED 226
4115 2417164303 information(5) SSH LOGIN REJECTED - MAX ATTEMPTS 227
4115 2417164296 information(5)
Touchstone SW Upgrade Failed Before Download Attempt 227
4115 2417164297 information(5)
Touchstone SW Upgrade Failed 228
4115 2417164298 information(5)
Touchstone SW Upgrade Successful 228
4115 2417164299 minor(3) Touchstone SW Upgrade Aborted due to Battery AC-FAIL Con- 229
dition
4115 2417164304 minor(3) Touchstone SW Upgrade Aborted due to Call in Progress 229
4115 2417164305 information(5) Touchstone SW Upgrade Reboot Delayed due to Call in Progress 229
4115 2417164308 information(5) Gateway has reset 230
4115 2417164309 information(5) Unit has been restored to factory defaults 231
4115 2417164311 information(5) Speedtest Results 231
4491 65528 minor(3) Battery Not Low 232
4491 65529 minor(3) Battery Low 232
4491 65530 minor(3) Battery Present 232
4491 65531 minor(3) Battery Missing 232
4491 65532 minor(3) Battery Good 232
4491 65533 minor(3) Replace Battery 232
4491 65534 minor(3) AC Restored 232
4491 65535 minor(3) AC Fail 232

Firmware Guide Release 7.5 Standard 1.2 August 2012

222 Chapter 5

ARRIS Events

The following are ARRIS eDVA-related events. ARRIS events use the enter-
prise number 4115.

Voice Line Diag The eDVA has failed manual diagnostics for the specified line.
Failed Format:
Voice Line Diag Failed, Line Number = line, Failure Reason = rea-
son
Fields:
The fields are as follows:
• line—The line number that failed diagnostics. The first line is
line 1.
• reason—one of the following:
– Line is Unprovisioned
– Invalid State to Init Diags
– Power/Clock Failure
– SLAC Revision Failure
– MPI Failure
– PCM Failure
– Standby Hook Failure
– Active Hook Failure
– VF Failure
– Ringing Failure
Action:
Use the reason code to determine the course of action as follows:
• Line is Unprovisioned—Provision the line and re-try the diagnos-
tics.
• Invalid State to Init Diags—Set the line state to oos and re-try the
diagnostics.
• others—Reset the eDVA and re-try diagnostics. If the problem
persists, replace the E-UE.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 223

Voice Line Diag Indicates that the eDVA has successfully completed manual diagnostics on
Passed the specified line.
Format:
Voice Line Diag Passed, Line Number = line
Fields:
line indicates the line that passed diagnostics. The first line is
line 1.
Action:
None.

Voice Line State The eDVA received an operator-requested state change for the specified line.
Change Format:
Voice Line State Change, Line Number = line, Prev State =
old_state, New State = new_state
Fields:
The fields are as follows:
• line—the line number that changed state. The first line is line 1.
• old_state, new_state—the previous and current line states; see
‘‘eDVA Line States’’ on page 219 for details.
Action:
If the new state indicates a trouble condition, correct the problem.

Voice Line Protec- The specified line has detected or cleared a protection fault.
tion State Change Format:
Voice Line Protection State Change, Line Number = line, New State
= new_state
Fields:
The fields are as follows:
• line—the line number that changed state. The first line is line 1.
• new_state—the current protection state; one of:
– Fault DETECTED
– Fault CLEARED
Action:
Monitor the E-UE for service issues and possible replacement.

Firmware Guide Release 7.5 Standard 1.2 August 2012

224 Chapter 5

Power Supply The E-UE has detected a change in its battery telemetry state.
Telemetry Log Format:
Power Supply Telemetry - state
Fields:
The state field reflects the telemetry state; see ‘‘E-UE Battery
States’’ on page 220 for details. If a Replace Battery condition per-
sists for 24 hours, the E-UE generates another Power Supply
Telemetry log.
Action:
Replace the E-UE battery if indicated by the telemetry state.

MTA TFTP: Suc- The E-UE successfully downloaded its eDVA provisioning file.
cessful Format:
MTA TFTP: Successful
Action:
None.

MTA PROV: Suc- The E-UE successfully completed its eDVA provisioning.
cessful! Format:
MTA PROV: Successful!
Action:
None.

SIP General Fail- Severity

ure Major, service-affecting
Cause
The registration request failed with a 4xx, 5xx, or 6xx error (other
than 401 or 407) and authorization has already been sent.
Impact
The eDVA is unable to register. Data communications are not nec-
essarily affected.
Action
Check the server logs for the error message associated with the reg-
istration request and correct the problem as required.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 225

SIP Network Fail- Severity

ure Major, service-affecting
Cause
An invalid domain name for registration was specified and the DNS
server could not resolve the name.
Impact
The eDVA is unable to register. Data communications are not nec-
essarily affected.
Action
Correct the domain name, or add the domain name to the DNS
server.

SIP Authentication Severity:

Failure Major, service-affecting
Cause:
(SIP loads only) Telephony Modem can not be authenticated by the
P-CSCF.
Impact:
Telephony is disabled. Data communications are not necessarily
affected.
Action:
Verify that the authentication strings in the eDVA configuration file
match those expected by the P-CSCF.

SIP Registration Severity:

Timeout Major, service-affecting
Cause:
(SIP loads only) Telephony Modem lost communications to the SIP
registry server.
Impact:
Telephony is disabled. Data communications are not necessarily
affected.
Action:
Check the communications path between the eDVA and the SIP reg-
istry server.

Firmware Guide Release 7.5 Standard 1.2 August 2012

226 Chapter 5

SIP Proxy Loss of Severity:

Communications Major, service-affecting
Cause:
(SIP loads only) Telephony Modem lost communications to the P-
CSCF and can not initiate calls.
Impact:
eDVA cannot initiate calls. Data communications are not necessar-
ily affected.
Action:
Check the communications path between the eDVA and the P-
CSCF.

SSH LOGIN AC- A user has successfully logged into the Telephony Modem using SSH.
CEPTED Format:
SSH LOGIN ACCEPTED FROM IP [ipaddr] . USERNAME -
(name).
Fields:
The ipaddr is the IP address (e.g. 192.168.42.42) of the client log-
ging into the Telephony Modem. The name field is the user name
entered. The num field is the number of unsuccessful login attempts
since the last successful login.
Action:
None.

SSH LOGIN RE- A user has unsuccessfully attempted to log into the Telephony Modem using
JECTED SSH.
Format:
SSH LOGIN REJECTED FROM IP [ipaddr] . USERNAME -
(name).
Fields:
The ipaddr is the IP address (e.g. 192.168.42.42) of the client log-
ging into the Telephony Modem. The name field is the user name
entered.
Action:
None. However, a large number of unsuccessful login attempts may
indicate a potential intrusion attempt.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 227

SSH LOGIN RE- A user unsuccessfully attempted to log in too many times. The session was
JECTED - MAX AT- disconnected.
TEMPTS Format:
REACHED SSH LOGIN REJECTED - MAX ATTEMPTS REACHED
Action:
Continue to monitor the logs for ‘‘SSH LOGIN REJECTED’’ mes-
sages. Blocking the IP addresses of any attempted intruders may be
necessary to protect your network.

Touchstone Touchstone Firmware Upgrade failed before attempting a download.

Firmware Upgrade Format:
Failed Before Touchstone Firmware Upgrade Failed Before Download Attempt:
Download Attempt reason
Fields:
The reason description is one of the following:
• Provisioned upgrade, bad IP address in arrisCmDoc30SwTable
Download initiated via configuration file has failed. A match was
found in the ARRIS table but the IP address was invalid. No
download was attempted.
• Provisioned upgrade, bad filename in arrisCmDoc30SwTable
Download initiated via configuration file has failed. A match was
found in the ARRIS table but the filename was invalid. No down-
load was attempted.
• Provisioned upgrade, no match in arrisCmDoc30SwTable
Download initiated via configuration file has failed. No match
was found in the ARRIS table. No download was attempted.
• Manual upgrade, bad IP address in arrisCmDoc30SwTable
Download initiated via remote SNMP browser has failed. A
match was found in the ARRIS table but the IP address was
invalid. No download was attempted.
• Manual upgrade, bad filename in arrisCmDoc30SwTable
Download initiated via remote SNMP browser has failed. A
match was found in the ARRIS table but the file name was
invalid. No download was attempted.
• Manual upgrade, no match in arrisCmDoc30SwTable
Download initiated via remote SNMP browser has failed. No
match was found in the ARRIS table. No download was
attempted.

Firmware Guide Release 7.5 Standard 1.2 August 2012

228 Chapter 5

• Manual upgrade, device not in operational state

Download initiated via remote SNMP browser has failed. Device
not in the operational state. This is also the error returned when
arrisCmDoc30SwAdminStatus is set to upgradeFromArrisMgt
in a configuration file.
Action:
Correct the data in the upgrade table or on the TFTP server as nec-
essary, then retry the download.

Touchstone Touchstone Firmware Upgrade has failed. Standard DOCSIS download logs
Firmware Upgrade should also be present to further describe the exact download failure reason.
Failed Format:
Touchstone Firmware Upgrade Failed: type
Fields:
The type code is one of the following:
• Provisioned upgrade
Download initiated via configuration file has failed.
• Manual upgrade
Download initiated via remote SNMP browser has failed.
Action:
Make sure the upgrade table and the specified TFTP servers are con-
figured properly, then retry the download.

Touchstone Touchstone Firmware Upgrade has succeeded. Standard DOCSIS download

Firmware Upgrade logs may also be present.
Successful Format:
Touchstone Firmware Upgrade Successful: type
Fields:
The type code is one of the following:
Provisioned upgrade
Download initiated via configuration file has succeeded.
Manual upgrade
Download initiated via remote SNMP browser has succeeded.
Action:
None.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 229

Touchstone SW Touchstone Firmware Upgrade has failed since the E-UE is running on bat-
Upgrade Aborted tery power.
due to Battery AC- Format:
FAIL condition Touchstone SW Upgrade Aborted due to Battery AC-FAIL condi-
tion
Fields:
None
Action:
Wait for AC power to be restored before attempting the firmware
upgrade again.

Touchstone SW Touchstone Firmware Upgrade has failed since one or more lines are off-
Upgrade Aborted hook and the arrisMtaDevSwDnldNoSvcImpact object is set to StrictEn-
due to Call in Pro- able(2).
gress Format:
Touchstone SW Upgrade Aborted due to Call in Progress
Fields:
None
Action:
Wait for all lines to go on-hook before attempting the firmware
upgrade again.

Touchstone SW Touchstone Firmware Upgrade has succeeded, but the E-UE has not rebooted
Upgrade Reboot since one or more lines are off-hook and the arrisMtaDevSwDnldNoSvc-
Delayed due to Impact object is set to enable(1).
Call in Progress Format:
Touchstone SW Upgrade Reboot Delayed due to Call in Progress
Fields:
None
Action:
None; the E-UE will reboot once all lines have been idle for at
least 30 seconds after the load has been accepted.

MTA DHCP RE- The eDVA DHCP RENEW sequence has been delayed because the arrisM-
NEW: Lease Re- taDevDhcpNoSvcImpact object is enabled (value is either dontSend or
newal delay; Voice sendIgnore) and one of the voice lines is offhook.
line offhook Format:
MTA DHCP RENEW: Lease Renewal delay; Voice line offhook

Firmware Guide Release 7.5 Standard 1.2 August 2012

230 Chapter 5

Action:
None; the eDVA will not RENEW its IP address until all voice lines
are on-hook.

MTA DHCP RE- The eDVA DHCP RENEW period has timed out, and the eDVA DHCP
BIND: Lease Re- REBIND sequence has been delayed, because the arrisMtaDevDhcp-
newal delay; Voice NoSvcImpact object is enabled (value is either dontSend or sendIgnore)
line offhook and one of the voice lines is offhook.
Format:
MTA DHCP REBIND: Lease Renewal delay; Voice line offhook
Action:
None; the eDVA will not RENEW its IP address until all voice lines
are on-hook.

Power Supply Severity:

Telemetry Alarm Major
Cause:
The E-UE has lost AC power or has encountered a problem in the
battery charging circuitry. The alarm includes one of the following
battery status codes:
• AC Fail—the E-UE has detected an AC power failure.
• Replace Battery—the battery has deteriorated to about 75% of its
off-the-shelf capacity and should be replaced.
• Battery Missing—the battery was not installed, has been removed,
or cannot be detected.
The event log provides more information about the battery status.
Impact:
None at time of alarm. Depending on the condition of the battery
and the nature of the power failure, the E-UE may exhaust the bat-
tery before AC power is restored.
Action:
Depends on the scope of the power outage.

Gateway has reset Severity:

Informational
Cause:
The WRM (Gateway) was reset either through the web pages or by
pressing the ‘‘Router Reset’’ button.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 231

Impact:
Data communications (Ethernet or wifi) may be disrupted for a few
seconds. Telephony is not affected.
Action:
None.

Unit has been re- Severity:

stored to factory Informational
defaults Cause:
The WRM (Gateway) was restored to factory defaults either through
the web pages or by holding the ‘‘Router Reset’’ button for more
than 15 seconds.
Impact:
Data communications (Ethernet or wifi) may be disrupted for a few
seconds. The subscriber may have to reconfigure the WRM or
restore previous settings. Telephony is not affected.
Action:
None.

Speedtest Results Format:

SpeedTest Results: Download Status: Complete, Speed: dl_speed,
Upload Status: Complete, Speed: ul_speed;CM-
MAC=cm_mac_addr;CMTS-MAC=cmts_mac_addr;CM-QOS=
cm_qos;CM-VER= cm_hw_ver;
Severity:
Informational
Cause:
A speed test was conducted, and the arrisCmDoc30SpeedtestCon-
figSyslogReports object is set to true(1) so results would be sent
to the Syslog server.
Impact:
None.
Action:
Check the results for expected performance. Note that rate limiting
can affect the results. If the performance is not as expected, monitor
the network for congestion or noise and correct any problems.

Firmware Guide Release 7.5 Standard 1.2 August 2012

232 Chapter 5

PacketCable Events

The following are PacketCable-related events. PacketCable events use the

enterprise number 4491. All supported PacketCable events are related to the
battery and charger system.

Battery Not Low The E-UE battery has recharged to over 25% of its maximum capacity.

Battery Low The E-UE battery charge is less than 25% of its maximum capacity.

Battery Present A missing battery has been replaced.

If a large number of ‘‘Battery Missing’’ and ‘‘Battery Present’’ messages
appear in the logs for a single E-UE, this may indicate a problem with either
the battery or the E-UE.

Battery Missing The E-UE battery has been either removed or is undetectable. If the battery
is still installed, it may be defective.
If a large number of ‘‘Battery Missing’’ and ‘‘Battery Present’’ messages
appear in the logs for a single E-UE, this may indicate a problem with either
the battery or the E-UE.

Battery Good An E-UE battery that had previously shown a ‘‘Replace Battery’’ state is now
good. This may indicate that the battery has been replaced.

Replace Battery The E-UE battery has deteriorated to about 75% of its off-the-shelf capacity
and should be replaced.

AC Restored AC power has been restored to the indicated E-UE.

If a large number of ‘‘AC Restored’’ and ‘‘AC Fail’’ messages appear in the
logs for a single E-UE, this may indicate that the E-UE is connected to a
switched outlet or the power connection may be intermittent.

AC Fail AC power has been removed from the E-UE, and the E-UE is running on bat-
tery power.
If a large number of ‘‘AC Restored’’ and ‘‘AC Fail’’ messages appear in the
logs for a single E-UE, this may indicate that the E-UE is connected to a
switched outlet or the power connection may be intermittent.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 233

Network Failure Recovery

Touchstone firmware can automatically recover from cable cuts or degraded

downstream RF conditions. No provisioning or control is necessary to take
advantage of recovery features.

Recovery from Ex- In a situation where the downstream RF signal degrades to the point where
treme Plant Condi- the upstream transmit buffers are full, and the E-UE cannot send packets, an
tions automatic recovery feature:
• resets the DOCSIS layer
• restarts the DSP
• notifies Call Processing to restore dialtone functionality
The result is a cleaner recovery from extreme RF degradation.

Firmware Guide Release 7.5 Standard 1.2 August 2012

234 Chapter 5

Working with Message Trace Logs

Touchstone E-UEs keep logs of:
• CM DHCP messages
• eDVA DHCP messages
• CallP messages
• MGCP
• DSX
Log messages are available only for NCS loads, through the CLI, SNMP, or
the troubleshooting pages. Use this procedure to display message trace logs.

Message Capacity The message log stores up to 250 messages. The buffer size is 25K bytes.
SIP loads generate larger messages, reducing the number of messages actu-
ally stored.
The DHCP log stores up to 50 CM messages and up to 50 eDVA DHCP mes-
sages. Each DHCP buffer is 5K bytes.
Note: The E-UE captures the original DHCP Discover-Offer exchange, and
all subsequent Renew exchanges.
The eDVA uses a circular buffer scheme to store messages. When a new
message exceeds the available buffer space, the eDVA deletes the oldest mes-
sages as needed.

SNMP Overview Log messages can be up to 4K bytes in length. Since an SNMP string is lim-
ited to 256 bytes, retrieving a message through SNMP requires breaking the
message up. The objects arrisMtaDevSignalingLastMsg1 through arris-
MtaDevSignalingLastMsg16 contain the selected message.

Action Perform any of the following tasks as necessary.

Task Page
Enabling or Disabling Message Tracing 235
Viewing Logs Using the CLI 236
Viewing Logs Using SNMP 236
Viewing Logs Using the Web-based Interface 237
Controlling Logs Using the Web-Based Interface 238
Clearing Message Trace Logs Using the CLI 239

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 235

Enabling or Dis- Follow these steps to enable or disable message tracing using the CLI or
abling Message SNMP. Trace logs are enabled by default.
Tracing 1 To control message tracing using SNMP:
a Specify which message type that you want to enable or disable by
setting the following objects:
arrisMtaDevEnableDHCPLog
Set to enable(1) to enable DHCP messages.
arrisMtaDevEnableMGCPLog
Set to enable(1) to enable MGCP messages.
b Enable or disable message tracing for the selected message type
by setting the arrisMtaDevEnableLogging object: either dis-
able(0) or enable(1).

2 To control DHCP message tracing using the CLI:

a Access the CLI as described in ‘‘Enabling and Accessing the
Troubleshooting CLI’’ on page 435.
b To enable eDVA DHCP trace logs:
/ dhcp mtaEnblLog 1 ↵

c To disable eDVA DHCP trace logs:

/ dhcp mtaEnblLog 0 ↵

d To enable CM DHCP trace logs:

/ dhcp cmEnblLog 1 ↵

e To disable CM DHCP trace logs:

/ dhcp cmEnblLog 0 ↵

3 To control CallP and DSx logs using the CLI:

a Access the CLI as described in ‘‘Enabling and Accessing the
Troubleshooting CLI’’ on page 435.
b To enable CallP signalling logs:
/ voice ↵
callp callpEnblLog 1 ↵

c To disable CallP signalling logs:

/ voice ↵
callp callpEnblLog 0 ↵

d To enable DSx logs:

Firmware Guide Release 7.5 Standard 1.2 August 2012

236 Chapter 5

/ voice ↵
callp dsxEnblLog 1 ↵

e To disable DSx logs:

/ voice ↵
callp dsxEnblLog 0 ↵

Viewing Logs Us- Follow these steps to view message trace logs using the command-line inter-
ing the CLI face.
1 Access the CLI as described in ‘‘Enabling and Accessing the Trou-
bleshooting CLI’’ on page 435.
2 To view the eDVA DHCP logs:
/ mta mtaDispLog ↵

3 To view the CM DHCP logs:

/ cm cmDispLog ↵

4 To view the CallP logs:

/ voice ↵
callp callpDispLog ↵

5 To view the DSx logs:

/ voice ↵
callp dsxDispLog ↵

Viewing Logs Us- Follow these steps to read message logs using SNMP.
ing SNMP 1 Follow the steps in ‘‘Enabling or Disabling Message Tracing’’ on
page 235 to specify which message types that you want to view.
2 Set the arrisMtaDevEnableCallSigLastMsgRpt object to enable, to
enable message logging to the arrisMtaDevSignalingLastMsg1
through arrisMtaDevSignalingLastMsg16 objects.
3 Read the arrisMtaDevSignalingLastMsg1 through arrisMtaDevSig-
nalingLastMsg16 objects to view the last log of the selected type. If
the message does not require all 16 objects, the unused objects return
empty strings.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 237

Viewing Logs Us- Follow these steps to view message logs using the web-based troubleshooting
ing the Web-based interface.
Interface 1 Use a web browser to access the web-based interface as described in
‘‘Accessing the Standard Pages’’ on page 457.
2 If you are currently viewing the Basic pages, click the Advanced link.
Enter the Password of the Day if necessary.
3 To view either CM or eDVA DHCP logs:
a Select the DHCP link at the top of any Advanced web page to
access the DHCP Parameters page.
b At the bottom of the DHCP Parameters page (scroll down to the
bottom of the page if necessary), select either the CM-DHCP or
MTA-DHCP link.

The E-UE displays the selected DHCP log.

4 To view MGCP and DSX logs:
a Select the QoS link at the top of any Advanced web page to access
the QoS Statistics page.
b To view MGCP logs, select the Show Call Signalling Log link
(about midway down the page).
c To view DSX logs, select the Show DSX Log link at the bottom of
the page (scroll down to the bottom of the page if necessary).
The E-UE displays the selected log.

Firmware Guide Release 7.5 Standard 1.2 August 2012

238 Chapter 5

Controlling Logs Follow these steps to enable, disable, or clear message logs using the web-
Using the Web- based interface.
Based Interface 1 Access the Advanced web pages as described in ‘‘Accessing the
Advanced Pages’’ on page 457.
2 To work with DHCP logs:
a Click the DHCP link to access the DHCP page.
b Scroll down to the bottom of the screen to view the logging con-
trols:

c To clear the CM DHCP or eDVA DHCP logs, click the Clear but-
ton for the desired log.
d To enable or disable CM DHCP logs, click the Disable CM Log
button. This button changes to Enable CM Log when logging is
disabled.
e To enable or disable eDVA DHCP logs, click the Disable MTA
Log button. This button changes to Enable MTA Log when log-
ging is disabled.
3 To work with MGCP and DSX logs:
a Click the QoS link to access the Qos Statistics page:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 239

b To clear the MGCP log, click the Clear button midway down the
screen.
c To enable or disable CallP logging, click the Disable Logging
button midway down the screen. This button changes to Enable
Logging when logging is disabled.

d To enable or disable DSX logging, click the Disable Logging

button at the bottom of the screen. This button changes to Enable
Logging when logging is disabled.

e To clear the DSX log, click the Clear button at the bottom of the
screen.

Clearing Message Follow these steps to clear message trace logs using the CLI.
Trace Logs Using 1 Access the CLI as described in ‘‘Enabling and Accessing the Trou-
the CLI bleshooting CLI’’ on page 435.
2 To clear the eDVA DHCP logs:
/ mta mtaClearLog ↵

3 To clear the CM DHCP logs:

/ cm cmClearLog ↵

4 To clear the MGCP logs:

/ voice ↵
callp callpClrLog ↵

Firmware Guide Release 7.5 Standard 1.2 August 2012

240 Chapter 5

5 To clear the DSx logs:

/ voice ↵
callp dsxClrLog ↵

Capturing Signaling Traces

CAUTION
Potential security breach
This feature allows NCS signaling messages to enter the network as clear
text. This breaks security as defined in the PacketCable Security specifica-
tion. IPsec is used to secure the message link between the eDVA and CMS
to, among other things, keep the voice keys exchanged between endpoints
secure. Unauthorized personnel may potentially be able to monitor a sub-
scriber’s voice traffic.

Touchstone firmware can generate a Syslog report that contains a full signal-
ing trace on a Touchstone E-UE. Individual signaling messages may be up to
4000 bytes in length. Since messages of this size would violate the maxi-
mum message size limitations of the Syslog server, long messages are broken
into blocks of 128 bytes, time stamped, and numbered for reassembly. The
eDVA then sends the blocks to the Syslog server IP address defined during
normal E-UE provisioning.
Signaling tracing is controlled using the arrisMtaDevEnableCallpSigTrace
MIB object. You can enable or disable message tracing output on an E-UE
using an SNMP manager.
Note: Touchstone firmware supports this feature only for capturing NCS sig-
naling traces. Support for capturing SIP signaling traces may be added in a
future release.

Controlling Signal- Use the arrisMtaDevEnableCallpSigTrace MIB object (part of the arrisMta-
ing Tracing DevBase MIB) to enable or disable signal tracing. The default value for this
object is disable(0).

CAUTION
Potential performance impacts
The number of messages expected as a result of enabling this feature can
affect the real-time performance of the E-UE, and may cause network con-
gestion.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 241

Set the object as follows:

• To enable signaling message tracing, set the object to enable(1). Trac-
ing continues until disabled using the MIB object, or the E-UE is reset.
• To disable signaling message tracing, set the MIB object to disable(0).
Note: The signaling trace feature cannot be enabled through either the CM
configuration file or the eDVA configuration file.

Interpreting the The following is an example of a single part transmission from the E-UE to a
Signaling Trace NCS Call server:
Output Data Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03
2005 mta17.dev61 <44> <4115> <37> <00:13:11:23:23:E7>
<Xmit: (17: 1 of 1) - ’NTFY 8 aaln/[email protected] MGCP 1.0 NCS
1.0 X: 26002 O: hu ’>

The following is an example of a single part Receive from a NCS Call Server
to the E-UE:
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03
2005 mta17.dev61 <45> <4115> <38> <00:13:11:23:23:E7>
<Rcv: (19: 1 of 1) - ’200 8 OK ’>

The following output is part of the Syslog header, and appears in both Trans-
mit and Receive trace messages.
Oct 21 10:55:04
Syslog server Date and Time.
10.1.61.17
The IP address of the eDVA that sent the message.
Oct 21 10:55:03 2005
The E-UE generated Data and Time.
mta17.dev61
The FQDN of the E-UE.
<44>
The Syslog message Event Number. It is incremented for each mes-
sage in the Syslog.
<4115>
The Arris Enterprise Number.
The following sections describe the transmit and receive data payloads.

Firmware Guide Release 7.5 Standard 1.2 August 2012

242 Chapter 5

Interpreting the Transmit Data Payload

The following is an example of a single part transmission from the E-UE to a

NCS Call server:
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03
2005 mta17.dev61 <44> <4115> <37> <00:13:11:23:23:E7>
<Xmit: (17: 1 of 1) - ’NTFY 8 aaln/[email protected] MGCP 1.0 NCS
1.0 X: 26002 O: hu ’>

The transmit message data can be broken down into two parts, the Header
and the signaling data itself. The header indicates that this is a transmitted
message from the E-UE; it provides the sequence number of the message, the
block number, total number of blocks in this message, and the payload of the
signaling message.
The following table shows the data payload that is part of the transmit mes-
sage trace. The first two parts comprise the header; the next two parts are the
actual message.
<37>
An Index number indicating that this is a transmitted message. All
transmitted messages are of type 37.
<00:13:11:23:23:E7>
The MAC address of the E-UE that transmitted the message.
Xmit: (17: 1 of 1) -
All transmitted messages start with Xmit. The 17 is a message
sequence number. All transmitted messages have a unique sequence
number that increases by one for each complete message transmit-
ted. This internal value is a 32-bit unsigned integer value that incre-
ments only when tracing is active. Sequence numbers start at zero.
The sequence numbers increment only when a message is sent to
the Syslog. The ‘‘1 of 1’’ indicates that this is part 1 of a one part
message. All parts of the same message have the same sequence
number.
’NTFY 8 aaln/[email protected]
MGCP 1.0 NCS 1.0 X: 26002 O: hu ’
The actual signaling message data. The data is surrounded by single
quotes. All signaling messages are NULL terminated strings.

Interpreting the Receive Data Payload

The following is an example of a single part Receive from a NCS Call Server
to the eDVA:
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03
2005 mta17.dev61 <45> <4115> <38> <00:13:11:23:23:E7>
<Rcv: (19: 1 of 1) - ’200 8 OK ’>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 243

The receive message data can be broken down into two parts, the Header and
the signaling data. The header indicates that this is a signaling message
received by the eDVA; it provides the sequence number of the message, the
block number, total number of blocks in this message, and the signaling data
received.
The following table shows the data payload that is part of a receive message
trace:
<38>
An index number indicating that this is a received signaling mes-
sage. All received messages are type 38.
<00:13:11:23:23:E7>
The MAC address of the Message Destination.
Rcv: (19: 1 of 1)
All received messages start with Rcv:. The 19 is a message
sequence number. All received messages have a unique sequence
number that increases by one for every complete message received
by the eDVA. This internal value is a 32-bit unsigned integer value
and only increments when the tracing is active. Sequence numbers
start at zero. All messages have a unique sequence number. The ‘‘1
of 1’’ indicates that this is part 1 of a 1-part message. All parts of
the same message have the same sequence number.
’200 8 OK ’
The actual received signaling data. The data is surrounded by single
quotes.

Signaling Trace Feature Example Output

Below is a small sample output for a typical off-hook and on-hook sequence
in NCS. In a real world situation on an actual network Syslog server, there
could be messages unrelated to this feature interleaved with these messages:
Oct 21 10:55:00 10.1.61.17 Oct 21 10:54:59
2005 mta17.dev61 <37> <4115> <37> <00:13:11:23:23:E7>
<Xmit: (14: 1 of 1) - ’NTFY 7 aaln/[email protected] MGCP 1.0 NCS
1.0 X: 25888 O: hd ’>
Oct 21 10:55:00 10.1.61.17 Oct 21 10:54:59 2005 mta17.dev61
<38> <4115> <38> <00:13:11:23:23:E7> <Rcv: (16:
1 of 1) - ’200 7 OK ’>
Oct 21 10:55:00 10.1.61.17 Oct 21 10:54:59 2005 mta17.dev61
<39> <4115> <38> <00:13:11:23:23:E7> <Rcv: (17:
1 of 1) - ’RQNT 3752 aaln/[email protected] MGCP 1.0 NCS 1.0 X: 26001
S: Q: loop R: hf(I), hu(N) ’>
Oct 21 10:55:01 10.1.61.17 Oct 21 10:54:59 2005 mta17.dev61
<40> <4115> <37> <00:13:11:23:23:E7> <Xmit: (15:
1 of 1) - ’200 3752 OK ’>
Oct 21 10:55:01 10.1.61.17 Oct 21 10:54:59 2005 mta17.dev61
<41> <4115> <38> <00:13:11:23:23:E7> <Rcv: (18:

Firmware Guide Release 7.5 Standard 1.2 August 2012

244 Chapter 5

1 of 2) - ’RQNT 3753 aaln/[email protected] MGCP 1.0 NCS 1.0 X: 26002

D: (#|A|D|[2-9]11|0[2-9]11|0T|00|010|11X|[2-9]XXXXXX|[01][2-9]XXXXXXXXX|0’>
Oct 21 10:55:01 10.1.61.17 Oct 21 10:54:59 2005 mta17.dev61
<42> <4115> <38> <00:13:11:23:23:E7> <Rcv: (18:
2 of 2) - ’1[1-9]XXXXX|10XXXX|X.#) S: dl R: hf(I,K), hu(N), oc,
of, [0-9*#T](D) ’>
Oct 21 10:55:01 10.1.61.17 Oct 21 10:54:59 2005 mta17.dev61
<43> <4115> <37> <00:13:11:23:23:E7> <Xmit: (16:
1 of 1) - ’200 3753 OK ’>
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03 2005 mta17.dev61
<44> <4115> <37> <00:13:11:23:23:E7> <Xmit: (17:
1 of 1) - ’NTFY 8 aaln/[email protected] MGCP 1.0 NCS 1.0 X: 26002 O:
hu ’>
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03 2005 mta17.dev61
<45> <4115> <38> <00:13:11:23:23:E7> <Rcv: (19:
1 of 1) - ’200 8 OK ’>
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03 2005 mta17.dev61
<46> <4115> <38> <00:13:11:23:23:E7> <Rcv: (20:
1 of 1) - ’RQNT 3788 aaln/[email protected] MGCP 1.0 NCS 1.0 X: 26025
S: Q: loop R: hd(N) ’>
Oct 21 10:55:04 10.1.61.17 Oct 21 10:55:03 2005 mta17.dev61
<47> <4115> <37> <00:13:11:23:23:E7> <Xmit: (18:
1 of 1) - ’200 3788 OK’>
Oct 21 10:55:33 10.1.61.17 Oct 21 10:55:32 2005 mta17.dev61
<48> <4115> <37> <00:13:11:23:23:E7> <Xmit: (19:
1 of 1) - ’NTFY 9 aaln/[email protected] MGCP 1.0 NCS 1.0 X: 26025 O:
hd ’>
Oct 21 10:55:33 10.1.61.17 Oct 21 10:55:32 2005 mta17.dev61
<49> <4115> <38> <00:13:11:23:23:E7> <Rcv: (21:
1 of 1) - ’200 9 OK ’>
Oct 21 10:55:33 10.1.61.17 Oct 21 10:55:32 2005 mta17.dev61
<50> <4115> <38> <00:13:11:23:23:E7> <Rcv: (22:
1 of 1) - ’RQNT 3940 aaln/[email protected] MGCP 1.0 NCS 1.0 X: 26060
S: Q: loop R: hf(I), hu(N) ’>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 245

Configuring SNMP Coexistence

Touchstone firmware provides several SNMPv3 security-related features.
SNMP Coexistence is a feature that allows SNMPv1 and SNMPv2c network
management systems to function within the context of SNMPv3 security and
view-based MIB access. The NMS can use an SNMPv1 or SNMPv2 com-
munity string to access the E-UE’s MIB or to receive traps.

Overview This procedure provides details on adding the necessary MIBs and TLVs to a
cable modem configuration file. See the Provisioning chapter for a listing of
the completed configuration file.
To configure the E-UE for coexistence mode, you must create a row entry in
the snmpCommunityTable, to map the community string to an SNMPv3
security name. You can optionally modify the following tables to provide
extended access control.
• vacmSecurityToGroupTable—two row entries, containing group name
information. One entry supports SNMPv1 access and the other entry
supports SNMPv2 access.
• vacmAccessTable—two row entries, which map the community name,
security name, and group name information to an SNMPv3 security
name. The DOCSIS-standard default security name for cable modems
is docsisManager. One entry supports SNMPv1 access and the other
entry supports SNMPv2 access.

Enabling SNMP Access

In DOCSIS 2.0, SNMP access was enabled and open to all users until apply-
ing any restricted settings in the CM configuration file. TS7.0 and newer ver-
sions of Touchstone firmware disables SNMP access by default. The follow-
ing example fragment can be placed in a CM configuration file to enable
SNMP access:
SnmpMib = docsDevNmAccessCommunity.1 "public"
SnmpMib = docsDevNmAccessControl.1 read
SnmpMib = docsDevNmAccessInterfaces.1 hexstr: 40
SnmpMib = docsDevNmAccessStatus.1 createAndGo
SnmpMib = docsDevNmAccessCommunity.2 "private"
SnmpMib = docsDevNmAccessControl.2 readWrite
SnmpMib = docsDevNmAccessInterfaces.2 hexstr: 40
SnmpMib = docsDevNmAccessStatus.2 createAndGo

Touchstone firmware also allows SNMP access through the RF interface

when the CM configuration file does not specify docsDevNmAccessInter-
faces but includes all other NmAccess entries. For example, the following
fragment enables SNMP access through the RF interface:

Firmware Guide Release 7.5 Standard 1.2 August 2012

246 Chapter 5

SnmpMib = docsDevNmAccessIp.10 192.168.31.0

SnmpMib = docsDevNmAccessIpMask.10 255.255.255.0
SnmpMib = docsDevNmAccessCommunity.10 "public"
SnmpMib = docsDevNmAccessControl.10 read
SnmpMib = docsDevNmAccessStatus.10 createAndGo

Note: TS7.5 allows read-only SNMP access to certain objects from the LAN
interfaces before the modem has ranged and registered, in accordance with
CM-SP-OSSIv3.0-I15-100115.

Configuration File Notes

Keep the following notes in mind when creating or editing configuration

files.
• A MIB object whose type is ‘‘StorageType’’ must always have a value
of volatile.
• A MIB object whose type is ‘‘RowStatus’’ should have a value of cre-
ateAndGo. The E-UE automatically changes its value to active after
successfully adding the row.

SNMP Access Mode

The following examples configure SNMP access to the E-UE for

SNMPv1v2c coexistence mode. This allows an NMS (i.e. a MIB Browser)
to access the E-UE’s MIBs with a simple community string using either
SNMPv1 or SNMPv2.
The SNMP requests GET, GET-NEXT, GET-BULK, and SET are all sup-
ported. The examples use the community name my_password.

SNMP Trap Transmission

SNMP trap transmission uses the DOCSIS TLV-38 (SNMPv3 Notification

Receiver) configuration file element.
The example configures two trap destinations, each with a different IP
address. One destination supports SNMPv1 traps and the other destination
supports SNMPv2 traps. The parameters for each trap destination are:
• Trap destination #1:
– IP Address: 10.1.50.100
– Trap Type: SNMPv1
• Trap destination #2:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 247

– IP Address: 10.1.50.80
– Trap Type: SNMPv2
Note: Change the trap IP address to the IP address of your specific trap server
in the configuration file.
This example starts with a basic DOCSIS 1.1 CM configuration file, contain-
ing enough information to allow a cable modem to range and register, and
then add the coexistence MIB elements to it. If you have a CM configuration
file that you are already using, start with that file and add the coexistence ele-
ments to it.

snmpCommunity- The following table shows the example row to add to the snmpCommunity-
Table Parameters Table. The index for this table is an octet string; the example uses the string
comm1 as the index value. You can use a different string if you desire. Itali-
cized values in the table are default values that are created automatically.
The following examples use the ARRIS PacketACE Configuration Editor to
create the configuration file, covering only the details needed to add the
desired functionality. See the PacketACE Configuration Tools User’s Guide
for more information about using PacketACE.
Object Name Value Required?
snmpCommunityName.comm1 my_password Yes
snmpCommunitySecurityName.comm1 rwAccess Yes
snmpCommunityContextEngineID.comm1 local snmpEngineID No
snmpCommunityContextName.comm1 (zero-length) No
snmpCommunityTransportTag.comm1 (zero-length) No
snmpCommunityStorageType.comm1 volatile (2) No
snmpCommunityStatus.comm1 createAndGo (4) Yes

Note: Avoid adding table index objects to the configuration file; the firmware
fills in the index object using the index value supplied with the object name
(.comm1 in this example). See ‘‘Adding the snmpCommunityTable’’ on
page 249 for the proper way to add rows.
Object order is not important.

vacmSecurity- The following table shows the example row to add to the vacmSecurity-
ToGroupTable Pa- ToGroupTable. This table has an index consisting of two objects:
rameters • vacmSecurityModel—corresponds to the SNMP version in use; in this
example, it takes the values 1 and 2 to allow support for both SNMPv1
and SNMPv2 requests.
• vacmSecurityName—corresponds to the snmpCommunitySecurity-
Name MIB object in the snmpCommunityTable (rwAccess in this
example).

Firmware Guide Release 7.5 Standard 1.2 August 2012

248 Chapter 5

Object Name Value (row 1) Value (row 2)

vacmSecurityModel (row index 1) 1 (SNMPv1) 2 (SNMPv2)
vacmSecurityName (row index 2) rwAccess rwAccess
vacmGroupName rwAccess1 rwAccess2
vacmSecurityToGroupStorageType volatile (2) volatile (2)
vacmSecurityToGroupStatus createAndGo (4) createAndGo (4)

vacmAccessTable The following table shows the example row to add to the vacmAccessTable.
Parameters This table has an index consisting of four objects:
• vacmGroupName—corresponds to the vacmGroupName object in the
vacmSecurityToGroupTable (rwAccess in our example). CM and
eDVA group names should be unique.
• vacmAccessContentPrefix—an octet string; in this example we use
an empty (zero length) string. This is shown as ‘‘’’ in the table below.
• vacmAccessSecurityModel—corresponds to the SNMP version in
use; in this example; it takes the values 1 and 2 to allow support for
both SNMPv1 and SNMPv2 requests.
• vacmAccessSecurityLevel—for SNMP coexistence, use a value of 1
(noAuthnoPriv). This means that the E-UE has no configured SNMPv3
USM security users/keys.
Object Name Value (row 1) Value (row 2)
GroupName (row index 1) rwAccess rwAccess
ContentPrefix (row index 2) ‘‘’’ ‘‘’’
SecurityModel (row index 3) 1 (SNMPv1) 2 (SNMPv2)
SecurityLevel (row index 4) 1 (noAuthnoPriv) 1 (noAuthnoPriv)
vacmAccessContextMatch exact (1) exact (1)
vacmAccessReadViewName docsisManagerView docsisManagerView
vacmAccessWriteViewName docsisManagerView docsisManagerView
vacmAccessNotifyViewName docsisManagerView docsisManagerView
vacmAccesssStorageType volatile (2) volatile (2)
vacmAccessStatus createAndGo (4) createAndGo (4)

Action Perform the following tasks in the order shown.

Task Page
Adding the snmpCommunityTable 249
Adding the vacmSecurityToGroupTable 252
Adding the vacmAccessTable 255

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 249

Adding the snmp- Follow these steps to add coexistence MIB objects to a CM configuration file
CommunityTable using PacketACE.
1 Click the ‘‘Add SNMP MIB’’ icon or select Edit menu -> Add SNMP
MIB.

The Available MIBs tree appears:

2 Locate the snmpCommunityTable MIB. If you are not sure where

the MIB is located in the tree, enter the name of the MIB in the upper
field along the right side of the PacketACE window and then click
Find MIB by Name. The following figure shows the snmpCommun-
ityTable MIB.

Firmware Guide Release 7.5 Standard 1.2 August 2012

250 Chapter 5

3 Double-click on one of the objects listed in the following table.

Object Name Value
snmpCommunityName my_password
snmpCommunitySecurityName rwAccess
snmpCommunityStatus createAndGo (4)

The Add SNMP MIB window appears:

4 Enter the index name (comm1) in the Index,DisplayString field, and

the value from the table in step 3 in the Value field.
Some of the objects have a fixed set of values; this is indicated by the
drop-down menu button at the end of the Value field. Click the menu
button to display a list of allowed values, and choose the correct
value.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 251

5 Repeat steps 3 and 4 until all values are filled in.

The configuration file should now look similar to the following:

Note: The order of your MIB entries may be different than what is
shown above.
6 Proceed to ‘‘Adding the vacmSecurityToGroupTable.’’

Firmware Guide Release 7.5 Standard 1.2 August 2012

252 Chapter 5

Adding the vacm- Follow these steps to add coexistence MIB objects to a CM configuration file
SecurityToGroup- using PacketACE.
Table 1 Click the ‘‘Add SNMP MIB’’ icon or select Edit menu -> Add SNMP
MIB.

The Available MIBs tree appears.

2 Locate the vacmSecurityToGroupTable MIB. If you are not sure

where the MIB is located in the tree, enter the name of the MIB in the
upper field along the right side of the PacketACE window and then
click Find MIB by Name.
3 Double-click on one of the objects listed in the following table.
Object Name Value (row 1) Value (row 2)
vacmGroupName rwAccess rwAccess
vacmSecurityToGroupStorageType volatile (2) volatile (2)
vacmSecurityToGroupStatus createAndGo (4) createAndGo (4)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 253

The Add SNMP MIB window appears:

4 Enter the first index (1 or 2) in the Index1,Integer field, the second

index (rwAccess) in the Index2,DisplayString field, and the value
from the table in step 3 in the Value field.
Some of the objects have a fixed set of values; this is indicated by the
drop-down menu button at the end of the Value field. Click the menu
button to display a list of allowed values, and choose the correct
value.

Firmware Guide Release 7.5 Standard 1.2 August 2012

254 Chapter 5

5 Repeat steps 3 and 4 until all values are filled in.

The configuration file should now be similar to the following:

Note: The order of your MIB entries may be different than what is
shown above.
6 Proceed to ‘‘Adding the vacmAccessTable.’’

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 255

Adding the vacm- Follow these steps to add coexistence MIB objects to a CM configuration file
AccessTable using PacketACE.
1 Click the ‘‘Add SNMP MIB’’ icon or select Edit menu -> Add SNMP
MIB.

The Available MIBs tree appears:

2 Locate the vacmAccessTable MIB. If you are not sure where the
MIB is located in the tree, enter the name of the MIB in the upper
field along the right side of the PacketACE window and then click
Find MIB by Name.

3 Double-click on one of the objects listed in the following table.

Object Name Value (row 1) Value (row 2)
vacmAccessContextMatch exact (1) exact (1)
vacmAccessReadViewName docsisManagerView docsisManagerView
vacmAccessWriteViewName docsisManagerView docsisManagerView
vacmAccessNotifyViewName docsisManagerView docsisManagerView
vacmAccesssStorageType volatile (2) volatile (2)
vacmAccessStatus createAndGo (4) createAndGo (4)

Firmware Guide Release 7.5 Standard 1.2 August 2012

256 Chapter 5

The Add SNMP MIB window appears:

4 Enter indexes as follows, and the value from the table in step 3 in the
Value field.

• Index1,DisplayString—rwAccess (or the value of the vacmGroup-

Name object from the vacmSecurityToGroupTable)
• Index2,DisplayString—leave blank
• Index3,Integer— 1 or 2, depending on the SNMP level row
• Index4,Integer—1 (noAuthnoPriv)
Some of the objects have a fixed set of values; this is indicated by the
drop-down menu button at the end of the Value field. Click the menu
button to display a list of allowed values, and choose the correct
value.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 257

5 Repeat steps 3 and 4 until all values are filled in.

The configuration file should now be similar to the following:

Note: MIB entries may be in a different order than what is shown

above.
6 Proceed to ‘‘Configuring Trap Servers.’’

Firmware Guide Release 7.5 Standard 1.2 August 2012

258 Chapter 5

Configuring Trap Servers

Use this procedure to configure trap destinations, using TLV-38 SNMPv3
Notification Receiver elements. The following procedure assumes that Pack-
etACE is running and the coexistence MIBs are in the configuration file, but
you can add the TLVs to the configuration file before adding the MIBs if you
prefer.

Action 1 Click the ‘‘Add TLV parameter’’ icon or select Edit menu -> Add
TLV.

The following window appears:

2 Select SNMPv3NotificationReceiver from the Type drop-down

menu, then click the Add TLV button.
The SNMPv3NotificationReceiver element appears in the main Pack-
etACE window.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 259

3 In the main PacketACE window, select the SNMPv3NotificationRe-

ceiver element, then click the ‘‘Add TLV sub-parameter’’ icon or
select Edit menu -> Add Sub-TLV.
The following window appears:

4 Select SNMPv3NrIpAddress from the Sub-Type drop-down menu.

5 Enter the IP address of the trap server (10.1.50.100 in this example) in
the Value box.
6 Click the Add TLV button.
PacketACE adds the Trap IP address sub-type to the SNMPv3Notifica-
tionReceiver element.
7 Repeat steps 4 through 6, adding the SNMPv3NrTrapType sub-
parameter and specifying a value of 1: SNMP v1 trap in an SNMP v1
packet.

Firmware Guide Release 7.5 Standard 1.2 August 2012

260 Chapter 5

8 Repeat steps 1 through 7 to create a second SNMPv3Notification-

Receiver element with an IP address of 10.1.50.80 and a trap type of
2: SNMP v2c trap in an SNMP v2c packet.

The configuration file should now resemble the following:

9 Save the configuration file and exit PacketACE.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 261

TR-069 Management

Touchstone firmware supports the TR-069 CPE WAN Management Protocol

for provisioning and managing Model 8 Touchstone Gateway products.

Overview This section provides a brief overview of TR-069 support.

Note: For specific use of TR-069 management software, see the documenta-
tion accompanying your server.

Supported and Unsupported Features

Touchstone firmware supports the following TR-069 features:

• Provisioning of ACS connection parameters through the CM configura-
tion file, using either TLV-43 or ARRIS-proprietary MIB objects
• Supports either non-secure (HTTP) or simplified secure (HTTPS) con-
nections
• IPv4 connections
• Router management, using the gateway IP address
• Use of DHCP to obtain ACS URL, user name, and password +
• Supports configuration of multiple SSIDs +
• TR-098 (subset) +
The following TR-069 features are specifically unsupported:
• IPv6 connections (TR-181); only IPv4 is supported
• Router management through the CM IP address (gateway IP address
only)
• Diagnostics, performance monitoring, or firmware download
• Full TR-069 security

Supported Servers

The Touchstone TR-069 implementation has been tested with the following
TR-069 servers:
• Incognito
• OpenACS

Firmware Guide Release 7.5 Standard 1.2 August 2012

262 Chapter 5

• Alcatel Lucent (ALU) Motive +

In addition, Touchstone firmware may support proprietary customer-specific
servers. See the Release Notes and Letter of Operational Considerations for
more details.

Supported TR-098 Touchstone firmware supports most objects in the InternetGatewayDevice

Objects group. The following tables provides a list of supported objects. In the
tables below, RO denotes a read-only parameter, while RW denotes a writable
parameter.

Baseline Profile Objects

The following TR-069 baseline profile objects are supported.

Object Parameter Status
Manufacturer RO
ManufacturerOUI RO
ModelName RO
InternetGatewayDevice.DeviceInfo.
SerialNumber RO
HardwareVersion RO
SoftwareVersion RO
URL RW
Username RW
Password RW
PeriodicInformEnable RW
InternetGatewayDevice.ManagementServer. PeriodicInformInterval RW
PeriodicInformTime RW
ConnectionRequestURL RO
ConnectionRequestUsername RW
ConnectionRequestPassword RW

LAN-side DHCP Controls

In this table, the indexes are as follows:

• LANDevice.{i} — The SSID; range 1 (the subscriber’s SSID) to 4
• WANConnectionDevice.{i} — always 1 (supported Touchstone prod-
ucts support only one WAN connection)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 263

Object Parameter Status Notes

DHCPServerEnable RW
MinAddress RW
MaxAddress RW
SubnetMask RW
IPRouters RW
InternetGatewayDevice. AllowedMACAddresses RW .TW/.NA loads only
LANDevice.{i}.LAN- DNSServers RO
HostConfigManagement. DHCPLeaseTime RW
X_ARRISI_COM_IPv6_PrefixLength RO integer, .TW/.NA loads only
X_ARRISI_COM_IPv6_ServerEnable RO Boolean, .TW/.NA loads only
X_ARRISI_COM_IPv6_MinAddress RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_MaxAddress RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_LeaseTime RO integer, .TW/.NA loads only
InternetGatewayDevice. IPInterfaceIPAddress RW
LANDevice.{i}.
LANHostConfigManage- IPInterfaceSubnetMask RW
ment.IPInterface.{j}.
ExternalIPAddress RW
MACAddress RW
AddressingType RW .TW/.NA loads only
SubnetMask RW .TW/.NA loads only

InternetGatewayDevice. DefaultGateway RW .TW/.NA loads only

WANDevice.{i}.WAN- DNSServers RW .TW/.NA loads only
ConnectionDevice.{i}. DNSOverrideAllowed RW .TW/.NA loads only
WANIPConnection. MaxMTUSize RW .TW/.NA loads only
X_ARRISI_COM_IPv6_AddressingType RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_ExternalIPAddress RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_PrefixLength RO integer, .TW/.NA loads only
X_ARRISI_COM_IPv6_DefaultGateway RO string, .TW/.NA loads only

Firmware Guide Release 7.5 Standard 1.2 August 2012

264 Chapter 5

Wi-Fi and Wireless LAN Controls

In this table, the indexes are as follows:

• LANDevice.{i} — The SSID; always 1 (the subscriber’s SSID) in
TS7.5
• WLANConfiguration.{i} — The radio ID; always 1
• PreSharedKey.{i} — The pre-shared key index; always 1

Object Parameter Status Notes

standard RO
Enable RW
Status RO
BSSID RO
MaxBitRate RW
Channel RW
AutoChannelEnable RW
SSID RW
InternetGatewayDevice. BeaconType RW
LANDevice.{i}.WLAN- WPAEncryptionModes RW
Configuration.{i}. WPAAuthenticationMode RW
IEEE11iEncryptionModes RW
IEEE11iAuthenticationMode RW
SSIDAdvertisementEnabled RW
WEPKeyIndex RW
WEPEncryptionLevel RW
MACAddressControlEnabled RW .TW/.NA loads only
RadioEnabled RW
AuthenticationServiceMode RW
InternetGatewayDevice. KeyPassphrase RW
LANDevice.{i}.WLAN-
Configuration.{i}.Pre-
SharedKey.{i}.
AllowedMACAddresses RW .TW/.NA loads only
RW .TW/.NA loads only
DNSServers
RO .CT loads only
InternetGatewayDevice. DHCPLeaseTime RW
LANDevice.{i}.LAN- X_ARRISI_COM_IPv6_PrefixLength RO integer, .TW/.NA loads only
HostConfigManagement. X_ARRISI_COM_IPv6_ServerEnable RO Boolean, .TW/.NA loads only
X_ARRISI_COM_IPv6_MinAddress RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_MaxAddress RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_LeaseTime RO integer, .TW/.NA loads only

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 265

Object Parameter Status Notes

InternetGatewayDevice. IPInterfaceIPAddress RW
LANDevice.{i}.LAN- IPInterfaceSubnetMask RW
HostConfigManagement.
IPInterface.{j}.
AddressingType RW .TW/.NA loads only
RW .TW/.NA loads only
SubnetMask
RO .CT loads only
RW .TW/.NA loads only
DefaultGateway
RO .CT loads only
InternetGatewayDevice. RW .TW/.NA loads only
WANDevice.1.WANCon- DNSServers
RO .CT loads only
nectionDevice.{i}.
DNSOverrideAllowed RW .TW/.NA loads only
WANIPConnection.{i}.
MaxMTUSize RW .TW/.NA loads only
X_ARRISI_COM_IPv6_AddressingType RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_ExternalIPAddress RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_PrefixLength RO string, .TW/.NA loads only
X_ARRISI_COM_IPv6_DefaultGateway RO string, .TW/.NA loads only

TR-098 Objects The following objects are recognized but not supported. These objects
Recognized but always return the default value defined in the TR-098 specification.
not Supported

Object
PasswordRequired
InternetGatewayDevice.UserInterface.
PasswordUserSelectable
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. DHCPServerConfigurable
Enable
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}.
IPInterfaceIPaddress
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPStaticAddress.{i}. Enable
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. MACAddressControlEnabled
PreSharedKey
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.{i}.
AssociatedDeviceMACAddress
AssociatedDeviceMACAddress
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}. AssociatedDeviceIPAddress
AssociatedDeviceAuthenticationState

Firmware Guide Release 7.5 Standard 1.2 August 2012

266 Chapter 5

References For more information about TR-069, see the following external references.
Links download the associated PDF or DOC file.
• [TR-069 Issue 3] 〈http://www.broadband-forum.org/
technical/download/TR-069_Amendment-3.pdf〉 —
TR-069 Amendment 3, CPE WAN Management Protocol
• [TR-098 Issue 2] 〈http://www.broadband-forum.org/
technical/download/TR-098_Amendment-2.pdf〉 —
TR-098 Internet Gateway Device Data Model for TR-069, Amendment
2
• Wi-Fi Provisioning Framework Specification 〈https://
www.cablelabs.com/doczone/wireless/requirements/
specs/current/wrspwifimgmti02101005.doc〉, WR-SP-
WiFi-MGMT-I02-101005

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 267

Recovery from Partial Service

The term partial service describes the situation where a DOCSIS 3.0 device
cannot acquire, or loses after acquisition, one or more of its bonded channels.
Section 8.4 of CM-SP-MULPIv3.0-I12-100115 defines the recovery mecha-
nisms to be used under the following scenarios:
The CM signals
When the channel. . .
the CMTS using. . .
is not acquired during registration REG-ACK
is not acquired during Dynamic Bonding Change DBC-RSP
becomes unusable during normal operation CM-STATUS

Most DOCSIS 3.0 CMTSs currently do not support all three partial service
signaling methods. Use the information in this procedure to configure the
Telephony Modem to work around the limitations of the CMTS, if necessary.
Consult the release notes for your CMTS firmware or software to determine
whether one of the following workarounds are needed.

Action Identify the workaround needed for your CMTS, if necessary, then use the
following tasks as needed.
Task Page
Identifying Partial Service Issues 267
If the CMTS does not Support CM-STATUS 268
If the CMTS does not Support REG-ACK 268

Identifying Partial Follow these steps to identify partial service issues on a Telephony Modem.
Service Issues 1 To identify partial service issues using an SNMP browser, read the
arrisCmDoc30ProvisionedChannelIDs object. This object displays
the channel IDs of the provisioned downstreams and upstreams. An
example display is:
DS: 8, 5, 6, (7) -- US: 5, 6, 7, 8
This example shows that the downstream channel DCID 7 is down
(enclosed in parentheses) and the modem thus has partial service.
2 To identify partial service issues using the web-based interface, access
the basic Status page. This page shows the provisioned downstreams
and upstreams in the ‘‘RF Parameters’’ section.
The Status page indicates down channels by replacing parameters
with dashes (----) for all but the provisioned frequency.

Firmware Guide Release 7.5 Standard 1.2 August 2012

268 Chapter 5

If the CMTS does If the CMTS supports the REG-ACK Partial Service Confirmation Code, but
not Support CM- not CM-STATUS message reporting, follow these steps.
STATUS 1 Set the arrisCmDoc30SetupSecDsLossReinitEnable object to
enable(1), using an SNMP manager or by changing the configuration
file.
2 If you made the change in the configuration file, reset the Telephony
Modem so the change takes effect.
3 If QAM or FEC lock is lost on a secondary downstream for 45 sec-
onds, the Telephony Modem re-initializes the downstream MAC; this
allows a REG-ACK to inform the CMTS which downstreams are
available.
4 When the secondary downstream becomes available, manually reset
the CM to restore full service.

If the CMTS does If the CMTS supports bonded channels, but does not support the REG-ACK
not Support REG- Partial Service Confirmation Code, follow these steps.
ACK 1 Set the arrisCmDoc30SetupPartServiceFallback20 object to
enable(1), using an SNMP manager or by changing the configuration
file.
2 If you made the change in the configuration file, reset the Telephony
Modem so the change takes effect.
3 If the Telephony Modem cannot acquire a secondary downstream, it
re-registers in DOCSIS 2.0 (non-bonded) mode. Every 15 minutes,
the Telephony Modem re-initializes the primary downstream DOCSIS
MAC until it can acquire all downstream channels. No further opera-
tor intervention is required.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 269

Model 8 Power Management

All Model 8 Telephony Modems and Telephony Gateways support enhanced

low-power features to maximize battery hold-up time.
When the E-UE loses AC power, it starts the data shutdown timer with a
default value of 5 minutes; use the arrisMtaDevPwrSupplyDataShutdown-
Time object to set the desired shutdown time (in seconds). If the timer
expires before AC power is restored, the device:
• powers down Ethernet and wireless (if equipped) interfaces. To leave
data services in place, set the arrisMtaDevPwrSupplyEnableData-
Shutdown object to disabled(2).

• switches to 1x1 unbonded mode after all lines go on-hook, informing

the CMTS using a CM-STATUS message.
Once AC power is restored, the E-UE:
• activates data interfaces (as provisioned)
• attempts to restore its original bonding mode.
• clears codeword counters as a side effect
If the arrisMtaDevPwrSupplyEnableDataShutdown is set to disabled(2) in
TS7.5 and newer versions of Touchstone firmware, the arrisCmDoc30Setup-
PowerSaveWifiShutdownOnly object allows shutting down the wifi inter-
face on Gateway products while leaving the Ethernet interfaces active.

Power Save vs. The arrisCmDoc30SetupPowerSaveOption object controls whether the

Synchronous Up- Telephony Modem maximizes compatibility or power saving, depending on
streams the setting:
Power Synchronous
Setting
Savings. . . Upstreams. . .
maxupstream(0) are reduced are supported
maxbattery(1) are maximized are not supported

Unless you are using synchronous upstreams, use the default setting maxbat-
tery(1) to maximize battery hold-up time during power outages.

CMTS Considera- For best results, the CMTS should fully support CM-STATUS partial service
tions messages. If the CMTS does not support CM-STATUS, add the arrisCm-
Doc30SetupPowerSaveMode object to the CM configuration file with a
value of reinitmac(1). This causes the CM to re-register in unbonded (1x1)
mode upon loss of AC power, and re-register to bonded mode when AC
power is restored.

Firmware Guide Release 7.5 Standard 1.2 August 2012

270 Chapter 5

Note: Re-registration may take up to 90 seconds.

When the CMTS is upgraded, change the value to the default partialser-
vice(0), or remove the object from the CM configuration file.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 271

ARRIS DOCSIS 3.0 MIB

The arrisCmDoc30 MIB provides information, access control, and DHCP

settings for Touchstone products supporting DOCSIS 3.0.
The following objects are part of the arrisCmDoc30 MIB.

arrisCm- Miscellaneous information and control objects:

Doc30Base arrisCmDoc30ResetFactoryDefaults
Set to 1 to reset the E-UE to factory default settings.
arrisCmDoc30FwImageName
A string containing the firmware image name.
arrisCmDoc30FwImageBuildTime
A string containing the firmware build date and time. This may be
useful when calling ARRIS Technical Support.
arrisCmDoc30MfgCertCommunityName
The community name of the manufacturing certificate in use: US for
North American DOCSIS, or BE for Euro-DOCSIS.
arrisCmDoc30BondingMode
The registration mode of the Telephony Modem and how many
downstreams and upstreams it uses. Example: DOCSIS3.0 4x1
arrisCmDoc30ResetAccessTime
Set to true(1) to reset access start times in non-volatile memory.
arrisCmDoc30ProvisionedChannelIDs
Displays the channel IDs of the provisioned upstreams and down-
streams. Downstreams that are not currently locked are enclosed in
parentheses, indicating that the modem has partial service.
arrisCmDoc30BaseReportDuplex
Displays the duplex status of the Ethernet port; one of: Full, Half, or
Unavailable.

arrisCmDoc30Ac- These objects control access to the CLI and web pages.
cess arrisCmDoc30AccessTelnetPassword
A string containing the password used to enable Telnet. Except for
TW loads, this object must be set to enable Telnet access.
arrisCmDoc30AccessTelnetEnable
Enables or disables access to the CLI using Telnet.
arrisCmDoc30AccessClientSeed
A string containing the seed used to generate the Password of the
Day. If you change this value, you must also change the value of
the seed used in the PacketACE Password of the Day generator.

Firmware Guide Release 7.5 Standard 1.2 August 2012

272 Chapter 5

Clear this value to use the default seed.

arrisCmDoc30AccessSinglePassword
A string containing an encrypted password to be used in place of the
Password of the Day.
arrisCmDoc30AccessHttpLan
Controls access to the web pages from the LAN (Ethernet, wireless,
and USB) interfaces.
arrisCmDoc30AccessHttpWan
Controls access to the web pages from the WAN (cable) interface.
arrisCmDoc30AccessHttpTimeout
The time, in minutes, that the Advanced web pages are accessible
before the Telephony Modem requires re-entry of the Password of
the Day. Use 0 to disable the timeout.
arrisCmDoc30CLITimeout
The time, in minutes, that a Telnet or SSH session can be idle before
the Telephony Modem terminates the session. Valid range: 1 to
65535 minutes, or 0 to disable timeout.

arrisCmDoc30AccessHttpPwCtrl
Controls which web pages are password protected:
• none(0): no pages are protected
• advanced(1): advanced pages are protected (default)
• all(2): all pages are protected
arrisCmDoc30AccessSSHEnable
Enables or disables SSH access. To enable SSH, this object must be
enabled, and (except for TW loads) the arrisCmDoc30AccessTel-
netPassword object must also be set.

arrisCmDoc30Set- These objects control Telephony Modem features.

up arrisCmDoc30SetupDsBonding
Enables or disables downstream channel bonding.
Note: The object setting takes effect at the next reboot, and persists
across reboots. If this object is set to disable(0), the modem dis-
ables DOCSIS 3.0 operation until re-enabled.
arrisCmDoc30SetupPacketProcessorEnable
Enables or disables the Telephony Modem packet processor. Do not
set this object except for testing and troubleshooting purposes.
arrisCmDoc30SetupMultiColorLedBitmap
Controls the behavior of the multi-color LEDs:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 273

0x1: Link LED

0x2: US LED
0x4: DS LED

Set a bit to 1 to enable multi-color functionality (green for high-

speed connections, yellow for normal speed); or 0 to use green for
all connection speeds.
Default: 7 (multi-color for all three LEDs)
arrisCmDoc30SetupSecDsLossReinitEnable
Set to enable(1) to force the cable modem to re-initialize the DOC-
SIS MAC on the primary downstream if QAM or FEC lock on a
bonded downstream secondary channel is lost for 45 seconds. This
can improve partial services support with certain DOCSIS 3.0
CMTS. Set to disable(0) for use with a CMTS that fully supports
DOCSIS 3.0 CM-STATUS messages.
arrisCmDoc30SetupPartServiceFallback20
When set to enable(1), and one or more secondary downstreams are
unavailable, the Telephony Modem does not send a partial services
confirmation code in a REG-ACK message; instead, it reinitializes
the primary downstream DOCSIS MAC and forces the CM to fall-
back to DOCSIS 2.0 mode (which disables channel bonding, effec-
tively limiting the CM to 1x1 operation). The CM tries to range and
register in DOCSIS 3.0 mode at 15-minute intervals.
This feature is designed specifically to allow interoperability with
certain DOCSIS 3.0 CMTS releases that do not support a REG-
ACK message containing a partial services confirmation code. This
feature may provide an improved level of partial services support in
this case.
Disable this object when used with a CMTS that fully supports
DOCSIS 3.0 CM-STATUS messages.
arrisCmDoc30SetupDSTPolicy
Sets the Daylight Savings Time (DST) policy. This object contains
a string, defining the starting and ending dates and times for DST.
The format of the string is as follows:
start=month/day/weekday/hour;end=month/day/weekday/hour
where. . . is. . .
month the month: 1 for January, to 12 for December.
day The day: −31 to −1 to count backwards from the
end of the month, 1 to 31 to count forward from
the beginning of the month.

Firmware Guide Release 7.5 Standard 1.2 August 2012

274 Chapter 5

weekday The day of the week that DST begins or ends: 1

for Monday, to 7 for Sunday, or 0 to ignore the
weekday and use the exact date. If not zero,
DST begins or ends on the specified weekday
after the date if the date is positive, or before the
date if negative.
hour The hour at which DST begins or ends: 00 to 23.

Example:
start=3/8/7/02;end=11/1/7/02
Implements the U.S. DST policy in effect since March 2007: DST
begins at 2 a.m. on the second Sunday in March and ends at 2 a.m.
on the first Sunday in November.
arrisCmDoc30SetupMddIpModeOverride
Specifies whether the CM honors or ignores the TLV5.1 message
from the CMTS. This object is deprecated in favor of the PacketCa-
ble-defined docsIf3CmMdCfgIpProvMode object. Use only one or
the other in the configuration file.
arrisCmDoc30SetupPacketCableRegion
Sets the region for MTA PacketCable provisioning: northAmeri-
can(0) or european(1).

arrisCmDoc30SetupTodDelaySecProv
Enables or disables delaying of secure provisioning when Time of
Day retrieval fails.
arrisCmDoc30SetupUdcAllowed
Allows or disallows upstream drop classifiers, overriding the REG-
RSP value. The settings are:
0: disallow UDC, regardless of what the CMTS sets
1: allow UDC

arrisCmDoc30SetupTODTimeOffset
Sets the CM ToD time offset from GMT, in seconds. Valid range:
−43200 (−12 hours) to 46800 (+13 hours). This value may be over-
written when the TOD offset option is received through DHCP.
arrisCmDoc30SetupDhcpRetries
The number of times the MTA ignores a non-Secure (BASIC or
HYBRID) DHCP OFFER while waiting for a SECURE flow DHCP
OFFER.
arrisCmDoc30SetupInvertMulticolorLEDs
Enables or disables inverted multicolor LED behavior. The setting
is stored to non-volatile memory and persists across reboots. The
settings are:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 275

disable(0):
Original WBM3.2/TS7.1 LED color scheme:
Bonded DS = Green; non-bonded DS = Yellow
Bonded US = Green; non-bonded US = Yellow
GigE/USB2.0 = Green; 10/100/USB1.x = Yellow
enable(1):
Inverted LED color scheme:
Bonded DS = Yellow; non-bonded DS = Green
Bonded US = Yellow; non-bonded US = Green
GigE/USB2.0 = Yellow; 10/100/USB1.x = Green
arrisCmDoc30SetupTurboDoxEnable
Enables or disables TurboDox operation. Set to true(1) (default) to
enable TurboDox operation mode, or false(2) to disable TurboDox.
This object can be changed only in the configuration file.
arrisCmDoc30SetupMdfSupportOverride
Configures MDF override support:
disable(0): disables MDF override, using the value provided in the
REG-RSP from the CMTS
enable(1): force-disables MDF support

arrisCmDoc30SetupAdvancedWebPageAccess
Enables or disables access to the Advanced web page:
• To disable all access to the Advanced pages, set the value to
none(0).

• To enable access from the LAN, set the value to lan-access(1).

• To enable access from the WAN, set the value to wan-access(2).
• To enable access from both the LAN and the WAN, set the value
to wan-lan-access(3).
arrisCmDoc30SetupReducedOORThreshold
Controls the number of Out-Of-Range packets that the modem dis-
cards, and the minimum time it waits before it re-syncs the ‘‘Next
Expected Packet Sequence Number’’ with the CMTS.
• When set to enable(1), the packet threshold is set to 3 and the
timeout to 1 second.
• When set to the default disable(0), the packet threshold is set to
1000 and the timeout to 2 minutes per the MULPI specification.
arrisCmDoc30SetupPowerSaveMode
Controls the method used for power save mode.
• When set to reinitmac(1), entering Power Save mode triggers a
MAC reinit to 1x1 unbonded, and exiting Power Save mode trig-
gers another MAC reinit to the provisioned bonding. When set to
partialservice(0), entering Power Save mode does not reinitialize
the MAC layer, but issues CM-STATUS messages to the CMTS to

Firmware Guide Release 7.5 Standard 1.2 August 2012

276 Chapter 5

report partial service when powering down the secondary chan-

nels.
arrisCmDoc30SetupPowerSaveOption
Sets the upstream behavior during Power Save mode:
maxbattery(1)
Configures maximum battery hold-up time during AC power
failure. In this mode the modem does not support synchro-
nous upstreams, such as SCDMA.
maxupstream(0)
In this mode, the modem supports all upstream types. Battery
hold-up time is reduced, even when not registered on a syn-
chronous upstream.
If this object is altered, the modem automatically reboots after the
change is applied.
arrisCmDoc30SetupKeepCpeOnIfDisconnect
Set to enable(1) to retain the CPE MAC address in the CPE table
when the interface is disconnected. The default is disable(0).
arrisCmDoc30SetupPowerSaveWifiShutdownOnly
Set to enable(1) to power down only the wifi interface during
Power Save mode. This allows the wired Ethernet interface to
remain active. When disabled (the default), the entire gateway
(including the Ethernet interface) is powered down during Power
Save mode.
arrisCmDoc30SetupTODSyncTimeout
The interval, in hours, between ToD sync operations. Valid range: 0
(default, disable sync completely) to 4320.
Setting this object restarts the timer.
arrisCmDoc30SetupSWDLFilenameCheckOverride
Controls whether the modem accepts and downloads a new image
that has the same filename as the previous download. A value of
disable(0) (the default) prevents an automated provisioning system
from downloading an image that the modem has already received.
This override affects only docsDevSwAdminStatus-initiated
upgrades using upgradeFromMgt; the upgrade system always dis-
ables upgrades using allowProvisioningUpgrade when the file
names are identical.
arrisCmDoc30SetupEthernetLinkBounce
When set to enable(1), the modem adds an additional step to the T4
DOCSIS MAC reinitialization sequence. In addition to the normal
DOCSIS MAC reinitilization, the modem briefly disables the Ether-
net link between the modem and the CPE. This causes the customer
CPE to drop its current IP address and restart its DHCP process.
The default setting is disable(0).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 277

arrisCmDoc30SetupIgnoreMddSymbolClockIndicator
When set to enable(1), the CM ignores the Symbol Clock Locking
Indicator TLV in the MDD message and always uses asynchronous
timing mode. In this mode, the cable modem does not lock to the
downstream symbol clock on its Primary Downstream Channel. It
acquires the synchronization timebase for upstream burst timing
from the SYNC messages.
When set to disable(0), the CM follows the timing mode specified
by the Symbol Clock Indicator TLV in the MDD message.
arrisCmDoc30SetupTCPAckSuppression
Enables or disables TCP Ack suppression. Default: true(1).
arrisCmDoc30SetupL2VPNPromiscuousMode
Enables or disables L2VPN promiscuous mode.

arrisCm- These objects provide DHCP status information. There are four groups
Doc30Dhcp under this MIB:
• arrisCmDoc30DhcpLeaseParameters
• arrisCmDoc30DhcpSvrParameters
• arrisCmDoc30DhcpCmParameters
• arrisCmDoc30DhcpMtaParameters

arrisCmDoc30DhcpLeaseParameters Objects

These objects provide information about the current DHCP lease.

arrisMtaDoc30DhcpOfferedLeaseTime
The offered lease time, in seconds.
arrisCmDoc30DhcpTimeUntilRenew
The time, in seconds, before the eDVA begins a RENEW exchange.
arrisCmDoc30DhcpTimeUntilRebind
The time, in seconds, before the eDVA begins a REBIND exchange.
arrisCmDoc30DhcpLeaseTimeRemaining
The remaining lease time, in seconds.

arrisCmDoc30DhcpSvrParameters Objects

These objects provide information about the DHCP server. All these objects
are read-only.
arrisCmDoc30DhcpState
The current CM DHCP state; one of:

Firmware Guide Release 7.5 Standard 1.2 August 2012

278 Chapter 5

• init-selecting(0)
• requesting(1)
• bound(2)
• renewing(3)
• rebinding(4)
• init-reboot(5)
• renew-requested(6)
• released(7)
arrisCmDoc30DhcpPrimaryDhcpServerIpAddr
Displays the primary DHCP server address.
arrisCmDoc30DhcpTftpSvrIpAddr
Displays the current TFTP server IP address in use.
arrisCmDoc30DhcpTimeSvrIpAddr
Displays the current Time server IP address in use.
arrisCmDoc30DhcpCmTimeOffset
Displays the current time offset being used by the CM.
arrisCmDoc30DhcpPrimaryTeleDhcpSvr
Displays the primary MTA DHCP server address.
arrisCmDoc30DhcpSecondaryTeleDhcpSvr
Displays the secondary MTA DHCP server address.

arrisCmDoc30DhcpCmParameters Objects

These objects provide information about the current CM DHCP lease. All
these objects are read-only.
arrisCmDoc30DhcpCmIpAddrType
Displays the type (IPv4 or IPv6) of the currently leased IP address.
arrisCmDoc30DhcpCmIpAddr
Displays the currently leased IP address.
arrisCmDoc30DhcpCmSubNetMask
Displays the current IP subnet mask in use.
arrisCmDoc30DhcpCmGatewayIpAddr
Displays the current IP gateway address in use.
arrisCmDoc30DhcpCmConfigFile
Displays the CM configuration file to be retrieved.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 279

arrisCmDoc30DhcpMtaParameters Objects

These objects provide information and control over MTA DHCP operation.
arrisCmDoc30DhcpMtaOpt60Override
Enables or disables SIP advertisement in MTA DHCP Option 60.
The default is disabled. This object can be set only using the CM
configuration file.

arrisCm- These objects provide extended DHCP information. All these objects are
Doc30DhcpEx- read-only.
tended arrisCmDoc30DhcpExtendedProvisionedMode
Displays the CM provisioned mode:
• ipv4-only(0)
• ipv6-only(1)
• alternate-prov-mode(2)
• dual-prov-mode(3)
arrisCmDoc30DhcpExtendedPreferredMode
Displays the CM preferred IP mode: ipv4(0) or ipv6(1).
arrisCmDoc30DhcpExtendedActiveMode
Displays the CM active IP mode: ipv4(0) or ipv6(1).

arrisCmDoc30DhcpExtendedLeaseParametersTable Objects

This table provides DHCP lease information.

arrisCmDoc30DhcpExtendedLeaseParametersType
The DHCP type: dhcpv4(0) or dhcpv6(1).
arrisCmDoc30DhcpExtendedOfferedLeaseTime
The offered IP lease time, in seconds.
arrisCmDoc30DhcpExtendedTimeUntilRenew
The current time remaining, in seconds, before the MTA starts the
lease renewal process.
arrisCmDoc30DhcpExtendedTimeUntilRebind
The current time remaining, in seconds, before the CM starts the
lease rebinding process.
arrisCmDoc30DhcpExtendedLeaseTimeRemaining
The remaining IP lease time, in seconds.

Firmware Guide Release 7.5 Standard 1.2 August 2012

280 Chapter 5

arrisCmDoc30DhcpExtendedSvrParametersTable

This table provides extended information about the DHCP server.

arrisCmDoc30DhcpExtendedSvrParametersType
The DHCP type: dhcpv4(0) or dhcpv6(1).
arrisCmDoc30DhcpExtendedState
The current DHCP state of the CM:
• init-selecting(0)
• requesting(1)
• bound(2)
• renewing(3)
• rebinding(4)
• init-reboot(5)
• renew-requested(6)
• released(7)
• dhcp6c-init(8)
• dhcp6c-solicit(9)
• dhcp6c-inforeq(10)
• dhcp6c-request(11)
• dhcp6c-renew(12)
• dhcp6c-rebind(13)
• dhcp6c-release(14)
• dhcp6c-decline(15)
• dhcp6c-confirm(16)
• dhcp6c-idle(17)
arrisCmDoc30DhcpExtendedPrimaryDhcpServerIpAddr
The primary DHCP server address.
arrisCmDoc30DhcpExtendedTftpSvrIpAddr
The current TFTP server IP address in use.
arrisCmDoc30DhcpExtendedTimeSvrIpAddr
The current time server IP address in use.
arrisCmDoc30DhcpExtendedCmTimeOffset
The current time offset used by the CM.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 281

arrisCmDoc30DhcpExtendedPrimaryTeleDhcpSvr
The primary MTA DHCP server address.
arrisCmDoc30DhcpExtendedSecondaryTeleDhcpSvr
The secondary MTA DHCP server address.

arrisCmDoc30DhcpExtendedCmParametersTable Objects

This table provides extended DHCP information for the CM.

arrisCmDoc30DhcpExtendedCmParametersType
The DHCP type: dhcpv4(0) or dhcpv6(1).
arrisCmDoc30DhcpExtendedCmIpAddr
The currently leased IP address.
arrisCmDoc30DhcpExtendedCmSubNetMask
The current IP subnet mask.
arrisCmDoc30DhcpExtendedCmPrefix
The current IP Prefix.
arrisCmDoc30DhcpExtendedCmGatewayIpAddr
The current IP gateway address.
arrisCmDoc30DhcpExtendedCmConfigFile
The CM configuration file to be retrieved.

arrisCmDoc30Re- These objects contain the reset reason log. All these objects are read-only.
setReasonLog arrisCmDoc30LastHwResetReason
The last reset reason retrieved from the processor hardware. This
reason is used to determine if hardware or firmware caused the
reset.

arrisCmDoc30ResetReasonLogTable Objects

This table contains the last ten reset reasons. The valid index range is 1 to
10.

arrisCmDoc30ResetReasonLogText
The reported reset reason log text.

arrisCm- See ‘‘Using Enhanced Firmware Loading’’ on page 47 for a description of

Doc30Software objects in this branch.

Firmware Guide Release 7.5 Standard 1.2 August 2012

282 Chapter 5

DOCSIS 3.0 MIB The following table shows how to map certain ARRIS DOCSIS 2.0 MIB
Object Mapping objects to their DOCSIS 3.0 counterparts.
DOCSIS 2.0 Object/OID DOCSIS 3.0 Object/OID
arrisCmProdResetToFactoryDefaults arrisCmDoc30ResetFactoryDefaults
1.3.6.1.4.1.4115.1.3.2.2.15 1.3.6.1.4.1.4115.1.3.4.1.1.6
arrisCmDevSwImageName arrisCmDoc30FwImageName
1.3.6.1.4.1.4115.1.3.1.1.1.2 1.3.6.1.4.1.4115.1.3.4.1.1.7
arrisCmDevSwImageBuildTime arrisCmDoc30FwImageBuildTime
1.3.6.1.4.1.4115.1.3.1.1.1.3 1.3.6.1.4.1.4115.1.3.4.1.1.8
arrisCmProdAccessPWD arrisCmDoc30AccessTelnetPassword
1.3.6.1.4.1.4115.1.3.2.2.2 1.3.6.1.4.1.4115.1.3.4.1.2.1
arrisCmDevTelnetEnable arrisCmDoc30AccessTelnetEnable
1.3.6.1.4.1.4115.1.3.1.1.2.3.23 1.3.6.1.4.1.4115.1.3.4.1.2.2
arrisCmDevHttpClientSeed arrisCmDoc30AccessClientSeed
1.3.6.1.4.1.4115.1.3.1.1.2.3.5.5 1.3.6.1.4.1.4115.1.3.4.1.2.3
arrisCmDevSinglePasswd arrisCmDoc30AccessSinglePassword
1.3.6.1.4.1.4115.1.3.1.1.2.3.22 1.3.6.1.4.1.4115.1.3.4.1.2.4
arrisCmDevHttpLanAccess arrisCmDoc30AccessHttpLan
1.3.6.1.4.1.4115.1.3.1.1.2.3.5.3 1.3.6.1.4.1.4115.1.3.4.1.2.5
arrisCmDevHttpWanAccess arrisCmDoc30AccessHttpWan
1.3.6.1.4.1.4115.1.3.1.1.2.3.5.4 1.3.6.1.4.1.4115.1.3.4.1.2.6
arrisCmDevSwTable arrisCmDoc30SwTable
1.3.6.1.4.1.4115.1.3.3.1.4.1 1.3.6.1.4.1.4115.1.3.4.1.5.1
arrisCmDevSwCustomerLoadId arrisCmDoc30SwCustomerLoadId
1.3.6.1.4.1.4115.1.3.3.1.4.1.1.2 1.3.6.1.4.1.4115.1.3.4.1.5.1.1.2
arrisCmDevSwHwModel arrisCmDoc30SwHwModel
1.3.6.1.4.1.4115.1.3.3.1.4.1.1.3 1.3.6.1.4.1.4115.1.3.4.1.5.1.1.3
arrisCmDevSwHwRev arrisCmDoc30SwHwRev
1.3.6.1.4.1.4115.1.3.3.1.4.1.1.4 1.3.6.1.4.1.4115.1.3.4.1.5.1.1.4
arrisCmDevSwFilename arrisCmDoc30SwFilename
1.3.6.1.4.1.4115.1.3.3.1.4.1.1.6 1.3.6.1.4.1.4115.1.3.4.1.5.1.1.5
arrisCmDevSwServerAddressType arrisCmDoc30SwServerAddressType
1.3.6.1.4.1.4115.1.3.3.1.4.1.1.7 1.3.6.1.4.1.4115.1.3.4.1.5.1.1.6
arrisCmDevSwServerAddress arrisCmDoc30SwServerAddress
1.3.6.1.4.1.4115.1.3.3.1.4.1.1.8 1.3.6.1.4.1.4115.1.3.4.1.5.1.1.7

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 283

Supported eDVA MIB Objects

TS7.5 supports the following ARRIS eDVA MIB objects.

PACKETPORT-MIB The following objects are supported:

Objects ppCfgMtaCountryTemplate
Specifies the country template for ring cadences and signaling tones.
ppCfgMtaCallpFeatureSwitch
The CallP Feature Switch. See ‘‘CallP Feature Switch’’ on page 74
for details.
ppCfgRfc2833DigitPayloadType
When bit 0x01000000 of the CallP Feature Switch is set, this object
specifies the payload type used to send DTMF events. Valid range:
97 to 127. Default: 101.

ppCfgMtaFeatureSwitch
The eDVA Feature Switch. See ‘‘eDVA Feature Switch’’ on
page 84 for details.

ppCfgPortTable Objects

The following objects are supported.

ppCfgPortLoopCurrent
Sets the loop current for the specified line: normal(1) or high(2).
ppCfgPortLocUserIndication
The tone applied during Loss of Communication (LoC): silence(0)
or reorderTone(1) (default).
ppCfgPortT38MaxDatagram
The maximum datagram size for incoming T.38 packets. Valid
range: 160 (default) to 65535. If this object is set to a value higher
than the default, the Call Agent must allocate more bandwidth
accordingly.

ppSurvPortTable Objects

The following objects are supported.

ppSurvPortMaintState
The maintenance state of the line.
ppSurvPortLcDiagLastResult
The last result of linecard diagnostics performed on the line.

Firmware Guide Release 7.5 Standard 1.2 August 2012

284 Chapter 5

ARRIS-MTA-MIB The following MIB objects from the ARRIS-MTA-MIB are supported. Bat-
(non-battery) tery-related objects are listed below.

arrisMtaDevControl Objects

The following arrisMtaDevControl objects are supported:

arrisMtaDevResetCallStats
Set this object to true(1) to reset the following objects to their
default values:
• arrisMtaDevRtpTxPktsTotal
• arrisMtaDevRtpRxPktsTotal
• arrisMtaDevRtpPercentPktsLostTotal
• arrisMtaDevSignalingAvgLatency
• arrisMtaDevSignalingTxSuccessfulMsgCnt
• arrisMtaDevSignalingRxSuccessfulMsgCnt
• arrisMtaDevSignalingTxNAKCnt
• arrisMtaDevSignalingRxNAKCnt
• arrisMtaDevSignalingRxNoACKCnt
Setting this object to false(2) does nothing. Reading this object
always returns false(2).
arrisMtaDevEnableCallpSigTrace
Controls CallP signaling message tracing in the Syslog. Take care
when setting this object, as excessive messaging could adversely
affect performance. The default value is disable(0).
arrisMtaDevEnableCallStatsSyslogRpt
Enables end-of-call statistics reporting, and CallP signaling last
message reporting, to the Syslog.
When set to enable(1), end-of-call statistics are reported in the Sys-
log. If the arrisMtaDevEnableCallSigLastMsgRpt object is
enabled, then the last 4K of signaling messages is also reported in
the Syslog.
When set to disable(0) (the default), end-of-call statistics and the
CallP last signaling messages are not reported in the Syslog.
arrisMtaDevSwDnldNoSvcImpact
Enables or disables the software download service impact feature.
When set to enable(1) (the default), the eDVA accepts the load, but
does not apply the load until all lines have been idle for at least 30
seconds after the load has been accepted.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 285

arrisMtaDevEnableCallSigLastMsgRpt
Enables or disables reporting of the CallP signaling ‘‘last message’’
to the MIB objects arrisMtaDevSignalingLastMsg1 through arris-
MtaDevSignalingLastMsg16. Together the sixteen objects contain
a signaling message up to 4000 bytes long. Each object contains a
255-byte segment of the message. If the message does not require
all sixteen MIBs, then the empty objects display ‘‘Buffer is empty.’’
The default value is disable(0).
arrisMtaDevNsadSwDnldStatus
(read-only) Displays the current firmware download status:
download-Idle(0)
Indicates that the firmware download has completed. This
value is also set at startup.
download-Acceptance-In-Progress(1)
The unit is currently downloading the firmware in the back-
ground.
download-Application-Pending(2)
Indicates that the load has been downloaded and accepted but
is waiting to be applied.
This MIB object is only valid if the arrisMtaDevSwDnldNoSvc-
Impact object is set to enabled(1).

arrisMtaDevRestoreNvmFactoryDefault
Set this object to true(1) to reset the NVM to default values.

arrisMtaDevTrace Objects

These objects control and display message trace results.

arrisMtaDevRtpTxPktsTotal
(read-only) Reports the total number of RTP packets sent from the
MTA since it was last started up or reset. This value represents the
total number of packets sent for all endpoints combined. It is calcu-
lated from values obtained from the signaling end of call statistics.
Set the arrisMtaDevResetCallStats object to true(1) to clear this
counter.
arrisMtaDevRtpRxPktsTotal
(read-only) Reports the total number of RTP packets received by the
MTA since it was last started up or reset. This value represents the
total number of packets received for all endpoints combined. It is
calculated from values obtained from the signaling end of call statis-
tics. Set the arrisMtaDevResetCallStats object to true(1) to clear
this counter.

Firmware Guide Release 7.5 Standard 1.2 August 2012

286 Chapter 5

arrisMtaDevRtpPercentPktsLostTotal
(read-only) This MIB object reports the percentage of RTP packets
lost since the MTA was last started up or reset. This value repre-
sents the total number of packets lost for all endpoints combined. It
is calculated from values obtained from the signaling end of call sta-
tistics. Set the arrisMtaDevResetCallStats object to true(1) to
clear this counter.
The value of this object is expressed in increments of 1/100 percent.
For example, a value of 1745 means that 17.45% of the packets
were lost.
arrisMtaDevProvState
(read-only) Reports the current provisioning state of the MTA:
• dhcpBound(1)
• dnsReqProvSvrIP(2)
• kdcHostNameDnsReq(3)
• kdcHostNameDnsRply(4)
• kdcIpDnsReq(5)
• kdcIpDnsRply(6)
• asReqSent(7)
• asRplyRcvd(8)
• tgsReqSent(9)
• tgsRplyRcvd(10)
• apReqSent(11)
• apRplyRcvd(12)
• enrollmentInform(13)
• cfgUrlSet(14)
• dnsReqTftpSvrIp(15)
• cfgFileReq(16)
• rcvCfgFile(17)
• syslogMsgProvComplete(18)
• statusInform(19)
• provcomplete(20)
arrisMtaDevSWUpgradeStatus
(read-only) Reports the current software upgrade status of the
device:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 287

• inProgress(1)
• completeFromProvisioning(2)
• completeFromMgt(3)
• failed(4)
• other(5)
arrisMtaDevSignalingAvgLatency
(read-only) The average latency or delay, in milliseconds, for
responses to signaling messages. It is calculated from values
obtained from the signaling end of call statistics. Set the arrisMta-
DevResetCallStats object to true(1) to clear this counter.

arrisMtaDevSignalingTxSuccessfulMsgCnt
(read-only) Reports the total number of successful signaling mes-
sages sent from the eDVA. Set the arrisMtaDevResetCallStats
object to true(1) to clear this counter.
arrisMtaDevSignalingRxSuccessfulMsgCnt
(read-only) Reports the total number of successful signaling mes-
sages received by the MTA. Set the arrisMtaDevResetCallStats
object to true(1) to clear this counter.
arrisMtaDevSignalingTxNAKCnt
(read-only) Reports the total number of negative acknowledgement
signaling messages (NAKmessages) sent from the MTA. Set the
arrisMtaDevResetCallStats object to true(1) to clear this counter.

arrisMtaDevSignalingRxNAKCnt
(read-only) Reports the total number of negative acknowledgement
signaling messages (NAKmessages) received by the MTA. Set the
arrisMtaDevResetCallStats object to true(1) to clear this counter.

arrisMtaDevSignalingRxNoACKCnt
(read-only) Reports the total number of ’no acknowledgement’ sig-
naling messages received by the MTA. Set the arrisMtaDevReset-
CallStats object to true(1) to clear this counter.

arrisMtaDevSignalingLastMsg1–16
(read-only) These objects contain a 255-byte segment of the CallP
last signaling message sent or received. The sixteen objects
together can display a signaling message as large as 4000 bytes. If
the message does not require all sixteen objects, then the empty
objects display the value ‘‘Buffer is empty.’’
Use arrisMtaDevEnableCallSigLastMsgRpt to enable or disable
reporting of the CallP signaling last message.
arrisMtaDevRtpPktsLostTotal
(read-only) The number of RTP packets lost since the MTA was last
started up or reset. This value represents the total number of pack-
ets lost for all endpoints combined. It is calculated from values

Firmware Guide Release 7.5 Standard 1.2 August 2012

288 Chapter 5

obtained from the signaling end of call statistics. Set the arrisMta-
DevResetCallStats object to true(1) to clear this counter.

arrisMtaDevLastCallStartTime
(read-only) The last call start time from the eDVA.
arrisMtaDevLastCallEndTime
(read-only) The last call end time from the eDVA.

arrisMtaDevCallStatsTable

This table reports various end of call statistics. All objects in this table are
read-only, and are indexed by line number.
arrisMtaDevCallStatsRtpTxPkts
The total number of RTP packets sent from the endpoint during the
most recent call. This value is obtained from the signaling end-of-
call statistics.
arrisMtaDevCallStatsRtpRxPkts
The total number of RTP packets received by the endpoint during
the most recent call. This value is obtained from the signaling end-
of-call statistics.
arrisMtaDevCallStatsRtpPercentPktsLost
The percentage of RTP packets lost during the most recent call.
This value is obtained from the signaling end-of-call statistics.
The value of this object is expressed in increments of 1/100 percent.
For example, a value of 1745 means that 17.45% of the packets
were lost.
arrisMtaDevCallStatsAvgJitter
The average jitter measurement, in milliseconds, during the most
recent call. This value is obtained from the signaling end-of-call
statistics.
arrisMtaDevCallStatsMaxJitter
The maximum jitter measurement, in milliseconds, during the most
recent call. This value is obtained from DSP statistics.
arrisMtaDevCallStatsAvgLatency
The average latency, in milliseconds, observed during the most
recent call. This value is obtained from the signaling end-of-call
statistics.
arrisMtaDevCallStatsHookStatus
The hook status for each endpoint: onHook(0) or offHook(1).
Note: The disconnected state is not a valid return value for this MIB
object.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 289

arrisMtaDevCallStatsSLICStatus
The over temperature condition of the SLIC chips: normal(0) or
overtemp(1).

arrisMtaDevCallStatsEndPntOpStatus
The current operational status for each endpoint. up(1) (ready to
pass packets), down(2), or testing(3) (in some test mode). This
object obtains its value from ifAdminOperStatus.
arrisMtaDevCallStatsLineSubState
The current sub-state for each line: normal(0), diagsPending(1),
diagsFailed(2), lcProtection(3), or dspFail(4). This object obtains
its value from the lineRec.

arrisMtaDevParameters

These objects provide information about E-UE and line parameters. All
objects in this group are read-only.
arrisMtaDevMaxCpeAllowed
Reflects the ‘‘MaxCpeAllowed’’ parameter in the CM config file.
arrisMtaDevNetworkAccess
Reflects the ‘‘NetworkAccess’’ parameter set in the CM config file:
no(0) or yes(1).

arrisMtaDevQosMode
Reflects the setting of the DSx DQoS bit (0x00004000) in the CallP
Feature Switch: bestEffort-FullDQos-PCMM(0) or dsxMode(1).
arrisMtaDevEventFormat
The PacketCable event format in use: pktc10(0) (PacketCable 1.0)
or pktc15(1) (PacketCable 1.5).

arrisMtaDevLineParameterTable

This table reports various line parameters on the eMTA.

arrisMtaDevInterfaceIndex
The ifIndex object for a particular line.
arrisMtaDevPktcDevEvEndpointName
The endpoint name in the following format:
AALN/line:FQDN/ipaddr.

arrisMtaDevActiveConnections
The number of active connections for a particular line. Active con-
nections include receive-only, send-only, and send/receive; but not
inactive.

Firmware Guide Release 7.5 Standard 1.2 August 2012

290 Chapter 5

arrisMtaDevLineMWIActive
The MWI status for the line.
arrisMtaDevLineRTCPXR
Indicates whether or not RTCP-XR is configured: disabled(0) or
enabled(1). The setting is based on the value of the arrisMtaDev-
VqmEnableRemote and pktcEDVACodecRTCPXR objects accord-
ing to the following table:
arrisMtaDevLineRTCPXR
arrisMtaDevVqmEnableRemote pktcEDVACodecRTCPXR(1)
PC2.0 Legacy SIP NCS
normal true enabled disabled disabled
normal false disabled(2) disabled(2) disabled(3)
forceDisable true disabled disabled disabled
forceDisable false disabled disabled disabled
forceEnable true enabled enabled enabled
forceEnable false enabled enabled enabled
(1)The pktcEDVACodecRTCPXR object is applicable only to PC2.0.
(2)Though arrisMTADevLineRTCPXR is set to disabled, the remote may still request RTCP-XR to be transmitted which
will be honored.
(3) Though arrisMTADevLineRTCPXR is set to disabled, the Call Agent may instruct the MTA to request RTCP-XR
through NCS signaling.

arrisMtaDevLineRTCPXRNegotiatedConnectionA
The negotiation status of RTCP-XR for a particular line’s A (i.e.
first) connection. The status is one of the following:
callNotInProgress(0)
no active call is utilizing this connection/call leg.
notNegotiated(1)
RTCP-XR is not negotiated to be sent on this call leg.
negotiated(2)
RTCP-XR is negotiated to be sent on this call leg.
arrisMtaDevLineRTCPXRNegotiatedConnectionB
The negotiation status of RTCP-XR for a particular line’s B (i.e.
second) connection. The status is identical to the A connection
above.

arrisMtaDevUpSvcFlowParameterTable

This table reports various Upstream Service Flow parameters on the eMTA.
arrisMtaDevDocsQosParamUpSvcFlowSFID
The upstream service flow SFID for a valid service flow index.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 291

arrisMtaDevDocsQosParamUpSvcFlowSchedulingType
The upstream service flow scheduling type for a valid service flow
index.

arrisMtaDevVqm Objects

These objects control the Voice Quality Monitoring (VQM) feature.

arrisMtaDevVqmLine
Specifies the line for Voice Quality Metrics reporting.
arrisMtaDevVqmClear
Clears Voice Quality Metrics: single-line(0) or all-lines(1). To
clear a single line, specify the line using arrisMtaDevVqmLine.
arrisMtaDevVqmEnable
Enables or disables recording of Local Voice Metrics: disable(0) or
enable(1) (the default).

arrisMtaDevVqmCallNumberTable
Voice Quality Metric history on a per call number basis. See ‘‘Man-
aging Voice Quality Monitoring’’ on page 371 for details.
arrisMtaDevVqmCallNumberIdentifier
Specifies the call number for Voice Quality Metrics reporting. Valid
IDs are obtained from arrisMtaDevVqmCallNumberIds.
arrisMtaDevVqmMetricTable
Voice Quality Metrics pertaining to a particular call number. See
‘‘Managing Voice Quality Monitoring’’ on page 371 for details.
arrisMtaDevVqmEnableRemote
Determines the policy to control Remote Voice Metrics (XR):
• normal(0) (default) — obey directives from the Call Server.
• forceDisable(1) — disables XR, overriding any directive from
the Call Server.
• forceEnable(2) — enables XR, overriding any directive from the
Call Server.
• default(3) — resets this object to the default and removes persis-
tence.
The value of this object is persistent if it is set after configuration.
arrisMtaDevVqmThresholdEnable
The maximum number of logs allowed to be sent in a report when a
threshold is exceeded. The more logs that are allowed, the more
metrics that can be reported. A value of 0 (default) disables thresh-
old reporting.

Firmware Guide Release 7.5 Standard 1.2 August 2012

292 Chapter 5

The eDVA reports metrics in the order specified by the arrisM-

taDevVqmMetricIndex. To minimize network traffic, logs are sent
only when a threshold is first exceeded. Thereafter until the metric
returns to normal, logs are inhibited. To send logs each time the
threshold is exceeded, add 100 to the value.
arrisMtaDevVqmHistorySize
The history size of the VQM record. Default: 10.
arrisMtaDevVqmCallNumberIdentifierLastCall
(read-only) The last call identifier for Voice Quality Metrics report-
ing.

arrisMtaDevOperationalSetup Objects

arrisMtaDevVPNomJitterBuffer
The Voice Playout nominal jitter buffer size, in terms of packetiza-
tion rate: packetizationRatex1(1) (default), packetizationRa-
tex2(2), packetizationRatex3(3), or packetizationRatex4(4).

arrisMtaDevVPJitterBufferMode
The Voice Playout jitter buffer mode: adaptive(1) (default) or
fixed(2).

arrisMtaDevRTPTxQueueSize
Sets the RTP transmit queue size. Default: 2.
arrisMtaDevEchoCancellerTailLength
The length, in milliseconds, of the echo canceller tail: eightMs(1) or
thirtyTwoMs(2) (default). This object can be set only in the eDVA
configuration file.
arrisMtaDevDspHandleNonPhaseReversedTone
Configures handling of the DSP non-phase reversed tone detection:
off(1)
ignores tone detection.
onECANEnable(2)
(default) the non-phase reversed CED tone is handled with the
echo canceller enabled.
onECANDisabled(3)
the non-phase reversed CED tone is handled with the echo
canceller disabled.
arrisMtaDevProvMethodIndicator
The method used to provision the device. This object can be set
only in the configuration file. The following provisioning methods
are supported:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 293

docsisOnly(0)
DOCSIS-only provisioning.
fullPacketCable(1)
PacketCable 1.5 flows. The arrisMtaDevPacketcableProvi-
sioningFlow object specifies which flow is in use.

packetCableMinusKDC(2)
same as full PacketCable, except with IPSEC and SNMPv3
disabled.
cps(3)
compatible with CPS2000 (SNMPv2; IPsec disabled).
gupi(4)
SNMPv2, with no SNMP Informs and IPsec disabled.
singleMAC(5)
single configuration file (SNMPv2, single IP address, single
MAC address, no SNMP Informs, IPsec disabled).
basic1(6)
Basic1 SNMPv2, without SNMP Enrollment, Status Informs,
or Hash.
basic2(7)
ARRIS Basic2 SNMPv2, without SNMP Enrollment Inform
or Hash.
gupiEncryptedMtaConfig(8)
Same as gupi(4), with the MTA config file encrypted using an
Arris-proprietary method.
gupiMacMta(9)
GUPI provisioning that uses the MTA MAC address as the
MTA configuration file name. Example: 1337c0ded00d.bin
gupiEncryptedMacMta(10)
GUPI encrypted MTA configuration provisioning that uses the
MTA MAC address as the MTA config file name.
gupiTftpSvrOverride(11)
GUPI provisioning, where the FQDN of the MTA TFTP
server is expected to be present in the arrisMtaDe-
vTFTPServerAddrOverrideFQDN object.

arrisMtaCfgRTPDynPortStart
The starting value for a range of ports that is used dynamically
when sending out SIP RTP voice packets. This object and arrisMta-
CfgRTPDynPortEnd define the port range.

Default: 49152.

Firmware Guide Release 7.5 Standard 1.2 August 2012

294 Chapter 5

arrisMtaCfgRTPDynPortEnd
The ending value for a range of ports that is used dynamically when
sending out SIP RTP voice packets. The value of this object must
be higher than arrisMtaCfgRTPDynPortStart.
Default: 65535.
arrisMtaDevVPMaxJitterBuffer
Indicates the Voice Playout maximum jitter buffer: packetization-
Ratex1(1), packetizationRatex2(2), packetizationRatex3(3)
(default), or packetizationRatex4(4).
arrisMtaDevPacketcableProvisioningFlow
(read-only) Indicates the PacketCable simplified provisioning flow
for PacketCable 1.5 compliance:
secure(0)
PacketCable 1.5 Secure Flow
hybrid2(1)
PacketCable 1.5 Hybrid 2 Flow
hybrid1(2)
PacketCable 1.5 Hybrid 1 Flow
basic2(3)
PacketCable 1.5 Basic 2 Flow
basic1(4)
PacketCable 1.5 Basic 1 Flow
none(5)
ARRIS non-PacketCable 1.5 Flow
arrisMtaDevEnableIndexTenEleven
Set to enable(1) to use 10 and 11 as the ifIndex for lines 1 and 2.
Default behavior uses 9 and 10 for the ifIndex.
arrisMtaDevDspCpsSetting
Enables or disables ECAN fast constant power signal detection.
The default value of on(2) makes the echo canceller disengage
immediately when a high level constant power signal is detected.
arrisMtaDevVbdOverwriteLineBitmap
A bitmask that defines which lines use the VbdOverwriteJitter-
Buffer values for fax/modem jitter buffer settings. A value of 0 (the
default) affects no lines; 0x01 enables line 1, and so on.
arrisMtaDevVbdOverwriteMinJitterBuffer
When arrisMtaDevVbdOverwriteLineBitmap is set for the line,
this value is used as the minimun jitter buffer setting in all
modem/fax calls. Default: 20.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 295

arrisMtaDevVbdOverwriteNomJitterBuffer
When arrisMtaDevVbdOverwriteLineBitmap is set for the line,
this value is used as the nominal jitter buffer setting in all
modem/fax calls. Default: 20.
arrisMtaDevVbdOverwriteMaxJitterBuffer
When arrisMtaDevVbdOverwriteLineBitmap is set for the line,
this value is used as the maximum jitter buffer setting in all
modem/fax calls. Default: 20.
arrisMtaDevEventHideFQDNandIPAddress
Set to enable(1) to hide the MTA FQDN and IP address on the
Event Log web page. Logging into the Advanced pages allows an
operator to view this information.
arrisMtaDevDhcpOptionOverride
Set to on(2) to disable DHCP option code 122/177 sub-option 3
value enforcement.
The default value, off(1), enforces DHCP option 122/177 sub-
option 3 value comparison checking. Typically, the value received
in the DHCP OFFER should not change in the DHCP ACK. DHCP
RENEW/REBIND values should be consistent with the value
received in the DHCP OFFER.
arrisMtaDevTFTPServerAddrOverrideFQDN
The FQDN of the TFTP server that delivers the MTA configuration
file, overriding the default TFTP server.
This can be used only with the gupiTftpSvrOverride(11) provision-
ing method.
arrisMtaDevDefaultReasonNoCIDName
The reason sent to the CPE when the Caller ID Name is not
included in the signal request. The default value is unavailable(0).
The following table shows the reason sent for each setting.
Value Reason Description
unavailable(0) ‘O’ Out of area
private(1) ‘P’ Private caller
sendnothing(2) NULL No reason sent
sdmf(3) number Number in NA SDMF format
excludeName(4) nothing No name parameters or reason

arrisMtaDevSipConfigFileURL
The URL of the SIP configuration file for re-downloading provi-
sioning and configuration parameters to this device.
arrisMtaDevSipDwnldConfig
Set to on(2) to enable a re-download of the SIP configuration file
parameters specified in the configuration file URL obtained from the
arrisMtaDevSipConfigFileURL object.

Firmware Guide Release 7.5 Standard 1.2 August 2012

296 Chapter 5

arrisMtaDevSpecialConfigurationOverrideEnable
A bitfield that enables proprietary features of the Arris eDVA. Cur-
rently, only 0x80000000 is supported, to enable DHCP Option 60
sub-option 18 override. The default value is 0.
arrisMtaDevRtcpTosValue
The value used in the IP ToS byte for RTCP packets.
arrisMtaDevAutomaticOsiDelay
The time, in 100ms increments, to wait after a DLCX is received
before determining whether an automatic OSI should be generated
to force a line disconnect.
Default: 50 (5 seconds). Use a value of 0 to send OSI immediately
(if there are no other connections on the line).
Note: This object takes effect only if the ppCfgMtaCallpFea-
tureSwitch has bit 0x20000000 set.

arrisMtaDevCustomJitterBufferEnabled
Set to on(1) to customize jitter buffer settings. When this setting is
off (the default), the jitter buffer size is set using the arrisM-
taDevVPNomJitterBuffer and arrisMtaDevVPMaxJitterBuffer
objects.
The default jitter buffer range depends on the setting of this object:
• When off(0), the defaults are (in ms):
minimum = [(packet rate *1) + 5]
nominal = minimum
maximum = [(packet rate * 3) + 5]
• When on(1), the defaults are:
minimum: 5
nominal: 10
maximum: 60
arrisMtaDevCustomMinJitterBuffer
The customized voice playout minimum jitter buffer size to use
when the arrisMtaDevCustomJitterBufferEnabled object is
enabled. Valid range: 5 (default) to 160, in increments of 5.
arrisMtaDevCustomNomJitterBuffer
The customized voice playout nominal jitter buffer size to use when
the arrisMtaDevCustomJitterBufferEnabled object is enabled.
Valid range: 5 to 160, in increments of 5. Default: 10.
arrisMtaDevCustomMaxJitterBuffer
The customized voice playout maximum jitter buffer size to use
when the arrisMtaDevCustomJitterBufferEnabled object is
enabled. Valid range: 5 to 160, in increments of 5. Default: 60.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 297

arrisMtaDevEnableDHCPLog
Enables or disables MTA DHCP logging.
arrisMtaDevEnableMGCPLog
Enable or disables CallP signaling logging.
arrisMtaDevClearDHCPLog
Set to clear(1) to clear the MTA DHCP Logs.
arrisMtaDevClearMGCPLog
Set to clear(1) to clear the MTA MGCP Logs.
arrisMtaDevTDDReportToCMS
Enables or disables reporting of TDD detection events to the CMS.
The default is enable(1).
arrisMtaDevAutomaticCallResourceRecovery
The time, in seconds, to delay after an on-hook event before detect-
ing whether resources acquired while a call was active need to be
recovered on a line in the idle state. Set to to disable this feature.
arrisMtaDevOffHookFskDelay
The time, in milliseconds, to delay before sending the FSK to the
CPE. The delay starts upon receiving the ACK (DTMF D) from the
CPE in response to the CAS tone for Call Waiting (or Type 2) Caller
ID.
arrisMtaDevT38Timeout
The T.38 timeout, in seconds. The audio is muted for this period
before reporting T.38 failure events to the CMS. Default: 15.
arrisMtaDevSuperG3FaxRelay
Set to enable(1) to allow SuperG3 fax processing upon detection of
the V.21 CM or V.8 data signal. When enabled, the MTA handles
the detection of SuperG3 signaling to start the T.38 process. The
negotiation during call setup determines whether or not T.38 can be
used to send the fax.
When disabled (the default), the MTA still detects signaling for
SuperG3 fax, and the signal is used to setup the endpoint for
SuperG3 pass-thru fax transmission via G.711.
arrisMtaDevDTMFEndEventForceAscending
Enables or disables RFC 2833 DTMF end event duration force
ascending. The default is disabled.
arrisMtaDevDspHandleBellModemTone
Set to enable(1) to detect the Bell Modem Tone (2225 kHz). The
Bell Modem Tone is frequently used by older data modems, usually
in low speed setups. When enabled. the DSP detects the Bell
Modem Tone from either the local or network end. When disabled
(the default), the tone will be ignored.

Firmware Guide Release 7.5 Standard 1.2 August 2012

298 Chapter 5

arrisMtaDevDhcpSubOpt3Immediate
Set to on(2) to enable immediate comparison and handling of MTA
DHCP Option 122 sub-option 3. SNMP notifications are sent to the
new Provisioning SNMP Entity.
The default value is off(1).
arrisMtaDevMaxCallPServiceFlows
Used to limit the number of active calls (service flows). Outgoing
calls, incoming calls, and conference call legs are included in this
count. The eDVA ports can call each other without this limitation.
The default value is 0.

arrisMtaDevEndPntTable Objects

This table provides per-line provisioning details.

arrisMtaDevEndPntDialingMethod
The method used to dial the digits for this endpoint:
tone(1)
(default) tone dialing (DTMF)
pulse(2)
dial-pulse signaling (DTMF is disabled)
toneAndPulse(3)
tone dialing (DTMF) and dial-pulse signaling
pulseWithDTMFRelay(4)
DTMF is disabled, and pulse dialed digits are relayed in-band
to the media gateway
toneAndPulseWithDTMFRelay(5)
DTMF is enabled, and pulse dialed digits are relayed in-band
to the media gateway.
Note: The values pulseWithDTMFRelay(4) and toneAndPulse-
WithDTMFRelay(5) require an IPDT solution as well as DTMF sup-
port by the media gateway.
arrisMtaDevEndPntRingingWaveform
The voltage waveform used when ringing this endpoint: normal(1)
(default) or sinusoidal(2). Sinusoidal waveform is for use with
telephones that exhibit increased sensitivity to ring voltage
waveform.
arrisMtaDevEndPntFaxOnlyLineTimeout
Set to a non-zero value to define a line as a fax-only line for NCS.
The default value is 0.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 299

In fax-only mode, this object defines a timer (in seconds) that is

started after the RTP mode becomes sendReceive. If this timer
expires without detecting fax/modem tones on the connection, the
call is dropped.
arrisMtaDevPersistentLineStatus
Controls persistent line status. This object and ifAdminStatus
impact the line status.
• Set to ignore(0) (the default) to base the line status on the setting
of ifAdminStatus in the MTA configuration file. If ifAdminSta-
tus is not set in the MTA configuration file, then it uses the
default value: up(1) if the line is provisioned or down(2) if the
line is not provisioned.
• Set to forceDisable(1) to force the service status of the line to
down(2) and the line state to EP_OOS after a reset.

This object is always ignored in a configuration file.

arrisMtaDevEndPntCallWaitingRepeatSteady
Set to enabled(1) to repeat the call waiting tone forever. The
default value disabled(0) uses the normal repeat rules.
arrisMtaDevEndPntCIDEnable
Set to disable(0) to disable sending of all Caller ID fields.
arrisMtaDevEndPntCIDNameEnable
Set to disable(0) to disable sending the CallerID Name field.
arrisMtaDevEndPntCIDDateTimeEnable
Set to disable(0) to disable sending the CallerID Date/Time field.
arrisMtaDevEndPntLoopReversal
When set to enabled(1), the line reverses to normal polarity once
the originating party hangs up first. The default value, disabled(0),
maintains reverse loop polarity while the originating party hangs up.
arrisMtaDevEndPntGainControlTxVoice
The transmit digital gain adjustment, in dBm, for voice calls. When
set to a value other than disabled(-128), this object supersedes
arrisMtaDevGainControlTxVoice. Default: 0. A value of 2
increases the voice level by 2 dBm. A value of −2 decreases the
voice level by 2 dBm.
This object does not effect the levels of local tones or FSK.
Note: Use caution when changing this object. Increasing or
decreasing the voice level by the larger numbers allowed in the
range may compromise voice quality.
arrisMtaDevEndPntGainControlRxVoice
The receive digital gain adjustment, in dBm, for voice calls. When
set to a value other than disabled(-128), this objects supersedes
arrisMtaDevGainControlRxVoice. Default: 0. A value of 2

Firmware Guide Release 7.5 Standard 1.2 August 2012

300 Chapter 5

increases the voice level by 2 dBm. A value of −2 decreases the

voice level by 2 dBm.
This object does not effect the levels of local tones or FSK.
Note: Use caution when changing this object. Increasing or
decreasing the voice level by the larger numbers allowed in the
range may compromise voice quality.

arrisMtaDevGainControl Objects

These objects provide digital gain adjustments for each endpoint.

arrisMtaDevGainControlFSK
The transmit digital gain adjustment, in dBm, for MTA-generated
FSK tones (CID and VMWI). Default: 0.
arrisMtaDevGainControlCAS
The transmit digital gain adjustment, in dBm, for MTA-generated
CAS tones. Default: 0.
arrisMtaDevGainControlLocalTone
The transmit digital gain adjustment, in dBm, for all MTA-gener-
ated Call Progress tones (Dialtone, Busytone, Ringback, etc.)
toward the CPE. Default: 0. This object does not effect CAS tone
levels; use arrisMtaDevGainControlCAS to adjust the CAS tone.
arrisMtaDevGainControlNetworkTone
The transmit digital gain adjustment, in dBm, for MTA-generated
Call Progress tones toward the network (Ringback). Default: 0.
arrisMtaDevGainControlLocalDTMF
The transmit digital gain adjustment, in dBm, for MTA-generated
DTMF tones toward the local CPE (ex. DTMF CID). Default: 0.
arrisMtaDevGainControlNetworkDTMF
The transmit digital gain adjustment, in dBm, for MTA-generated
DTMF tones toward the network (ex. IPDT Pulse Dialing). Default:
0.

arrisMtaDevGainControlTxVoice
The transmit digital gain adjustment, in dBm, for voice. This value
does not effect the levels of local tones or FSK. Default: 0.
Note: Use caution when changing this object. Increasing or
decreasing the voice level by the larger numbers allowed in the
range may compromise voice quality.
arrisMtaDevGainControlRxVoice
The receive digital gain adjustment, in dBm, for voice. Default: 0.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 301

Note: Use caution when changing this object. Increasing or

decreasing the voice level by the larger numbers allowed in the
range may compromise voice quality.

arrisMtaDevLevelControl Objects

These objects control off-hook tone gain.

arrisMtaDevLevelControlOffHookEnable
Set to enable(1) to allow use of the arrisMtaDevLevelControlOff-
HookFSK and arrisMtaDevLevelControlOffHookCAS objects,
instead of arrisMtaDevLevelControlFSK and arrisMtaDevLevel-
ControlCAS, in off-hook situations.

arrisMtaDevLevelControlOffHookFSK
The transmit digital gain setting, in dBm, for MTA-generated FSK
tones (CID and VMWI) while the line is off-hook. Default: −15.
arrisMtaDevLevelControlOffHookCAS
The transmit digital gain setting, in dBm, for MTA-generated CAS
tones (CID and VMWI) while the line is off-hook. Default: −15.

arrisMtaDevDiagLoopTable Objects

These objects provide per-line Loop Diagnostic (patent pending) details.

arrisMtaDevDiagLoopTime
(read-only) The time and date when loop diagnostics were last run
on the selected line.
arrisMtaDevDiagLoopRequest
Set this value to true(2) to start loop diagnostics on the line.
arrisMtaDevDiagLoopLastResult
(read-only) Current loop diagnostics status; one of:
• diagnostics-passed(1)
• hazardous-potential-test-failure(2)
• foreign-emf-test-failure(3)
• resistive-faults-test-failure(4)
• receiver-offhook-test-failure(5)
• ringer-test-failure(6)
• invalid-state-to-init-diags(7)
• line-is-unprovisioned(8)

Firmware Guide Release 7.5 Standard 1.2 August 2012

302 Chapter 5

• diagnostics-results-pending(9)
• not-started(10)
• unsupported(11)
• ringer-test-warning(12)
When complete, the status is either diagnostics-passed(1) or the
first test failed. During the test, the status is always diagnostics-
results-pending(9).

arrisMtaDevDiagLoopHazardousPotentialTest
(read-only) The Hazardous Potential Test result for the last time that
loop diags were run.
arrisMtaDevDiagLoopForeignEmfTest
(read-only) The Foreign EMF Test result for the last time that loop
diags were run.
arrisMtaDevDiagLoopResistiveFaultsTest
(read-only) The Resistive Faults Test result for the last time that
loop diags were run.
arrisMtaDevDiagLoopReceiverOffHookTest
(read-only) The Receiver Off-hook Test result for the last time that
loop diags were run.
arrisMtaDevDiagLoopRingerTest
(read-only) The Ringer Test result for the last time that loop diags
were run.

ARRIS-MTA-MIB Battery-related objects appear in the following groups:

(battery telemetry • arrisMtaDevPwrSupplyBase
items)
• arrisMtaDevPwrSupplyControl
• arrisMtaDevPwrSupplyTimers
• arrisMtaDevPwrSupplyStats
• arrisMtaDevPwrSupplyAlarm

arrisMtaDevPwrSupplyBase Objects

These read-only objects provide basic information.

arrisMtaDevBatteryChargerFWRev
The firmware revision of the battery charger.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 303

arrisMtaDevPwrSupplyControl Objects

These objects provide control and status information for the charger system.
arrisMtaDevPwrSupplyEnableDataShutdown
Set to disabled(2) to allow CPE interfaces (Ethernet and wifi, if
equipped) to provide service during a power outage. This reduces
battery hold-up time.
arrisMtaDevPwrSupplyLowBatteryThresh
Sets the low battery threshold, in 10 watt*minutes increments. A
charge below this threshold indicates a low battery condition. The
initial default value is equivalent to 1 hour of holdup time.
arrisMtaDevPwrSupplyTypicalIdlePwr
(read-only) The typical idle power, in 50 mW increments. A nomi-
nal value is loaded when the modem powers up. This value is used
in conjunction with the Tested Battery Capacity, Low Battery
Threshold, and the Replace Battery Threshold to determine when to
raise the Replace Battery or Low Battery alarms.
arrisMtaDevPwrSupplyReplaceBatThresh
The minimum acceptable battery charge, in 10 watt*minutes incre-
ments, needed to achieve the desired End of Life hold-up time,
based on typical idle power. If the Tested Battery Capacity minus
the Charge Hysteresis loss (20%) is less than this value, the modem
raises the Replace Battery alarm. The initial default value provides
1 hour of holdup time.
arrisMtaDevPwrSupplyChargeState
The ‘‘full charge’’ state, in 10 watt*minutes increments. The initial
default value is 80% of the Rated Battery Capacity. Writing to this
object forces the charger to start a discharge/charge cycle, to charge
the battery to the specified level.
Be careful when changing this value. Specifying a higher charge
level may increase hold-up times, but can reduce overall battery life.
arrisMtaDevPwrSupplyBatteryTest
Controls the battery test schedule:
testScheduled(0)
Resumes the battery test scheduler at its current value. When
read, this value indicates that the battery test runs when the
scheduled time expires.
disableAutoTesting(1)
Freezes the battery test scheduler at its current value. When
read, this value indicates that the battery test is suspended.
Removing and replacing the battery forces the charger to run
the test one time. To resume normal operation, set the value to
testScheduled(0) or testInProgress(2).

Firmware Guide Release 7.5 Standard 1.2 August 2012

304 Chapter 5

testInProgress(2)
Starts the battery test cycle immediately, and resets the test
scheduler to its default value of 180 days. When read, this
value indicates a test in progress.
testPending(3)
(read-only) A battery test was in progress, and either AC
power was lost or a full charge was requested.
arrisMtaDevPwrSupplyConfigRunTime
The estimated battery hold-up time, in minutes, based on the typical
idle power and the programmed battery charge setting. The battery
hold-up time may be adjusted using this object. By setting the hold-
up time to a lower value, the total service life of the battery is
extended. Increasing the hold-up time decreases the total service
life of the battery.
Note: This value can only be set in multiples of 5 minutes. Setting a
value greater than arrisMtaDevPwrSupplyBatAvailableMinutes
does not extend the hold-up time beyond that specified by arrisMta-
DevPwrSupplyBatAvailableMinutes.

arrisMtaDevPwrSupplyConfigReplaceBatTime
The replace battery threshold, in terms of minutes of hold-up time.
If a battery’s capacity has degraded to a point where its hold-up time
is below this threshold, the Replace Battery condition becomes
active.
This value can only be set to multiples of 5 minutes. The default
value at power up is 60 minutes.
arrisMtaDevPwrSupplyConfigReplaceBatTime2
(currently unused) Same as arrisMtaDevPwrSupplyConfigRe-
placeBatTime, but for a second battery.

arrisMtaDevPwrSupplyOverTempAlarmControl
Set to enable(1) to issue an Over Temperature Alarm if the charger
exceeds the temperature specified in arrisMtaDevPwrSupply-
OverTempAlarmThreshold, and to shut down the charger if the
temperature exceeds 90°C.
arrisMtaDevPwrSupplyOverTempAlarmThreshold
The temperature threshold, in degrees C, for the Over Temperature
alarm.
arrisMtaDevPwrSupplyTemperature
(read-only) The current charger temperature, in degrees C. This is
available only when arrisMtaDevPwrSupplyOverTempAlarm-
Control is enabled.

arrisMtaDevPwrSupplyHiTempBatteryShutdownControl
Set to enable(1) to turn off the battery if the temperature reaches
75°C.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 305

arrisMtaDevPwrSupplyHighestTemperature
(read-only) The highest recorded battery charger temperature, in
degrees C. This is available only when arrisMtaDevPwrSupply-
OverTempAlarmControl is enabled.

arrisMtaDevPwrSupplyHighestTemperatureTime
(read-only) The time and date when the highest temperature was
recorded.
arrisMtaDevPwrSupplyHighestTemperatureClear
Set to clear(1) to clear current values of arrisMtaDevPwrSupply-
HighestTemperature and arrisMtaDevPwrSupplyHighestTemper-
atureTime. These objects reset to current values within 4 seconds.

arrisMtaDevPwrSupplyControlChargerReset
Set to true(1) to reset the battery charger.
Note: Resetting the battery charger during an AC Fail condition
immediately shuts down the unit.

arrisMtaDevPwrSupplyTimers Objects

These object provide timers for the battery charging system.

arrisMtaDevPwrSupplyDataShutdownTime
The timeout period, in seconds, until the device terminates data ser-
vices (Ethernet, USB, and wifi if equipped) after loss of AC power.
Default: 900 seconds (15 minutes).
arrisMtaDevPwrSupplyFullChargeTime
The number of days to maintain the battery at 100% of its rated
voltage. Any ongoing or schedule battery tests are stopped. This
may be useful when widespread power outages are expected (for
example, an approaching hurricane). After the time has elapsed, the
charger allows the battery to return to the value specified by arrisM-
taDevPwrSupplyChargeState.

A value of 0 may also be read, which indicates that the charger is

operating normally.

arrisMtaDevPwrSupplyStats Objects

These object provide battery and charger statistics. All objects in this group
are read-only.
arrisMtaDevPwrSupplyBatteryTestTime
The present value of the test timer scheduler, in days. If the value is
0xFF (255), the timer has been paused.

arrisMtaDevPwrSupplyRatedBatCapacity
The rated capacity, in 10 watt*minutes increments, of the battery.

Firmware Guide Release 7.5 Standard 1.2 August 2012

306 Chapter 5

arrisMtaDevPwrSupplyTestedBatCapacity
The measured battery capacity, in 10 watt*minutes increments, as
measured by the last battery test cycle.
arrisMtaDevPwrSupplyBatStateOfCharge
The present battery state of charge, in 10 watt*minutes increments.
This value is approximate and is re-calibrated following a battery
test cycle.
arrisMtaDevPwrSupplyReadBatteryPwr
The present load power, in 50mW increments, over an eight-second
moving average. This is the power being removed (when running
on battery power) or applied to the battery (when charging).
arrisMtaDevPwrSupplySecondsOnBattery
The time, in seconds, that the modem has been using battery power.
arrisMtaDevPwrSupplyBatRatedMinutes
The estimated rated hold-up time, in minutes, based on typical idle
power and the rated capacity of the battery when fully charged.
arrisMtaDevPwrSupplyBatAvailableMinutes
The estimated available hold-up time, in minutes, based on typical
idle power and the tested capacity of the battery when fully charged.
arrisMtaDevPwrSupplySecondsOnBattery2
Same as arrisMtaDevPwrSupplySecondsOnBattery, but for a sec-
ond battery.
arrisMtaDevPwrSupplyBatRatedMinutes2
Same as arrisMtaDevPwrSupplyBatRatedMinutes, but for a sec-
ond battery.
arrisMtaDevPwrSupplyBatAvailableMinutes2
Same as arrisMtaDevPwrSupplyBatAvailableMinutes, but for a
second battery.
arrisMtaDevPwrSupplyTelemetryValues
Power supply telemetry values, used by ARRIS technical support
when troubleshooting a battery issue.

arrisMtaDevBatteryStatusTable

The Power Supply telemetry table. All objects in this table are read-only.
arrisMtaDevBatteryOperState
The current operational state of the battery:
• unavailable(0)
• invalid(1)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 307

• shutdownWarning(2)
• batteryReversedShorted(3)
• batteryLow-replaceBattery-acFail(4)
• batteryLow-replaceBattery(5)
• batteryLow-acFail(6)
• batteryLow(7)
• batteryMissing(8)
• acFail-replaceBattery(9)
• replaceBattery(10)
• acFail(11)
• normal(12)
• testInProgress(13)
• chargerFailure(14)
arrisMtaDevBatteryLastStateChange
The value of sysUpTime when the battery entered its current opera-
tional state.
arrisMtaDevBatteryOperSubState
The current sub-state of the battery. The sub-state is not designed to
match the arrisMtaDevBatteryOperState but to provide additional
information about the charger status.
arrisMtaDevBatteryOrderingCode
The ARRIS ordering code for the battery.
arrisMtaDevBatteryEprom
EPROM information for the battery.

Firmware Guide Release 7.5 Standard 1.2 August 2012

308 Chapter 5

ARRIS-ROUTER-MIB Objects

TS7.5 supports the ARRIS-ROUTER-MIB for configuration and manage-

ment. Objects in this MIB appear in the following groups:
• arrisRouterWanConfig
• arrisRouterLanConfig
• arrisRouterWirelessCfg
• arrisRouterFWCfg
• arrisRouterSysCfg
• arrisRouterHostAccess
• arrisRouterPingMgmt
• arrisRouterTraceRtMgmt

arrisRouterWan- The following objects configure and control the router’s WAN connection.
Config Objects arrisRouterWanConnType
The address type of the WAN connection; one of: unknown(0),
dynamic(1), static(2), l2tpStatic(5), l2tpDynamic(6).

arrisRouterWanConnHostName
The host name of the router.
arrisRouterWanConnDomainName
The domain name of the router.
arrisRouterWanMTUSize
The MTU size for the WAN connection.
Valid range: 256 to 1500, or 0 to use the negotiated MTU size.
arrisRouterWanStaticFreeIdx
(read-only) The lowest available index that can be used to create a
new row/instance in the arrisRouterWanStaticTable. A value of
zero indicates that there are no more rows available.
arrisRouterWanIFMacAddr
The MAC address of the WAN interface.
arrisRouterWanConnTypeV6
For IPv6 installations, the WAN connection type: unknown(0),
dynamic(1), or static(2).

arrisRouterWanIPProvMode
The gateway initialization mode: disabledBridge(0), ipv4(1),
ipv6(2), or dualStack(3).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 309

arrisRouterWanCurrentTable Entries

This table contains information for each WAN IP address. In some environ-
ments, there may be both an IPv4 and IPv6 address or multiple IPv6
addresses. Up to four entries may appear. All objects in this table are read-
only
arrisRouterWanCurrentIPAddrType
The static IP address type.
arrisRouterWanCurrentIPAddr
The static IP address for the WAN connection.
arrisRouterWanCurrentPrefix
The netmask (prefix) for the WAN connection.
arrisRouterWanCurrentGWType
The gateway address type for the WAN connection.
arrisRouterWanCurrentGW
The gateway address for the WAN connection.
arrisRouterWanCurrentIPType
The IP address type: unknown(0), dynamic(1), or static(2).
arrisRouterWanCurrentNetMask
For IPv4 addresses, the netmask for the WAN connection.
arrisRouterWanCurrentPrefixDelegationV6
For IPv6 addresses, the prefix or initial bits of the address given to
the gateway to delegate to its attached CPEs.
arrisRouterWanCurrentPrefixDelegationV6Len
For IPv6 addresses, the length for the prefix to be delegated to
attached CPEs.
arrisRouterWanCurrentPreferredLifetimeV6
For IPv6 addresses, the preferred lifetime (in seconds) for the
assigned IPv6 address of the router.
arrisRouterWanCurrentValidLifetimeV6
For IPv6 addresses, the valid lifetime (in seconds) for the assigned
IPv6 address of the router.

Firmware Guide Release 7.5 Standard 1.2 August 2012

310 Chapter 5

arrisRouterWanStaticTable Entries

This table contains information for a specific static WAN IP address. This ta-
ble supports only a single entry.
arrisRouterWanStaticIPAddrType
The IP address type for the static WAN connection.
arrisRouterWanStaticIPAddr
The static IP address for the WAN connection.
arrisRouterWanStaticPrefix
The netmask (prefix) for the WAN connection.
arrisRouterWanStaticGatewayType
The gateway address type for the WAN connection.
arrisRouterWanStaticGateway
The gateway address for the WAN connection.
arrisRouterWanStaticRowStatus
The RowStatus object used to add or remove rows from the table.
arrisRouterWanDelegatedPrefixLength
For IPv6 static addresses, the length of IPv6 delegated prefix.
arrisRouterWanDelegatedPrefix
For IPv6 static addresses, the IPv6 delegated prefix.

arrisRouterWanTunnelObjects

These objects provide L2TP controls.

arrisRouterWanUserName
The L2TP login user name.
arrisRouterWanPassword
The L2TP login password.
arrisRouterWanEnableIdleTimeout
Set to true(1) to enable idle timeout.
arrisRouterWanIdleTimeout
The idle timeout value, in seconds, for L2TP connections. Default:
300.

arrisRouterWanTunnelAddrType
The address type (IPv4 or IPv6) of the L2TP server.
arrisRouterWanTunnelAddr
The IP address of the L2TP server. This object or arrisRouterWan-
TunnelHostName must be set.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 311

arrisRouterWanTunnelHostName
The host name of the L2TP server. This object or arrisRouterWan-
TunnelAddr must be set.

arrisRouterWanEnableKeepAlive
Set to true(1) to enable keep-alive timeout.
arrisRouterWanKeepAliveTimeout
The L2TP keep-alive time, in seconds. Default: 30.

arrisRouterWanDNSObjects

These objects provide information about DNS services available to the WAN
interface.
arrisRouterWanUseAutoDNS
Set to true(1) to use automatic DNS servers as specified by DHCP.
arrisRouterWanStaticDNSFreeIdx
(read-only) The first free index available for adding a row to the
arrisRouterWanStaticDNSTable. A value of 0 means no rows are
available.

arrisRouterWanCurrentDNSTable Objects

This table contains the IP addresses of the current DNS servers. The servers
may be dynamically obtained from the WAN DHCP server, or statically con-
figured in the arrisRouterWanStaticDNSTable. Up to four entries are avail-
able; the lowest index is checked first for DNS lookups.
arrisRouterWanCurrentDNSIPAddrType
(read-only) The IP address type of the DNS server (IPv4 or IPv6).
arrisRouterWanCurrentDNSIPAddr
(read-only) The IP address of the DNS server.

arrisRouterWanStaticDNSTable Objects

This table contains the IP addresses of any statically-assigned DNS servers.

Up to 8 rows are available. This table may be empty if arrisRouterWanUse-
AutoDNS is true.

arrisRouterWanStaticDNSIPAddrType
The IP address type of the DNS server (IPv4 or IPv6).
arrisRouterWanStaticDNSIPAddr
The IP address of the DNS server.
arrisRouterWanStaticDNSRowStatus
The RowStatus used to add and remove rows.

Firmware Guide Release 7.5 Standard 1.2 August 2012

312 Chapter 5

arrisRouterWanDHCPObjects

These objects provide information about the current DHCP lease for the
WAN interface.
arrisRouterWanRenewLease
Set to apply(1) to renew the primary public WAN DHCP lease.
arrisRouterWanReleaseLease
Set to apply(1) to release the primary public WAN DHCP lease.
arrisRouterWanDHCPDuration
(read-only) The time, in seconds, that the current WAN DHCP lease
is valid.
arrisRouterWanDHCPExpire
(read-only) The date and time when the current WAN DHCP lease
expires.
arrisRouterWanRenewLeaseV6
For IPv6 installations, set to apply(1) to renew the primary public
WAN DHCP lease.
arrisRouterWanReleaseLeaseV6
For IPv6 installations, set to apply(1) to release the primary public
WAN DHCP lease.
arrisRouterWanDHCPDurationV6
(read-only) The time, in seconds, that the current WAN DHCPv6
lease is valid.
arrisRouterWanDHCPExpireV6
(read-only) The date and time when the current WAN DHCPv6
lease expires.

arrisRouterDSLiteWanObjects

These objects control DS-Lite.

arrisRouterDSLiteWanEnable
Enables or disables DS-Lite.
arrisRouterDSLiteWanLSNATAddrType
The address type for LSNAT: IPv6 or FQDN.
arrisRouterDSLiteWanLSNATAddr
The IP address of the LSNAT server.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 313

arrisRouterLan- The following objects configure and control the LAN interfaces.
Config Objects arrisRouterLanSettings
Applies LAN settings as follows:
doNothing(0)
No effect. Reading this object always returns doNothing(0).
applyPrimaryLan(1)
Applies settings for the Ethernet and subscriber wifi.
applyGuestLans(2)
Applies settings for the non-subscriber wifi LANs.
applyAllLans(3)
Applies settings for all networks. The network will be
restarted.
resetDefaults(11)
Resets all values in the arrisRouterLanTable and arris-
RouterWirelessCfg to their defaults.

restartWLAN(12)
Restarts only the wireless LAN interfaces.
revertSettings(10)
Clears all modifications, restoring the values from non-volatile
memory.
Note: If applying settings fails, the action can be retried. Modified
settings are kept until the gateway is rebooted or revertSettings(10)
is used.

arrisRouterLanSrvTable Entries

The following objects are part of the arrisRouterLanSrvTable. This table is

indexed by the LAN ID.
arrisRouterLanName
The human-readable name for this LAN.
arrisRouterLanSubnetMaskType
The type of IP address used for the subnet mask: ipv4 or ipv6.
arrisRouterLanSubnetMask
The subnet mask for this LAN.
arrisRouterLanGatewayIpType
The type of IP address used for the gateway: ipv4 or ipv6.
arrisRouterLanGatewayIp
The IP address of the gateway used to connect this LAN to the
Internet.

Firmware Guide Release 7.5 Standard 1.2 August 2012

314 Chapter 5

arrisRouterLanGatewayIp2Type
The IP address type of the Gateway for a specific network.
arrisRouterLanGatewayIp2
The IP address of the Gateway for a specific network.
arrisRouterLanVLanID
The VLAN ID to be used for this LAN. A value of zero disables
VLAN functionality on this LAN.
arrisRouterLanUseDHCP
Enables or disables the local DHCP server for this LAN.
arrisRouterLanStartDHCPType
The IP address type of the first address in the DHCP pool.
arrisRouterLanStartDHCP
The first IP address in the range of IP addresses assigned by the
DHCP server.
arrisRouterLanEndDHCPType
The IP address type of the last address in the DHCP pool.
arrisRouterLanEndDHCP
The last IP address in the range of IP addresses assigned by the
DHCP server.
arrisRouterLanLeaseTime
The lease time, in seconds, for addresses assigned by the DHCP
server.
arrisRouterLanDomainName
(optional) The domain name for this LAN.
arrisRouterLanRateLimit
Enables or disables rate limiting on this LAN.
arrisRouterLanDownRateLimit
The downlink limiting rate. Use zero for no rate limiting.
arrisRouterLanUpRateLimit
The uplink limiting rate. Use zero for no rate limiting.
arrisRouterLanRelayDNS
Controls DNS relay. In this version of Touchstone firmware, DNS
relay is always enabled.
arrisRouterLanIPv6Mode
The IPv6 setting: linkLocalOnly(1) or siteLocalOnly(2).
arrisRouterLanPassThru
The LAN routing mode:
passThru(1)
Puts the device into non-bridged mode with routing and NAT
disabled.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 315

routedNAT(2)
Puts the device into bridged (routed) mode with Network
Address Translation (NAT) enabled.
routedNoNAT(3)
Puts the device into bridged (routed) mode with Network
Address Translation (NAT) disabled.
arrisRouterLanFirewallOn
Enables or disables the firewall for this LAN.
arrisRouterLanUPnPEnable
Enables or disables UPnP for this LAN.
arrisRouterLanCPEAging
The time, in seconds, for aging-out dynamically learned forwarding
information. The default value of zero disables aging-out entries.
arrisRouterLanOverrideDNS
Enables or disables DNS override. If DNS override is enabled, the
IP addresses in arrisRouterLanDNSTable are passed to LAN
clients using DHCP. Otherwise, the DNS servers received by the
WAN connection are passed to the LAN clients.
arrisRouterLanNatAlgsEnabled
A bitmask that specifies which NAT Application Layer Gateway
(ALG) supplements are enabled on this device. The following bits
are available:
Bit Direction Protocol Port
rsvp(0) US/DS IP 46
ftp(1) US/DS TCP 21
tftp(2) US UDP 17
kerb88(3) US UDP 88
netBiosDgm(4) US UDP 138
ike(5) US/DS UDP 500
rtsp(6) US/DS TCP 554
kerb1293(7) US UDP 1293
h225(8) US/DS TCP 1720
pptp(9) US/DS TCP 1723
msn(10) US/DS TCP 1863
sip(11) US UDP 5060
icq(12) US TCP 5190
irc666x(13) US TCP 6661–6669
icqTalk(14) US/DS UDP 6701
net2Phone(15) US/DS UDP 6801
irc7000(16) US TCP 7000
irc8000(17) US TCP 8000

Firmware Guide Release 7.5 Standard 1.2 August 2012

316 Chapter 5

The default value for this object enables all ALGs.

arrisRouterLanMappedInterface
A bitmask that specifies which interfaces are mapped to the primary
LAN subnet. The following bits are valid:
Bit Interface Support
0x00000001 Ethernet yes
0x00000002 USB no
0x00000004 MoCA no
0x00000008 SSID0 yes
0x00000010 SSID1 yes
0x00000020 SSID2 yes
0x00000040 SSID3 yes
0x00000080 SSID4 no
0x00000100 SSID5 no
0x00000200 SSID6 no
0x00000400 SSID7 no

For example, a value of 0x0000000F (15) maps the Ethernet, USB,

MoCA, and SSID0 interfaces to the primary LAN subnet.
Note: An interface may not be assigned to more than one LAN sub-
net.
arrisRouterLanEnvironmentControl
Enables or disables changes to the LAN subnet using the web-based
interface. The values are unlocked(0) and locked(1).
arrisRouterLanPrefixLengthV6
(read-only) For IPv6 configurations, the length indicating the
routable portion of the prefix. This length is advertised to the host
either through DHCP or router advertisement. The host uses this
length to generate the rest of the bits in its IPv6 address.
arrisRouterLanUseDHCPV6
For IPv6 configurations, enables or disables the local DHCPv6
server on this VLAN.
arrisRouterLanStartDHCPV6
For IPv6 configurations, the first address range in the DHCPv6 pool.
Note: Do not include the prefix bits in the starting and ending range.
For example, if the prefix length is 112, creating a 16-bit subnet,
then the values :0001 to :8000 would assign the lower half of the
address range to the DHCPv6 pool.
arrisRouterLanEndDHCPV6
For IPv6 configurations, the last address range in the DHCPv6 pool.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 317

arrisRouterLanLeaseTimeV6
For IPv6 configurations, the lease time for IP addresses provided by
the router’s DHCPv6 server.
arrisRouterLanLinkLocalAddressV6
For IPv6 configurations, the link local IPv6 address.
arrisRouterLanDNSRelayV6
For IPv6 configurations, enables or disables DNS relay.
arrisRouterLanDNSOverrideV6
For IPv6 configurations, enables or disables DNS override. When
DNS override is enabled, the IPv6 addresses in the arrisRouter-
LanDNSTable are passed to LAN clients using DHCPv6. Other-
wise, the DNS servers received by the WAN connection are passed
to the LAN clients.

arrisRouterLanDNSTable

This table provides DNS server information for a specific LAN. The table is
indexed by the ifIndex of the LAN and an internal index. The current imple-
mentation supports two DNS servers per interface.
arrisRouterLanDNSIPAddrType
The IP address type for the DNS server.
arrisRouterLanDNSIPAddr
The IP address of the DNS server.
arrisRouterLanDNSRowStatus
Use this object to add or remove DNS row entries.

arrisRouterLanEtherPortTable

This table provides configuration information for the physical Ethernet ports.
arrisRouterLanEtherPortIFIndex
(read-only) The ifIndex of this Ethernet interface.
arrisRouterLanEtherPortEnabled
Enables or disables this Ethernet port.
arrisRouterLanEtherPortDuplex
Configures the duplex setting for this Ethernet port: halfDuplex(0)
or fullDuplex(1). The device may need to be restarted to apply this
setting.
arrisRouterLanEtherPortSpeed
Configures the speed, in MB/sec, for this Ethernet port: 10, 100, or
1000. This object applies only if auto-negotiate is off.

Firmware Guide Release 7.5 Standard 1.2 August 2012

318 Chapter 5

To query the actual current speed of the interface, use the ifSpeed
object. The device may need to be restarted to apply this setting.
arrisRouterLanEtherPortAuto
Configures the auto-negotiate setting for this Ethernet port: manual-
Configure(0) or autoNegotiate(1).

If auto-negotiate is active, the settings for arrisRouterLanEther-

PortDuplex and arrisRouterLanEtherPortSpeed are not used.
The device may need to be restarted to apply this setting.

arrisRouterClientObjects

These objects provide information about clients attached to the LAN inter-
faces.
arrisRouterLanClientCount
(read-only) The current number of clients on this LAN. This corre-
sponds to the number of active rows in the arrisRouterLanCurrent-
ClientTable.

arrisRouterLanCustomCount
(read-only) The number of custom maps of LAN clients to friendly
names and other attributes. This corresponds to the number of rows
in the arrisRouterLanClientCustomTable.

arrisRouterLanClientTable

This table lists the DHCP clients on this LAN.

arrisRouterLanClientIPAddrType
The IP address type for the DHCP client.
arrisRouterLanClientIPAddr
The IP address of the DHCP client.
arrisRouterLanClientHostName
The host name for the DHCP client.
arrisRouterLanClientMAC
The MAC address of the DHCP client.
arrisRouterLanClientMACMfg
(read-only) The manufacturer of the hardware adapter.
arrisRouterLanClientAdapterType
(read-only) The adapter type: unknown(0), ethernet(1), or wire-
less(2).

arrisRouterLanClientType
(read-only) The type of IP address: dynamic(1) or static(5). When
creating or editing an entry, this object is always static(5).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 319

arrisRouterLanClientLeaseStart
(read-only) The time and date when this lease started. For static
entries, this is the time and date when the row was created (if
known).
arrisRouterLanClientLeaseEnd
(read-only) The time and date when this lease expires. If the arris-
RouterLanClientType is static, this object returns an unspecified
time and date.
arrisRouterLanClientStatus
(read-only) The status of the IP interface: down(0) or up(1).
arrisRouterLanClientInfLease
(read-only) Returns true(1) if the lease is infinite, false(2) other-
wise. This applies only to dynamic leases. Rows for static items
always return notApplicable(0).
arrisRouterLanClientLeaseState
(read-only) The lease state: leaseStateAvailable(0), leaseS-
tateArping(1), leaseStateOffering(2), leaseStateUnavailable(3),
leaseStateReserved(4), leaseStateArpBlackListed(5), leaseS-
tateInactive(6), or leaseStateZombie(7).

arrisRouterLanClientRowStatus
The RowStatus, used to create or remove static clients. Rows that
correspond to dynamic IP addresses cannot be removed.
arrisRouterLanClientOnline
(read-only) The client connection state: offline(0) or online(1).
arrisRouterLanClientComment
An administrative comment field for the client.
arrisRouterLanClientCustom
(read-only) The client custom state: unknown(0) or custom(1).

arrisRouterDeviceUpDownTable

This table provides information on whether client devices connected to this

Router are accessible. The table supports up to 30 devices.
arrisRouterDeviceUpDownIPType
(read-only) The IP address type for the client during the time period
specified by this row.
arrisRouterDeviceUpDownIPAddr
(read-only) The IP address for the client during the time period
specified by this row.
arrisRouterDeviceUpDownStart
(read-only) Time when this client device was detected to be accessi-
ble.

Firmware Guide Release 7.5 Standard 1.2 August 2012

320 Chapter 5

arrisRouterDeviceUpDownEnd
(read-only) Time when this client device was detected to be inacces-
sible.
arrisRouterDeviceUpDownStatus
RowStatus, used to remove rows from this table.

arrisRouterLanCustomTable

This table displays mapping of LAN clients to friendly names and other
attributes.
arrisRouterLanCustomMAC
The MAC address of the client.
arrisRouterLanCustomIPAddrType
The IP address type. This address is optional, but either the IP or
MAC address should be present.
arrisRouterLanCustomIPAddr
The IP address. This address is optional, but either the IP or MAC
address should be present.
arrisRouterLanCustomFriendName
The friendly name for this client. The default is the host name.
Users can change the host name in the web interface.
arrisRouterLanCustomHostName
The host name for the client.
arrisRouterLanCustomMACMfg
(read-only) The manufacturer of the hardware adapter.
arrisRouterLanCustomComments
An administrative comments field.
arrisRouterLanCustomRowStatus
Used to remove rows from the table.

arrisRouterLanCurrentClientTable

This table contains all current client devices on the LAN. Entries include:
• Primarily LAN devices that use DHCP to request an IP address from
the Gateway device.
• Any device that was statically configured with an IP address on the
same subnet as the Gateway device. These devices are usually discov-
ered through ARP.
• Any device added to the arrisRouterLanStaticClientTable.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 321

This table supports up to 64 entries.

arrisRouterLanCurrentClientIPAddrType
(read-only) The IP address type for the client device.
arrisRouterLanCurrentClientIPAddr
(read-only) The IP address for the client device.
arrisRouterLanCurrentClientIPAddrTextual
(read-only) A human-readable textual representation of the arris-
RouterLanCurrentClientIPAddr.

arrisRouterLanCurrentClientHostName
(read-only) The host name for the client.
arrisRouterLanCurrentClientMAC
(read-only) The MAC address of the client.
arrisRouterLanCurrentClientMACMfg
(read-only) The manufacturer of the hardware adapter.
arrisRouterLanCurrentClientAdapterType
(read-only) The adapter type: unknown(0), ethernet(1), or wire-
less(2).

arrisRouterLanCurrentClientType
(read-only) The client type:
unknown(0)
The Router is unable to determine the client type.
dynamic(1)
DHCP clients.
staticDiscover(2)
Clients that are statically configured and discovered via ARP.
staticConfigure(3)
Clients that are configured in the arrisRouterLanStaticClient-
Table.

arrisRouterLanCurrentClientLeaseStart
(read-only) The time and date when this lease started. This only
applies to clients whose arrisRouterLanCurrentClientType is
dynamic(1).

arrisRouterLanCurrentClientLeaseEnd
(read-only) The time and date when this lease expires. This only
applies to clients whose arrisRouterLanCurrentClientType is
dynamic(1).

arrisRouterLanCurrentClientStatus
(read-only) The most recent known status of the LAN client:
unknown(-1), down(0), or up(1).

Firmware Guide Release 7.5 Standard 1.2 August 2012

322 Chapter 5

arrisRouterLanCurrentClientInfLease
(read-only) Returns true(1) if the lease is infinite. This only applies
to clients whose arrisRouterLanCurrentClientType is dynamic(1).
arrisRouterLanCurrentClientLeaseState
(read-only) The state of the lease: leaseStateAvailable(0), leaseS-
tateArping(1), leaseStateOffering(2), leaseStateUnavailable(3),
leaseStateReserved(4), leaseStateArpBlackListed(5), leaseS-
tateInactive(6), or leaseStateZombie(7). This only applies to
clients whose arrisRouterLanCurrentClientType is dynamic(1).
Static clients return leaseStateUnavailable(3).
arrisRouterLanCurrentClientFirstSeen
(read-only) The time, if known, when this client was first seen.
For dynamic clients, this is usually when the first DHCP lease was
given to this client since the last boot. This value does not necessar-
ily match arrisRouterLanCurrentClientLeaseStart, as several
DHCP renewals may have occurred.
For staticDiscover and staticConfigure clients, this is the time of the
first ARP response since the last boot.
arrisRouterLanCurrentClientLastSeen
(read-only) The time, if known, when this client was most recently
(last) seen. If the device is currently active, this time should within
one minute of the current system time.
arrisRouterLanCurrentClientConnectionInfo
(read-only) A string that may contain additional connection details.
For Ethernet clients, this may provide the connection port and con-
nection speed. For wireless clients, this may provide brief details
about the wireless connection. This field may also be blank.
arrisRouterLanCurrentClientLeaseTime
(read-only) The time, in seconds, of the DHCP lease. For static
LAN clients, this value is zero.

arrisRouterLanStaticClientTable

This table contains clients that are statically configured to maintain the same
IP address between reboots. The table supports up to 16 entries.
arrisRouterLanStaticClientIPAddrType
The IP address type of the statically configured address.
arrisRouterLanStaticClientIPAddr
The static IP address.
arrisRouterLanStaticClientHostName
An optional host name for the client device.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 323

arrisRouterLanStaticClientMAC
The MAC address of the client device.
arrisRouterLanStaticClientRowStatus
The RowStatus, used to remove clients from the table.

arrisRouterRIPObjects

These objects configure RIP on the Router.

arrisRouterRIPEnable
Enables or disables RIP.
arrisRouterRIPAuthEnable
The RIP authentication type: unknown(-1), disable(0) (default),
textAuth(1), or md5Auth(2).

arrisRouterRIPReportTime
The RIP reporting interval, in seconds. Default: 30.
arrisRouterRIPAuthKeyString
The RIP authentication key.
arrisRouterRIPAuthKeyID
The RIP authentication key identifier.
arrisRouterRIPIPAddrType
The RIP destination IP address type.
arrisRouterRIPIPAddr
The RIP unicast reporting destination IP address. If this contains an
IP address other than 0.0.0.0, then RIP messaging (which is multi-
casted by default) is unicasted to this IP address.
arrisRouterRIPPrefixLen
The prefix for the routed subnet. The subnet can be specified by this
object or by arrisRouterRIPSubnetMask.
arrisRouterRIPAuthKeyChain
The RIP authentication key chain.
arrisRouterRIPRoutedSubnetIPType
The IP address type for arrisRouterRIPRoutedNetIP.
arrisRouterRIPRoutedSubnetIP
The specific network in the configured subnet that is advertised and
routed.
This allows configuration of a public LAN-side subnet of hosts
which is not necessarily on the same subnet as the CMTS HFC IP
address, CM IP address, or WAN-MAN IP address subnet. CPEs
belonging to this routed subnet have their IP addresses assigned
statically. The default gateway for these CPEs is one of the
addresses in the configured subnet. The gateway IP address speci-
fied becomes an actual secondary IP address on the device. The

Firmware Guide Release 7.5 Standard 1.2 August 2012

324 Chapter 5

secondary IP address shares a single private LAN interface MAC

address; that is, there are two IP addresses on a single IP stack
(192.168.0.1 and arrisRouterRIPSubnetGWNetIP). The device
also sends RIP messages upstream to the CMTS router advertising
this LAN-side routed subnet, so the CMTS can properly route pack-
ets destined for this subnet.
arrisRouterRIPRoutedSubnetGWNetIPType
The IP address type for arrisRouterRIPRoutedNetIP.
arrisRouterRIPRoutedSubnetGWNetIP
The Gateway IP address for the routeable subnet. For more details,
see the description of arrisRouterRIPRoutedNetIP above.
arrisRouterRIPRoutedSubnetMask
The subnet mask used for the routed subnet. This value matches
arrisRouterRIPPrefixLen. Usually, prefixes are used with IPv6 and
netmasks are used with IPv4.
arrisRouterRIPRoutedSubnetEnabled
Set to true(1) to advertise the RIP routed subnet network IP address
with the next hop as the CM IP address.
arrisRouterRIPSendCMInterface
Set to true(1) to send RIP advertisements through the CM IP inter-
face.
If set to false(2) (default), then RIP advertisements are sent through
the eRouter WAN IP interface.
arrisRouterRIPRoutedSubnetDHCP
Set to true(1) to start a DHCP server on the device for the routed
subnet.
arrisRouterRIPRoutedSubnetNAT
Set to true(1) to use NAT on the Routed Subnet using the Gateway
IP address.

arrisRouterRIPRoutedSubnetTable

This table lists up to three RIP routed subnet items.

arrisRouterRIPRoutedSubnetTableIPType
The IP address type for arrisRouterRIPRoutedNetIP.
arrisRouterRIPRoutedSubnetTableIP
The specific network in the configured subnet that is advertised and
routed.
This feature supports configuration of a public LAN-side subnet of
hosts which is not necessarily on the same subnet as the CMTS
HFC IP address, CM IP address, or WAN-MAN IP address subnet.
The CPEs belonging to this routed subnet have their IP addresses
assigned statically. The default gateway for these CPEs is one of

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 325

the addresses in the configured subnet. The gateway IP address

specified becomes an actual secondary IP address on the device.
This secondary IP address shares a single private LAN interface
MAC address; that is, there are two IP addresses on a single stack
(192.168.0.1 and arrisRouterRIPSubnetGWNetIP). The device
also sends RIP messages upstream to the CMTS router advertising
this LAN-side routed subnet; so the CMTS router can properly route
packets destined for this subnet.
arrisRouterRIPRoutedSubnetTableGWNetIPType
The IP address type for arrisRouterRIPRoutedNetIP.
arrisRouterRIPRoutedSubnetTableGWNetIP
The Gateway IP address for the routable subnet. For details, see the
description of arrisRouterRIPRoutedNetIP.
arrisRouterRIPRoutedSubnetTableMask
The subnet mask used for the routed subnet. This value matches
arrisRouterRIPPrefixLen. Usually, prefixes are used with IPv6 and
netmasks are used with IPv4.
arrisRouterRIPRoutedSubnetTableEnabled
Set to true(1) to advertise the RIP routed subnet network IP address
with the next hop as the CM IP address.
arrisRouterRIPTableSendCMInterface
Set to true(1) to send RIP advertisements through the CM IP inter-
face. If set to false(2) (default), then RIP advertisements are sent
through the eRouter WAN IP interface.
arrisRouterRIPRoutedSubnetTableDHCP
Set to true(1) to start a DHCP server on the device for the routed
subnet.
arrisRouterRIPRoutedSubnetTableNAT
Set to true(1) to use NAT on the Routed Subnet using the Gateway
IP address.

arrisRouterWire- These objects provide configuration and monitoring of the wireless inter-
lessCfg Objects faces.
Note: TS7.5 and newer versions of Touchstone firmware use the ifIndex of
the wireless interface as the index; the interface numbers are 12 to 15 for
SSIDs 0 through 3. Earlier versions of Touchstone firmware used a range of
1 through 4.

arrisRouterWiFiCountry
(read-only) The country name configured for the wireless interface.
arrisRouterWiFiChannel
Sets the current channel number (802.11g) or control channel
(802.11n).

Firmware Guide Release 7.5 Standard 1.2 August 2012

326 Chapter 5

If set to 0, the wireless interface automatically scans for the least-

crowded channel.
Valid range:
• 802.11g: 1 to 14.
• 802.11n: 34 to 216.
• Depending on the selected country code, the actual range may be
restricted.
arrisRouterWiFiMode
Sets the 802.11 operating mode: unknown(-1), mixBG(0),
bOnly(1), gOnly(4), nOnly(6), mixGN(7), or mixBGN(9).

arrisRouterWiFiBGProtect
Sets the 54g protection state. When protection is enabled, the
access point uses RTS/CTS to improve 802.11g performance in
mixed 802.11g/802.11b networks. Disabling protection maximizes
802.11g throughput under most conditions.
arrisRouterWiFiBeaconInterval
The time, in milliseconds, between beacon transmissions.
arrisRouterWiFiDTIMInterval
The time, in milliseconds, between Delivery Traffic Indication Mes-
sages.
arrisRouterWiFiTxPreamble
Sets the transfer preamble length: long(0) or short(1).
arrisRouterWiFiRTSThreshold
The minimum packet (MPDU) size that uses RTS/CTS handshake.
Packets smaller than this threshold do not use RTS/CTS handshake.
A value of zero enables RTS/CTS handshake for all packets; a value
of 2347 effectively disables RTS/CTS handshake.
An RTS/CTS handshake is performed when all the following condi-
tions apply:
• The MPDU is of type Data or Management.
• The MPDU has an individual address in the Address field.
• The length of the MPDU is greater than the threshold value.
arrisRouterWiFiFragmentThresh
The maximum size of a packet before the packet data is fragmented
into two or more packets.
arrisRouterWiFiShortSlot
Enables or disables short slot timing mode. This is the amount of
time a device waits after a collision, before retransmitting a packet.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 327

You can increase throughput on 802.11g, 2.4-GHz channels by

enabling short slot time. The arrisRouterWiFiShortSlotEnhanced
object can automatically enable or disable short slot timing as
needed.
arrisRouterWiFiFrameBurst
Enables or disabled frame burst mode, also known as ‘‘XPress Tech-
nology.’’ Frame burst may increase the link connection throughput
under certain conditions, in mixed and uniform networks.
arrisRouterWiFiEnableRadio
Enables or disables the WiFi radio.
arrisRouterWiFiTxPower
Sets the transmit power level. Some PHYs also use this value to
determine the receiver sensitivity requirements for CCA.
arrisRouterWiFiShortRetryLimit
Sets the retry limit of frames longer than the RTS threshold.
arrisRouterWiFiLongRetryLimit
Sets the retry limit of frames shorter than the RTS threshold.
arrisRouterWiFiOutputPower
Sets the output power relative to the hardware’s maximum capabil-
ity: percent25(25), percent50(50), percent75(75), or per-
cent100(100).

These values correspond to the web-based interface settings as fol-

lows:
SNMP Setting Web Setting
percent25(25) LOW
percent50(50) MED
percent100(100) HIGH

arrisRouterWiFiMulticastA
Sets the multicast rate for 802.11a: rate12mbps(12),
rate18mbps(18), rate24mbps(24), rate36mbps(36),
rate48mbps(48), rate72mbps(72), rate96mbps(96), or
rate108mbps(108).

arrisRouterWiFiMulticastBG
Sets the multicast rate for 802.11b/g: auto(0), bgMrate2mbps(2),
bgMrate4mbps(4), bgMrate11mbps(11), bgMrate12mbps(12),
bgMrate18mbps(18), bgMrate22mbps(22), bgMrate24mbps(24),
bgMrate36mbps(36), bgMrate48mbps(48), bgMrate72mbps(72),
bgMrate96mbps(96), or bgMrate108mbps(108).

arrisRouterWiFiBasicRateSet
Determines which rates are advertised as BASIC rates in the bea-
con. If set to default(1), the driver uses the defaults for the selected
54g mode. If set to all(2), all available rates are advertised as

Firmware Guide Release 7.5 Standard 1.2 August 2012

328 Chapter 5

BASIC rates regardless of the 54g mode setting.

arrisRouterWiFiTxRate
Forces the transmission rate to a particular speed: auto(0),
mbits1(1), mbits2(2), mbits5half(5), mbits6(6), mbits9(9),
mbits11(11), mbits12(12), mbits18(18), mbits24(24),
mbits36(36), mbits48(48), or mbits54(54).

arrisRouterWiFiResetDefaults
Resets Wifi settings to default values as follows:
• resetWifiDefaults(1) resets all wireless networks to their default
settings.
• resetWifiDefaultsPrimaryOnly(2) resets only the primary wire-
less network.
• resetWiFiDefaultGuestOnly(3) resets all the non-primary/guest
wireless networks.
The wireless drivers are immediately restarted, and any clients con-
nected to the wireless networks are disconnected.
arrisRouterWiFiEnableRadioNow
Enables or disables the WiFi radio, immediately applying the
change.
arrisRouterWiFiCustomSSIDStr
The default SSID prefix. The last four characters of the CM MAC
address are appended to this string to form the SSID. The default is
ARRIS.

arrisRouterWiFiRadioControlMode
Sets the radio control mode:
userControlled(0)
(default) All settings remain in effect as specified through
other means (web, SNMP, CLI).
msoControlled24bgnMode(1)
The current channel number and channel bandwidth selection
remain in effect, but all other wireless radio settings are set to
optimize support for a mixture of 802.11b/g/n devices using
2.4GHz channels and transmitting at full power. If concurrent
2.4GHz and 5.0GHz frequency bands are supported, only the
2.4GHz band is affected.
msoControlled24nMode(2)
The current channel number and channel bandwidth selection
remain in effect, but all other wireless radio settings are set to
optimize support for only 802.11n devices using 2.4GHz
channels and transmitting at full power. If concurrent 2.4GHz
and 5.0GHz frequency bands are supported, only the 2.4GHz
band is affected.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 329

msoControlled50nMode(3)
Unsupported.

arrisRouterBSSTable Entries

This table contains settings for individual wireless networks.

arrisRouterBssID
(read-only) The physical address associated with this BSS.
arrisRouterBssSSID
The SSID for this BSS.
arrisRouterBssActive
Enables or disables this BSS.
arrisRouterBssSSIDBroadcast
Enables or disables SSID broadcast. Disabling broadcast adds a
small measure of security from casual intruders as the SSID does
not appear in a list of available networks.
arrisRouterBssSecurityMode
The security mode; one of:
• disabled(0)
• wep(1)
• wpaPsk(2)
• wpa2Psk(3)
• wpaEnterprise(4)
• wpa2Enterprise(5)
• wepEnterprise(6)
• wpaWpa2Psk(7)
• wpaWpa2Enterprise(8)
arrisRouterBssAccessMode
Controls what stations have access to the device.
• If set to allowAny(1), then any station will be allowed to connect.
• If set to allowList(2), then only stations whose MAC address
appears in the arrisRouterMACAccessTable are allowed to con-
nect.
• If set to denyList(3), any station will be allowed to connect
except those in the arrisRouterMACAccessTable.

Firmware Guide Release 7.5 Standard 1.2 August 2012

330 Chapter 5

arrisRouterBssNetworkIsolate
If set to true(1), this service set has restricted access to the local
area network. The default value of false(2) authorizes this service
set as a full member of the LAN.
arrisRouterBssMACAccessCount
(read-only) The number of entries in the arrisRouterMACAc-
cessTable.

arrisRouterBssMACAccessClear
Set to clear(1) to clear the entire list of MAC addresses in the arris-
RouterMACAccessTable.

arrisRouterWEPTable Entries

This table contains WEP settings for each wireless network.

arrisRouterWEPCurrentKey
Sets the default key to use when 64- or 128-bit encryption is
enabled. Indicates the entry from the arrisRouterWEP64Bit-
KeyTable if the arrisRouterWEPEncryptionMode object is set to
wep64(1), or the entry from the arrisRouterWEP128BitKeyTable
if set to wep128(2).
This object may only be set to indicate an active row in the arris-
RouterWEP64BitKeyTable or arrisRouterWEP128BitKeyTable.
If the value corresponds to a row which does not exist or a row
which is not active, the gateway rejects the setting with an inconsis-
tentValue error.
arrisRouterWEPEncryptionMode
Selects the WEP encryption method used by this service set:
wep64(1) or wep128(2).

arrisRouterWEPPassPhrase
The passphrase used for WEP security. This can be used to auto-
matically generate the hex WEP keys.

arrisRouterWEP64BitKeyTable Entries

A table of 40-bit key values used when operating in WEP64 mode. Up to

four entries are supported.
arrisRouterWEP64BitKeyValue
A 40-bit key to be used when the corresponding instance of arris-
RouterWiFiSecurityMode is set to wep(1) and the corresponding
instance of arrisRouterWEPEncryptionMode is set to wep64(1).
arrisRouterWEP64BitKeyStatus
The RowStatus of this entry. The following restrictions apply:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 331

• A newly created entry cannot be made active until the correspond-

ing instance of arrisRouterWEP64BitKeyValue has been set.
This object may not be set to a value of notInService(2) or
destroy(6) if the corresponding instance of arrisRouterWEPDe-
faultKey identifies this entry as the key in use.

arrisRouterWEP128BitKeyTable Entries

A table of 104-bit key values used when operating in WEP128 mode. Up to

four entries are supported.
arrisRouterWEP128BitKeyValue
A 104-bit key to be used when the corresponding instance of arris-
RouterWiFiSecurityMode is set to wep(1) and the corresponding
instance of arrisRouterWEPEncryptionMode is set to
wep128(128).

arrisRouterWEP128BitKeyStatus
The RowStatus of this conceptual row. The following restrictions
apply:
• A newly created entry cannot be made active until the correspond-
ing instance of arrisRouterWEP128BitKeyValue has been set.
This object may not be set to a value of notInService(2) or
destroy(6) if the corresponding instance of arrisRouterWEPDe-
faultKey identifies this entry as the key in use.

arrisRouterWPATable Entries

A table used to configure settings related to the WPA security modes.

arrisRouterWPAAlgorithm
Sets the WPA encryption mode used by the service set.
• The WPA algorithm for WPA-PSK and WPA-Enterprise is either
tkip(1) or aes(2).

• The WPA algorithm for WPA2-PSK and WPA2-Enterprise is

either aes(2) or tkipPlusAes(3).
arrisRouterWPAPreSharedKey
Sets the WPA Pre-Shared Key (PSK) used by this service set. The
key must be one of the following:
• a 64 byte hexadecimal number
• an 8- to 63-character ASCII string
arrisRouterWPAGroupRekeyInterval
Sets the WPA Group Rekey Interval for this service set. A value of
zero disables periodic rekeying for this service set.

Firmware Guide Release 7.5 Standard 1.2 August 2012

332 Chapter 5

arrisRouterWPAReAuthInterval
The WPA Group reauthentication interval, in seconds, for this ser-
vice set. A value of zero disables periodic reauthentication for this
service set.
arrisRouterWPAPreAuthEnable
Enables or disables WPA2 pre-authentication. When pre-authenti-
cation is enabled, a WPA2 wireless client can perform an 802.1X
authentication with other wireless access points in its range when it
is still connected to its current wireless access point.

arrisRouterRadiusTable Entries

This table configures settings related to the RADIUS security modes, includ-
ing WPA-Enterprise, WPA2-Enterprise and RADIUS-WEP. This table is
indexed by the ifIndex of the applicable wifi network.
arrisRouterRadiusAddressType
The type of internet address used for arrisRouterRadiusAddress.
arrisRouterRadiusAddress
The IP address of the RADIUS server.
arrisRouterRadiusPort
The UDP port used to communicate with the RADIUS server.
arrisRouterRadiusKey
The RADIUS key.
arrisRouterRadiusReAuthInterval
The network re-authentication interval, in seconds. A value of zero
disables re-authentication.

arrisRouterMACAccessTable Entries

A table of MAC addresses which defines the MAC address based access
restrictions for each wifi network. This table is indexed by the ifIndex of the
wireless network and by an internal index. Each network supports up to 32
entries.
arrisRouterMACAccessAddr
The MAC address of a client device. Client appearing in this table
are allowed or denied access based on the value of arrisRouterB-
ssAccessMode.

arrisRouterMACAccessStatus
Set to active(1) to enable this entry.
The arrisRouterMACAccessAddr object for this entry must be set
before making the entry active.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 333

arrisRouterWMMCfg Objects

These objects control Wifi Multimedia (WMM) support. TS7.5 supports

WMM only on the end-user’s network (SSID 0).
arrisRouterWMMEnable
Set to true(1) to enable WMM QOS support.
arrisRouterWMMNoAck
Set to true(1) to enable MAC-level no-acknowledgment. This can
improve throughput, at the cost of higher error rates In a noisy wifi
channel. The default value is false(2).
arrisRouterWMMAPSD
Set to true(1) (the default) to enable Automatic Power Save Deliv-
ery. This provides more efficient power management than legacy
802.11 Power Save Polling.

arrisRouterWMMEDCAAPTable

This table configures WMM Enhanced Distributed Channel Access (EDCA)

for traffic flowing from the access point to the client station. This feature
allows the Router to prioritize traffic by type.
The table supports four entries; positions are significant and correspond to
the following flows:
1 Access Category: Best Effort (ACBE)
2 Access Category: Background (ACBK)
3 Access Category: Video (ACVI)
4 Access Category: Voice (ACVO)
This is an advanced configuration feature; the table is populated with reason-
able defaults that should work for most deployments.
arrisRouterWMMEDCAAPCWmin
Sets the Minimum Contention Window (CWmin), in milliseconds.
This is the upper bound of the first (minimum) random backoff time
for retrying a transmission. Valid settings are: 1, 3, 7, 15, 31, 63,
127, 255, and 511. The setting must be lower than the setting for
arrisRouterWMMEDCAAPCWmax.

arrisRouterWMMEDCAAPCWmax
Sets the Maximum Contention Window (CWmax), in milliseconds.
This is the upper bound of the maximum random backoff time for
retrying a transmission. Valid settings are: 1, 3, 7, 15, 31, 63, 127,
255, and 511. The setting must be higher than the setting for arris-
RouterWMMEDCAAPCWmin.

Firmware Guide Release 7.5 Standard 1.2 August 2012

334 Chapter 5

arrisRouterWMMEDCAAPAIFSN
Sets the Arbitration Inter-Frame Spacing Number, in milliseconds.
This is the wait time for data frames.
arrisRouterWMMEDCAAPTxOpBLimit
Sets the Transmission Opportunity (TXDP) for 802.11b, in
microseconds. During this interval, a WMM AP has the right to ini-
tiate transmissions onto the wireless network.
arrisRouterWMMEDCAAPTxOpAGLimit
Sets the Transmission Opportunity (TXDP) for 802.11a/g, in
microseconds. During this interval, a WMM AP has the right to ini-
tiate transmissions on the wireless network.
arrisRouterWMMEDCAAPAdmitCont
Set to true(1) to enable admission control for specific category of
traffic.
arrisRouterWMMEDCAAPDiscardOld
Set to true(1) to enable ‘‘discard oldest packet first’’ mode.

arrisRouterWMMEDCASTATable

This table configures WMM Enhanced Distributed Channel Access (EDCA)

for traffic flowing from the client station to the access point. This feature
allows the Router to prioritize traffic by type.
The table supports four entries; positions are significant and correspond to
the following flows:
1 Access Category: Best Effort (ACBE)
2 Access Category: Background (ACBK)
3 Access Category: Video (ACVI)
4 Access Category: Voice (ACVO)
This is an advanced configuration feature; the table is populated with reason-
able defaults that should work for most deployments.
arrisRouterWMMEDCASTACWmin
Sets the Minimum Contention Window (CWmin), in milliseconds.
This is the upper bound of the first (minimum) random backoff time
for retrying a transmission. Valid settings are: 1, 3, 7, 15, 31, 63,
127, 255, and 511. The setting must be lower than the setting for
arrisRouterWMMEDCASTACWmax.

arrisRouterWMMEDCASTACWmax
Sets the Maximum Contention Window (CWmax), in milliseconds.
This is the upper bound of the maximum random backoff time for
retrying a transmission. Valid settings are: 1, 3, 7, 15, 31, 63, 127,
255, and 511. The setting must be higher than the setting for arris-
RouterWMMEDCASTACWmin.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 335

arrisRouterWMMEDCASTAAIFSN
Sets the Arbitration Inter-Frame Spacing Number, in milliseconds.
This is the wait time for data frames.
arrisRouterWMMEDCASTATxOpBLimit
Sets the Transmission Opportunity (TXDP) for 802.11b, in
microseconds. During this interval, a WMM AP has the right to ini-
tiate transmissions onto the wireless network.
arrisRouterWMMEDCASTATxAGLimit
Sets the Transmission Opportunity (TXDP) for 802.11a/g, in
microseconds. During this interval, a WMM AP has the right to ini-
tiate transmissions on the wireless network.

arrisRouterWPSCfg Objects

These objects enable and configure Wifi Protected Setup (WPS).

arrisRouterWpsMode
Set to enabled(1) to enable (WPS).
arrisRouterWpsConfigState
Set to enabled(1) to enable the WPS configuration state.
arrisRouterWpsDevicePIN
The WPS device PIN, up to eight characters. The PIN is displayed
to the user to input on the client device.
arrisRouterWpsDeviceName
The name of this device for WPS, up to 32 characters.
arrisRouterWpsModelName
The WPS model name, up to 32 characters.
arrisRouterWpsMfg
The WPS manufacturer string up to 64 characters.
arrisRouterWpsResultStatus
(read-only) The result of the most recent WPS operation: wpsRe-
sultUnknown(-1), wpsResultNoneIssued(0), wpsResultAdd-
ClientSuccess(1), wpsResultAddClientFail(2), wpsResultAdd-
ClientAbort(3), wpsResultConfigApSuccess(4), wpsResultCon-
figApFail(5), or wpsResultConfigApAbort(6).

arrisRouterWpsStatus
(read-only) The WPS subsystem status: wpsUnknown(-1), wpsIni-
tialState(0), wpsAssociatedStarted(1), wpsM2Sent(2),
wpsM7Sent(3), wpsTimedOut(4), wpsMsgDone(5), wpsSuc-
cessful(6), wpsMsgExchangeErr(7), wpsPushButtonOverlap(8),
wpsAssociating(9), or wpsPushButtonFindAP(10).

Firmware Guide Release 7.5 Standard 1.2 August 2012

336 Chapter 5

arrisRouterWpsConfigTimeout
Set to enabled(1) to enable WPS timeout.
arrisRouterWpsSTAPin
The WPS PIN for a new station/device, up to 8 characters. This is
the PIN from a client device.
arrisRouterWpsPushButton
The virtual WPS push-button:
activatePushButton(1)
Start the WPS push-button process, as if a user pushed the
WPS button.
activePINCfg(2)
Starts the WPS PIN process. The arrisRouterWpsSTAPin
object must have a value set before triggering the WPS
process.
cancelWPS(3)
Cancels an active WPS configuration.
arrisRouterWpsBoardNum
Sets the WPS Board serial number, up to 32 characters.
arrisRouterWpsModelNum
The WPS model number, up to 32 characters.
arrisRouterWpsUUID
The WPS Universal Unique Identifier, up to 16 characters.

arrisRouterWiFi80211NSettings Objects +

The following objects apply only when the router is using 802.11n. +

arrisRouterWiFi80211NBand +
If operating in 802.11n mode, this is either band24G(1) for 2.4GHz +
operation or band5G(2) for 5GHz operation. +

arrisRouterWiFiGuardInterval +
If operating in 802.11n mode, the interval between transmission of +
symbols (in nanoseconds): gi400(0) (400ns) or gi800(1) (800ns). +

arrisRouterWiFiHTMCS +
The 802.11n physical modulation coding scheme (MCS) rate. Set- +
ting this object forces the transmission rate for the AP to a particular +
speed. Each pair of rates corresponds to a 20 MHz or 40 MHz +
channel configuration. Use auto(0) to allow the router to choose a +
transmission rate. The value legacy(1) allows setting the transmis- +
sion rate using the normal parameters. +

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 337

• mcs0(2): 6.5 or 13.5 Mbps +

• mcs1(3): 13 or 273 Mbps +

• mcs2(4): 19.5 or 40.54 Mbps +

• mcs3(5): 26 or 545 Mbps +

• mcs4(6): 39 or 816 Mbps +

• mcs5(7): 52 or 1087 Mbps +

• mcs6(8): 58.5 or 121.58 Mbps +

• mcs7(9): 65 or 1359 Mbps +

• mcs8(10): 13 or 2710 Mbps +

• mcs9(11): 26 or 5411 Mbps +

• mcs10(12): 39 or 8112 Mbps +

• mcs11(13): 52 or 10813 Mbps +

• mcs12(14): 78 or 16214 Mbps +

• mcs13(15): 104 or 21615 Mbps +

• mcs14(16): 117 or 24316 Mbps +

• mcs15(17): 130 or 27017 mibts +

arrisRouterWiFiChannelBW +
Determines the 802.11n bandwidth; one of: +

• width20MHz(0) +

• width40MHz(1) +

• width20and40Mhz(2) +

arrisRouterWiFi80211NSideBand +
When 40MHz mode is selected, determines which sideband the +
channel uses: upper(1) or lower(2). +

arrisRouterWiFiHTMode +
The 802.11n operating mode; one of mixed(0) (the default) or +
greenField(1). +

In mixed mode, 802.11n devices can interoperate with 802.11a or +

802.11g devices. Greenfield mode provides higher efficiency, but +
802.11a/b/g devices cannot interoperate. +

arrisRouterWiFiGuardInterval +
The time, in nanoseconds, between symbol transmissions. The +
choices are: +

Firmware Guide Release 7.5 Standard 1.2 August 2012

338 Chapter 5

• gi400(0) (better throughput) +

• gi800(1) (default, more robust) +

• auto(2) (automatically chosen based on the network) +

arrisRouterWiFiAMSDUEnable +
Set to true(1) to aggregate MAC Service Data Units (MSDUs) at +
the top of the MAC-level frame. The default is false(2). +

arrisRouterWiFiDeclinePeerBA +
Set to true(1) to enable rejection of a peer BA-request. The default +
is false(2). +

arrisRouterWiFiBlockAck +
Set to true(1) to enable ACK blocking (BA) during data transfer. +
The default is false(2). +

arrisRouterWiFiNProtection +
The 802.11n protection setting, either off(0) or auto(1). This is for +
OFDM protection for MIMO frames. +

arrisRouterWiFiAllow40MHzOnlyOperation +
Set to true(1) to allow end-users to set 40 MHz-only Wifi operation. +
This adds a new selection to the Bandwidth menu in the configura- +
tion web pages. The default is false(2). +

arrisRouterFWCfg These objects configure the following firewall services:

Objects • parental controls
• virtual servers
• IP filters
• MAC filters
• port triggers
• DMZ
arrisRouterFWEnabled
Enables or disables the firewall.
arrisRouterFWEnableDMZ
Enables or disables a configured client in the DMZ.
arrisRouterFWIPAddrTypeDMZ
The IP address type of the DMZ client.
arrisRouterFWIPAddrDMZ
The IP address of the DMZ client.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 339

arrisRouterFWSecurityLevel
(CT loads only) This variable can be used to set a generic firewall
level. The allowed levels are:
• minimum(1): allows all incoming and outgoing connections
except IDENT (port 113).
• medium(2): rejects all incoming connections and allows all out-
going connections except: IDENT (port 113), ICMP, Kazaa (port
1214), Bittorrent (Ports 6881-6999), Gnutella (6346), and Vuze
(49152-65534).
• maximum(3): rejects all incoming connections. Rejects all out-
going connections except: HTTP (80), HTTPS (443), DNS (53),
Email (25,110,143,465,587,993,995), NTP (119, 123), VPN (500,
1723), and iTunes (3689).
• custom(4): Uses operator- or subscriber-specified port filters and
triggers.
arrisRouterFWApplySettings
(CT loads only) Apply or reject changes made to the firewall config-
uration. Allowed values are:
• applySettings(1): applies all changes.
• revertSettings(2): rejects changes made since the last apply.
• resetDefaults(3): reverts firewall settings to their defaults.
arrisRouterFWAllowICMP
Enables or disables ICMP messages such as Ping and Traceroute.
arrisRouterFWResetDefaults
(CT loads only) Set to true(1) to reset firewall settings to their
default values.
arrisRouterFWBlockHTTP
(CT loads only) Enables or disables blocking of incoming HTTP
traffic.
arrisRouterFWBlockP2P
(CT loads only) Enables or disables blocking of peer-to-peer appli-
cations.
arrisRouterFWBlockIdent
(CT loads only) Enables or disables blocking of the IDENT proto-
col.
arrisRouterFWBlockICMP
(CT loads only) Enables or disables blocking of ICMP messages
such as Ping and Traceroute.

Firmware Guide Release 7.5 Standard 1.2 August 2012

340 Chapter 5

arrisRouterFWBlockMulticast
(CT loads only) Enables or disables blocking of multicast traffic.
arrisRouterFWVirtSrvTableEnabled
(CT loads only) Enables or disables Port Forwarding.
arrisRouterFWPortTrigTableEnabled
(CT loads only) Enables or disables port triggering.
arrisRouterFWAllowAll
Set to true(1) to allow all devices to connect to the network, except
those in the arrisRouterFWMACFilterTable. Set to false(2) to
block all devices from connecting to the network, except those in
the arrisRouterFWMACFilterTable.

arrisRouterFWVirtSrvTable Entries

This table defines virtual servers. This service allows incoming requests on
specific ports to reach servers behind the firewall. This allows access to
servers from the public network.
arrisRouterFWVirtSrvDesc
A text string (up to 16 characters), describing this entry.
arrisRouterFWVirtSrvPortStart
The beginning of the port range to forward to this virtual server.
Note that the arrisRouterFWVSSrcPortExclude object can disal-
low certain ports.
arrisRouterFWVirtSrvPortEnd
The end of the port range to forward to this virtual server.
arrisRouterFWVirtSrvProtoType
Specifies which protocol(s) are forwarded: udp(0), tcp(1), or
both(2).

arrisRouterFWVirtSrvIPAddrType
The destination IP address type on the private network.
arrisRouterFWVirtSrvIPAddr
The destination IP address on the private network.
arrisRouterFWVirtSrvTOD
(CT loads only) A 32-bit bitmask that sets the time of day and days
of the week when this virtual service is active. The bits are:
0 67 30
Day of Week Hours of Day

Bits 0 through 6 represent days of the week, Sunday through Satur-

day. Set each bit to enable this virtual service for the corresponding
day.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 341

Bits 7 through 30 represent the hours of the day, midnight through

11 p.m. Set each bit enable the virtual service for the specified hour.
arrisRouterFWVirtSrvLocalPortStart
The beginning of the port range to forward to this virtual server.
arrisRouterFWVirtSrvLocalPortEnd
The end of the port range to forward to this virtual server.
arrisRouterFWVirtSrvRowStatus
The RowStatus variable used to add, remove, or enable entries.

arrisRouterFWIPFilterTable

This table defines IP address filters. The filters block or allow Internet traffic
to or from specific IP address ranges.
arrisRouterFWIPFilterDesc
A text string, up to 32 characters, that describes this entry.
arrisRouterFWIPFilterStartType
The IP address type for the starting address in the range.
arrisRouterFWIPFilterStartAddr
The beginning IP address in the range. To filter all IP addresses, use
0.0.0.0 (IPv4 networks).

arrisRouterFWIPFilterEndType
The IP address type for the ending address in the range.
arrisRouterFWIPFilterEndAddr
The ending IP address in the range. To filter all IP addresses, use
0.0.0.0 (IPv4 networks).

arrisRouterFWIPFilterPortStart
The beginning of the port range to filter.
arrisRouterFWIPFilterPortEnd
The end of the port range to filter.
arrisRouterFWIPFilterProtoType
Specifies the protocols to filter: udp(0), tcp(1), or both(2).
arrisRouterFWIPFilterTOD
A 32-bit bitmask that sets the time of day and days of the week
when this IP filter is active. The bits are:
0 67 30
Day of Week Hours of Day

Firmware Guide Release 7.5 Standard 1.2 August 2012

342 Chapter 5

Bits 0 through 6 represent days of the week, Sunday through Satur-

day. Set each bit to enable this IP filter for the corresponding day.
Bits 7 through 30 represent the hours of the day, midnight through
11 p.m. Set each bit enable the IP filter for the specified hour.
arrisRouterFWIPFilterRowStatus
The RowStatus variable used to add, remove, or enable entries.

arrisRouterFWMACFilterTable

This table defines MAC addresses that are denied access to the gateway.
arrisRouterFWMACFilterAddr
The MAC address of a device on the local network that is blocked
by the firewall.
arrisRouterFWMACFilterTOD
A 32-bit bitmask that sets the time of day and days of the week
when this MAC filter is active. The bits are:
0 67 30
Day of Week Hours of Day

Bits 0 through 6 represent days of the week, Sunday through Satur-

day. Set each bit to enable this MAC filter for the corresponding
day.
Bits 7 through 30 represent the hours of the day, midnight through
11 p.m. Set each bit enable the MAC filter for the specified hour.
arrisRouterFWMACFilterRowStatus
The RowStatus variable used to add, remove, or enable entries.
arrisRouterFWMACFilterHostName
(CT loads only) The name of the device on the local network that is
being filtered.

arrisRouterFWPortTrigTable

This table defines port triggers. Port triggers support special applications that
require specific port numbers with bi-directional traffic to function properly.
Applications such as video conferencing, voice, gaming, and some messeng-
ing program features may require port triggers.
arrisRouterFWPortTrigDesc
A text string, up to 16 character, describing the name for this port
trigger.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 343

arrisRouterFWPortTrigPortStart
The beginning of the trigger port range.
arrisRouterFWPortTrigPortEnd
The end of the trigger port range.
arrisRouterFWPortTargPortStart
The beginning of the target port range.
arrisRouterFWPortTargPortEnd
The end of the target port range.
arrisRouterFWPortTrigProtoType
Specifies which protocol(s) are filtered: udp(0), tcp(1), or both(2).
arrisRouterFWPortTrigRowStatus
The RowStatus variable used to add, remove, or enable entries.

arrisRouterFWFilterRules

These objects control filtering. Except where noted, all filters are disabled by
default.
arrisRouterFWFilterProxy
Set to true(1) to enable HTTP proxy filtering.
arrisRouterFWFilterCookies
Set to true(1) to filter cookies.
arrisRouterFWFilterJavaApplets
Set to true(1) to filter Java applets.
arrisRouterFWFilterActiveX
Set to true(1) to filter ActiveX controls.
arrisRouterFWFilterPopupWnds
Set to true(1) to filter pop-up windows.
arrisRouterFWBlockFragIPPkts
Set to true(1) to block fragmented IP packets.
arrisRouterFWPortScanProtect
Set to true(1) to enable port scan protection.
arrisRouterFWIPFloodDetect
Set to true(1) (default) to enable detection of IP floods.

arrisRouterFWDDNSObjs

These objects set up and control DDNS clients.

arrisRouterFWDDNSEnable
Set to true(1) to enable dynamic DNS (DDNS).

Firmware Guide Release 7.5 Standard 1.2 August 2012

344 Chapter 5

arrisRouterFWDDNSType
The DDNS service to use: unknown(0), dynDNS(1), or tzo(2).
arrisRouterFWDDNSUserHame
The user name (up to 64 characters) to log into the DDNS service.
arrisRouterFWDDNSPassword
The password (up to 64 characters) to log into the DDNS service.
arrisRouterFWDDNSDomainName
The domain name that the DDNS service associates with this router.
arrisRouterFWDDNSIPAddrType
(read-only) The IP address type (IPv4 or IPv6) for the DDNS IP
address.
arrisRouterFWDDNSIPAddr
(read-only) The DDNS IP address.
arrisRouterFWDDNSStatus
(read-only) The current status of the DDNS service.

arrisRouterFWFeatures

These objects control various router features. All these features are disabled
by default.
arrisRouterFWEnableWanBlocking
Set to true(1) to enable WAN blocking.
arrisRouterFWIPSecPassThru
Set to true(1) to enable IPsec pass-through.
arrisRouterFWPPTPPassThru
Set to true(1) to enable PPTP pass-through.
arrisRouterFWEnableMulticast
Set to true(1) to enable multicast support.
arrisRouterFWEnableRemoteMgmt
Set to true(1) to enable remote web management.
arrisRouterFWEnableRGPassThru
Set to true(1) to enable pass-through mode. Enabling this feature
automatically disables UPnP.
The router must be rebooted after enabling this feature.
arrisRouterFWL2TPPassThru
Set to true(1) to enable L2TP pass-through.
arrisRouterFWEnableWanSNMP
Set to true(1) to enable SNMP access (ports 161, 1161, 162) on the
eRouter WAN port. Changing this value takes affect without apply-
ing settings.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 345

arrisRouterFWEnableWanSSH
Set to true(1) to enable SSH access (port 22) on the eRouter WAN
port. Changing this value takes affect without applying settings.

arrisRouterFWParentalControls

These objects manage the parental control features.

arrisRouterKeywordCount
(read-only) The number of keywords in the block table.
arrisRouterKeywordClear
Set to clear(1) to remove all keywords from the block table.
arrisRouterBlackListCount
(read-only) The number of black listed domains.
arrisRouterBlackListClear
Set to clear(1) to remove all domains from the blacklist.
arrisRouterWhiteListCount
(read-only) The number of white listed domains.
arrisRouterWhiteListClear
Set to clear(1) to remove all domains from the whitelist.
arrisRouterTrustedDeviceCount
(read-only) The number of trusted devices which bypass parental
controls.
arrisRouterTrustedDeviceClear
Set to clear(1) to remove all entries from the trusted devices list.
arrisRouterKeywordTableFreeIdx
(read-only) The first available index that may be used to add a row
instance to the arrisRouterKeywordBlkTable.
arrisRouterBlackListFreeIdx
(read-only) The first available index that may be used to add a row
instance to the arrisRouterBlackListTable.
arrisRouterWhiteListFreeIdx
(read-only) The first available index that may be used to add a row
instance to the arrisRouterWhiteListTable.
arrisRouterTrustedDeviceFreeIdx
(read-only) The first available index that may be used to add a row
instance to the arrisRouterTrustedDeviceTable.
arrisRouterEnableParentalCont
Set to true(1) to enable parental controls.

Firmware Guide Release 7.5 Standard 1.2 August 2012

346 Chapter 5

arrisRouterManagedSitesEnabled
Set to true(1) to enable parental control managed sites.
arrisRouterManagedServicesEnabled
Set to true(1) to enable parental control managed services.
arrisRouterManagedDevicesEnabled
Set to true(1) to enable parental control managed devices.

arrisRouterKeywordBlkTable

This table defines the block table. URLs that contain a keyword from this ta-
ble are blocked. The table supports up to 50 keywords.
arrisRouterKeywordBlkWord
The keyword to block, up to 32 characters.
arrisRouterKeywordBlkTOD
A 32-bit bitmask that sets the time of day and days of the week
when this keyword is blocked. The bits are:
0 67 30
Day of Week Hours of Day

Bits 0 through 6 represent days of the week, Sunday through Satur-

day. Set each bit to enable this keyword block for the corresponding
day.
Bits 7 through 30 represent the hours of the day, midnight through
11 p.m. Set each bit enable the keyword block for the specified
hour.
arrisRouterKeywordBlkStatus
The RowStatus used to create, change, or delete an entry in this ta-
ble. Use createAndGo(4) or createAndWait(5) to create a row.
All fields must be specified to make a row active
Only rows with a status of active(1) are applied.

arrisRouterBlackListTable

This table contains domain names to block. The table supports up to 16

domains.
arrisRouterBlackListDomain
The domain to block, up to 64 characters.
arrisRouterBlackListTOD
A 32-bit bitmask that sets the time of day and days of the week
when this blacklist entry is active. The bits are:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 347

0 67 30
Day of Week Hours of Day

Bits 0 through 6 represent days of the week, Sunday through Satur-

day. Set each bit to enable this blacklist entry for the corresponding
day.
Bits 7 through 30 represent the hours of the day, midnight through
11 p.m. Set each bit enable the blacklist entry for the specified hour.
arrisRouterBlackListStatus
The RowStatus used to create, change, or delete an entry in this ta-
ble. Use createAndGo(4) or createAndWait(5) to create a row.
All fields must be specified to make a row active
Only rows with a status of active(1) are applied.

arrisRouterWhiteListTable

This table contains domain names that are never blocked, even if there are
matches in the keyword list or blacklist. The table supports up to 16
domains.
arrisRouterWhiteListDomain
The domain to whitelist, up to 64 characters.
arrisRouterWhiteListTOD
A 32-bit bitmask that sets the time of day and days of the week
when this domain is whitelisted. The bits are:
0 67 30
Day of Week Hours of Day

Bits 0 through 6 represent days of the week, Sunday through Satur-

day. Set each bit to enable this whitelist entry for the corresponding
day.
Bits 7 through 30 represent the hours of the day, midnight through
11 p.m. Set each bit enable the whitelist entry for the specified
hour.
arrisRouterWhiteListStatus
The RowStatus used to create, change, or delete an entry in this ta-
ble. Use createAndGo(4) or createAndWait(5) to create a row.
All fields must be specified to make a row active
Only rows with a status of active(1) are applied.

Firmware Guide Release 7.5 Standard 1.2 August 2012

348 Chapter 5

arrisRouterTrustedDeviceTable

A table of trusted devices (up to three) which bypass parental controls.

arrisRouterTrustedDeviceMAC
The MAC address of a device on the local network that bypasses
parental controls.
arrisRouterTrustedDeviceStatus
The RowStatus used to create, change, or delete an entry in this ta-
ble. Use createAndGo(4) or createAndWait(5) to create a row.
All fields must be specified to make a row active.
Only rows with a status of active(1) are applied.
arrisRouterTrustedDeviceName
The name of the trusted device.
arrisRouterTrustedDeviceAddrType
The IP address type for the trusted device.
arrisRouterTrustedDeviceAddr
The IP address for the trusted device.

arrisRouterTrustedDeviceManagedServicesTable

A table of trusted devices which bypass parental control service settings.

The table supports up to three devices.
arrisRouterTrustedDeviceManagedServicesMAC
The MAC address of the trusted device.
arrisRouterTrustedDeviceManagedServicesStatus
The RowStatus used to create, change, or delete an entry in this ta-
ble. Use createAndGo(4) or createAndWait(5) to create a row.
All fields must be specified to make a row active.
Only rows with a status of active(1) are applied.
arrisRouterTrustedDeviceName
The name of the trusted device.
arrisRouterTrustedDeviceAddrType
The IP address type for the trusted device.
arrisRouterTrustedDeviceAddr
The IP address for the trusted device.
arrisRouterTrustedDeviceManagedServicesName
The name of the service that bypasses parental controls.
arrisRouterTrustedDeviceManagedServicesAddrType
The IP address type for the service.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 349

arrisRouterTrustedDeviceManagedServicesAddr
The IP address for the service.

arrisRouterSysCfg The following objects provide administrative settings.

Objects arrisRouterAdminPassword
(deprecated) The administrative password to log into the gateway
web interface.
arrisRouterAdminTimeout
The time, in seconds, that a gateway web interface session remains
active. Default: 900 (10 minutes).
arrisRouterReboot
Set to restart(1) to restart the gateway component.
arrisRouterDefaults
Resets the selected router settings to their defaults:
• restoreUser(1): restores default settings for the primary wireless
network.
• restoreGuest(2): restores default settings for the guest wireless
networks.
• restoreAll(3): restores all settings.
arrisRouterLanguage
Sets the current language for the router web interface. Supported
languages are English, Spanish, French, German, and Por-
tuguese (Brazilian).

arrisRouterName
(optional) The name of the gateway router.
arrisRouterSerialNumber
(read-only) The device serial number.
arrisRouterBootCodeVersion
(read-only) The device boot code version.
arrisRouterHardwareVersion
(read-only) The device hardware version.
arrisRouterFirmwareVersion
(read-only) The device firmware version.
arrisRouterLogLevel
The logging level for the Arris SNMP daemon: noLogging(0),
logError(1) (default), logWarn(2), or logInfo(3).

arrisRouterCustomSettings
A text string used for web interface settings.

Firmware Guide Release 7.5 Standard 1.2 August 2012

350 Chapter 5

arrisRouterCustomID
A customer-assigned ID.
arrisRouterCurrentTime
The current time on the router.
arrisRouterTACACSAddr
The FQDN or IP Address of the TACACS server.
arrisRouterTACACSPort
The TACACS server port. Default: 49.
arrisRouterTACACSSecretKey
The secret key used to communicate with the TACACS server.
arrisRouterXmlProvisioningFile
The fully qualified path to a provisioning file to load. The file may
be an URL using HTTP or TFTP.
Note: This value is not permanently stored in non-volatile memory,
and is cleared on reboot.
arrisRouterXmlProvisioningStatus
The download status of the gateway XML configuration file; one of:
• notSpecified(1)
• inProgress(2)
• downloadSuccess(3)
• serverError(4)
• fileNotFound(5)
• fileFormatError(6)
• downloadFromMgt(7)
Setting this object to downloadFromMgt(7) immediately starts
downloading the XML configuration file.
Note: This value is not permanently stored in non-volatile memory
and resets to notSpecified(1) when the gateway reboots.

arrisRouterSNTPSettings Sub-group

These objects configure the network time (SNTP) client.

arrisRouterEnableSNTP
Enables or disables the SNTP service: disable(0) or enable(1).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 351

arrisRouterSNTPServerTable Entries

This table configures up to three SNTP servers.

arrisRouterSNTPServerAddrType
The IP address type of the Network Time Server address.
arrisRouterSNTPServerAddr
The IP address of the Network Time Server.
arrisRouterSNTPServerName
The host name of the Network Time Server.
arrisRouterSNTPServerStatus
The RowStatus object used to add or remove rows in the table. The
server address must be properly configured before a row can be set
to active(1).

arrisRouterEmailSettings Sub-group

These objects define a mail drop for sending router logs and similar informa-
tion.
arrisRouterEmailServerName
The name of the email server to use.
arrisRouterEmailServerUser
The optional user ID used to log into the SMTP email server.
arrisRouterEmailServerPW
The optional password used to log into the SMTP email server.
arrisRouterEmailAddress
The email address that receives communications from the gateway.
arrisRouterEnableLogEmail
Enables or disables emailing router logs.
arrisRouterEmailApplySettings
Set to applySettings(1) to apply the email settings.

arrisRouterLogSettings Sub-group

The objects configure firewall logs and MSO change logs. They are sepa-
rated into two groups and a series of tables, defined below.

arrisRouterUserLogs Objects

A series of tables defining user-accessible log entries.

Firmware Guide Release 7.5 Standard 1.2 August 2012

352 Chapter 5

arrisRouterFirewallLogTable
A read-only table of up to 30 firewall logs. The objects are:
arrisRouterFWLogTime
(read-only) The date and time when this event occurred.
arrisRouterFWLogInfo
(read-only) The log entry text.
arrisRouterParentalContLogTable
A read-only table of up to 30 parental control logs. The objects are:
arrisRouterPCLogTime
(read-only) The date and time when this event occurred.
arrisRouterPCLogInfo
(read-only) The log entry text.
arrisRouterChangeLogTable
A read-only table of up to 48 subscriber configuration change logs.
The objects are:
arrisRouterChangeLogTime
(read-only) The date and time when this event occurred.
arrisRouterChangeLogInfo
(read-only) The log entry text.
arrisRouterDebugLogTable
A read-only table of up to 100 debug logs. The objects are:
arrisRouterDebugLogTime
(read-only) The date and time when this event occurred.
arrisRouterDebugLogInfo
(read-only) The log entry text.

arrisRouterMSOLogs Objects

These objects display and control log entries based on MSO actions.
arrisRouterMSOChgLogTable
A table of up to 48 MSO change log entries. These entries are con-
figuration changes performed by a technician on-site or remotely
from the NOC. The objects are:
arrisRouterMSOChgLogTime
(read-only) The date and time when this event occurred.
arrisRouterMSOChgLogInfo
(read-only) The log entry text.
arrisRouterClearMSOLogs
Set to clearLogs(1) to clear the MSO logs.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 353

arrisRouterAuthTable Entries

This table contains authorization information for web UI users, roles, and
passwords.
arrisRouterAuthUserName
The user name, up to 32 characters.
arrisRouterAuthPassword
The password for the user, up to 32 characters.
arrisRouterAuthType
A string describing the type of user. For example, ‘‘technician’’ or
‘‘subscriber.’’

arrisRouterInboundTrafficLogTable Entries

This table contains recent inbound packet headers. Up to 50 headers are

stored.
arrisRouterInboundTrafficLogData
(read-only) Raw IP/UDP/TCP packet headers.

arrisRouter- These objects control access to router interfaces (web and CLI).
HostAccess Ob-
jects
arrisRouterWebAccessTable Entries

This table configures access levels (subscriber, technician, or blocked) for

any web page in the gateway web interface. Up to 50 entries are supported.
arrisRouterWebAccessPage
The web page to control. This object is a text string, containing the
name of the page file (for example, router.html) or any unique
string that identifies a web interface page.
arrisRouterWebAccessLevel
Access level for the web page: noAccessAll(0), accessTech(1), or
accessAll(2).

arrisRouterWebAccessRowStatus
The RowStatus object used to add or remove rows from the table.

arrisRouterPing- These objects control the Ping utility, allowing controlled testing of network
Mgmt Objects connectivity.
arrisRouterPingTargetAddrType
The IP address type for the target address.

Firmware Guide Release 7.5 Standard 1.2 August 2012

354 Chapter 5

This object may be changed while a ping is in progress.

arrisRouterPingTargetAddress
The IP address of the entity to be pinged. Use an all-zeros IP
address to specify the default gateway (if configured).
This object may be changed while a ping is in progress.
arrisRouterPingNumPkts
The number of pings to send. A value of zero means the ping utility
runs until stopped by the operator. Default: 3.
This object may be changed while a ping is in progress.
arrisRouterPingPktSize
Sets the initial size of the ping packets. The size includes the LLC
header, IP header, ICMP header, and the CRC32 at the end.
Default: 64.
This object may be changed while a ping is in progress.
arrisRouterPingInterval
The time, in milliseconds, that the device waits after receiving a
ping response before sending the next ping. If waiting for replies is
disabled, this is the time between sending pings.
Note that the total time between sending pings varies, depending on
whether you enable waiting for replies, and how long it takes to
receive the reply.
This object may be changed while a ping is in progress.
arrisRouterPingTimeout
The time, in milliseconds, that the gateway waits for a reply after
sending a ping.
If set to zero or a positive value, the gateway sends a ping and waits
for a response for the specified amount of time. If set to −1, the
gateway neither waits nor checks for a response.
This object may be changed while a ping is in progress.
arrisRouterPingVerifyReply
Enables or disables verification of ping responses. If enabled, and if
waiting for responses is enabled, then the gateway verifies that
received pings match the pings sent, and that the ping data is intact.
This object may be changed while a ping is in progress.
arrisRouterPingIpStackNumber
Sets the IP stack from which the pings are sent. A value of zero
means that the pings are sent from the same IP stack on which this
MIB is hosted.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 355

This object may not be changed while a ping is in progress.

arrisRouterPingStartStop
Starts or stops pinging, or indicates whether a ping is in progress. If
a ping is already in progress and this object is set to true(1), pinging
continues but ping statistics are reset.
This object may be changed while a ping is in progress.
arrisRouterPingPktsSent
(read-only) The number of packets sent since the ping was started.
arrisRouterPingRepliesReceived
(read-only) The number of replies received since the ping was
started.
arrisRouterPingRepliesVerified
(read-only) The number of replies which were verified since the
ping was started.
arrisRouterPingOctetsSent
(read-only) The total number of octets that have been sent in pings
since the ping was started.
arrisRouterPingOctetsReceived
(read-only) The total number of octets that have been sent in pings
since the ping was started.
arrisRouterPingIcmpErrors
(read-only) The total number of ICMP errors received since the ping
was started.
arrisRouterPingLastIcmpError
(read-only) The value of the last ICMP error which was received, if
any. If there have been no errors, this object has a value of 0.

arrisRouterTrac- These objects control the Traceroute utility, allowing controlled testing of
eRtMgmt Objects network connectivity.
arrisRouterTraceRtTargAddrType
The IP address type for the target address.
arrisRouterTraceRtTargetAddr
The IP address of the destination for the traceroute.
arrisRouterTraceRtMaxHops
The maximum number of hops for the traceroute.
arrisRouterTraceRtDataSize
The data size of the traceroute packet.
arrisRouterTraceRtResolveHosts
Specifies host name resolution: noResolve(0) or resolve(1)
(default).

Firmware Guide Release 7.5 Standard 1.2 August 2012

356 Chapter 5

arrisRouterTraceRtBasePort
The base port to use for traceroute.
arrisRouterTraceRtStart
Starts or stops the traceroute, or indicates the current traceroute sta-
tus: traceRouteNotRunning(0), traceRouteRunning(1), or start-
Trace(10).

arrisRouterTraceRtLog
(read-only) The most recent output log for the traceroute, up to 255
bytes.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Operations 357

ARRIS Speedtest MIB

The Speedtest MIB objects are collected in the arrisSpeedTestMib. The fol-
lowing objects are defined, separated into configuration, control, and results.

Configuration Ob- The uplink and downlink configurations are set using URL formatted strings.
jects arrisSpeedTestConfigEndUserGui
Set to true(1) to include the Speedtest web page in the Basic (sub-
scriber-accessible) pages.
arrisSpeedTestConfigSyslogReports
Set to true(1) to report results to Syslog and the event log.
arrisSpeedTestConfigCpeAccess
Set to true(1) to allow CPE access to the Internet while running a
speed test.
arrisSpeedTestConfigDownlinkURL
Defines the downlink configuration, in URL format (see below for
an example).
arrisSpeedTestConfigUplinkURL
Defines the uplink configuration, in URL format (see below for an
example).

Download Examples

The following examples show typical download URLs for FTP and HTTP
tests. In these examples, the user ID and password are both speedtest.
ftp://speedtest:[email protected]/movie.mpg
?ftpmode=passive&tcpwindow=2048&tcpmss=1460
&tcptimestamps=1&pmtud=1&cpeaccess=1

http://speedtest:[email protected]:80/movie.mpg
?tcpwindow=63&tcpmss=1460&tcptimestamps=1&pmtud=1
&cpeaccess=1

Upload Examples

The following examples show typical upload URLs for FTP and HTTP tests.
In these examples, the user ID and password are both speedtest.

Firmware Guide Release 7.5 Standard 1.2 August 2012

358 Chapter 5

ftp://speedtest:[email protected]:21/uptest.txt
?ftpmode=active&uploadsize=10&tcpwindow=63&tcpmss=1460
&tcptimestamps=1&pmtud=1&cpeaccess=1

http://speedtest:[email protected]:80/uptest.txt
?uploadsize=10&script=cgi-bin/upload.cgi&postfields
=ac˜upload;login˜admin;pass˜admin&filefield=file
&tcpwindow=63&tcpmss=1460&tcptimestamps=1&pmtud=1
&cpeaccess=1

Control Object Use the following object to start and stop the speed tests:
arrisSpeedTestConfigStartStopTest
One of the following:
• stopTest(0)
• startDownlinkTest(1)
• startUplinkTest(2)

Results Table Use the following object to retrieve speed test results:
arrisSpeedTestResultsStatus
Use an index of 1 to 3 to retrieve a test result. arrisSpeedTestRe-
sultsStatus.1 contains the latest result.

The string is formatted as shown in the following example:

Status=complete&starttime=Thu Aug 11 13:19:04 2011
&endtime=Thu Aug 11 13:19:04 2011&vlstart=0&vlend=0
&cpedata=1 Download=complete&speed= 99.40Mbps
&bytes=105541632&ohspeed=103.33&ohbytes=109734528
&totalspeed=103.33&totalbytes=109735469&pkts=72302
&pkterrors=0&pktdropped=0&setuptime=60
UploadStatus=complete&speed= 36.52Mbps&bytes=10486058
&ohspeed= 37.44&ohbytes=10874607&totalspeed= 37.44
&totalbytes=10874607&pkts=7190&pkterrors=0
&pktdropped=0&setuptime=20

If the arrisSpeedTestConfigSyslogReports object is set to true(1), the

device also reports the results to Syslog. The following message (Event ID
2417164311, Informational) is an example:
SpeedTest Results: Download Status: Complete,
Speed: 86.91, Upload Status: Complete,
Speed: 37.27;CM-MAC=00:15:d1:ad:96:9d;
CMTS-MAC=00:01:5c:23:62:82;CM-QOS=1.1;CM-VER=3.0;

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

6 Administration

Administration involves collecting performance statistics, capacity planning,

and maintaining system reliability.
This chapter includes the following topics:
Topic Page
Administration Objects 360
End of Call Connection Statistics 364
Managing Voice Quality Monitoring 371
Using the Speedtest Application 389

Firmware Guide Release 7.5 Standard 1.2 August 2012

360 Chapter 6

Administration Objects

TS7.5 supports both standard and ARRIS-proprietary SNMP MIBs for

administration and other purposes. This section describes several generic
objects. See the Operations chapter for ARRIS-proprietary objects.

System Descrip- The system objects can be used to identify a Touchstone product and find
tion Objects general information about it. Most of these objects are generic to all devices,
but those described below have values unique to ARRIS products.

sysDescr Object

Touchstone Telephony Modems support the sysDescr MIB object. This

object provides firmware version and product description information in the
format specified in section 4.2.1 of the DOCSIS Operations Support System
Interface Specification, CM-SP-OSSIv3.0-I15-100115. The specification
requires the sysDescr object to be in the following format:
any text <<HW_REV: hardware version information;
VENDOR: vendor name; BOOTR: BootROM version;
SW_REV: firmware version; MODEL: hardware model information>> any text

Since the content is in a consistent format, the object can be automatically

parsed and used for various functions such as determining when firmware
upgrades are required. The fields in the sysDescr.0 object are:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 361

Field Meaning Description

HW_REV Hardware Revision The hardware revision of the
Telephony Modem. ARRIS
updates this field as needed to
reflect significant hardware
changes or improvements to the
product.
VENDOR Vendor Name The vendor name; in this case,
‘‘Arris Interactive, L.L.C.’’
BOOTR Boot ROM The BootROM image version that
is embedded in the product, and
used to load the application
firmware image.
SW_REV Firmware Revision The firmware version of the appli-
cation firmware image currently
loaded on the Telephony Modem.
Note: In addition to the System
Descriptor MIB object (sys-
Descr.0), the SW_REV informa-
tion is also available in the docs-
DevSwCurrentVers MIB object.
MODEL Model Number The hardware model number of
the Telephony Modem.

The following is an example of the sysDescr.0 contents for the TS7.5

firmware release.
ARRIS DOCSIS 3.0 / PacketCable 1.5 Touchstone Telephony Gateway
<<HW_REV: 1; VENDOR: Arris Interactive, L.L.C.; BOOTR: 1.2.1.44;
SW_REV: 7.3.65; MODEL: TG852G>>

sysObjectID Object

The sysObjectID object provides a condensed version of the data found in

the sysDescr object. The data in this object is in OID format, consisting of
the following fields:
Field(s) Description
1-9 Equivalent to the OID representing arris: 1.3.6.1.4.1.4115.
Some SNMP software may display this as arris or enter-
prises.4115.
10 The model number; for example, 902
11 Hardware release
12–16 Not used, display as 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

362 Chapter 6

sysORTable Objects

The following sysORTable objects provide useful information:

sysORID
Equivalent to the OID representing modemAgentDocsis20.
sysORDescr
Contains the string ‘‘DOCSIS 3.0 Cable Modem agent.’’

Bridging and Depending on provisioning and model-specific capabilities, Touchstone hard-

Routing Objects ware can function either as a bridge or a router. The MIBs described here
provide information about each function.

dot1dBridge Objects

The dot1dBridge MIB provides information about the bridging function.

The following objects can be of use:
dot1dBaseBridgeAddress.0
In Touchstone hardware, the MAC address of the Ethernet interface.
dot1dBaseNumPorts.0
The number of interfaces connected to the bridge. Touchstone hard-
ware uses the ifIndex of the interface as indexes to various tables in
the dot1dBridge MIB.
dot1dBaseType.0
The bridge type.
dot1dTpFdbTable
The forwarding database. This table uses the MAC address of sup-
ported interfaces as the index.

rip2 Objects

The rip2 MIB provides routing information when the E-UE is provisioned
for RIPv2 routing support. The following objects can be of use:
rip2IfStatTable
Statistics for each interface enabled for RIP routing.
rip2IfConfTable
RIP interface configuration for each interface enabled for RIP rout-
ing.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 363

arrisRouterMib Objects

The arrisRouterMib provides ARRIS-specific objects for managing and pro-

visioning the built-in router in ARRIS gateway products. See ‘‘ARRIS-
ROUTER-MIB Objects’’ on page 308 for brief descriptions of these objects.

Firmware Guide Release 7.5 Standard 1.2 August 2012

364 Chapter 6

End of Call Connection Statistics

Touchstone firmware supports the PacketCable 1.0-defined call connection

statistics, with clarifications as defined in ECN EC-MGCP-N-04.0175-7.
The EC clarifies the requirement to ensure that the statistics represent the
actual packets sent/received regardless of the current connection state of the
call.
Note: End-of-call connection statistics and Voice Quality Monitoring (VQM)
statistics are different features. For information about the VQM feature, see
‘‘About Voice Quality Monitoring’’ on page 371.
Touchstone firmware makes end-of-call connection statistics available
through proprietary MIB objects and Syslog messages. The arrisMtaDev-
EnableCallStatsSyslogRpt MIB object controls end-of-call statistics report-
ing through Syslog. The arrisMtaDevEnableCallSigLastMsgRpt MIB
object controls reporting of the last 4K of signaling messages through Sys-
log. Each MIB may be set independently, and interact as follows:
CallStats LastMsg CMS LoC
Messages Sent
MIB MIB Alarm
Inactive None
Disabled
Active None
Disabled
Inactive None
Enabled
Active None
Inactive None
Disabled
Active Last messages sent/received
Enabled
Inactive Last 4K of messages sent/received
Enabled
Active Last 4K of messages sent/received

NCS Behavior Touchstone NCS loads make end-of-call connection statistics available
through proprietary MIB objects and Syslog messages. Touchstone firmware
supports the PacketCable-defined call connection statistics, with clarifications
as defined in ECN EC-MGCP-N-04.0175-7. Previously, the PacketCable
NCS specification implied that these statistics were related to the connection
mode requested by the CMS. The EC clarifies the requirement to ensure that
the statistics represent the actual packets sent/received regardless of the cur-
rent connection state of the call.
The E-UE sends connection statistics to the call server (and optionally, Sys-
log servers) during the call tear-down procedure. PacketCable-compliant call
servers provide a method of reporting these captured statistics. See the call
server documentation for instructions on accessing the statistics.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 365

SIP Behavior TS7.2 and newer versions of Touchstone SIP loads support end-of-call statis-
tics reporting through the SIP PUBLISH mechanism (defined in RFC 3903).
The content of the PUBLISH message uses the session report format.
To enable end-of-call statistics reporting, set the following MIB objects:
pktcEDVACodecPubRepAddrType
Specifies the IP address type (IPv4 or IPv6) of the device that
receives statistics reports.
pktcEDVACodecPubRepAddr
The IP address of the device that receives statistics reports. If this
object is not specified, end-of-call statistics are disabled.
pktcEDVACodecRTCPXR
Determines whether the eDVA includes far-end statistics in the
report. The default is true(1).

End-of-Call Statis- Touchstone firmware provides MIB objects for monitoring eDVA end-of-call
tics MIB Objects statistics.
The monitoring MIB is broken into groups under arrisMtaDevTrace:
• Objects that report on a per-call level (the counter values represent the
total count for the most recently completed call on an endpoint). These
objects are indexed by the endpoint number in the table arrisMtaDev-
CallStatsEntry.

• Objects that report on a device level (the counter values represent the
sum total for all endpoints), located under arrisMtaDevTrace.
• Objects that control and reset counters, located under the arrisMtaDev-
Control MIB tree.

Clearing Counters To clear the device-level end-of-call statistics counters, set the arrisMtaDev-
ResetCallStats MIB to true(1). Setting this object to a value of false(2) has
no effect. Reading this object always returns false(2).
This object clears the following counters:
• arrisMtaDevRtpTxPktsTotal
• arrisMtaDevRtpRxPktsTotal
• arrisMtaDevRtpPercentPktsLostTotal
• arrisMtaDevSignalingAvgLatency
• arrisMtaDevSignalingTxSuccessfulMsgCnt
• arrisMtaDevSignalingRxSuccessfulMsgCnt

Firmware Guide Release 7.5 Standard 1.2 August 2012

366 Chapter 6

• arrisMtaDevSignalingTxNAKCnt
• arrisMtaDevSignalingRxNAKCnt
• arrisMtaDevSignalingRxNoACKCnt

Device Level End- Device-level MIB objects represent combined end-of-call statistics for all
of-Call Statistics lines on the eDVA.
arrisMtaDevRtpTxPktsTotal
The total number of RTP packets sent from the eDVA since it was
last started up or reset. It is calculated from values obtained from
the signaling end of call statistics.
arrisMtaDevRtpRxPktsTotal
The total number of RTP packets received by the eDVA since it was
last started up or reset. It is calculated from values obtained from
the signaling end of call statistics.
arrisMtaDevRtpPercentPktsLostTotal
The percentage of RTP packets lost since the eDVA was last started
up or reset. It is calculated from values obtained from the signaling
end of call statistics. The value of this object is an integer, repre-
senting percentage divided by 100. For example, a value of 1745
represents 17.45% packet loss.
arrisMtaDevRtpPktsLostTotal
The total number of RTP packets lost, across all endpoints, since the
eDVA was started or reset. Set the arrisMtaDevResetCallStats
object to true(1) to clear this counter.
arrisMtaDevLastCallStartTime
The start time of the last call made from the eDVA.
arrisMtaDevLastCallEndTime
The end time of the last call made from the eDVA.
arrisMtaDevSignalingAvgLatency
The average latency/delay, in milliseconds, for responses to signal-
ing messages. This value is calculated from end-of-call signaling
statistics and is a running average during eDVA uptime. It is calcu-
lated from values obtained from the signaling end of call statistics.
arrisMtaDevSignalingTxSuccessfulMsgCnt
The total number of successful signaling messages sent from the
eDVA.
arrisMtaDevSignalingRxSuccessfulMsgCnt
The total number of successful signaling messages received by the
eDVA.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 367

arrisMtaDevSignalingTxNAKCnt
The total number of negative acknowledgment signaling messages
(NAK messages) sent from the eDVA.
arrisMtaDevSignalingRxNAKCnt
The total number of negative acknowledgment signaling messages
(NAK messages) received by the eDVA.
arrisMtaDevSignalingRxNoACKCnt
The total number of ‘‘no acknowledgment’’ signaling messages
received by the eDVA.

Last Signaling To make a short trace of the last messages available at the end of the most
Message Sent recent call, Touchstone firmware allocates a 4K byte circular buffer to store
the last signaling messages sent on the most recent call. To enable collection
of signaling messages, set the arrisMtaDevEnableCallSigLastMsgRpt
object to enable(1). The default value is disable(0).
The following table shows the behavior of the buffer under certain condi-
tions.
arrisMtaDevEnable
CMS LoC Alarm Buffer Contents Stored
CallSigLastMsgRpt
Inactive None
Disable
Active Last messages sent/received
Inactive Last 4k of messages
Enable
Active Last 4k of messages

Since the maximum PDU size for a MIB object response is 256 bytes, the
message is split into 256-byte segments and stored in MIB objects arrisMta-
DevSignalingLastMsg1 through arrisMtaDevSignalingLastMsg16. Empty
objects in this group report ‘‘Buffer is empty.’’ When reading these objects,
the eDVA sets the arrisMtaDevEnableCallSigLastMsgRpt object to dis-
able(0) to prevent another message from overwriting these MIB objects
while reading the contents. After reading the objects, you must manually set
the arrisMtaDevEnableCallSigLastMsgRpt object to enable(1) to capture
the next message.

Line Level Status Line-level MIB objects report end-of-call statistics and general status for the
most recently-completed call on each line in the eDVA. Each MIB object
described in this section is indexed by the endpoint number (1 to N), where N
is the maximum number of lines supported by the eDVA; for example,
arrisMtaDevCallStatsAvgJitter.2 shows the average jitter for the second
line.
Other MIB objects in this table provide information about endpoint tempera-
ture, hook status, and operational status.

Firmware Guide Release 7.5 Standard 1.2 August 2012

368 Chapter 6

arrisMtaDevCallStatsRtpTxPkts
The total number of RTP packets sent from the endpoint during the
most recent call. This value is obtained from the signaling end of
call statistics.
arrisMtaDevCallStatsRtpRxPkts
The total number of RTP packets received by the endpoint during
the most recent call. This value is obtained from the signaling end
of call statistics.
arrisMtaDevCallStatsRtpPercentPktsLost
The percentage of RTP packets lost during the most recent call. It is
calculated from values obtained from the signaling end of call statis-
tics. The value of this object is an integer, representing percentage
divided by 100. For example, a value of 1745 represents 17.45%
packet loss.
arrisMtaDevCallStatsAvgJitter
The average jitter measurement, in milliseconds, during the most
recent call. This value is obtained from the signaling end of call sta-
tistics.
arrisMtaDevCallStatsMaxJitter
The maximum jitter measurement, in milliseconds, during the most
recent call. This value is obtained from DSP statistics.
arrisMtaDevCallStatsAvgLatency
The average latency, in milliseconds, observed during the most
recent call. This value is obtained from the RTCP signaling end of
call statistics.
arrisMtaDevCallStatsHookStatus
The hook status for each endpoint; one of:
• onHook(0)
• offHook(1)
The disconnected state is not a valid return value for this MIB.
arrisMtaDevCallStatsSLICStatus
The over-temperature condition of the endpoint’s SLIC (line inter-
face card) chips; one of:
• normal(0)
• overtemp(1)
arrisMtaDevCallStatsEndPntOpStatus
The current operational status for each endpoint. This object is a
direct copy from ifAdminOperStatus; its value is one of:
• up(1)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 369

• down(2)
• testing(3)

Per-Call Syslog Touchstone firmware can generate a Syslog report of call status and monitor-
Reporting ing information on a per-call basis.
In addition to statistical data, the Syslog report can also include up to the last
4K bytes of signaling messages associated with the last call in a circular
buffer. The Syslog report can be configured to supply only statistical data, or
statistical data and signaling messages.
Enable or disable Syslog reporting using the arrisMtaDevEnableCallStats-
SyslogRpt object, which is part of the arrisMtaDevBase MIB. The default
value for this object is Disable(0); set to Enable(1) to enable reporting.
Enable or disable the signaling message buffer using the arrisMtaDev-
EnableCallSigLastMsgRpt object. The default value for this object is Dis-
able(0); set to Enable(1) to enable the buffer. The contents of the buffer
depends on the setting of this MIB, the arrisMtaDevEnableCallStatsSys-
logRpt object, and the state of the CMS LoC alarm.

The following table shows how the MIB settings interact with the Loss of
Comms alarm to affect the buffer contents.
arrisMtaDevEnable arrisMtaDevEnable Buffer contents
CMS LoC Alarm
CallStatsSyslogRpt CallSigLastMsgRpt contained in Syslog
Inactive None
Disable
Active None
Disable
Inactive None
Enable
Active None
Inactive None
Disable Active Last messages sent/
Enable received
Inactive Last 4k of messages
Enable
Active Last 4k of messages

Per Call Syslog Report Example

Below is an example of a per-call Syslog report (statistical output only):

09-06-2007 10:11:02 Local0.Warning 10.1.36.205
Sep 06 09:39:27 2007 AALN/1:mta205.dev36/10.1.36.205 <6> <4115> <37>
<00:00:CA:CB:23:E7> <Call Stats: L1, HW: TM402G, SW: 5.2.21, RTP Tx 0,
RTP Rx 0, RTP Lost 0.00%, Prov State: MTA Prov Complete. (20),
Avg Jtr 0, Max Jtr 0, Avg Ltc RTP 0, Avg Ltc Sig Msg 11, No ACKs 0,
Batt 100%:INACTIVE, CMS LOC:INACTIVE>

Firmware Guide Release 7.5 Standard 1.2 August 2012

370 Chapter 6

Data Explanations:
• HW: Hardware Model Number
• SW: Firmware Rev Version Number
• Ttl Rx RTP: Total number of RTP packets received. This only reports
RTP packets and not data packets.
• Ttl Tx RTP: Total number of RTP packets sent. This only reports RTP
packets and not data packets.
• RTP Lost: Percentage of RTP packets lost. This only reports RTP pack-
ets and not data packets.
• Prov State: The step of the eDVA Provisioning Flow that the eDVA is
currently in.
• Avg Jtr: Average Jitter in milliseconds.
• Max Jtr: Maximum Jitter in milliseconds.
• Avg Ltc RTP: Average latency for RTP packets, in milliseconds.
• Avg Ltc Sig Msg: average latency for a response to signaling messages,
in milliseconds. This value is calculated from end-of-call signaling sta-
tistics and is a running average during eDVA uptime.
• No ACKs: Count of the number of ‘‘negative acknowledgment’’ mes-
sages received from the Call Agent.
• SNMP Traps: Battery Percentage; CMS LOC.

Message Trace Example

The following is an example Syslog report showing Send (Xmit) and Receive
(Rcv) Messages:
Nov 17 18:34:11 2005 mta161.dev35 <13>
<4115> <42> <00:00:CA:CB:22:FB> <Rcv: (3: 1 of 1) -
<010>Q: loop<010>R: hf(I), hu(N)’>
Nov 17 18:34:11 2005 mta161.dev35 <14> <4115> <41> <00:00:CA:CB:22:FB>
<Xmit: (3: 1 of 1) - ’200 31855 OK’>

See ‘‘Capturing Signaling Traces’’ on page 240 for a breakdown of send and
receive message formats.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 371

Managing Voice Quality Monitoring

You can retrieve stored Voice Quality Monitoring (VQM) data using either
SNMP, the CLI, or the web-based interface.
Touchstone NCS loads are compatible with draft PacketCable requirements
for VQM data, as described in RTCP XR VoiP Metrics Package for the Media
Gateway Control Protocol, IETF draft-auerbach-mgcp-rtcpxr-06 for NCS.
SIP and PC20 loads are partially compatible with Session Initiation Protocol
(SIP) Package for Voice Quality Reporting Event, IETF draft-ietf-sipping-
rtcp-summary-02 for SIP.

About Voice Quali- The Voice Quality Monitoring (VQM) feature provides a per-line history of
ty Monitoring voice call quality metrics. VQM data is available from SNMP, CLI, and
HTTP. The information provided is an extension of RFC 3611 recommenda-
tions.
Metrics are provided for both the near-end (eDVA) and far-end sides of the
call (the far-end eDVA must also support RTCP-XR). Remote VQM is dis-
abled by default.
Note: Touchstone firmware does not support reporting VQM data to the
CMS. The eDVA ignores any VQM requests from the CMS.
A monitoring feature provides a Syslog notification if MOS scores fall below
a threshold specified by the arrisMtaDevVqmThresholds objects.

VQM Data The following list briefly describes the supported VQM metrics, noting met-
rics that are extensions of RFC 3611. See RFC 3611 for full descriptions of
those metrics.
Call Start Time (extension)
(ARRS02) A timestamp defining the time the call began.
Call End Time (extension)
(ARRS03) A timestamp defining the time the call ended.
Call Duration (extension)
(ARRS04) The total length of the call time, in hours, minutes, and
seconds.
Line Number (extension)
(ARRS05) The phone line used for this call.
Remote IP Address (extension)
(IPAD) The IP address of the destination endpoint.
CW Errors(extension)
(ARRS06) The number of codeword errors that occurred during the
call.

Firmware Guide Release 7.5 Standard 1.2 August 2012

372 Chapter 6

CW Error Rate (extension)

(ARRS07) The ratio of errored codewords to total codewords.
SNR (extension)
(ARRS08) The signal-to-noise ratio, in dB.
MicroReflections (extension)
(ARRS09) Microreflection power, in dBc. A microreflection is RF
energy that is reflected back toward the point of origin due to an
impedance mismatch. It is not a measure of audio echo.
Downstream Power (extension)
(ARRS10) The downstream power, in dBmV, measured at the
eDVA.
Upstream Power (extension)
(ARRS11) The upstream power, in dBmV, measured at the eDVA.
EQI Average (extension)
(ARRS12) The average Echo Quality Index (EQI). The EQI is an
estimate of the quality of echo signals presented to the LEC. The
value displayed is between 0 and 1, with higher values indicating
higher echo quality. Low EQI measurements represent a high risk
for echo-related problems.
EQI Minimum (extension)
(ARRS13) The minimum measured Echo Quality Index.
EQI Maximum (extension)
(ARRS14) The maximum measured Echo Quality Index.
EQI Instantaneous (extension)
(ARRS15) The last measured Echo Quality Index value.
MOS-LQ
(MLQ) The estimated Mean Opinion Score for Listening Quality
(MOS-LQ). Valid range: 10 to 50, corresponding to MOS × 10.
For example, a value of 35 corresponds to an estimated MOS score
of 3.5. MOS-LQ does not include the effects of delay and can be
compared to MOS scores obtained from listening quality (ACR)
tests.
A value of 127 indicates that this parameter is unavailable.
MOS-CQ
(MCQ) The estimated Mean Opinion Score for Conversational
Quality (MOS-CQ). Valid range: 10 to 50, corresponding to
MOS × 10, as for MOS-LQ.
A value of 127 indicates that this parameter is unavailable.
Echo Return Loss
(RERL) The residual echo return loss (RERL), in decibels. RERL
may be measured directly by the VoIP-end system’s echo canceller
or may be estimated by adding the echo return loss (ERL) and echo

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 373

return loss enhancement (ERLE) values reported by the echo can-

celler.
RERL(dB) = ERL (dB) + ERLE (dB)
In the case of a VoIP gateway, the source of echo is typically line
echo that occurs at 2–4 wire conversion points in the network. This
can be in the 8–12 dB range. A line echo canceler can provide an
ERLE of 30 dB or more and hence reduce this to 40–50 dB. A typi-
cal handset would result in 40–50 dB of echo loss due to acoustic
feedback.
Signal Level
(SL) The voice signal relative level — the ratio of the signal level to
a 0dBm0 reference, expressed in decibels. Signal level is measured
only for packets containing speech energy. This measurement pro-
vides a real time indication that the signal level may be excessively
high or low.
signal level = 10 Log10 ( rms talkspurt power(mW) )

A value of 127 indicates that this parameter is unavailable. Typical

values are in the −15 to −20 dBm range.
Noise Level
(NL) The ratio of the silent period background noise level to a 0
dBm0 reference, expressed in decibels.
noise level = 10 Log10 ( rms silence power (mW) )

A value of 127 indicates that this parameter is unavailable.

Loss Rate
(NLR) The fraction of RTP data packets from the source, lost since
the beginning of reception. Valid range: 0 (no packet loss) to 255
(near-complete packet loss). Duplicated packets and discarded
packets are not counted as lost. However, significantly late packets
may be counted as lost.
Pkt Loss Concealment
(PLC) The Packet Loss Concealment (PLC) method; describes how
the eDVA is concealing lost packets. The value is one of the follow-
ing:
Standard A simple replay or interpolation algorithm is being
used to fill-in the missing packet; this approach typi-
cally conceals isolated lost packets at low packet
loss rates.
Enhanced An enhanced interpolation algorithm is being used;
algorithms of this type can conceal high packet loss
rates effectively.
Disabled Silence is being inserted in place of lost packets.

Firmware Guide Release 7.5 Standard 1.2 August 2012

374 Chapter 6

Unspecified No information is available concerning the use of

PLC; however, for some codecs this may be inferred.

Discard Rate
(JDR) The fraction of RTP data packets from the source that have
been discarded since the beginning of reception, due to late or early
arrival, under-run, or overflow at the receiving jitter buffer. Valid
range: 0 (no packets discarded) to 255 (nearly all packets dis-
carded).
Burst Density
(BLD) The fraction of RTP data packets within burst periods since
the beginning of reception that were either lost or discarded. Valid
range: 0 (no packets lost/discarded, or no packets received) to 255
(nearly all packets lost/discarded).
Gap Density
(GLD) The fraction of RTP data packets, within inter-burst gaps
since the beginning of reception, that were either lost or discarded.
Valid range: 0 (no packets lost/discarded, or no packets received) to
255 (nearly all packets lost/discarded).

Burst Duration
(BD) The mean duration, in milliseconds, of the burst periods that
have occurred since the beginning of reception. The duration of
each period is calculated based upon the packets that mark the
beginning and end of that period. If there have been no burst peri-
ods, the burst duration value is zero.
Gap Duration
(GD) The mean duration, in milliseconds, of the gap periods that
have occurred since the beginning of reception. The duration of
each period is calculated based upon the packet that marks the end
of the prior burst and the packet that marks the beginning of the sub-
sequent burst.
In the case of a gap that occurs at the beginning of reception, the
sum of the timestamp of the prior burst packet and the duration of
the prior burst packet are replaced by the reception start time. In the
case of a gap that occurs at the end of reception, the timestamp of
the subsequent burst packet is replaced by the reception end time. If
there have been no gap periods, the gap duration value is zero.
Round Trip Delay
(RTD) The most recently calculated round trip time between RTP
interfaces, in milliseconds.
End System Delay
(ESD) The most recently estimated end system delay, in millisec-
onds. End system delay is the sum of the total sample accumulation
and encoding delay associated with the sending direction and the jit-
ter buffer, decoding, and playout buffer delay associated with the
receiving direction.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 375

Gmin
(GMN) The gap threshold, the value used for this report to deter-
mine if a gap exists. The recommended value of 16 corresponds to
a burst period having a minimum density of 6.25% of lost or dis-
carded packets, which may cause noticeable degradation in call
quality. During gap periods, if packet loss or discard occurs, each
lost or discarded packet would be preceded by and followed by a
sequence of at least 16 received non-discarded packets.
Lost or discarded packets that occur within Gmin packets of a report
being generated may be reclassified as part of a burst or gap in later
reports.
R Factor
(NSR) A voice quality metric describing the segment of the call that
is carried over this RTP session. Valid range: 0 to 100, with a value
of 94 corresponding to toll quality voice and values of 50 or less
regarded as unusable. This metric is defined as including the effects
of delay, consistent with ITU-T G.107 [6] and ETSI TS 101 329-5
[3].
A value of 127 indicates that this parameter is unavailable.
External R Factor
(XSR) A voice quality metric describing the segment of the call that
is carried over a network segment external to the RTP segment. The
valid range and interpretation are the same as defined for the RTP R
factor described above. This metric includes the effects of delay,
consistent with ITU-T G.107 and ETSI TS 101 329-5, and relates to
the outward voice path from the VoIP termination for which this
metrics block applies.
A value of 127 indicates that this parameter is unavailable.
A value of 0 indicates that no measurement was obtained.
Jitter Buf Adaptive
(JBA) Describes the jitter buffer adaptation; one of the following:
Adaptive The jitter buffer size is being dynamically adjusted
to deal with varying levels of jitter. See the jitter
buffer size parameters below for details.
Non-adaptive The jitter buffer size is maintained at a fixed level.
See the jitter buffer size parameters below for
details.

Jitter Buf Rate

(JBR) The adjustment rate (J) in adaptive mode, referred to as ‘‘JB
rate’’ in RFC 3611. Valid range: 0 to 15. This parameter is defined
in terms of the approximate time taken to fully adjust to a step
change in peak to peak jitter from 30 ms to 100 ms such that:

Firmware Guide Release 7.5 Standard 1.2 August 2012

376 Chapter 6

adjustment time = 2 × J × frame size (ms)

A value of 0 indicates that the adjustment time is unknown.
JB Nominal Delay
(JBN) The current nominal jitter buffer delay, in milliseconds,
which corresponds to the nominal jitter buffer delay for packets that
arrive exactly on time.
JB Max Delay (JB max)
(JBM) The current maximum jitter buffer delay in milliseconds,
which corresponds to the earliest arriving packet that would not be
discarded. In adaptive jitter buffer implementations, this value may
dynamically vary up to JB abs max (see below).
JB Abs. Max Delay (JB abs max)
(JBS) The absolute maximum delay in milliseconds, that the adap-
tive jitter buffer can reach under worst case conditions. If this value
exceeds 65535 milliseconds, the report shows a value of 65535.
This parameter MUST be provided for adaptive jitter buffer imple-
mentations and its value MUST be set to JB max for fixed jitter
buffer implementations.
Tx Packets
(PS) The number of RTP packets transmitted during this call.
Tx Octets
(OS) The number of octets transmitted during this call.
Rx Packets
(PR) The number of RTP packets received during this call.
Rx Octets
(OR) The number of octets received during this call.
Packet Loss
(PL) The percentage of RTP packets lost during this call.
Jitter
(IAJ) The estimated statistical variance of the RTP data packet inter-
arrival time, in milliseconds.
When remote VQM is enabled, the eDVA also displays remote VQM data.
Remote metrics have the same definitions as local metrics. See ‘‘Collecting
Remote Metrics’’ on page 379 for details.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 377

Interpreting The following table describes the VQM metrics and (where applicable)
Results acceptable ranges. See RFC 3611 for full descriptions of those metrics.
Metric names marked with an asterisk (*) are extensions to RFC 3611.
Ranges
Metric Description
Allowed Good
CW Errors* Codeword error count n/a n/a
CW Error Rate* Errored codeword ratio n/a ≤ 9.0−7
SNR* Signal to noise ratio n/a ≥ 35 dB
Multiple echoes:
• −20 dBc @ ≤1.5 µsec
• −30 dBc @ ≥1.5 µsec
• −10 dBc @ ≤0.5 µsec
• −15 dBc @ ≥1.0 µsec
Microreflections* Microreflection powerNote 1 n/a
Single echo:
• −10 dBc @ ≤0.5 µsec
• −20 dBc @ ≤1.0 µsec
• −30 dBc @ >1.0 µsec
Downstream Power* Downstream power at the E-UE n/a −3 to 3
Upstream Power* Upstream power at the E-UE n/a 50 to 60
EQI Average* Average Echo Quality Index 0 to 1 > 0.6Note 2
EQI Minimum* Minimum measured EQI 0 to 1 > 0.3Note 2
EQI Maximum* Maximum measured EQI 0 to 1 > 0.7Note 2
EQI Instantaneous* Last measured EQI 0 to 1 > 0.6Note 2
MOS-LQ Listening Quality score 1.0 to 5.0 3.5+
MOS-CQ Conversational Quality score 1.0 to 5.0 3.5+
Echo Return
Residual echo return loss, in dB 0 to 255 40+
Loss
Signal Level Relative voice signal level, in dB, compared to dBm0 −128 to 127 −15 to −20
Silent period background noise level, in dB,
Noise Level −128 to 127 < −70
compared to dBm0
Loss Rate Fraction of RTP data packets lost 0 to 255 0
Pkt Loss
How the eDVA is concealing lost packets n/a n/a
Concealment
Discard Rate Fraction of RTP data packets discarded 0 to 255 0
Fraction of RTP data packets lost or discarded within
Burst Density 0 to 255 0
burst periods
Fraction of RTP data packets lost or discarded within
Gap Density 0 to 255 0
inter-burst gaps
Burst Duration Mean duration, in milliseconds, of burst periods 0 to 65535 0
Gap Duration Mean duration, in milliseconds, of gap periods 0 to 65535 near Call Duration
Most recently calculated round trip time between
Round Trip Delay 0 to 65535 0 to 60
RTP interfaces, in milliseconds

Firmware Guide Release 7.5 Standard 1.2 August 2012

378 Chapter 6

Ranges
Metric Description
Allowed Good
Most recently calculated end system delay, in
End System Delay 0 to 65535 0 to 120
milliseconds
Gmin Gap threshold 0 to 255 16
Voice: 90+
R Factor Voice quality of the call carried over this RTP session 0 to 100
Fax: 70–90
Voice quality of the call carried over network
External R Factor 0 to 100 90+
segments external to this RTP session
Voice calls: Adaptive
Jitter Buf Adaptive Jitter Buffer adaptation n/a
Fax calls: Fixed
Jitter Buf Rate The adjustment rate in adaptive mode 0 to 15 0 to 15
Voice: approx. 20ms
JB Nominal Delay Current nominal jitter buffer delay, in milliseconds 0 to 65535
Fax: approx. 70ms
JB Max Delay Current maximum jitter buffer delay, in milliseconds 0 to 65535 0 to 60
Absolute maximum jitter buffer delay, in
JB Abs Max Delay 0 to 65535 0 to 60
milliseconds
Tx Packets Number of RTP packets transmitted n/a n/a
Tx Octets Number of octets transmitted n/a n/a
Rx Packets Number of RTP packets received n/a n/a
Rx Octets Number of octets received n/a n/a
Packet Loss Percentage of packets lost 0 to 100 <1
Jitter Estimated jitter, in milliseconds n/a approx. 2 ms

Note 1: The value for microreflections is displayed as a positive number, but

is actually negative.
Note 2: EQI measures the potential for poor echo quality. Minimum values
in particular may be less than 0.2 for brief durations, especially near the
beginning of a call, without subscribers noticing any problems. Short calls
(less than 30 seconds) in particular may not allow for accurate EQI measure-
ments.

Voice Quality Mon- The arrisMtaDevVqm MIB provides objects for controlling the Voice Qual-
itoring MIB Ob- ity Monitoring (VQM) feature and for retrieving VQM data. See ‘‘Managing
jects Voice Quality Monitoring’’ on page 371 for more information.
The following objects are available.
arrisMtaDevVqmLine
Specifies the line for Voice Quality Metrics reporting. Writing to
this object loads the arrisMtaDevVqmCallNumberTable with the
buffer IDs for the last 10 calls on the specified line.
arrisMtaDevVqmCallNumberIds
Provides the buffer numbers containing VQM data for the last 10
calls on the line specified by arrisMtaDevVqmLine. This object is
indexed starting with the most recent call; that is,

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 379

arrisMtaDevVqmCallNumberIds.1 contains the buffer with the

most recent call data. Entries containing no valid call data have the
value 65535.
arrisMtaDevVqmCallNumberIdentifier
Specifies the buffer to read. Writing this object loads the arrisMta-
DevVqmMetricTable with the data contained in this buffer.

arrisMtaDevVqmMetricValues
The entries in the arrisMtaDevVqmMetricTable that contain the
call data. Walk the arrisMtaDevVqmMetricTable to retrieve the
data in the buffer.
arrisMtaDevVqmThresholdEnable
Enables VQM threshold monitoring. See ‘‘Setting VQM Thresh-
olds’’ on page 387 for details.
arrisMtaDevVqmHistorySize
Sets the size of the VQM history buffer. Valid range: 2 to 50
records. Default: 10.
arrisMtaDevVqmCallNumberIdentifierLastCall
Reading this object updates the arrisMtaDevVqmCallNumber-
Identifier object to point to the metrics for the last call. After read-
ing this object, walking the arrisMtaDevVqmMetricTable shows the
last call metrics.
arrisMtaDevVqmThresholds
A table of monitoring thresholds. The eDVA generates a Syslog
message if VQM data scores fall below the specified thresholds.
arrisMtaDevVqmEnableRemote
Controls remote collection of VQM data. Use normal(0) to use
PacketCable rules; forceDisable(1) to force-disable remote VQM;
or forceEnable(2) to force-enable remote VQM. When set through
SNMP, the setting persists across reboots.

Collecting Remote Touchstone firmware supports recording and display of far-end voice quality
Metrics metrics. The following conditions must be true for the eDVA to receive far-
end metrics:
• The remote eDVA must support the RTCP-XR protocol.
• The call must be up long enough to receive remote data (remote metrics
not received display a value of ‘‘Call too Short’’).
Touchstone NCS loads comply with PacketCable 1.5 NCS specifications
(PKT-SP-NCS1.5-I03-070412). SIP loads comply with IETF draft-ietf-sip-
ping-rtcp-summary-02 for enabling and sending remote VQM data. For NCS
loads and default operation, eDVAs send VQM data:

Firmware Guide Release 7.5 Standard 1.2 August 2012

380 Chapter 6

1 if the Call Server has not instructed the eDVA to disable remote
VQM; and
2 the remote eDVA requests VQM data.
For SIP operation, Touchstone eDVAs send remote VQM data upon request
from the far end.
Note: The arrisMtaDevVqmEnableRemote MIB object can force remote
metric data, either on or off, for all loads. In NCS operation, this object can
override directives from the Call Server.

Action Perform any of the following tasks as necessary.

Task Page
Configuring Local VQM Reporting 380
Retrieving the Last Call Using SNMP 381
Retrieving VQM Data Using SNMP 381
Retrieving VQM Data Using the CLI 383
Retrieving VQM Data Using the Web-based Interface 384
Setting VQM Thresholds 387
Clearing VQM Data 387

Configuring Local Follow these steps to configure local Voice Quality Monitoring using SNMP
VQM Reporting or the CLI (the web-based interface does not support enabling or disabling
VQM). VQM is enabled by default with a history buffer size of 10.
1 To enable or disable VQM using SNMP:
a Set the arrisMtaDevVqmEnable object to control local collection
of VQM data. Use 0 to disable local VQM, or 1 to enable local
VQM.
b Set the arrisMtaDevVqmEnableRemote object to control remote
reporting of VQM data. Use normal(0) to use PacketCable rules;
forceDisable(1) to force-disable remote VQM; or forceEnable(2)
to force-enable remote VQM. When set through SNMP, the set-
ting persists across reboots.
c To set the size of the VQM buffer, set the arrisMtaDevVqmHis-
torySize object.

Valid range: 2 to 50 (calls). Default: 10.

2 To enable or disable VQM from the CLI:
a Enter the Voice → VQM submenu:
Console> voice ↵
Voice> vqm ↵

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 381

b Use the following command to enable or disable collection of

local VQM data:
vqLocEnable flag ↵

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

c Use the following command to enable or disable collection of
remote VQM data:
vqRemEnable flag ↵

Where flag is 0 to use PacketCable rules; 1 to force-disable remote

data collection; or 2 to force-enable remote data collection.

Retrieving the Last Follow these steps to retrieve data for the last completed call using SNMP.
Call Using SNMP See ‘‘Retrieving VQM Data Using SNMP’’ to retrieve arbitrary call data.
1 Read the arrisMtaDevVqmCallNumberIdentifierLastCall object.
The eDVA updates the arrisMtaDevVqmCallNumberIdentifier object
and loads the arrisMtaDevVqmMetricTable with the data for the last
call.
2 Walk the arrisMtaDevVqmMetricTable to read the metrics from the
specified buffer.

Retrieving VQM Retrieving arbitrary VQM data through SNMP is more complex than the CLI
Data Using SNMP or web-based methods, requiring a multi-step process. To retrieve data for
the last completed call, see ‘‘Retrieving the Last Call Using SNMP’’ above.
Follow these steps to retrieve VQM data through SNMP. See ‘‘Voice Quality
Monitoring MIB Objects’’ on page 378 for detailed descriptions of VQM-
related MIB objects.
1 Write the desired line number to the arrisMtaDevVqmLine object.
Valid range: 1 to the number of lines supported by the eDVA.
The eDVA loads the arrisMtaDevVqmCallNumberTable with pointers
to reports for up to the last 10 calls.
2 Walk the arrisMtaDevVqmCallNumberTable to read the buffer IDs:
***** SNMP QUERY STARTED *****
1: arrisMtaDevVqmCallNumberIds.1 (integer) 19
2: arrisMtaDevVqmCallNumberIds.2 (integer) 16
3: arrisMtaDevVqmCallNumberIds.3 (integer) 14
4: arrisMtaDevVqmCallNumberIds.4 (integer) 12
5: arrisMtaDevVqmCallNumberIds.5 (integer) 11
6: arrisMtaDevVqmCallNumberIds.6 (integer) 9
7: arrisMtaDevVqmCallNumberIds.7 (integer) 6
8: arrisMtaDevVqmCallNumberIds.8 (integer) 4
9: arrisMtaDevVqmCallNumberIds.9 (integer) 2

Firmware Guide Release 7.5 Standard 1.2 August 2012

382 Chapter 6

10: arrisMtaDevVqmCallNumberIds.10 (integer) 1

***** SNMP QUERY FINISHED *****
Entry 1 is the buffer containing the most recent call (in the above
example, buffer 19). Entries containing Empty represent no data for
that call (for example, less than 10 calls have been made since the
MTA started or since VQM data was cleared).
3 Write the desired buffer number to the arrisMtaDevVqmCallNumber-
Identifier object.

The eDVA loads the arrisMtaDevVqmMetricTable with the contents

of the buffer.
4 Walk the arrisMtaDevVqmMetricTable to read the metrics from the
specified buffer:
***** SNMP QUERY STARTED *****
1: arrisMtaDevVqmMetricValues.1 (octet string) Call End Time: THU JAN 10 16:59:37 2008
2: arrisMtaDevVqmMetricValues.2 (octet string) Call Start Time: THU JAN 10 16:58:21 2008
3: arrisMtaDevVqmMetricValues.3 (octet string) Call Duration: 0h 1m 16s
4: arrisMtaDevVqmMetricValues.4 (octet string) Line Number: 2
5: arrisMtaDevVqmMetricValues.5 (octet string) Remote IP Address: 10.1.36.151
6: arrisMtaDevVqmMetricValues.6 (octet stri CW Errors: 0
7: arrisMtaDevVqmMetricValues.7 (octet string) CW Error Rate: 0.00e+00
8: arrisMtaDevVqmMetricValues.8 (octet string) SNR: 36 dB
9: arrisMtaDevVqmMetricValues.9 (octet string) MicroReflections: 29 dBc
10: arrisMtaDevVqmMetricValues.10 (octet string) Downstream Power: -6.0 dBmV
11: arrisMtaDevVqmMetricValues.11 (octet string) Upstream Power: 44.0 dBmV
12: arrisMtaDevVqmMetricValues.12 (octet string) EQI Average: 0.468
13: arrisMtaDevVqmMetricValues.13 (octet string) EQI Minimum: 0.389
14: arrisMtaDevVqmMetricValues.14 (octet string) EQI Maximum: 0.595
15: arrisMtaDevVqmMetricValues.15 (octet string) EQI Instantaneous: 0.389
16: arrisMtaDevVqmMetricValues.16 (octet string) MOS-LQ: 3.3
17: arrisMtaDevVqmMetricValues.17 (octet string) MOS-CQ: 3.3
18: arrisMtaDevVqmMetricValues.18 (octet string) Echo Return Loss: Unavailable
19: arrisMtaDevVqmMetricValues.19 (octet string) Signal Level: -21 dBm0
20: arrisMtaDevVqmMetricValues.20 (octet string) Noise Level: -58 dBm0
21: arrisMtaDevVqmMetricValues.21 (octet string) Loss Rate: 0 %
22: arrisMtaDevVqmMetricValues.22 (octet string) Pkt Loss Concealment:Standard
23: arrisMtaDevVqmMetricValues.23 (octet string) Discard Rate: 0 %
24: arrisMtaDevVqmMetricValues.24 (octet string) Burst Density: 0 %
25: arrisMtaDevVqmMetricValues.25 (octet string) Gap Density: 12 %
26: arrisMtaDevVqmMetricValues.26 (octet string) Burst Duration: 0 ms
27: arrisMtaDevVqmMetricValues.27 (octet string) Gap Duration: 65+ seconds
28: arrisMtaDevVqmMetricValues.28 (octet string) Round Trip Delay: 5 ms
29: arrisMtaDevVqmMetricValues.29 (octet string) End System Delay: 57 ms
30: arrisMtaDevVqmMetricValues.30 (octet string) Gmin: 16 packets
31: arrisMtaDevVqmMetricValues.31 (octet string) R Factor: 67
32: arrisMtaDevVqmMetricValues.32 (octet string) External R Factor: 0
33: arrisMtaDevVqmMetricValues.33 (octet string) Jitter Buf Adaptive: Adaptive
34: arrisMtaDevVqmMetricValues.34 (octet string) Jitter Buf Rate: 15

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 383

35: arrisMtaDevVqmMetricValues.35 (octet string) JB Nominal Delay: 12 ms

36: arrisMtaDevVqmMetricValues.36 (octet string) JB Max Delay: 25 ms
37: arrisMtaDevVqmMetricValues.37 (octet string) JB Abs. Max Delay: 60 ms
38: arrisMtaDevVqmMetricValues.38 (octet string) Remote MOS-LQ: No Remote Data
39: arrisMtaDevVqmMetricValues.39 (octet string) Remote MOS-CQ: No Remote Data
40: arrisMtaDevVqmMetricValues.40 (octet string) Remote Echo Return Loss: No Remote Data
41: arrisMtaDevVqmMetricValues.41 (octet string) Remote Signal Level: No Remote Data
42: arrisMtaDevVqmMetricValues.42 (octet string) Remote Noise Level: No Remote Data
43: arrisMtaDevVqmMetricValues.43 (octet string) Remote Loss Rate: No Remote Data
44: arrisMtaDevVqmMetricValues.44 (octet string) Remote Pkt Loss Concealment:No Remote Data
45: arrisMtaDevVqmMetricValues.45 (octet string) Remote Discard Rate: No Remote Data
46: arrisMtaDevVqmMetricValues.46 (octet string) Remote Burst Density: No Remote Data
47: arrisMtaDevVqmMetricValues.47 (octet string) Remote Gap Density: No Remote Data
48: arrisMtaDevVqmMetricValues.48 (octet string) Remote Burst Duration: No Remote Data
49: arrisMtaDevVqmMetricValues.49 (octet string) Remote Gap Duration: No Remote Data
50: arrisMtaDevVqmMetricValues.50 (octet string) Remote Round Trip Delay: No Remote Data
51: arrisMtaDevVqmMetricValues.51 (octet string) Remote End System Delay: No Remote Data
52: arrisMtaDevVqmMetricValues.52 (octet string) Remote Gmin: No Remote Data
53: arrisMtaDevVqmMetricValues.53 (octet string) Remote R Factor: No Remote Data
54: arrisMtaDevVqmMetricValues.54 (octet string) Remote External R Factor: No Remote Data
55: arrisMtaDevVqmMetricValues.55 (octet string) Remote Jitter Buf Adaptive: No Remote Data
56: arrisMtaDevVqmMetricValues.56 (octet string) Remote Jitter Buf Rate: No Remote Data
57: arrisMtaDevVqmMetricValues.57 (octet string) Remote JB Nominal Delay: No Remote Data
58: arrisMtaDevVqmMetricValues.58 (octet string) Remote JB Max Delay: No Remote Data
59: arrisMtaDevVqmMetricValues.59 (octet string) Remote JB Abs. Max Delay: No Remote Data
60: arrisMtaDevVqmMetricValues.60 (octet string) Tx Packets: 7584
61: arrisMtaDevVqmMetricValues.61 (octet string) Tx Octets: 606720
62: arrisMtaDevVqmMetricValues.62 (octet string) Rx Packets: 7582
63: arrisMtaDevVqmMetricValues.63 (octet string) Rx Octets: 606560
64: arrisMtaDevVqmMetricValues.64 (octet string) Packet Loss: 1
65: arrisMtaDevVqmMetricValues.65 (octet string) Interval Jitter: 0 ms
***** SNMP QUERY FINISHED *****

Retrieving VQM Follow these steps to retrieve VQM data using the command-line interface.
Data Using the CLI This procedure assumes you are already logged into the CLI at the top level.
1 Enter the Voice → VQM submenu:
Console> voice ↵
Voice> vqm ↵

2 Use the vqMetrics command to print the desired report:

vqMetrics line call ↵

Firmware Guide Release 7.5 Standard 1.2 August 2012

384 Chapter 6

where . . . is . . .
line The line number. Valid range: 1 to
the highest line on the E-UE.
call The call number. Valid range: 1 to
10 (where 1 is the most recent
call), or 0 to print all calls for the
specified line.

The eDVA prints a report.

Note: The message ‘‘No data to display for call’’ means that the
specified call report has not been filled since the E-UE last started.

Retrieving Follow these steps to retrieve VQM data using the web-based interface.
VQM Data Using 1 Access the Advanced web pages as described in ‘‘Accessing the
the Web-based Advanced Pages’’ on page 457.
Interface
2 Select the VQM link from the menu bar.
The Voice Quality Metrics page displays. If there have been no calls
since the last reboot, the page displayed is blank as shown below.

3 Select the line number from the Line Number drop-down. Valid
range: 1 to the number of lines on the eDVA.
4 Select the call number from the Call Number drop-down. Valid
range: 1 to 10, or All to display all call data in a report format, or Ta-
ble to display all call data in a table format.

5 Click the Submit button.

The eDVA displays the selected data.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 385

Examples:

Firmware Guide Release 7.5 Standard 1.2 August 2012

386 Chapter 6

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 387

Setting VQM Follow these steps to set threshold monitoring. The eDVA sends a Syslog
Thresholds notification if a call does not meet the specified thresholds.
1 Configure event reporting for the ‘‘VQ Threshold’’ log as described
in the Touchstone Telephony Provisioning Guide. The Event ID for
this log is 49.
2 To enable threshold monitoring, set the arrisMtaDevVqmThreshold-
Enable object to the maximum number of ‘‘VQ Threshold’’ logs
desired for reporting a threshold crossing.
In practice, a single call may send up to three logs to report metrics
for a threshold crossing. To minimize unnecessary network traffic,
Touchstone firmware only reports metrics for which values were
obtained (for example, if the eDVA does not receive remote metrics,
it does not report any).
3 Set the instances in the arrisMtaDevVqmThresholds table to moni-
tor VQM data as follows:
Index Parameter
.16 MOS-LQ score (0.1 to 5.0)
.17 MOS-CQ score (0.1 to 5.0)

4 If you have added these objects to the eDVA configuration file, reset
the eDVA to allow the changes to take effect.

Clearing VQM Follow these steps to clear VQM data for either a single line or all lines.
Data 1 To clear VQM data using SNMP:
a To clear a single line, set the arrisMtaDevVqmLine object to the
desired line number.
Note: You can skip this step if you want to clear all lines.
b Write one of the following values to the arrisMtaDevVqmClear
object:
0 — clear a single line

1 — clear all lines

2 To clear VQM data using the CLI:

a Enter the Voice → VQM submenu:
Console> voice ↵
Voice> vqm ↵

Firmware Guide Release 7.5 Standard 1.2 August 2012

388 Chapter 6

b Enter the following command:

vqClear [line]

Where line is the line number to clear. Omit this parameter to

clear all lines.
3 To clear VQM data using the web-based interface:
a Select the line to clear from the Line Number drop-down menu.
Note: You can skip this step if you want to clear all lines.
b To clear the line selected in Line Number, select Clear Line
Stats from the Action drop-down menu. To clear all lines, select
Clear All Lines.

c Click the Submit button to perform the selected action.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 389

Using the Speedtest Application

The Speedtest application allows remote testing of download and upload
speeds between the modem and an external server, without using a CPE.
Speed tests can be conducted from the CLI, advanced web pages, or SNMP.
Touchstone firmware stores the results of the last three tests. Syslog report-
ing is optional.
Tests may run whether phone lines are in use, and do not impact calls started
or in progress while the test is running. If phone calls or connected CPE
devices are active, the speed test includes that traffic in its results.
See ‘‘Speedtest CLI’’ on page 547 for the Speedtest-specific CLI commands.

Requirements and Speedtest is supported only on Model 7 and Model 8 Telephony Modems and
Limitations Telephony Gateways. Specifically, the following models are supported:
• WBM760, CM820
• TM702, TM722
• TM802, TM804, TM822
• TG852, TG862
The WBM750 is specifically not supported.

Server Requirements

To conduct speed tests, an HTTP or FTP server must be available. Server

location can be used to determine throughput in a variety of ways:
Server Location Throughput Test
Local headend HFC throughput
Master headend Internal network throughput
External site Peering throughput

An HTTP server used for Uplink testing must meet the following require-
ments:
• HTTP 1.1 support
• Support for an upload submission form, with an input element of type
FILE
• The server must provide a script to process POST HTTP requests, in
accordance with RFC 1867

Firmware Guide Release 7.5 Standard 1.2 August 2012

390 Chapter 6

The open-source Apache server supports all requirements and is widely

available.

Testing Limitations

The following limitations apply to speed tests in general:

• Rate limiting at the CM is not disabled when running a speed test.
• Speed tests do not run when the modem is operating on battery power.
• Speed tests always run as Best Effort traffic.
• On Gateway products, transfer speeds are measured at the CM inter-
face, not the Router interface.
The following items are not configurable:
• TCP Selective Acknowledgement (SACK) is always enabled.
• The HTTP version is always 1.1.

Action Perform any of the following tasks as needed.

Task Page
Running a Speed Test using the Web Pages 390
Running a Speed Test using SNMP 392
Running a Speed Test using the CLI 393

Running a Speed Follow these steps to use the Speedtest web page. Note that this requires
Test using the access to the Advanced web pages.
Web Pages 1 Access the Advanced web pages as described in ‘‘Enabling and
Accessing the Troubleshooting CLI’’ on page 435.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 391

2 Click the Speedtest link to display the Speedtest page:

3 Configure the test as follows:

Test direction
Select Download Only or Upload Only as desired.
Test mode
Select FTP or HTTP as desired.
Server address
Enter the IP address or FQDN of the server.
Port
Enter the port number for the server. The defaults are 21 for
FTP, and 80 for HTTP.
Server Username
Enter the user ID required to access the server. Required for
FTP, optional for HTTP unless authentication is required.
Server Password
Enter the password required to access the server. Required for
FTP, optional for HTTP unless authentication is required.

Firmware Guide Release 7.5 Standard 1.2 August 2012

392 Chapter 6

Filename
Enter the filename to transfer. For Download tests, the modem
discards the information received. For Upload tests, the
modem sends random data to the server.
Note: The following parameters are optional. You can accept the
defaults.
TCP Window
The size, in KB, of the receive buffer used in the transfer.
TCPMSS
The maximum TCP segment size, in bytes.
TCP Timestamps
Check this box to enable TCP timestamping.
Path MTU Discovery
Check this box to negotiate the MTU size for the transfer.
MTU
When Path MTU Discovery is not checked, specifies the size
(in bytes) for the MTU.
4 Click the Save button to save the settings.
5 Repeat steps 3 and 4 to configure test parameters for the other direc-
tion (download vs. upload), if desired.
6 To test both upload and download speeds, select Download / Upload
from the Test direction drop down menu.
7 Click the Start button to begin the speed test.
The Start button changes to Cancel.
8 Allow the test to run, or click the Stop button to end the test before
the transfer is complete.
The test results display in the upper section of the Speedtest page.

Running a Speed Follow these steps to run a speed test using SNMP.
Test using SNMP 1 To configure the download test, set the arrisSpeedTestConfig-
DownlinkURL object to the URL specifying the server and file used
for the transfer. The URL begins with either ftp:// or http://,
and is followed by:
[userID:password@]ipaddr/path[?param=value[&param=value...]]
The userID and password are required for FTP transfers, and
optional for HTTP transfers. The param list may consist of any of
the following:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 393

Parameter Description
tcpwindow The size, in KB, of the receive buffer used in the
transfer.
tcpmss The maximum TCP segment size, in bytes.
tcptimestamps Set to 1 to enable TCP timestamping.
pmtud Set to 1 to negotiate the MTU size for the trans-
fer.
mtu When pmtud is set to 0, specifies the size (in
bytes) for the MTU.
cpeaccess Set to 1 to allow CPE network access during the
speed test, or 0 to disable CPE access.

Example:
ftp://root:[email protected]/wolves_hockey.mpg?
tcpwindow=2048&tcpmss=1460&tcptimestamps=1
&pmtud=1&cpeaccess=1
2 To configure the upload test, set the arrisSpeedTestConfigUplink-
URL object to the URL specifying the server and file used for the
transfer. The format of the URL is the same as for the download
object described above.
3 To start the test, write startDownlinkTest(1) or startUplinkTest(2)
(or both) to the arrisSpeedTestConfigStartStopTest object as
needed.
4 Allow the test to complete, or write stopTest(0) to the arris-
SpeedTestConfigStartStopTest object to end the test early.

5 To display the results of the last test, read the arrisSpeedTestRe-

sultsStatus.1 object.

Running a Speed Follow these steps to run a speed test using the CLI. This task requires
Test using the CLI access to the CLI.
1 Access the CLI as described in ‘‘Enabling and Accessing the Trou-
bleshooting CLI’’ on page 435.
2 Enter Speedtest at the Console> prompt to enter the Speedtest sub-
menu.
3 (optional) Use the ShowConfig command to display the current con-
figuration.
4 To configure the test, enter the following commands:
Configure dir ↵
Mode protocol [mode] ↵
Address ipaddr ↵
File path ↵

Firmware Guide Release 7.5 Standard 1.2 August 2012

394 Chapter 6

where... is...
dir either up or down.
protocol either ftp or http, depending on the server.
mode for FTP tests only, either passive or active.
ipaddr the IP address or FQDN of the server.
path the path to the file to download.

5 The following commands are optional, or may be needed depending

on your server:
Username userID ↵
Password password ↵
Port portnum ↵
where... is...
userID the userID required to access the server.
password the password required to access the server.
port the port number for FTP or HTTP access,
if the server uses a non-standard port.

6 The following commands are optional, and may be used to optimize

the test:
TCPWindow windowsize ↵
TCPMSS segsize ↵
TCPTimeStamp flag ↵
PMTU flag ↵
MTU mtusize ↵
CpeAccess flag ↵
Lro flag ↵
Bypass flag ↵
LED flag ↵
where... is...
windowsize the size, in KB, of the TCP receive buffer.
segsize the Maximum Segment Size (MSS), in bytes.
mtusize the Maximum Transmission Unit (MTU) size, in bytes.
flag either enable or disable to configure the specified fea-
ture.

7 Enter the Start command to begin the speed test.

With no parameter specified, the test selected by Configure is run.
Use one of the parameters down, up, or downup to specify which
tests to run.
8 Allow the test to complete, or enter the Stop command to stop the
test.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Administration 395

9 Enter the ShowResults command to display the results of the last

test.

Firmware Guide Release 7.5 Standard 1.2 August 2012

396 Chapter 6

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 7 Maintenance

Maintenance involves upgrades, enabling new features, diagnostics, and trou-

bleshooting.
This chapter includes the following topics:
Topic Page
Overview of Maintenance Interfaces 397
LED Patterns 399
SIP Concepts 407
Running Line Card Diagnostics 419
Running Loop Diagnostics 420
Loopback Testing 429
Reset to Factory Defaults 429
Using the Password of the Day Tool 431
Enabling and Accessing the Troubleshooting CLI 435
Using the Web-based Troubleshooting Interface 439
Troubleshooting SIP 458
SIP Loopback Testing 460

Overview of Maintenance Interfaces

Touchstone firmware provides the following interfaces for maintenance and

troubleshooting:
• Command-line Interface (CLI)
• Web-based interface (WebGUI)
• SNMP
The information below covers the CLI and WebGUI. SNMP is covered else-
where in this document.

Firmware Guide Release 7.5 Standard 1.2 August 2012

398 Chapter 7

Note: SNMP access from LAN interfaces is disabled by default.

CLI Access Levels The CLI may be accessed through either Telnet or SSH2. Each method (Tel-
and Defaults net or SSH2) can be individually enabled or disabled.
There are two access levels in Touchstone gateway products running TS7.5:
Technician level
Technician-level access is always available before the CM portion
of the gateway has ranged and registered, even if the CLI is dis-
abled through provisioning. Technician access is restricted to
router configuration.
The default password used for technician-level access is techni-
cian. This password can be changed through XML provisioning or
through TACACS-related CLI commands and SNMP MIB objects.
General level
General-level access allows access to all the commands listed in
this document. The arrisCmDoc30AccessTelnetEnable object
provides a master control over general-level access. Other objects,
described in ‘‘Enabling and Accessing the Troubleshooting CLI’’
on page 435, provide further control.
The Password of the Day (PWoD) is needed for access to the gen-
eral-level CLI. See ‘‘Using the Password of the Day Tool’’ on
page 431 for details.

WebGUI Access The WebGUI can be accessed from the WAN or LAN interfaces. It has two
Levels and De- levels of access:
faults Subscriber level
Subscriber level access is restricted to user-controlled settings, and
is only available at non-gateway LAN interfaces.
User name: admin
Default password: password (can be changed by the subscriber)
Technician level
Technician level access allows making changes to all settings avail-
able in the WebGUI. It is available at the WAN interface and non-
gateway LAN interfaces.
User name: technician
Default password: none (the ARRIS Password of the Day also
allows access)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 399

About TACACS+ TACACS+ (Terminal Access Controller Access-Control System) is a Cisco

Support remote authentication protocol. Touchstone products configured for
TACACS+ authentication must be able to reach a TACACS+ server through
the HFC network.
To enable TACACS+ support for CLI and WebGUI access, add the following
MIB objects to the CM configuration file:
arrisRouterTACACSAddr
The IP address or FQDN of the remote TACACS+ server.
arrisRouterTACACSPort
The port on which the TACACS+ server listens for connections.
arrisRouterTACACSServerKey
The authentication key used to access the TACACS+ server.
When configuring TACACS+ support, keep the following items in mind:
• To save authentication time, the gateway device checks the entered
password in the following order:
1 the Password of the Day
2 the XML provisioned password (if provisioned)
3 the technician password stored on the gateway (applicable only to
technician login for Telnet/SSH)
4 TACACS+ authentication
This order is non-configurable, and was selected since locally-stored
passwords provide faster authentication and do not require network
access.
• Only one TACACS+ server and key are supported in TS7.5.
• CHAP and PAP authentication are not supported.
• If the gateway device has not ranged and registered, TACACS+
authentication cannot be completed.

LED Patterns

The Touchstone Telephony Modem has eight indicator lights to assist in trou-
bleshooting. Note that not all models have a Battery light.

Firmware Guide Release 7.5 Standard 1.2 August 2012

400 Chapter 7

Battery Mismatch If the Telephony Modem alternates flashing the Battery light and all other
lights, the installed battery is incompatible with the Telephony Modem.
Remove the battery and install a supported battery.

Wiring Problems If the Telephony Modem begins flashing all its lights for more than 10 sec-
onds, this indicates a problem with the telephone wiring—the tip and ring
(red and green) wires may be shorted (touching), or there may be undesired
voltage on the lines. If this pattern persists for more than 10 seconds, discon-
nect the telephone lines from the Telephony Modem, then call a wiring tech-
nician for assistance.

TM702 Normal Op- The following table shows LED patterns during normal operation.
eration

Tel. 1/
Mode Power DS US Online Link Battery
Tel. 2
AC Power On On = Con- On = Con- On = On = On = On- On = Bat-
Good nected to the nected to the Internet Computer hook tery good or
Internet Internet available connected low1
Flash = Off-
Flash = Not Flash = Not Off = Off = hook Off =
connected to connected to Internet not Computer Battery
the Internet the Internet available not con- Off = missing or
nected Disabled eDVA not
registered
Flash =
Computer Flash = Bat-
Activity tery bad
No AC Flash Off Off Off Off On = On- Off = Bat-
Power hook tery power
Battery
Installed Flash = Off- Flash = Bat-
hook tery bad or
low
Off = dis-
abled
No AC
Power No Off Off Off Off Off Off Off
Battery
Firmware (normal (normal (normal
On Flash Flash On
Upgrade operation) operation) operation)

Note 1: Loads with a .TW extension flash the Battery LED for the Battery
Low condition, regardless of the AC Power state, and turn off the Battery
LED for the Replace Battery state.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 401

TM722/TM802/TM804/TM822
The following table shows LED patterns during normal operation.
Normal Operation

Tel. 1/
Mode Power DS US Online Link Battery
Tel. 2
AC Power On Green1, 3 = Green1, 3 = On = Inter- Green2, 3 = On = On- On = Bat-
Good Connected Connected net Avail- Connected hook tery good or
to the Inter- to the Inter- able (high-speed) low4
net (high- net (high- Flash = Off-
speed) speed) Off = Inter- Yellow2 = hook Off = Bat-
net not Connected tery missing
Yellow1 = Yellow1 = available (normal Off = or eDVA not
Connected Connected speed) Disabled registered
to the Inter- to the Inter-
net (normal net (normal Off = Com- Flash = Bat-
speed) speed) puter not tery bad
connected
Flash = Not Flash = Not
connected to connected to Flash =
the Internet the Internet Computer
activity
No AC Flash Off Off Off Off On = On- Off = Bat-
Power hook tery power
Battery
Installed Flash = Off- Flash = Bat-
hook tery bad or
low
Off = dis-
abled
No AC
Power No Off Off Off Off Off Off Off
Battery
Firmware (normal (normal (normal
On Flash Flash On
Upgrade operation) operation) operation)

Note 1: For the TM722 and Model 8 DS and US LEDs, ‘‘High-speed’’ means
2–4 bonded channels; ‘‘normal speed’’ is a single channel.
Note 2: For the TM722 and Model 8 Link LED, ‘‘High-speed’’ means no
10/100 BaseT Ethernet or USB 1.1 devices are connected directly to the
Telephony Modem; ‘‘normal speed’’ means at least one of the connected
devices are 10/100 BaseT or USB 1.1.
Note 3: You can configure the Telephony Modem to always display US, DS,
and Link LEDs in green, by setting the arrisCmDoc30SetupMultiColorLed-
Bitmap object to 0.

Note 4: Loads with a .TW extension flash the Battery LED for the Battery
Low condition, regardless of the AC Power state, and turn off the Battery
LED for the Replace Battery state.

Firmware Guide Release 7.5 Standard 1.2 August 2012

402 Chapter 7

TM702/TM722/TM802/TM804/TM822
The following tables show the Telephony Modem LED patterns during each
Startup Sequence phase of the startup sequence. There are two phases of startup: the Tele-
phony phase and the cable modem phase. Both are outlined below.

eDVA Startup Sequence

Power, DS, Telephone

Link Battery* Description
US, Online 1 2
Off Off Off Off Off
No power to Cable
Modem
Flash Flash Flash Flash Flash Power-on Self Test
See ‘‘Cable Modem Start Up Sequence’’ Below
On On1 Flash Off Off Retrieving tele-
phone network
information
On On Off Flash Off Retrieving tele-
phone line infor-
mation
On On Flash Flash Off Activating tele-
phone service
Normal Operation
* = Battery LEDs only apply to those models with battery backup

Note 1: When On, the TM722 and Model 8 Link LED color is green if all
connected devices are high-speed (1000BaseT Ethernet or USB 2.0), and yel-
low if any connected device is normal speed (10/100BaseT Ethernet or
USB 1.x).

Cable Modem Startup Sequence

DS US Online Link Description

Flash Off Off Off Downstream search
On Flash Off Off Downstream found; upstream search
On On Flash Off Downstream and Upstream found;
retrieving setup information from
cable operator
On On On On Ready for service

TG852G Normal The following table shows LED patterns during normal operation.
Operation

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 403

Tel. 1/
Mode Power DS US Online Ethernet WiFi Secure Battery
Tel. 2
AC Power On Green1,3 Green1,3 On = Green2,3 On = On = On = On- On = Bat-
Good = Con- = Con- Internet = Con- Computer WPS con- hook tery good
nected to nected toAvailable nected connected nection or low4
the Inter- the Inter- (high- estab- Flash =
net (high- Off =
net (high- speed) Off = lished Off-hook Off = Bat-
speed) speed) Internet Computer tery miss-
not avail- Yellow2 = not con- Off = No Off = dis- ing or
1 1
Yellow = Yellow = able Con- nected WPS con- abled eDVA not
Con- Con- nected nection registered
nected to nected to (normal Flash = estab-
the Inter- the Inter- speed) Wifi activ- lished Flash =
net (nor- net (nor- ity Battery
mal mal Off = Flash = bad
speed) speed) Computer WPS
not con- search
Flash = Flash = nected active
Not con- Not con-
nected to nected to Flash =
the Inter- the Inter- Computer
net net activity
No AC Flash Off Off Off Off Off Off On = On- Off = Bat-
Power hook tery
Battery power
Installed Flash =
Off-hook Flash =
Battery
Off = dis- bad or low
abled
No AC
Power No Off Off Off Off Off Off Off Off Off
Battery
Firmware (normal (normal (normal (normal (normal
On Flash Flash On
Upgrade operation) operation) operation) operation) operation)

Note 1: For the DS and US LEDs, ‘‘High-speed’’ means 2–4 bonded chan-
nels; ‘‘normal speed’’ is a single channel.
Note 2: For the Link LED, ‘‘High-speed’’ means no 10/100 BaseT Ethernet
devices are connected directly to the Telephony Modem; ‘‘normal speed’’
means at least one of the connected devices are 10/100 BaseT.
Note 3: You can configure the Telephony Modem to always display US, DS,
and Link LEDs in green, by setting the arrisCmDoc30SetupMultiColorLed-
Bitmap object to 0.

Note 4: Loads with a .TW extension flash the Battery LED for the Battery
Low condition, regardless of the AC Power state, and turn off the Battery
LED for the Replace Battery state.

Firmware Guide Release 7.5 Standard 1.2 August 2012

404 Chapter 7

TG852G Startup The following tables show the Telephony Gateway LED patterns during each
Sequence phase of the startup sequence. There are two phases of startup; the Tele-
phony phase and the cable modem phase. Both are outlined below.
Note: The states of the WiFi and Secure LEDs are not relevant in the startup
sequence.

eDVA Startup Sequence

Power, DS, Telephone

Ethernet Battery Description
US, Online 1 2
Off Off Off Off Off No power to Cable
Modem
Flash Flash Flash Flash Flash Power-on Self Test
See ‘‘Cable Modem Start Up Sequence’’ Below
On On1 Flash Off Off Retrieving tele-
phone network
information
On On Off Flash Off Retrieving tele-
phone line infor-
mation
On On Flash Flash Off Activating tele-
phone service
Normal Operation

Note 1: When On, the Link LED color is green if all connected devices are
high-speed (1000BaseT Ethernet or USB 2.0), and yellow if any connected
device is normal speed (10/100BaseT Ethernet or USB 1.x).

Cable Modem Startup Sequence

DS US Online Link Description

Flash Off Off Off Downstream search
On Flash Off Off Downstream found; upstream search
On On Flash Off Downstream and Upstream found;
retrieving setup information from
cable operator
On On On On Ready for service

TG852G/CT Nor- TG852G/CT models have single-color LEDs, and a single LED (DS/US)
mal Operation provides downstream and upstream indication as shown in the following ta-
ble.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 405

Tel. 1/
Mode Power US/DS Online Wifi Battery
Tel. 2
AC Power On On = Con- On = Inter- On = Device On = On- On = Bat-
Good nected to the net Available connected hook tery good or
Internet low
Off = Inter- Off = No Flash = Off-
Flash/Off = net not avail- device con- hook Off = Bat-
Not con- able nected tery missing
nected to the Off = dis- or eDVA not
Internet Flash = abled registered
Computer
Activity Flash = Bat-
tery bad
No AC Flash Off Off Off On = On- Off = Bat-
Power Bat- hook tery power
tery Installed
Flash = Off- Flash = Bat-
hook tery bad or
low
Off = dis-
abled
No AC
Power No Off Off Off Off Off Off
Battery
Firmware (normal (normal (normal
On Flash On
Upgrade operation) operation) operation)

TG852G/CT Start- The following tables show the Telephony Gateway LED patterns during each
up Sequence phase of the startup sequence. There are two phases of startup; the Tele-
phony phase and the cable modem phase. Both are outlined below.

Firmware Guide Release 7.5 Standard 1.2 August 2012

406 Chapter 7

eDVA Startup Sequence

Power, Telephone
US/DS Link Battery Description
Online 1 2
Off Off Off Off Off Off No power to Cable
Modem
Flash Flash Flash Flash Flash Flash Power-on Self Test
See ‘‘Cable Modem Start Up Sequence’’ Below
On On On Flash Off Off Retrieving tele-
phone network
information
On On On Off Flash Off Retrieving tele-
phone line infor-
mation
On On On Flash Flash Off Activating tele-
phone service

Cable Modem Startup Sequence

US/DS Online Link Description

Slow Flash Off Off Downstream search
Flash Off Off Downstream found; upstream search
On Flash Off Downstream and Upstream found;
retrieving setup information from
cable operator
On On On Ready for service

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 407

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 P-CSCF informed of the location/phone
number of the eDVA.
• 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.

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_trans 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 P-CSCF challenges the request by rejecting it with a 401 or 407
response.
2 The eDVA re-sends the request with an authorization header.
The 401/407 message includes a nonce (number used once) that the eDVA
hashes with its username and password. This prevents an intruder from
snooping the session to re-use the communication to authenticate. The P-
CSCF periodically requires a new nonce to be used.
The list of authorization headers persist until the dialog is torn down. The
eDVA 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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

408 Chapter 7

Registration A SIP device must register with a registrar periodically. The registrar asso-
ciates the SIP URI (including the phone number) with the device and stores
this association in a database. This allows the P-CSCF 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 eDVA
had registered at least once. Current versions allows outbound calls before
registration, allowing emergency calls without registering first.
Each registration succeeds when the registrar responds with a 200 OK mes-
sage. This response includes an ‘‘expires’’ value in either the Expires:
header or the Contact: header. The eDVA 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.
The eDVA can offer an expiration value to the P-CSCF. The eDVA’s offer is
the lower of the expiration value specified in the configuration file and the
expiration value specified in the registrar response. The P-CSCF is not
bound to accept the offer.
The sip_reg command in the CallP sub-mode allows tracing of SIP registra-
tion-related messages.

Subscriptions 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 notifica-
tion of certain events. For example, the SUBSCRIBE method is used to sub-
scribe to VMWI updates. This allows the P-CSCF to notify the eDVA when
messages are waiting.
Each SUBSCRIBE method subscribes to a specific event package. This
informs the P-CSCF 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 409

Call Legs The eDVA 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 P-CSCF 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 one of the
following codes:
180 The far-end is providing power ringing and the originator should pro-
vide local ringback tone.
183 The far-end is providing power ringing and providing remote ring-
back 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: <sip:[email protected]:5060>

• reINVITE:
To: <sip:[email protected]:5060>;tag=95490288-a013d1f-
13c4-50029-bb-6edc1cd1-bb

Firmware Guide Release 7.5 Standard 1.2 August 2012

410 Chapter 7

Basic Call Flow

The following diagram shows signaling flows for a basic call.

MTA1 Proxy MTA2

INVITE sip:[email protected]:5060 w/SDP

401 Unauthorized

ACK sip:[email protected]:5060

INVITE sip:[email protected]:5060 w/SDP

100 trying - your call is important to us

INVITE sip:[email protected]:5060 w/SDP

100 Trying

180 Ringing

180 Ringing

200 OK w/SDP

200 OK w/SDP

ACK sip:[email protected]:5060

ACK sip:[email protected]:5060

BYE sip:[email protected]:5060

BYE sip:[email protected]:5060

200 OK

200 OK

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 411

Basic Call Flow with PRACK

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

MTA1 Proxy MTA2

INVITE sip:[email protected]:5060 w/SDP

401 Unauthorized

ACK sip:[email protected]:5060

INVITE sip:[email protected]:5060 w/SDP

100 trying - your call is important to us

INVITE sip:[email protected]:5060 w/SDP

180 Ringing w/SDP

180 Ringing w/SDP

PRACK sip:[email protected]:5060

PRACK sip:[email protected]:5060

200 OK

200 OK

200 OK

200 OK

ACK sip:[email protected]:5060

ACK sip:[email protected]:5060

BYE sip:[email protected]:5060

BYE sip:[email protected]:5060

BYE sip:[email protected]:5060

200 OK

200 OK

200 OK

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

Firmware Guide Release 7.5 Standard 1.2 August 2012

412 Chapter 7

Forking

During a call, P-CSCFs can make flexible routing decisions to decide where
to send a request. A P-CSCF 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 P-CSCF. Each response is distinguished by the tag parame-
ter in the To: header field, and each represents a distinct dialog, with a dis-
tinct dialog identifier.
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. P-CSCFs 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 eDVA communicates
with this ‘‘hinted’’ media gateway if it receives the 183, but it is not guaran-
teed.

Call Forking Trace

The following diagram shows the signaling flow for call forking.

Proxy/
MTA
Sipp

INVITE sip:[email protected]:5060 w/SDP

180 Ringing w/SDP

180 Ringing w/SDP

200 OK w/SDP

ACK sip:10.1.63.10:5060;transpor t=UDP

BYE sip:10.1.63.10:5060;transpor t=UDP

200 OK

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 413

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.

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 acknowl-
edge these provisional responses.

Session Timer SIP connections use a session timer to prevent calls from staying up indefi-
nitely 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 eDVA 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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

414 Chapter 7

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 eDVA 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 eDVA uses in a subsequent standard
DNS lookup (A record) to get the IP address for communication.
Priority is used to specify a primary/secondary relationship for backup sce-
narios. The lower the number, the higher the priority.
Weight is used to load-balance between multiple P-CSCFs. The weight val-
ues 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

;; ANSWER SECTION:
_sip._udp.ser.arris-i.org. 120 IN SRV 10 10 5060 serc.arris-i.org.
_sip._udp.ser.arris-i.org. 120 IN SRV 30 10 5060 ser.arris-i.org.
_sip._udp.ser.arris-i.org. 120 IN SRV 10 10 5060 serb.arris-i.org.

;; AUTHORITY SECTION:
arris-i.org. 120 IN NS pc-alps.arris-i.org.

;; ADDITIONAL SECTION:
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

;; Query time: 30 msec

;; SERVER: 10.1.63.10#53(10.1.63.10)
;; WHEN: Fri Jun 6 15:46:51 2008
;; MSG SIZE rcvd: 236

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 415

Message When the transport is UDP, each request is retransmitted with an exponential
Retransmission backoff routine. This means that the interval between each retransmission
doubles after each retransmission. The initial interval is T1 seconds (.5 sec-
onds 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.
For INVITE messages, retransmissions stop after Timer B expires (7 trans-
missions 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 This section provides a brief description of SIP message types.
Overview
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 416 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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

416 Chapter 7

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.

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 P-CSCF 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.

PRACK

Part of RFC 3262 (100rel). This message is used to acknowledge a provi-

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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 417

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 alter-
native 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 exam-
ple, adding appropriate authorization). However, the same request to a differ-
ent 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.

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

Firmware Guide Release 7.5 Standard 1.2 August 2012

418 Chapter 7

• RFC 3262 — Reliability of Provisional Responses in SIP

(PRACK/100Rel
• 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

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 419

Running Line Card Diagnostics

Use this procedure to manually initiate line card diagnostics on a Touchstone
Telephony eDVA line.

About Line Card Line card diagnostics check the following functionality:
Diagnostics • processor communication
• power/clock
• on-hook/off-hook functionality
• ring

Testing Overview Start line card diagnostics by using the diag or diagForce CLI commands.
Use the dresults command to show line card diagnostics results.

Action Follow these steps to run line card diagnostics from the CLI.
1 If necessary, access the CLI using the instructions in ‘‘Accessing the
CLI through Telnet’’ on page 437.
2 Enter the Line Card sub-menu:
[ 1]Console> voice ↵
[ 2]Voice> lc ↵
[ 3]Linecard>

3 Start line card diagnostics on an out-of-service line:

diag line

Where line is the line number to test: 1 or 2.

Note: If you see an error message like:
Warning: Action is Service Affecting. Use ’diagForce’
to force diagnostics
Use the diagForce command to force the line out of service and run
line card diagnostics.
4 Wait for the message Diags test ended to appear on the con-
sole. See the CLI Reference for a complete list of messages that may
appear in response to the diag command.
5 Display the test results:
dresults ↵

Firmware Guide Release 7.5 Standard 1.2 August 2012

420 Chapter 7

Running Loop Diagnostics

Use this procedure to run loop diagnostics on a subscriber’s phone line. For
line card diagnostics, see ‘‘Running Line Card Diagnostics’’ on page 419.

About Loop Diag- Loop diagnostics include the following tests:

nostics
Hazardous Potential Test

Tests for the presence of a foreign AC or DC voltage from tip to ground or

ring to ground. Failure conditions are:
• Tip-ground or ring-ground AC voltage is greater than 50 VRMS

• Tip-ground or ring-ground DC voltage is greater than 135 V

The failure types are shown below, with possible causes and symptoms:
Test Failure Possible Cause Possible Symptoms Normal Test
Data Limits
-DC Tip-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
-DC Ring-Grd Ring shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
+DC Tip-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
+DC Ring-Grd Ring shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
AC Tip-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment AC power out, no phones ring, loud
supply lines or house 60Hz buzz when off hook
wiring on line, phone may ring
at 60Hz, LC in protection
state
AC Ring-Grd Ring shorted to other No dial tone, can not dial 0 Voltage
equipment AC power out, no phones ring, loud
supply lines or house 60Hz buzz when off hook
wiring on line, phone may ring
at 60Hz, LC in protection
state

Foreign Electromotive Test

Tests for the presence of an AC or DC voltage from tip to ground or ring to

ground. Failure conditions are:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 421

• Tip-ground or ring-ground AC voltage is greater than 10 VRMS

• Tip-ground or ring-ground DC voltage is greater than 6 V

The failure types are shown below, with possible causes and symptoms:
Test Failure Possible Cause Possible Symptoms Normal Test
Data Limits
-DC Tip-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
-DC Ring-Grd Ring shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
+DC Tip-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
+DC Ring-Grd Ring shorted to other No dial tone, can not dial 0 Voltage
equipment power supply out, no phones ring, LC
lines in protection state
AC Tip-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment AC power out, no phones ring, loud
supply lines or house 60Hz buzz when off hook
wiring on phone, phone may
ring at 60Hz, LC in pro-
tection state
AC Ring-Grd Tip shorted to other No dial tone, can not dial 0 Voltage
equipment AC power out, no phones ring, loud
supply lines or house 60Hz buzz when off hook
wiring on phone, phone may
ring at 60Hz, LC in pro-
tection state

Resistive Faults Test

Tests the tip to ring, tip to ground, and ring to ground DC resistance.
Failure condition: tip-ring, tip-ground or ring-ground DC resistance is less
than 150 kΩ. This test discriminates between a resistive fault in the loop and
a receiver off-hook condition from properly working terminal equipment.
The failure types are shown below, with possible causes and symptoms:
Test Failure Possible Cause Possible Symptoms Normal Test
Data Limits
Tip-Grd Tip shorted to cable No dial tone, 60Hz buzz 150kΩ or
shield, moisture in cable, on line due to longitudi- greater
house line protection nal imbalance, no incom-
device shorted Tip to ing calls
Grd.
Ring-Grd Ring shorted to cable No dial tone, 60Hz buzz 150kΩ or
shield, moisture in cable, on line due to longitudi- greater
house line protection nal imbalance, no incom-
device shorted Ring to ing calls
Grd.

Firmware Guide Release 7.5 Standard 1.2 August 2012

422 Chapter 7

Test Failure Possible Cause Possible Symptoms Normal Test

Data Limits
Tip-Ring Staple or nail shorting No dial tone, no incom- 150kΩ or
Tip and Ring, moisture in ing calls Greater
cable, house line protec-
tion device shorted Tip to
Ring

Receiver Off Hook Test

Failure condition: detection of a non-linear tip-ring DC resistance.

The failure types are shown below, with possible causes and symptoms:
Test Failure Possible Cause Possible Symptoms Normal Test
Data Limits
Off Hook One of multiple phones Can not receive calls, can On Hook
left off hook not get dial tone on other
phones in house

Ringers Test

Measures the terminal equipment’s AC ringer impedance at the frequency of

the selected template.
Failure condition: the measured equivalent ringer count across tip-ring is less
than 0.175 REN (no phones connected, low REN phone, or broken wire) or
greater than 5 REN (too many phones connected).
Note 1: 1 REN = 7000Ω at 20Hz in North America
Note 2: Some CPE devices with electronic ringers present less than 0.175
REN and thus fail the Ringers test.
The failure types are shown below, with possible causes and symptoms:
Test Failure Possible Cause Possible Symptoms Normal Test
Data Limits
Less Than 0.175 Ringer is open, no phone Phone does not ring Between
REN connected, open in cop- 0.175 and 5.0
per line, phone may actu- REN
ally have REN value less
than 0.175
More Than 5.0 Total REN in multiple Line ring trips after short Between
REN phones exceeds 5 REN, ring burst, some phones 0.175 and 5.0
ringer capacitor shorted may ring and others do REN
not, low ring loudness on
some phones with old
bell type ringers.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 423

Limitations
CAUTION
Service affecting
Performing loop diagnostics requires the line under test to be first taken out
of service. This must be done manually when using SNMP. The CLI and
web-based interfaces provide the option of forcing a line out of service. Note
that forcing a line out of service while a call is in progress, drops a call.
Perform loop diagnostics only during installation or a scheduled maintenance
window, unless the subscriber is unable to use the line.

Loop Diagnostics and Line Card Diagnostics always run together.

From any interface, you can start loop diagnostics on a second line while
diagnostics are running on another line. However, you cannot start another
loop diagnostics run on a line already running loop diagnostics until the tests
have completed.

Test Results You can examine the test results either by walking the arrisMtaDevDiag-
LoopTable entry that corresponds to the line under test, or by using the lpre-
sults CLI command (in the Linecard menu). Both SNMP- and CLI-based
tests display the date and time of the last test run, and the following possible
results for each test:
Result Meaning Action
Not Started No tests have been run Start (or re-start) the diagnostics.
since the modem was last
started.
In Progress Diagnostics are still run- Wait 10–20 seconds and try again.
ning
Invalid State The line must be out of Take the line out of service and
service (OOS) before retry the diagnostics.
starting loop diagnostics.
Aborted The test could not be Check the other tests for failures.
completed, possibly Correct any problems and re-try
because a higher order the diagnostics.
test failed.
Fail A test has failed. The results show the values
returned by the failing test. Cor-
rect any problems and re-try the
diagnostics.
Pass A test has passed. None.
Unsupported Loop diagnostics are not None.
supported on single-line
Telephony Modems.

Firmware Guide Release 7.5 Standard 1.2 August 2012

424 Chapter 7

The arrisMtaDevDiagLoopLastResult MIB object provides a summary

result:
diagnostics-passed(1),
hazardous-potential-test-failure(2),
foreign-emf-test-failure(3),
resistive-faults-test-failure(4),
receiver-offhook-test-failure(5),
ringer-test-failure(6),
invalid-state-to-init-diags(7),
line-is-unprovisioned(8),
diagnostics-results-pending(9),
not-started(10), or
unsupported(11).

If more than one a test failed, only the first failing test is shown.
The Telephony Modem stores the results of the last loop diagnostics run for
each line since the modem was started or rebooted. If the arrisMtaDevDiag-
LoopTime object is set to midnight on January 1, 1970, no loop diagnostics
have been run on that line since the modem was started or rebooted.

Action Perform one of the following tasks.

Task Page
Running Loop Diagnostics from an SNMP Manager 424
Running Loop Diagnostics from the CLI 425
Running Loop Diagnostics from the Web-based Interface 426

Running Loop Di- Follow these steps to run loop diagnostics from an SNMP network manage-
agnostics from an ment system.
SNMP Manager 1 Locate the eDVA and line you wish to test.
2 Use the following table to find the interface index number for the
line:
Line Interface
1 9
2 10

3 Take the desired line out of service by setting the associated ifAd-
minStatus MIB object to down(2). This object is indexed by the
interface number; use the interface number for the line found in
step 2. For example, ifAdminStatus.9 corresponds to line 1.
4 Set the arrisMtaDevDiagLoopRequest object for this line to
true(1). This object is indexed by the line number; that is,
arrisMtaDevDiagLoopRequest.1 corresponds to line 1.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 425

The diagnostics begin running on the line. The tests require about 10
to 20 seconds to complete.
5 After 10 to 20 seconds, retrieve the diagnostics results from the
arrisMtaDevDiagLoopTable.

6 See ‘‘Test Results’’ above to interpret the results.

Running Loop Follow these steps to run loop diagnostics from the Telephony Modem CLI.
Diagnostics from 1 If necessary, access the CLI using the instructions in ‘‘Accessing the
the CLI CLI through Telnet’’ on page 437.
2 Enter the Line Card sub-menu:
[ 1]Console> voice ↵
[ 2]Voice> lc ↵
[ 3]Linecard>

3 Start the diagnostics on a line that is out-of-service:

lpdiag line ↵
Where line is the line number to test: 1 or 2.
The diagnostics begin running on the line. The tests require about 10
to 20 seconds to complete.
Note 1: If you see an error message like:
Warning: Action is Service Affecting. Use ’lpdiagForce’
to force diagnostics
the line is in service. Use the lpdiagForce command to force the
line out of service and run loop diagnostics.
Note 2: If you see an error message like:
Loop diags request already in queue
Then loop diagnostics are already running on this line. Wait for 10
to 20 seconds for the current diagnostics run to complete before
attempting to start another (you can, however, start diagnostics on
another line).
4 After 10 to 20 seconds, you should see the message Diags test
ended. When this message appears, enter the following command
to see the results:
lpresults ↵
5 See ‘‘Test Results’’ above to interpret the results.

Firmware Guide Release 7.5 Standard 1.2 August 2012

426 Chapter 7

Running Loop Di- Follow these steps to run loop diagnostics from the web-based troubleshoot-
agnostics from the ing interface.
Web-based Inter-
face
CAUTION
Service affecting
Performing loop diagnostics from the web-based interface give you the
option of taking the line under test out of service after confirmation.

1 Access the Advanced pages, following the steps outlined in ‘‘Access-

ing the Advanced Pages’’ on page 457.
When accessing the Advanced pages for the first time, the Product
Details page appears. If you are at another Advanced page, select
the Product link to move to the Product Details page. Note that the
Loop Diagnostics is near the bottom of the Product Details page at
first.

2 Select the line to test using the Line Number menu.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 427

3 Click the Run Diags button to start the test.

4 If the chosen line is in service, the E-UE displays the following
warning (note that the Loop Diagnostics section has moved to the top
of the page). Click the Force Diags button to continue.

If the chosen line is already running loop diagnostics, the E-UE dis-
plays the following warning. Wait for 10 to 20 seconds for the cur-
rent diagnostics run to complete before attempting to start another
(you can, however, start diagnostics on another line).

5 To view the progress of the test, click the Refresh button.

Firmware Guide Release 7.5 Standard 1.2 August 2012

428 Chapter 7

6 The test typically takes about 10 to 20 seconds to complete. After 10

to 20 seconds, click the Refresh button to show the results. When
the test completes, all five tests are marked either PASS or FAIL as
shown in the two examples below.
Passing:

Failing:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 429

Loopback Testing

Touchstone NCS firmware supports both NETWLOOP and NETWTEST

loopback connection modes. You must activate loopback mode on a line
from the call server.
For SIP loopback configuration, see ‘‘SIP Loopback Testing’’ on page 460.

Reset to Factory Defaults

Touchstone firmware provides the ability to reset a Telephony Modem to its

factory-default configuration. To reset a Telephony Modem, press and hold
the Reset button on the back of the unit for 15 seconds, or set the arrisCm-
Doc30RestoreFactoryDefaults object to 1. Either method resets the E-UE
and (for Telephony Gateways) the router to factory defaults.
The reset writes the following default values to non-volatile memory:
Parameter Default Value
pktcMtaDevEnabled 0 (WBM7xx); 1 (all others)
Manufacturing Org Name ‘‘Arris Interactive, L.L.C.’’
Ethernet IP address 192.168.100.1
Ethernet IP Mask 255.255.255.0
ifName ‘‘lan0’’
Telnet Settings DISABLED_HTTP, DISABLED_SNMP
SSH Settings DISABLED_HTTP, DISABLED_SNMP
WAN Http Setting 0
LAN Http Setting 1
Debug/Info Logging OFF
Factory Mode disable
Op Mode Enable disable
CvcAccessStart 010101000000Z
CodeAccessStart 010101000000Z
Number of Tuners 1
DocsisPhyMultiFact 0
Upstream Frequency Cache empty
Downstream Frequency Cache empty
docsDevSwAdminStatus allowProvisioningUpgrade(2)
Secure Firmware Download enabled
Downstream Channel Bonding enabled
Persistent Line Status ignore
Tx/Rx Endpoint Voice Gain -128

Firmware Guide Release 7.5 Standard 1.2 August 2012

430 Chapter 7

Resetting the The TG852 Telephony Gateway provides an additional method of resetting
Router (TG852) the router to factory defaults without resetting the E-UE. To reset only the
router, use the ‘‘Reset/Reboot Gateway’’ web page under the Troubleshoot-
ing tab.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 431

Using the Password of the Day Tool

This procedure describes the purpose and usage of the ARRIS Password of
the Day (PWoD) tool.
Touchstone firmware provides a command-line interface (CLI), and a web-
based troubleshooting interface consisting of two parts:
• Standard pages, available (by default) to both subscribers and opera-
tors.
• Advanced pages, available only by entering a password. These pages
may contain sensitive information. The password changes daily for
further protection.
The PWoD tool generates the appropriate password to access the CLI, and
the advanced troubleshooting pages.

About the Pass- The PWoD tool, ARRISpwod.exe, is available through the Firmware Down-
word of the Day load Center. It is a Windows application, with the following requirements:
Tool • Windows 98, Windows NT, Windows 2000, Windows XP or Windows
7
• Microsoft.Net plus Service Pack 2. The installer provides this package
if required.
• Internet Explorer version 5.1 or newer. The newest version of Internet
Explorer is available at the Microsoft web site 〈http://
www.microsoft.com/windows/ie/default.asp〉.
The PWoD tool can create a single password, or a list of passwords for a
range of days (up to 365). For added security, you can also define a seed
value used to generate the passwords.

Firmware Guide Release 7.5 Standard 1.2 August 2012

432 Chapter 7

Before performing any of the tasks in this procedure, double-click the file to
start the PWoD tool. The following diagram shows the tool.

Action Perform the following tasks as needed.

Task Page
Generating a Single Password 432
Generating a List of Passwords 432
Changing the Seed 433
Generating an Operator-Defined Password 434

Generating a Sin- Follow these steps to generate a single password.

gle Password 1 Start the PWoD tool, if you have not done so already.
2 Check the Use Default Seed checkbox.
3 Set the Begin Day and End Day dates to the same date (the default
for both fields is the current date).
4 Click the Calculate Password of the Day button.
The Password of the Day appears in the text box at the right of the
PWoD tool window. You can select and copy the password as
needed.

Generating a List Follow these steps to generate a list of passwords.

of Passwords 1 Start the PWoD tool, if you have not done so already.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 433

2 Check the Use Default Seed checkbox.

3 Set the Begin Day and End Day dates to the range of days that you
want to generate passwords for (the default for both fields is the cur-
rent date).
4 Use the Browse button to specify a file name and location for the
output file.
5 Click the Calculate Password of the Day button.
The Password of the Day for the first day appears in the text box at the bot-
tom of the PWoD tool window.
The PWoD tool writes the list of passwords to the specified file. The file con-
tains a list of dates and the associated password for that day.

Changing the The PWoD tool can use a default seed to generate the password of the day.
Seed For added security, you can create a different seed to change the password
pattern. Follow these steps to change the seed.
1 Start the PWoD tool, if you have not done so already.
2 Enter a new seed value (4 to 8 ASCII characters) in the Seed field at
the top of the PWoD window. Make sure the Use Default Seed box
is not checked.
The encoded seed appears in the DES encoded field.
Note: The Touchstone E-UEs also need to have the changed seed so
that their internal PWoD generators remain in sync with the external
tool. Write the DES encoded seed to the arrisCmDevHttp-
ClientSeed MIB object in the eDVA configuration file.

Example seed values:

abCd1234
Abc#$ˆ&
*!() 1_?
A1h53
abcdEFGH
3 If you want to save the seed, make sure the Save Seed box is
checked.
The PWoD tool saves the new seed to a file called password.dat, in
the directory where the PWoD is located. Make sure that any com-
puter that can access a password file is reasonably secure.

Firmware Guide Release 7.5 Standard 1.2 August 2012

434 Chapter 7

Generating an Op- Touchstone firmware supports an alternate, operator-defined password, to

erator-Defined access the CLI and advanced web pages. The password is encrypted using
Password the PWoD tool and stored in the CM or eDVA configuration file.
Note: The normal Password of the Day is still accepted after setting an oper-
ator-defined password.
Follow these steps to generate an alternate password. Use the following
screen as an example.

1 Start the PWoD tool, if you have not done so already.

2 Enter the operator-defined password (4 to 8 ASCII characters) in the
Seed field at the top of the PWoD window. Make sure the Use
Default Seed box is not checked.

3 Click the Calculate Password of the Day button.

The encoded password appears in the DES encoded field.
4 Add the encoded password to the CM or eDVA configuration file as
follows, removing the periods. The following example uses the
encoded password in the figure above:
SnmpMib=arrisCmDevSinglePasswd "0A7C46132A02B29E"

5 Reset the E-UE to set the operator-defined password.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 435

Enabling and Accessing the Troubleshoot-

ing CLI
Use this procedure to access the troubleshooting CLI. You can enable CLI
access one time (until logging out or rebooting) or permanently (access is
available across reboots). For details about CLI commands, see ‘‘Refer-
ences.’’
CLI access is available for both Telnet and SSHv2 clients.

SSH Login IDs The following SSH user accounts are supported:
• User name: root
Password: arris
After successfully logging in, the Telephony Modem displays the Password
of the Day prompt.

Action Perform the following tasks as needed.

Task Page
Enabling CLI Access Using the Web Pages 435
Enabling CLI Access Using SNMP 436
Setting the CLI Timeout 437
Accessing the CLI through Telnet 437
Accessing the CLI through SSH 438

Enabling CLI Follow these steps to enable CLI access through the web-based interface.
Access Using the 1 Using any web browser, connect to the E-UE’s troubleshooting web
Web Pages pages using the CM IP address.
Note: You must use the CM IP address to enable CLI access.
2 Enable access to the Advanced web pages (see ‘‘Accessing the
Advanced Pages’’ on page 457 for details). Use the PacketACE
‘‘MSO Password of the Day’’ tool to generate the correct password.
The browser displays the URL in the form http://cm-
ipaddr/page.htm.
3 In the browser’s address line, replace the page name with
techsupport.htm and press Enter.

The browser displays the Technical Support page:

Firmware Guide Release 7.5 Standard 1.2 August 2012

436 Chapter 7

Note: If you see a ‘‘page not found’’ error, return to step 1 and try
again. Do not access any other Advanced pages before accessing the
Technical Support page.
4 Enter the password of the day (the same password you used to access
the Advanced pages) in the Arris Password field, set the Telnet Sta-
tus and SSH Status drop-downs to either disable or enable as
desired, then click the Submit Request button.
5 Proceed to ‘‘Accessing the CLI through Telnet.’’

Enabling CLI Follow these steps to enable CLI access using SNMP.
Access Using 1 Add the arrisCmDoc30AccessTelnetPassword object to the con-
SNMP figuration file, and set it to the MSO password of the day.
2 Reset the E-UE to apply the new settings.
3 Use an SNMP manager to set the following objects as desired.
arrisCmDoc30AccessTelnetEnable
Set to disable(0) to disable Telnet access, or enable(1) to
enable Telnet access.
arrisCmDoc30AccessSSHEnable
Set to disable(0) to disable SSH access, or enable(1) to enable
SSH access.
4 To enable CLI access through TACACS+ authentication, add the fol-
lowing objects:
arrisRouterTACACSAddr
The IP address or FQDN of the remote TACACS+ server.
arrisRouterTACACSPort
The port on which the TACACS+ server listens for connec-
tions.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 437

arrisRouterTACACSServerKey
The authentication key used to access the TACACS+ server.
5 If you added these objects to the configuration files, reset the E-UE
to allow the settings to take effect.
Note: If you do not add the arrisCmDoc30AccessSSHEnable or
arrisCmDoc30AccessTelnetEnable objects to the CM configura-
tion file, you must add the arrisCmDoc30AccessTelnetPassword
object to the CM configuration file to prevent SNMP SET failures.

Setting the CLI You can configure a session timeout, that automatically terminates a CLI ses-
Timeout sion after a specified period of inactivity, through SNMP. Follow these steps
to set or disable the CLI timeout.
1 Set the arrisCmDoc30CLITimeout object to the time (in minutes)
the CLI may be idle until timeout. Valid range: 1 to 65535 minutes,
or use 0 to disable the timeout. Default: 1440.

Accessing the CLI Follow these steps to access the CLI through Telnet.
through Telnet 1 If you have not already done so, use ‘‘Enabling CLI Access Using
SNMP’’ on page 436 to make sure CLI access is enabled.
2 From a PC or workstation, start a Telnet program and connect to the
CM IP address of the E-UE.
The E-UE displays a banner message and an Enter Password>
prompt.
3 At the Enter Password> prompt, enter the MSO password of the day.
Use the PacketACE ‘‘MSO Password of the Day’’ tool to generate
the correct password.
If the password was entered correctly, the Telephony Modem displays
a login banner.

Firmware Guide Release 7.5 Standard 1.2 August 2012

438 Chapter 7

Accessing the CLI Follow these steps to access the CLI through SSH.
through SSH 1 If you have not already done so, use ‘‘Enabling CLI Access Using
the Web Pages’’ on page 435 to make sure CLI access is enabled.
2 From a PC or workstation, start an SSH program.
3 Connect to the CM IP address of the E-UE as follows:
• For graphical clients, set up the account with the correct account
based on ‘‘SSH Login IDs’’ on page 435.
• For command-line clients, enter the account on the command line
with the CM IP address. For example, Unix SSH clients use a
command similar to: ssh [email protected]
The E-UE displays a banner message and an Enter Password>
prompt.
4 At the Enter Password> prompt, enter the password for the account
as shown in ‘‘SSH Login IDs’’ on page 435. Use the PacketACE
‘‘MSO Password of the Day’’ tool to generate the correct password
of the day, if needed.
If the password was entered correctly, the Telephony Modem displays
a login banner.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 439

Using the Web-based Troubleshooting Inter-

face
Touchstone firmware provides a web-based interface to a status monitoring
and troubleshooting subsystem. Status information is available to anyone by
using a standard web browser to access the cable modem IP address. A pass-
word-protected set of pages provides views of advanced network settings.
The following sections describe the screens available from the web interface.
To access the screens, see ‘‘Accessing the Standard Pages’’ on page 457
below.

Access Options You can access the troubleshooting screens through either the Touchstone
Telephony product RF or Ethernet interfaces.

Requirements You need the following equipment to access the troubleshooting pages:
• computer with an Ethernet interface and a web browser
• Ethernet cable (if using the E-UE Ethernet interface)
• (advanced pages only) the password of the day

Controlling The following MIB objects control access to the basic and advanced trou-
Access to the bleshooting pages.
Interface arrisCmDoc30AccessHttpLan
Values: disable(0), enable(1)
Determines which pages are available from the Ethernet port of the
E-UE. The value is stored in non-volatile memory.
arrisCmDoc30AccessHttpWan
Values: disable(0), enable(1)
Determines which pages are available from the network attached to
the CMTS. The value is stored in non-volatile memory.
arrisCmDoc30AccessHttpPwCtrl
Values:
none(0): No password is required for any screen;
advanced(1): The PWoD is required for Advanced screens;
all(2): The PWoD is required for all screens.

Sets which groups of troubleshooting pages are password pro-

tected. The default is advanced(1).

Firmware Guide Release 7.5 Standard 1.2 August 2012

440 Chapter 7

arrisCmDoc30AccessClientSeed
Changing the seed changes the results of the Password of the Day
(PWoD). See ‘‘Using the Password of the Day Tool’’ on page 431
for details about the PWoD. Store the seed value in the CM config-
uration file.
arrisCmDoc30AccessHttpTimeout
The time, in seconds, that the advanced pages are available before
the Telephony Modem requires password re-entry. Valid range: 1
to 1440 seconds, or 0 to disable the timeout.
arrisCmDoc30AccessSinglePassword
A DES-encoded password string, used to bypass the Password of
the Day mechanism. When this object is set, the Password of the
Day is disabled.
When using TACACS+ authentication, the following objects specify the
TACACS+ server to use and the password:
arrisRouterTACACSAddr
The IP address or FQDN of the remote TACACS+ server.
arrisRouterTACACSPort
The port on which the TACACS+ server listens for connections.
arrisRouterTACACSServerKey
The authentication key used to access the TACACS+ server.

Standard Screens Anyone can access the screens described in this section.

Status Screen

The status screen is the index page, and can also be selected by choosing the
Status link at any standard screen. The following is an example:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 441

The top section of this page provides the following information:

• Downstream and upstream settings
• System uptime
• Number of computers on the LAN that the modem detected
• Cable modem status
The bottom section provides the names, MAC addresses, and status of each
interface on the E-UE. For subscriber-side data interfaces (Ethernet and
USB), the page also reports interface speed in Mb/sec.

Firmware Guide Release 7.5 Standard 1.2 August 2012

442 Chapter 7

HW/SW Versions Screen

The Hardware/Firmware Versions screen provides information about the

hardware and firmware revision levels. To display this screen, choose the
HW/SW Versions link.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 443

Event Log Screen

The Event Log screen displays a table of recent events. The E-UE stores the
event log in non-volatile memory. To display this screen, choose the Event
Log link.

Firmware Guide Release 7.5 Standard 1.2 August 2012

444 Chapter 7

Note: Setting the arrisMtaDevEventHideMacFQDNandIPAddress MIB

object to enable(0) in the CM configuration file prevents display of the
device FQDN and IP address on the basic Event Log screen. Users with
access to the Advanced pages (using the Password of the Day) can always
see FQDN and IP address information on the Advanced Event Log screen.

Registration Status Screen

The Registration Status screen shows the results of the E-UE registration
process and current battery telemetry state and serial number. To display this
screen, choose the CM State link.

The following states may appear under the CM State listing.

Hardware Diags
Status of hardware diagnostics. Displayed only if the diagnostics
find a problem.
Docsis-Downstream Scanning
Status of DOCSIS downstream scanning.
Docsis-Downstream Ranging
Status of DOCSIS downstream ranging.
Docsis-Upstream Ranging
Status of DOCSIS upstream ranging.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 445

Docsis-DHCP
Status of the CM DHCP phase. The Registration Status page also
displays the number of attempts required to obtain a CM IP
address.
Docsis-TFTP
Status of the CM configuration file download.
Docsis-Data Reg Complete
Shows whether the modem has completed DOCSIS data registra-
tion.
Telephony-ERR-LC Over Current Protection
Indicates that one or more phone lines are in protection mode. The
front panel LEDs indicate which lines are in protection mode.
Battery Mismatch
Indicates that the wrong battery has been inserted in the Telephony
Modem (see below).
If the Battery Part Number is ‘‘Contact ARRIS’’ as shown below, the battery
is either defective or the Telephony Modem has the wrong type of battery
installed.

The operational status is ‘‘No Status Reported’’ if the battery charger has
been disabled. Check the Event Log page for a ‘‘Battery Charger Disabled’’
alarm to verify. Power-cycle or reset the E-UE to re-enable the charger.
If you see this display, contact ARRIS Technical Support. Make a note of the
hexadecimal code and operational status before calling.
The following is a list of other messages that may appear in the Battery Serial
Number field:
Battery Serial Number Not Supported
The Telephony Modem does not read battery serial numbers.
Battery Missing
No battery is installed.
AC Failed. S/N Temporarily Unavailable
Appears when the Telephony Modem is running on battery power.
Unable to obtain Battery Serial Number(s)
Appears in cases where the serial number is missing or unreadable.

Firmware Guide Release 7.5 Standard 1.2 August 2012

446 Chapter 7

Wireless Screen

Touchstone Gateway products provide access to the router’s web-based con-

figuration pages through the Wireless link.

To return to the Basic pages from the Wireless page, click the HSD link at the
top of the page.
See the ARRIS Router Setup Web GUI User Guide for details about the wire-
less pages.

Scanning Override Screen

The Scanning Override screen allows a technician to force the cable modem
to look for a carrier on a specified downstream frequency.
This screen does not have a link from the other screens. See ‘‘Provisioning
Preset Downstream Frequencies’’ on page 118 for instructions on accessing
and using this screen.

Advanced Screens The following screens require a Password of the Day (see ‘‘Using the Pass-
word of the Day Tool’’ on page 431 for details). Use the Basic link on any
screen to return to the standard status pages.
Note: Advanced screens contain potentially sensitive information about the
network.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 447

Product Details Screen

The Detailed Status screen provides the following information:

• E-UE status
• IP (IPv4 or IPv6, as appropriate) and MAC address parameters
• system information, including enabled features
To access this screen, choose the Product link from any advanced screen.

Firmware Guide Release 7.5 Standard 1.2 August 2012

448 Chapter 7

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 449

DHCP Parameters

The DHCP Parameters screen lists DHCP details for the cable modem and
eDVA portions of the E-UE, including IPv4 or IPv6 addresses as appropriate.
To access this screen, choose the DHCP link from any advanced screen.

The DHCP Parameters screen provides links to CM DHCP and eDVA DHCP
message trace logs.

Firmware Guide Release 7.5 Standard 1.2 August 2012

450 Chapter 7

QoS Statistics Screen

The QoS Statistics screen shows the eDVA QoS statistics. To access this
screen, choose the QoS link from any advanced screen.

Note: Currently, the packet counts for the downstream service flows are not
incremented and always show 0.
At the bottom of the screen, the following controls provide control and dis-
play of the CallP signalling log:
• The Show Call Signalling Log button displays the Call Signalling
Log.
• The Disable Logging button disables CallP signal logging. When
logging is disabled, the button name becomes Enable Logging.
• The Clear button clears the CallP signalling log.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 451

Call Signalling Log

The Call Signalling Log screen shows the call signaling log.

Firmware Guide Release 7.5 Standard 1.2 August 2012

452 Chapter 7

Configuration Parameters Screen

The Configuration Parameters screen shows the values of common cable

modem and eDVA configuration parameters. To access this screen, use the
Config Params link from any advanced screen.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 453

Technical Support Screen

The Technical Support screen allows an operator to set access parameters for
the CLI and web pages. This screen does not have a link from the other
screens. See ‘‘Enabling CLI Access Using the Web Pages’’ on page 435 for
details on accessing and using this screen.

The fields are:

Arris Password
Enter the Password of the Day before submitting changes to the
other fields.
Telnet Status
Enables or disables CLI access for both Telnet and SSH.
Http LAN Access
Enables or disables access to the troubleshooting pages from the
Ethernet or USB ports.
Http WAN Access
Enables or disables access to the troubleshooting pages from the
cable network.

Firmware Guide Release 7.5 Standard 1.2 August 2012

454 Chapter 7

Speedtest Web Page

The Speedtest screen allows configuration, control, and viewing of test

results.
To access this screen, use the Speedtest link from any advanced screen.

Note: By setting the arrisCmDoc30SpeedtestConfigEndUserGui object,

the Speedtest screen may optionally be made available on the Basic screens.
The Speedtest screen is divided into Results and Configuration sections.

Results Section

The top of the screen displays each of the three latest results. The Prev and
Next buttons allow the user to cycle through each of the stored results. In the
screen displayed above, the screen displays the latest result (Next is dis-
abled), and there are older results available (Prev is enabled).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 455

The results displayed are:

Test start conditions:
The time the test started, the number of voice lines active at that
time, and whether CPE data was enabled for the test.
Test end conditions:
The time the test ended, and the number of voice lines active at that
time.
Test duration:
The time is split into the DNS lookup time, connection setup time,
and the actual transfer time. If an address is given as an FQDN,
the DNS lookup time is the amount of time needed to perform the
lookup. If an IP address is used (as shown in the example), this
time should be 0.
The setup time for FTP transactions is the amount of time from the
initial request until the second TCP (data connection) has been
established. For HTTP, the setup time is simply the time from the
initial request until the request is satisfied.
The transfer time is used to compute the uplink and download
speeds, as this is when the actual payload is transferred.
Payload statistics:
The payload is the actual file data transferred. The number of
bytes transferred, and the transfer speed are shown for the upload
and download directions.
Payload including overhead:
This is the payload including TCP/IP header information. Note
that acknowledgments generate traffic in the opposing direction.
Number of bytes, number of packets, and speed, are shown for the
upload and download directions.
Total Interface Traffic:
This shows the total amount of data through the DOCSIS network
interface during the transfer. It includes voice traffic and CPE traf-
fic flowing through the Packet Processor.

Configuration Section

The configuration section can be used to change the test parameters. Two
sets of parameters are available, for Upload or Download. Select Upload or
Download from the ‘‘Test Direction’’ drop down to select which set of con-
figuration data to display. The default test configuration runs both download
and upload tests.
The following parameters are available. Unless noted, these apply to both
upload and download tests.

Firmware Guide Release 7.5 Standard 1.2 August 2012

456 Chapter 7

Test Direction
Choose Upload Only or Download only to configure the test. The
selection Download / Upload does not allow changing parameters,
but allows both tests to run.
Test Mode
Choose HTTP or FTP.
Server Address
The IP address or FQDN of the server to use for the speed test.
Server Port
The port number for the server. Default: 21 for FTP, 80 for HTTP.
Server Username
If required, the user ID used to log into the server.
Server Password
If required, the password used to log into the server.
Filename
(Download only) The file name to download from the server. The
file size should be at least 10MB.
Upload Size
(Upload only) The amount of data, in MB, to send to the server.
Scriptname
(Upload only) For HTTP servers, the name of the script used to
read the POST data sent to the server.
POST fields
(Upload only) For HTTP servers, any fields needed to pass to the
script. Fields have the format name˜value, and are separated by
ampersand (&) characters.
File Field
(Upload only) For HTTP servers, the name of the field in the
upload form that receives the uploaded file.
Use the Save button to save your configuration before switching to the other
set of parameters.

Action Perform the following tasks as necessary.

Task Page
Accessing the Standard Pages 457
Accessing the Advanced Pages 457

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 457

Accessing the Follow these steps to access the standard troubleshooting pages.
Standard Pages 1 Make sure the E-UE is configured to allow access to the pages (see
‘‘Controlling Access to the Interface’’ on page 439).
2 Obtain the cable modem IP address of the E-UE.
Note: If the E-UE has not registered, you can access the pages only
from the Ethernet interface. After registration, you can use either the
RF or Ethernet interfaces.
The Ethernet interface recognizes connections to the address
192.168.100.1, whether or not the modem has registered. To use this
address, set your computer’s IP address to an address in the same
subnet, such as 192.168.100.2.
3 Start your web browser and access the E-UE using the address
http://192.168.100.1/

Accessing the Follow these steps to access the advanced troubleshooting pages.
Advanced Pages 1 Perform steps 1 and 2 of ‘‘Accessing the Standard Pages’’ above.
2 Obtain the Password of the Day from the PWoD tool. See ‘‘Using
the Password of the Day Tool’’ on page 431 for details about the
PWoD tool.
3 Start your web browser and access the E-UE, using the address
http://192.168.100.1/cgi-bin/product_cgi (replace the IP address
shown with the cable modem IP address if desired).
The E-UE displays a web form that prompts you for the password.

4 Enter the Password of the Day in the web form and press Enter.
The E-UE displays the Product Details Screen shown on page 447.
Note: If the Password of the Day does not allow you to access the advanced
pages, verify that the date shown below the password entry field matches the
date associated with the Password of the Day.

Firmware Guide Release 7.5 Standard 1.2 August 2012

458 Chapter 7

Troubleshooting SIP
Use the information in this procedure to troubleshoot issues with SIP eDVAs.

Internal eDVA The following list describes internal eDVA states when running SIP firmware
States 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.
• CONFERENCE_BEFORE_ANSWER — Phone is off-hook and con-
nected with a single party. The other outbound call is outstanding and
has not been answered. Media is mixed and both parties hear ring-
back. 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.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Maintenance 459

Action Perform the following tasks to troubleshoot SIP problems.

Task Page
Enabling SIP Logging 459
Tracing SIP Messages 459

Enabling SIP Log- Enable log types 65, 66, 67, 68, and 69 when troubleshooting any SIP issue.
ging 1 Move to the second console:
Console> co ↵

2 Change to the Log directory:

mainMenu> log ↵

3 Enable SIP logging:

logger> ModuleConfig 6 26 1 ↵

Tracing SIP Mes- Follow these steps to perform SIP traces:

sages 1 Change to the Callp Directory:
Console> / voice ↵
Voice> callp ↵

2 To enable tracing of all SIP messages associated with a call:

Call Processing> callpEnblLog 1 ↵

3 To enable tracing of SIP transactions (not associated with a call): For

example: OPTIONS, PING requests/responses
Call Processing> trace 22 ↵

4 To enable tracing of SIP registrations:

Call Processing> trace 18 ↵

5 To enable tracing for SIP subscriptions, used for solicited VMWI

(RFC 3841) and call transfer — SUBSCRIBE and REFER messages:
Call Processing> trace 21 ↵

6 To enable tracing of SIP state and input, use the following com-
mands:
Console> co ↵
mainMenu> logger ↵
Logger> ModuleConfig 6 26 1 ↵

Firmware Guide Release 7.5 Standard 1.2 August 2012

460 Chapter 7

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.
SIP loads also support remote initiated loopback. Using remote initiated
loopback, the eDVA starts either media loopback or packet loopback when
receiving a call from a phone number provisioned in the sipCfgMediaLoop-
backNumber or sipCfgPacketLoopbackNumber MIB objects.

When running loopback tests, the eDVA 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 sipCfgMediaLoopback-
Number object to the eDVA configuration file.

2 To set a packet loopback number, add the sipCfgPacketLoopback-

Number object to the eDVA configuration file.

3 After saving the configuration file, restart the eDVA to make the
changes take effect.
4 To start a loopback test, call any line on the eDVA from the numbers
specified in the above MIB objects.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 8 References

The following reference material is available:

Topic Page
Supported Calling Features 461
Country Code Templates 464
Default Tone Settings 477
XML Configuration File 495
Command-Line Interface Reference 499

Supported Calling Features

Touchstone firmware supports the following calling features:

• Automatic Number Assignment Confirmation (ANAC) via CID2
• Direct Distance Dialing (DDD)
• Critical Interdigital Timing for Dialing Plan
• International DDD (IDDD) Local Billing Control
• Residence Distinctive Alerting Service
• Free Terminating Service
• Code Restriction & Diversion
• Toll Restricted Service
• DTMF Dialing
• Pulse Dialing
• CLASS™: Calling Number Delivery
• CLASS: Customer Originated Trace

Firmware Guide Release 7.5 Standard 1.2 August 2012

462 Chapter 8

• CLASS: Anonymous Call Rejection

• CLASS: Calling Number Delivery Blocking
• CLASS: Calling Identity Delivery & Suppression
• CLASS: Calling Name Delivery Blocking
• CLASS: Calling Name Delivery
• CLASS: Calling Identity Delivery on Call Waiting
• Speed Calling 8
• Speed Calling 30
• Call Waiting
• Cancel Call Waiting (*70)
• Call Waiting Deluxe
• Access to Telecommunications Relay Service (TDD)
• Intercept Routing for blank/changed/etc. phone numbers
• Customer-Changeable Speed Calling
• Call Forwarding Variable
• Call Forwarding Busy Line
• Call Forwarding — Don’t Answer — All Calls
• VIP Alert (Distinctive Ringing)
• Visual Message Waiting Indicator (FSK)
• Message Waiting Tone (stutter dial tone)
• Conference Calling — Six-Way Station Controlled
• Call Hold, Call Pick-up, Toll Free Calling
• Emergency Calling Services (E911)
• Customer Call Back (Automatic Recall) (*69)
• Three-Way Calling
• Service Provider Originated Trace
• Courtesy Ring Generation
• Multiple Directory Numbers on a Line
• Customer Access Treatment (CAT) code restrictions
• Semi-Restricted Originating & Terminating (including 1010xxx block-
ing)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 463

• Fully Restricted Originating & Terminating

• Single-Digit Dialing
• Manual Line Service
• Direct Connect
• Denied Terminating Service
• Denied Originating Service
• Local Number Portability
• Remote Activation of Call Forwarding (RACF)
• Outside Calling Area Alerting (OCAA)

Firmware Guide Release 7.5 Standard 1.2 August 2012

464 Chapter 8

Country Code Templates

Use the ppCfgMtaCountryTemplate object to set the country code template.

TS7.5 firmware supports the following country code templates:
Flash time (ms)
Gain settings (dB)
Name (NA load only)
Tx Rx Min Max
North America 5/7 (1) −5 −7 250 1200
Chile (2) −3 −9.5 40 600
Japan (3) −4 −8 200 1200
Australia (4) −3 −9.5 250 1200
Austria (5) −3 −9.5 85 500
France (6) −3 −9.5 300 500
Germany (7) −3 −9.5 300 500
Ireland (8) −3 −9.5 250 1200
Netherlands (9)
−3 −9.5 300 500
(Euro-DOCSIS default)
Portugal (10) −3 −9.5 100 300
Spain (11) −3 −9.5 90 650
Belgium (12) −3 −9.5 50 600
Poland (13) −3 −9.5 50 520
Israel (14) −2 −4 200 800
Czech Republic (15) −3 −9.5 250 1200
Brazil (16) −3 −9.5 220 320
North America 3/3 (17)
−3 −3 250 1200
(DOCSIS default)
North America 0/9 (18) 0 −9 250 1200
Netherlands 0/9 (19) 0 −9 300 500
Japan (20)
−4 −8 200 1200
(Japan default)
Hungary (21) −3 −9.5 60 200
Sweden (22) −3 −9.5 250 1200
Norway (23) −3 −9.5 90 800
Slovakia (24) −3 −9.5 250 1200
Japan 600L412 (25)
−4 −12 200 1200
(see note)
Mexico (26) 0 −7 100 800
Panama (27) −3 −9.5 220 320
MexicoC (28) 0 −7 100 800

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 465

Flash time (ms)

Gain settings (dB)
Name (NA load only)
Tx Rx Min Max
Switzerland (29) −3 −9.5 88 600
Poland1010 (30) −13 −19.5 70 250
Germany2 (31) −3 −9.5 300 500
North America 6/6 (32)
−6 6 250 1200
(.TW default)
Argentina (33) 0 −7 100 1100

North American The following ring cadences may be provisioned using the PacketCable NCS
Ring Cadences Signaling MIB (see PKT-SP-MIB-SIG1.5-I01-050128). The following table
shows the default ring cadences for North America.
Name Description Default
L/RG Standard Ringing 2 seconds on, 4 seconds off
L/R0 Distinctive Ringing #0 2 seconds on, 4 seconds off
L/R1 Distinctive Ringing #1 2 seconds on, 4 seconds off
L/R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
L/R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
L/R4 Distinctive Ringing #4 300 ms on, 200 ms off,
1 second on, 200 ms off,
300 ms on, 4 seconds off
L/R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
L/R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
L/R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
L/RS Ring Splash 500 ms on, 5.5 seconds off
(not repeated)
L/RT Ringback Tone 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

Firmware Guide Release 7.5 Standard 1.2 August 2012

466 Chapter 8

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 eDVA configuration file with the provision-
ing for the appropriate MIB objects to define ring cadences (for example,
pktcSigDevRgCadence). To make this setting, add 0x02000000 to the cur-
rent feature switch setting in the CM configuration file.

Netherlands/ The following table shows the default ring cadences for all Netherlands tem-
Netherlands09 plates.
Ring Cadences Name Description Default
RG Standard Ringing 1000 ms on, 4000 ms off
R0 Distinctive Ringing #0 1.3 seconds on, 300 ms
off, 300 ms on, 3.1 sec-
onds off
R1 Distinctive Ringing #1 1.3 seconds on, 300 ms
off, 1.3 seconds on, 2.1
seconds off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1
second on, 200 ms off, 300
ms on, 4 seconds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 450 ms on (not repeated)
RT Ringback Tone 1 second on, 4 seconds off

Provisioning European standard ring cadence and ring splash may be provisioned through
European Ring the PKTC-IETF-MTA-MIB objects pktcSigDevRgCadence (standard ring),
Cadences pktcSigDevR0Cadence through pktcSigDevR7Cadence, and pktcSigDev-
RsCadence (ring splash). These objects consist of the following fields:

length repeat cadence

(2 octets) (1 octet) (. . .)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 467

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 is
00.50.00.FF.FF.F0.00.00.00.00.00.00.00, which corresponds to:

• 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 non-
repeatable. The eDVA rejects any attempt to make the ring splash repeatable.

Austria Ring The following table shows the default ring cadences for Austria.
Cadences
Name Description Default
RG Standard Ringing 1000 ms on, 5000 ms off
R0 Distinctive Ringing #0 2000 ms on, 4000 ms off
R1 Distinctive Ringing #1 2000 ms on, 4000 ms off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4000 ms off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4000 ms off
R4 Distinctive Ringing #4 300 ms on, 200 ms off,
1000 ms on, 200 ms off,
300 ms on, 4000 ms off
R5 Distinctive Ringing #5 500 ms on, 5500 ms off
R6 Distinctive Ringing #6 2000 ms on, 4000 ms off
R7 Distinctive Ringing #7 2000 ms on, 4000 ms off
RS Ring Splash 450 ms on
RT Ringback Tone 1000 ms on, 5000 ms off

Firmware Guide Release 7.5 Standard 1.2 August 2012

468 Chapter 8

Australia Ring The following table shows the default ring cadences for Australia.
Cadences
Name Description Default
RG Standard Ringing 400 ms on, 200 ms off, 400 ms on,
2000 ms off
R0 Distinctive Ringing #0 2000 ms on, 4000 ms off
R1 Distinctive Ringing #1 2000 ms on, 4000 ms off
R2 Distinctive Ringing #2 800 ms on, 400 ms off, 800 ms on,
4000 ms off
R3 Distinctive Ringing #3 400 ms on, 200 ms off, 400 ms on,
200 ms off, 800 ms on, 4000 ms off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1000 ms on,
200 ms off, 300 ms on, 4000 ms off
R5 Distinctive Ringing #5 500 ms on, 5500 ms off (not repeated)
R6 Distinctive Ringing #6 2000 ms on, 4000 ms off
R7 Distinctive Ringing #7 2000 ms on, 4000 ms off
RS Ring Splash 650 ms on (not repeated)
RT Ringback Tone 2000 ms on, 4000 ms off

Belgium Ring The following table shows the default ring cadences for Belgium.
Cadences
Name Description Default
RG Standard Ringing 1 second on, 3 seconds off
R0 Distinctive Ringing #0 1 second on, 300 ms off,
250 ms on, 2450 ms off
R1 Distinctive Ringing #1 1 second on, 300 ms off, 1
second on, 1700 ms off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1
second on, 200 ms off, 300
ms on, 4 seconds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 300 ms on (not repeated)
RT Ringback Tone 1 second on, 3 seconds off

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 469

France Ring The following table shows the default ring cadences for France.
Cadences
Name Description Default
RG Standard Ringing 1500 ms on, 3500 ms off
R0 Distinctive Ringing #0 1350 ms on, 300 ms off, 350
ms on, 3 seconds off (see note)
R1 Distinctive Ringing #1 1350 ms on, 300 ms off, 1350
ms on, 2 seconds off (see note)
R2 Distinctive Ringing #2 800 ms on, 400 ms off, 800 ms
on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off, 400 ms
on, 200 ms off, 800 ms on, 4
seconds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1 sec-
ond on, 200 ms off, 300 ms
on, 4 second off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 700 ms on (not repeated)
RT Ringback Tone 1.5 seconds on, 3.5 seconds off

Firmware Guide Release 7.5 Standard 1.2 August 2012

470 Chapter 8

Germany/Ger- The following table shows the default ring cadences for Germany and Ger-
many2 Ring many2.
Cadences Name Description Default
RG Standard Ringing 1000 ms on, 4000 ms off
R0 Distinctive Ringing #0 2 seconds on, 4 seconds off
R1 Distinctive Ringing #1 2 seconds on, 4 seconds off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1
second on, 200 ms off, 300
ms on, 4 seconds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 450 ms on (not repeated)
RT Ringback Tone 1 second on, 4 seconds off

Hungary Ring The following table shows the default ring cadences for Hungary.
Cadences
Name Description Default
RG Standard Ringing 1250 ms on, 3750 ms off
R0 Distinctive Ringing #0 2 seconds on, 4 seconds off
R1 Distinctive Ringing #1 2 seconds on, 4 seconds off
R2 Distinctive Ringing #2 800 ms on, 400 ms off, 800 ms
on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off, 400 ms
on, 200 ms off, 800 ms on, 4 sec-
onds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1 second
on, 200 ms off, 300 ms on, 4 sec-
onds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 450 ms on (not repeated)
RT Ringback Tone 1.25 seconds on, 3.75 seconds off

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 471

Israel Ring The following table shows the default ring cadences for Israel.
Cadences
Signal Description Default
RG Standard Ringing 1s on, 4s off
R0 Distinctive Ringing #0 2s on, 4s off
R1 Distinctive Ringing #1 2s on, 4s off
R2 Distinctive Ringing #2 800ms on, 400ms off,
800ms on, 4000ms off
R3 Distinctive Ringing #3 400ms on, 200ms off,
400ms on, 200ms off,
800ms on, 4000ms off
R4 Distinctive Ringing #4 300ms on, 200ms off,
1000ms on, 200ms off,
300ms on, 4000ms off
R5 Distinctive Ringing #5 500ms on, 5500ms off
R6 Distinctive Ringing #6 2s on, 4s off
R7 Distinctive Ringing #7 2s on, 4s off
RS Call Forward Ring Splash 650ms on (not repeated)
DR Delayed Ringing 1s on, 4s off
SR Special Ringing 1.65s on, 3.35s off
PR Precedence Ringing 0.3s on, 0.35s off, 0.65s
on, 0.3s off, 0.3s on, 0.35s
off, 0.65s on, 2s off
CR Continuous Ringing 6s on, 4s off
CAR CPE Activation Ring Splash 650ms on
TR1 Teen Ring 1s on, 0.65s off, 1s on,
2.35s off

Firmware Guide Release 7.5 Standard 1.2 August 2012

472 Chapter 8

Japan Ring The following table shows the default ring cadences for Japan.
Cadences
Name Description Default
RG Standard Ringing 1 second on, 2 seconds off
R0 Distinctive Ringing #0 1 second on, 2 seconds off
R1 Distinctive Ringing #1 800 ms on, 400 ms off,
800 ms on, 4 seconds off
R2 Distinctive Ringing #2 300 ms on, 300 ms off,
300 ms on, 2100 ms off
R3 Distinctive Ringing #3 300 ms on, 200 ms off, 1
second on, 200 ms off,
300 ms on, 4 seconds off
R4 Distinctive Ringing #4 500 ms on, 5.5 seconds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
R6 Distinctive Ringing #6 1 second on, 2 seconds off
R7 Distinctive Ringing #7 1 second on, 2 seconds off
RS Ring Splash 500 ms on (not repeated)
RT Ringback Tone 1 second on, 4 seconds off

Mexico Ring The following table shows the default ring cadences for Mexico.
Cadences
Name Description Default
RG Standard Ringing 1 sec on, 4 sec off
R0 Distinctive Ringing #0 1300 ms on, 300 ms off,
300 ms on, 3100 ms off
R1 Distinctive Ringing #1 500 ms on, 250 ms off,
1000 ms on, 250 ms off,
500 ms on, 3500 ms off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4000 ms off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4000 ms off
R4 Distinctive Ringing #4 300 ms on, 200 ms off,
1000 ms on, 200 ms off,
300 ms on, 4000 ms off
R5 Distinctive Ringing #5 500 ms on, 5500 ms off
R6 Distinctive Ringing #6 2000 ms on, 4000 ms off
R7 Distinctive Ringing #7 2000 ms on, 4000 ms off
RS Ring Splash 250 ms on
RT Ringback Tone 1000 ms on, 4000 ms off

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 473

MexicoC Ring The following table shows the default ring cadences for MexicoC.
Cadences
Name Description Default
RG Standard Ringing 1 sec on, 4 sec off
R0 Distinctive Ringing #0 1000 ms on, 500 ms off,
1000 ms on, 3500 ms off
R1 Distinctive Ringing #1 500ms on, 500 ms off,
500 ms on, 500 ms off,
1000 ms on, 3000 ms off
R2 Distinctive Ringing #2 500 ms on, 500 ms off,
1000 ms on, 500 ms off,
500 ms on, 3000 ms off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4000 ms off
R4 Distinctive Ringing #4 300 ms on, 200 ms off,
1000 ms on, 200 ms off,
300 ms on, 4000 ms off
R5 Distinctive Ringing #5 500 ms on, 5500 ms off
R6 Distinctive Ringing #6 2000 ms on, 4000 ms off
R7 Distinctive Ringing #7 2000 ms on, 4000 ms off
RS Ring Splash 250 ms on
RT Ringback Tone 1000 ms on, 4000 ms off

Firmware Guide Release 7.5 Standard 1.2 August 2012

474 Chapter 8

Netherlands/ The following table shows the default ring cadences for all Netherlands tem-
Netherlands09 plates.
Ring Cadences Name Description Default
RG Standard Ringing 1000 ms on, 4000 ms off
R0 Distinctive Ringing #0 1.3 seconds on, 300 ms
off, 300 ms on, 3.1 sec-
onds off
R1 Distinctive Ringing #1 1.3 seconds on, 300 ms
off, 1.3 seconds on, 2.1
seconds off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1
second on, 200 ms off, 300
ms on, 4 seconds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 450 ms on (not repeated)
RT Ringback Tone 1 second on, 4 seconds off

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 475

Norway Ring The following table shows the default ring cadences for Norway.
Cadences
Name Description Default
RG Standard Ringing 1000 ms on, 4000 ms off
R0 Distinctive Ringing #0 1000 ms on, 4000 ms off
R1 Distinctive Ringing #1 1000 ms on, 4000 ms off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4000 ms off
R3 Distinctive Ringing #3 1000 ms on, 2000 ms off
R4 Distinctive Ringing #4 800 ms on, 200 ms off,
200 ms on, 200 ms off,
400 ms on, 1400 ms off
R5 Distinctive Ringing #5 200 ms on, 200 ms off,
400 ms on, 200 ms off,
200 ms on, 200 ms off,
400 ms on, 1400 ms off
R6 Distinctive Ringing #6 1000 ms on, 4000 ms off
R7 Distinctive Ringing #7 1000 ms on, 4000 ms off
RS Ring Splash 450 ms on
RT Ringback Tone 1000 ms on, 4000 ms off

Panama Ring The following table shows the default ring cadences for Panama.
Cadences
Name Description Default
RG Standard Ringing 1000 ms on, 4000 ms off
R0 Distinctive Ringing #0 1300 ms on, 300 ms off,
300 ms on, 3100 ms off
R1 Distinctive Ringing #1 1300 ms on, 300 ms off,
1300 ms on, 2100 ms off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4000 ms off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4000 ms off
R4 Distinctive Ringing #4 300 ms on, 200 ms off,
1000 ms on, 200 ms off,
300 ms on, 4000 ms off
R5 Distinctive Ringing #5 500 ms on, 5500 ms off
R6 Distinctive Ringing #6 2000 ms on, 4000 ms off
R7 Distinctive Ringing #7 2000 ms on, 4000 ms off
RS Ring Splash 650 ms on
RT Ringback Tone 1200 ms on, 4650 ms off

Firmware Guide Release 7.5 Standard 1.2 August 2012

476 Chapter 8

Poland/ The following table shows the default ring cadences for Poland and Slovakia.
Poland1010/Slo-
Name Description Default
vakia Ring
Cadences RG Standard Ringing 1 second on, 4 seconds off
R0 Distinctive Ringing #0 2 seconds on, 4 seconds off
R1 Distinctive Ringing #1 2 seconds on, 4 seconds off
R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1
second on, 200 ms off, 300
ms on, 4 seconds off
R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
RS Ring Splash 450 ms on (not repeated)
RT Ringback Tone 1 second on, 4 seconds off

Switzerland Ring The following table shows the default ring cadences for Switzerland.
Cadences
Name Description Default
L/RG Standard Ringing 1 seconds on, 4 seconds off
L/R0 Distinctive Ringing #0 2 seconds on, 4 seconds off
L/R1 Distinctive Ringing #1 2 seconds on, 4 seconds off
L/R2 Distinctive Ringing #2 800 ms on, 400 ms off,
800 ms on, 4 seconds off
L/R3 Distinctive Ringing #3 400 ms on, 200 ms off,
400 ms on, 200 ms off,
800 ms on, 4 seconds off
L/R4 Distinctive Ringing #4 300 ms on, 200 ms off, 1
second on, 200 ms off, 300
ms on, 4 seconds off
L/R5 Distinctive Ringing #5 500 ms on, 5.5 seconds off
(not repeated)
L/R6 Distinctive Ringing #6 2 seconds on, 4 seconds off
L/R7 Distinctive Ringing #7 2 seconds on, 4 seconds off
L/RS Ring Splash 450 ms on

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 477

Customizing Any of the above ring cadences may be customized in the eDVA configura-
Default Ring tion file. All MIB objects are eDVA based; therefore, the first cadence is
Cadences index 0.
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 rep-
resenting 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 sec-
onds on, 4 seconds off, repeatable, has a value of 0x0001F00000000000 and
would be provisioned in the eDVA configuration file as
00.01.F0.00.00.00.00.00.

Default Tone Settings

The following tables show default tones for supported country templates.
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.

Firmware Guide Release 7.5 Standard 1.2 August 2012

478 Chapter 8

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 pat-
tern completes (used, for example, with stutter dial).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 479

Firmware Guide Release 7.5 Standard 1.2 August 2012

480 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 481

Firmware Guide Release 7.5 Standard 1.2 August 2012

482 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 483

Firmware Guide Release 7.5 Standard 1.2 August 2012

484 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 485

Firmware Guide Release 7.5 Standard 1.2 August 2012

486 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 487

Firmware Guide Release 7.5 Standard 1.2 August 2012

488 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 489

Firmware Guide Release 7.5 Standard 1.2 August 2012

490 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 491

Firmware Guide Release 7.5 Standard 1.2 August 2012

492 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 493

Firmware Guide Release 7.5 Standard 1.2 August 2012

494 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 495

XML Configuration File

Touchstone Gateway products using TS7.5 firmware download an XML con-

figuration file if the Gateway component receives a valid URL in DHCP
Option 67. The Gateway requests the configuration file using HTTP GET
with the following parameters:
Parameter Description
gatewaymac MAC address of gateway
cmmac MAC address of cable modem
emtamac MAC address of the eMTA
class Either ‘‘ResidentialWirelessGateway’’
or ‘‘CommercialWirelessGateway’’

The server responds with an XML configuration file. The file provides con-
figuration information only for the router component of the Touchstone Gate-
way.
Note: If the returned URL is invalid in any way (for example, the site cannot
be reached or the specified file does not exist), the Gateway uses the last valid
configuration file it received. If the Gateway has no valid configuration, it
uses default settings.

Example The following is an example XML configuration file.

<?xml version="1.0" encoding="UTF-8"?>

<!-- An example XML config file -->

<deviceConfig version="1.0">
<ethernet enabled="true">
<ip ipVersion="4">
<address>192.168.0.1</address>
<netmask>255.255.255.0</netmask>
</ip>
<dhcpServer enabled="true">
<addressRange ipVersion="4">
<start>192.168.0.10</start>
<end>192.168.0.70</end>
</addressRange>
</dhcpServer>
</ethernet>

<moca enabled="false">
</moca>

<wirelessConfig enabled="true">
<region>USA</region>

Firmware Guide Release 7.5 Standard 1.2 August 2012

496 Chapter 8

<txPower>75</txPower>
<channelSelection mode="auto"></channelSelection>
<maxDataRate>auto</maxDataRate>
<beaconInterval>2500</beaconInterval>
<fiftyFourGProtection>true</fiftyFourGProtection>

<!-- the subscriber’s SSID -->

<ssid index="0" enabled="true">
<ip ipVersion="4">
<address>192.168.10.1</address>
<netmask>255.255.255.0</netmask>
</ip>
<dhcpServer enabled="true">
<addressRange ipVersion="4">
<start>192.168.10.10</start>
<end>192.168.10.200</end>
</addressRange>
</dhcpServer>
<name>Subscriber1234</name>
<networkType>open</networkType>
<netMode>maxCompatibility</netMode>
<securityMode>WPA2-PSK</securityMode>
<wpaPSK>
<preSharedKey>d00ddeadbeef1234</preSharedKey>
<groupRekeyInterval>3600</groupRekeyInterval>
</wpaPSK>
</ssid>

<!-- the wifi phone SSID -->

<ssid index="1" enabled="true">
<ip ipVersion="4">
<address>192.168.100.1</address>
<netmask>255.255.255.0</netmask>
</ip>
<dhcpServer enabled="true">
<addressRange ipVersion="4">
<start>192.168.100.10</start>
<end>192.168.100.250</end>
</addressRange>
</dhcpServer>
<name>PhoneAccess1234</name>
<networkType>open</networkType>
<netMode>maxCompatibility</netMode>
<securityMode>WPA2-Enterprise</securityMode>
<wpaEnterprise>
<encryptionMode>aes+tkip</encryptionMode>
<radius key="1234+bjf9@x" rekey="1800">
<server name="radius.example.com">
<port>57734</port>
</server>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

References 497

</radius>
</wpaEnterprise>
</ssid>

<!-- SSID 2 & 3 are reserved for future use -->

<ssid index="2" enabled="false"></ssid>
<ssid index="3" enabled="false"></ssid>

</wirelessConfig>

<gateway>
<ssh enabled="true">
<username>noc</username>
<password>noc@11+gty</password>
</ssh>
<timezone>US/Eastern</timezone>

<ntp>ntp1.example.com</ntp>
<ntp>ntp2.example.com</ntp>
<ntp>0.pool.ntp.org</ntp>

<nat>
<ipsecPassthru>true</ipsecPassthru>
<pptpPassthru>false</pptpPassthru>
<multicastPassthru>true</multicastPassthru>
<tcpSesWaitTimeout>300</tcpSesWaitTimeout>
<udpSesWaitTimeout>60</udpSesWaitTimeout>
<icmpSesWaitTimeout>30</icmpSesWaitTimeout>
</nat>

<firewall enabled="true">
<proxy>true</proxy>
<javaApp>true</javaApp>
<activeX>false</activeX>
<popUp>true</popUp>
<blockFragPackets>true</blockFragPackets>
<portScan>true</portScan>
<ipFloodDetect>true</ipFloodDetect>
</firewall>

<mediaServer enabled="false"></mediaServer>
</gateway>

<account name="technician" enabled="true">

<password>bvKtKHAo/F3tw</password>
</account>
</deviceConfig>

Firmware Guide Release 7.5 Standard 1.2 August 2012

498 Chapter 8

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 9 Command-Line Inter-
face Reference

When you enter the command-line interface (see ‘‘Enabling and Accessing
the Troubleshooting CLI’’ on page 435 for instructions), you receive a pass-
word prompt. Enter the Password of the Day to continue to the console
prompt:
Arris console is active
Command interface Copyright 2008, ARRIS Group, Inc.,
All rights reserved
Type ’help’ for available commands
[ 1] Console>

Common Top-Level Commands

The following commands are common to all menus in the initial CLI.

status Shows the E-UE status. Example:

[ 1] Console> status

Hardware Model: TM702G

Firmware Name: TS070518_111011_MODEL_8
Firmware Revision: 7.3.48
Base Version: 1.0.0.21
Firmware Build Time: Aug 19 2010 14:56:02
Boot Revision: 1.2.0.7
Downstream Frequency: 741.00 0.00 0.00 0.00
Upstream Frequency: 31.40 0.00 0.00 0.00
CM status: OPERATIONAL
System Uptime: 0d:19h:50m

Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

500 Chapter 9

!reset Resets the E-UE as if you pushed the Reset button.

help Displays the commands available at the current prompt.

!logout Disconnects the session.

persist Syntax: persist {1 | 0}

Controls logging of report levels after a CLI session has ended or over a
reboot. Use persist 1 to enable persistent logging. Persistent logging
remains in effect until an operator uses persist 0 to cancel logging so ARRIS
recommends caution when using this command.

quit Quits the CLI (equivalent to the !logout command).

Top-level Commands

The following commands are available from the initial console prompt:

tech Enters the Technician menu. See ‘‘Technician Commands’’ on page 508.

system Enters the System menu. See ‘‘System Menu’’ on page 502.

nvm Technical Support only: Enters the NVM menu.

download Technical Support only: Enters the Download menu.

mdiag Technical Support only: Enters the Manufacturing Diagnostics menu.

led Enters the LED menu. See ‘‘LED Menu’’ on page 506.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 501

dhcp Enters the DHCP menu. See ‘‘DHCP Menu’’ on page 507.

tlm Enters the Telemetry menu. See ‘‘Telemetry Menu’’ on page 512.

database Enters the Database menu. See ‘‘Database Menu’’ on page 515.

rf Enters the RF menu. See ‘‘RF Menu’’ on page 516.

gw Enters the Gateway menu. See ‘‘Gateway Commands’’ on page 531.

co Enters the second console. See ‘‘MAIN Console Commands’’ on page 553.

voice Enters the eDVA console. See ‘‘Voice CLI Commands’’ on page 619.

speedtest Enters the Speedtest menu. See ‘‘Speedtest CLI’’ on page 547.

Firmware Guide Release 7.5 Standard 1.2 August 2012

502 Chapter 9

System Menu

The System commands provide information about the E-UE.

sysinfo Displays a detailed system info listing, including:

• Modem status
• NVRAM settings
• IP interface settings
• CM and eDVA DHCP settings
• TFTP settings
• Database contents

dhcp Displays DHCP parameters and options.

Example:
[109] system> dhcp
dhcp
===== CM DHCP =====
Interface Name - wan0
Provisioned IP Mode - IPv4 only
Preferred IP Mode - IPv4
Active IP Mode - IPv4
CM IP - 10.1.216.33
CM IP Netmask - 255.255.255.128
Router 0 IP - 10.1.216.126
DHCP Server IP - 10.1.50.30
Syslog Server IP - 10.1.50.30
TOD Server 0 IP - 10.1.50.30
TOD Time Offset - -18000
TFTP Server 0 IP - 10.1.50.30
TFTP Config File - /cm0015cf001d3b/kmh_cm_basic1_euro.bin
Lease Time - 86400 sec (58220 sec remaining)
Renew Time - 43200 sec (15020 sec remaining)
Rebind Time - 75600 sec (47420 sec remaining)

===== MTA DHCP =====

mta0 Link encap:Ethernet HWaddr 00:15:CF:00:1D:3C
inet addr:10.1.216.133 Bcast:10.1.216.255 Mask:255.255.255.128
UP BROADCAST RUNNING MTU:1500 Metric:1
RX packets:22942 errors:0 dropped:0 overruns:0 frame:0
TX packets:1851 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:1000
RX bytes:2939608 (2.8 MiB) TX bytes:189071 (184.6 KiB)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 503

Lease Time - 86400 sec (58250 sec remaining)

Renew Time - 43200 sec (15050 sec remaining)
Rebind Time - 75600 sec (47450 sec remaining)

{pktcMtaDevBase 5} pktcMtaDevFQDN: mta133.dev216

{pktcMtaDevBase 7} pktcMtaDevEnabled: 1
{pktcMtaDevBase 8} pktcMtaDevTypeIdentifier: pktc1.0:051901010002010209010
10b040106090F0d010110010912020007
{pktcMtaDevBase 9} pktcMtaDevProvisioningState: 4
{pktcMtaDevBase 11} pktcMtaDevProvisioningTimer: 10
{pktcMtaDevBase 12} pktcMtaDevProvisioningCounter: 1
{pktcMtaDevBase 13} pktcMtaDevErrorOidsTable:
{pktcMtaDevErrorOidsEntry 1} ErrorOid: 1.3.6.1.4.1.
4491.2.2.1.1.2.7.0
ErrorGiven: ÈÏ@û]Yí˜fÖñejo
ErrorReason: Unsatisfied dependency /
NO_CREATION
{pktcMtaDevServer 3} pktcMtaDevServerDns1: 10.1.50.30
{pktcMtaDevServer 3} pktcMtaDevServerDns2: 0.0.0.0
{pktcMtaDevServer 5} pktcMtaDevConfigFile: tftp://10.1.50.30/cm0015cf001d3b/
sn08_mta_tm702_netherlands_euro.bin
{pktcMtaDevServer 5} debug data: pktcMtaDevConfigFileName: cm0015cf001d3b/
sn08_mta_tm702_netherlands_euro.bin
{pktcMtaDevServer 5} configuration server was suplied as IP 10.1.50.30
{pktcMtaDevServer 6} pktcMtaDevSnmpEntity: PC-ALPS30.DEV50
{pktcMtaDevServer 7} pktcMtaDevProvConfigHash: no config hash, length: 0
{pktcMtaDevServer 8} pktcMtaDevProvConfigKey: no config key, length: 0
{pktcMtaDevServer 15} pktcMtaDevProvState: 1
{pktcMtaDevServer 16} pktcMtaDevServerDhcp1: 10.1.50.30
{pktcMtaDevServer 17} pktcMtaDevServerDhcp2: 10.1.50.30
{pktcMtaDevServer 18} pktcMtaDevTimeServer: 0.0.0.0
{pktcMtaDevSecurity 4} pktcMtaDevCorrelationId: 205221607

Return Status: 0

telnet_timer Syntax: telnet_timer [time]

Displays or sets the Telnet/SSH inactivity timer. The parameter time is the
time, in minutes, that the Telephony Modem waits for console activity before
disconnecting the session. Omit this parameter to display the current timer
setting.

lastreset Displays the ‘‘last reset reason’’ log, stored in non-volatile memory.
Example:

Firmware Guide Release 7.5 Standard 1.2 August 2012

504 Chapter 9

Fri Oct 23 00:28:44 2009 [USER_DEFINED] [ARRIS.RESET_REASON(pid=2197)

(download_thread:437)]: Arris CLI download complete -> reboot
Thu Oct 29 11:44:25 2009 [USER_DEFINED] [ARRIS.RESET_REASON(pid=20984)
(download_thread:437)]: Arris CLI download complete -> reboot
Thu Oct 29 15:41:58 2009 [USER_DEFINED] [ARRIS.RESET_REASON(pid=914)
(download_thread:437)]: Arris CLI download complete -> reboot
Thu Nov 5 15:31:28 2009 [USER_DEFINED] [ARRIS.RESET_REASON(pid=22798)
(download_thread:437)]: Arris CLI download complete -> reboot
Thu Nov 12 16:50:29 2009 [USER_DEFINED] [ARRIS.RESET_REASON(pid=22896)
(download_thread:437)]: Arris CLI download complete -> reboot
Fri Nov 13 11:13:04 2009 [USER_DEFINED] [ARRIS.RESET_REASON(pid=2834)
(download_thread:437)]: Arris CLI download complete -> reboot

Return Status: 0

exception Displays the Exception/PCD log file.

Example:
Wed Oct 14 13:57:00 2009 Error: Failed to send termination reply message.
Wed Oct 14 15:39:34 2009 Error: Failed to send termination reply message.
Thu Oct 29 15:09:56 2009 Error: Process /usr/sbin/sw_dl (917) exited with
result code 3 (Rule DOCSIS_SWDL).
Thu Oct 29 15:09:56 2009 Error: Rule DOCSIS_SWDL failed.
Thu Oct 29 15:38:52 2009 Error: Process /usr/sbin/sw_dl (985) exited with
result code 3 (Rule DOCSIS_SWDL).
Thu Oct 29 15:38:52 2009 Error: Rule DOCSIS_SWDL failed.

Return Status: 0

dpacm Displays PACM parameters stored in non-volatile memory.

buffer Displays the log buffer.

gw_diag Syntax: gw_diag {level} [intrusive]

Checks the status of the gateway and its ability to provide Ethernet and wifi
service. The parameters are:
level
The diagnostics level to use:
0: display only the first error
1: display only errors
2: display errors and warnings
3: display all data

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 505

intrusive
Set to 0 to avoid intrusive actions, or 1 to allow intrusive actions.

rf_diag Syntax: rf_diag {level} [intrusive]

Checks for upstream and downstream RF issues on the cable modem. The
parameters are:
level
The diagnostics level to use:
0: display only the first error
1: display only errors
2: display errors and warnings
3: display all data

intrusive
Set to 0 to avoid intrusive actions, or 1 to allow intrusive actions.

Firmware Guide Release 7.5 Standard 1.2 August 2012

506 Chapter 9

LED Menu

The LED menu commands allow manual control of the front panel LEDs for
testing.

all_on Turns on all the LEDs; the US, DS, and Link LEDs on TM722, WBM760,
and all Model 8 models are red.

all_on_green Turns on all the LEDs; the US, DS, and Link LEDs on TM722, WBM760,
and all Model 8 models are green.

all_off Turns off all the LEDs.

flash Flashes the LEDs.

resume Resumes normal LED operation.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 507

DHCP Menu

The DHCP menu commands control DHCP logging and features.

cmEnblLog Syntax: cmEnblLog [flag]

Enables or disables the CM DHCP log. The flag is either 0 to disable the log,
or 1 to enable the log. Omit the flag to display the current logging status.

cmDispLog Displays the CM DHCP log.

cmClrLog Clears the CM DHCP log.

mtaEnblLog Syntax: mtaEnblLog [flag]

Enables or disables the eDVA DHCP log. The flag is either 0 to disable the
log, or 1 to enable the log. Omit the flag to display the current logging status.

mtaDispLog Displays the eDVA DHCP log.

mtaClrLog Syntax: mtaClrLog

Clears the eDVA DHCP log.

mtaSubOpt3Imme- Syntax: mtaSubOpt3Immediate [flag]

diate Sets how the eDVA handles the DHCP Option 122 SubOption 3. The flag is
either 1 to disable immediate handling of the Sub-Option 3 value, or 2 to
enable immediate handling. Omit the parameter to display the current set-
ting.

Firmware Guide Release 7.5 Standard 1.2 August 2012

508 Chapter 9

Technician Commands

The Technician sub-menu provides commands to provision the WRM router

interface. This sub-menu is available prior to the Gateway completing rang-
ing and registration, using the special password technician. This password
is disabled once the Gateway ranges and registers.
To enter the Technician sub-menu, enter tech at the Console prompt. The
Technician prompt is Technician Menu>.

setRouteMode Syntax: setRouteMode { bridge | route | natroute }

Sets the bridge or router mode:
bridge
Specifies bridge mode.
route
Specifies router mode without NAT services.
natroute
Specifies router mode with NAT services.

setWanIp Syntax: one of:

setWanIp static {ipaddr} {netmask}

setWanIp dynamic

Sets a static or dynamic IP address. The parameters are:

dynamic
Specifies a dynamic address. The IP address and netmask are fur-
nished by an external DHCP server.
static
Specifies a static address. This requires the two following parame-
ters.
ipaddr
The static IP address.
netmask
The subnet mask for the static IP address.

setWanGateway Syntax: setWanGateway {ipaddr}

Sets the IP address of the default gateway, for networks that do not provide
this information using DHCP.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 509

setWanDns Syntax: one of:

setWanDns {primary} [secondary]

setWanDNS auto

Sets the IP address of the primary and (optional) secondary DNS servers, for
networks that do not provide this information using DHCP.
Specify the auto keyword to use DNS information provided by DHCP.

showWan Displays configured IP information for static assignments.

setDhcpEnable Syntax: setDhcpEnable {flag}

Enables or disables the local DHCP service. The flag is either 0 to disable
DHCP service, or 1 to enable.

setDhcpPool Syntax: setDhcpPool {startip} {endip}

Configures the address pool for local DHCP service. The parameters are:
startip
The first IP address in the DHCP pool. This must be the entire
address.
endip
The last IP address in the DHCP pool.

setLanIp Syntax: setLanIp {ipaddr} {netmask}

Sets the static LAN IP address. The parameters are:
ipaddr
The static IP address.
netmask
The subnet mask for the static IP address.

setTACACSServer Syntax: setTACACSServer {ipaddr} [port]

Sets the IP address and optional listening port for the TACACS+ server. The
default port is 49.

setTACACSSecret Syntax: setTACACSSecret {key}

Sets the authentication key used to access the TACACS+ server.

Firmware Guide Release 7.5 Standard 1.2 August 2012

510 Chapter 9

showTACACS Displays the configured TACACS+ information.

setRipEnable Syntax: setRipEnable {flag}

Enables or disables RIP on the router. Set the flag to 0 to disable RIP, or 1 to
enable.

setRipIp Syntax: setRipIp {ipaddr} {netmask}

Sets the RIP IP address and subnet mask.

setRipAuth Syntax: setRipAuth {mode}

Sets the RIP authorization mode. The mode is one of: none, text, or MD5.

setRipKeyId Syntax: setRipKeyId {key}

For MD5 authentication, sets the RIP key ID to use for authentication. Valid
range: 1 to 255.

setRipDhcpEnable Syntax: setRipDhcpEnable {flag}

Enables or disables local DHCP service for the RIP subnet. The flag is either
0 to disable DHCP service, or 1 to enable.

showRip Displays the configured RIP information.

setRipLogMask Syntax: setRipLogMask {mask}

Sets RIP logging. The mask is a bitmask, controlling the following logging
types:
1: RIP events
2: RIP packets
4: Zebra

showRipLog Syntax: showRipLog {action}

Controls RIP logging. The action is one of the following:
0: Disable realtime RIP logging
1: Enable realtime RIP logging
2: Dump the accumulated log buffer, then clear the log buffer

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 511

setHttpWanAc- Syntax: setHttpWanAccess {flag}

cess Enables or disables access to the web interface from the WAN (RF) port.

setHttpLanAccess Syntax: setHttpWanAccess {flag}

Enables or disables access to the web interface from the LAN (Ethernet,
wireless) ports.

showHttpAccess Displays the current web interface access configuration.

setEthernet Syntax: setEthernet {port} {status} { auto | {mode} {speed} }

Configures the specified Ethernet port. The parameters are:
port
The port to configure. Valid range: 0 to 3.
status
The port status, either up or down.
auto
Allow the specified port to auto-negotiate the duplex mode and
connection speed.
mode
Specifies the duplex mode, either 0 for half-duplex, or 1 for full-
duplex.
speed
Specifies the connection speed; one of: 10M, 100M, or 1G.

showEthernet Displays the current Ethernet configuration.

showStatus Displays the following information:

• WAN IP configuration (equivalent to showWan)
• Router and DHCP configuration
• Ethernet configuration (equivalent to showEthernet)
• TACACS+ configuration (equivalent to showTACACS)
• Web page access (equivalent to showHttpAccess)
• RIP configuration (equivalent to showRip)

Firmware Guide Release 7.5 Standard 1.2 August 2012

512 Chapter 9

resetDefaults reset to factory default settings

commit commit changes

status Show Modem Status

!reset Reset Modem

Telemetry Menu

You can enter a Telemetry sub-mode command without entering Telemetry

sub-mode by preceding any of the following commands with / tlm. In
Telemetry sub-mode, the prompt is Telemetry>.
Telephony Modems without battery backup capability hide the tlm sub-
mode.

/ Returns to the Console> prompt.

chgrStatus Shows the status of the Model 5 or Model 6 battery charger. Not supported
in multi-line Telephony Modems.
Example:
[ 5] TLM> chgr
Failure Status: No Failures

Return Status: 1

tlmStatus Displays general battery telemetry status and active alarms, if any.
Example:
[ 7] TLM> tlmStatus
tlmStatus
-- Battery 1 --
BatteryStatus = BATTERY REPLACE
BatterySubStatus=
HexUpsValue = 0xd0
testInProgress = 0
testIsPending = 0
Active Battery Level Alarms: None

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 513

-- Active System Alarms --

None

tapi Syntax: tapi [cmd value]

Reads and writes provisionable charger-related MIB objects. With no param-
eters, this command displays all provisionable MIB objects and their values.
The parameters are:
cmd
(optional) The MIB object to display or change:
Value MIB Object
0 upsBatteryStatus
1 arrisMtaDevPwrSupplySecondsOnBattery
2 upsConfigLowBattTime
3 arrisMtaDevPwrSupplyConfigRunTime
4 arrisMtaDevPwrSupplyConfigReplaceBatTime
5 upsEstimatedChargeRemaining
6 arrisMtaDevPwrSupplyBatRatedMinutes
7 arrisMtaDevPwrSupplyBatAvailableMinutes
8 upsEstimatedMinutesRemaining
9 arrisMtaDevBatteryOperState
10 arrisMtaDevBatteryOperSubState
11 arrisMtaDevBatteryEprom
12 arrisMtaDevPwrSupplyBatteryTest
13 arrisMtaDevPwrSupplyBatteryTestTime
14 arrisMtaDevPwrSupplyFullChargeTime
15 arrisMtaDevPwrSupplyReadBatteryPwr
16 arrisMtaDevPwrSupplyTelemetryValues
17 arrisMtaDevPwrSupplyTemperature
18 upsAlarmsPresent
19 upsOutputSource
20 upsSecondsOnBattery
21 arrisMtaDevPwrSupplyEnableDataShutdown
22 arrisMtaDevPwrSupplyDataShutdownTime
23 arrisMtaDevPwrSupplyHiTempBatteryShutdownControl
24 arrisMtaDevPwrSupplyOverTempAlarmControl
25 arrisMtaDevPwrSupplyOverTempAlarmThreshold
26 arrisMtaDevPwrSupplyHighestTemperature
27 arrisMtaDevPwrSupplyHighestTemperatureTime
28 arrisMtaDevPwrSupplyHighestTemperatureClear
29 arrisMtaDevBatteryChargerFWRev
30 arrisMtaDevPwrSupplyControlChargerReset
31 LogRepeatInterval
32 upsIdentManufacturer
33 upsIdentModel
34 upsIdentAgentSoftwareVersion
35 upsIdentName

Firmware Guide Release 7.5 Standard 1.2 August 2012

514 Chapter 9

Value MIB Object

36 upsIdentAttachedDevices
37 upsInputNumLines
38 upsOutputNumLines
39 upsShutdownType
40 upsShutdownAfterDelay
41 upsStartupAfterDelay
42 upsRebootWithDuration
43 arrisMtaDevBatteryLastStateChange
44 arrisMtaDevBatteryOrderingCode
45 arrisMtaDevEstimatedMinutesRemaining
46 arrisMtaDevEstimatedChargeRemaining

value
(optional) The value to write to the selected MIB object.

eprom Verifies the battery EPROM checksums (if a battery is installed) and displays
battery manufacturing data.
Example:
[ 6] TLM> eprom
eprom
EPROM Data Revision: A
PCB Assy Part Number: 00884
PCB Assembly Revision: C
PCB Assembly Test Code: ee
Cell Manufacturer: MI
Cell Manufacturer Factory Location: 1
Cell Lot: 018603
Cell Capacity: 6.6 ah
Pack Serial Number: 08065000715
PCB Assembly Test Code: ee

Return Status: 1

Returns: 1 to indicate a valid checksum and 0 to indicate a bad checksum.

resetChrgr Internal use only: Resets the battery charger.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 515

Database Menu

display Displays current database values.

Example:
[ 13] database> disp

DB Contents:
Num Lines - 2
LC Type - 4
Ethernet - 1
USB - 1
Router - 0
Telemetry - 1
Tuner HW - 0
Market - 0 (NA)
MultiColor LEDs - 0
Ethernet HW - 0
Model Number - 0
NA Dual Mode - 0
HW Model - TM802G
HW Info - ARRIS DOCSIS 3.0 / PacketCable 1.5
Touchstone Telephony Modem
Image Name - TS07010X_091609_ARRIS_TM
HTTP PW Check - 1
HTTP Timeout - 0
CLI PID - 0
PTY PID - 20635
PTY interface - wan0
PTY owner - 1
Telnet/SSH timeout - 1440
App Mode Enabled - 1
Packet Processor Enabled - 1
MultiColor LED Bitmap - 0
Secondary DS Reinit - 0
Partial Service Fallback 2.0 - 0
PartServ Fallback 2.0 Active - 0
FLASH Manufacturer - SPANSION
Config File MIB Bitmap - 0x0
MAC and IP/FQDN event hiding flag - 0

Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

516 Chapter 9

byteget Syntax: byteget {addr}

Displays a byte value from the specified database address.

intget Syntax: intget {addr}

Displays an integer value from the specified database address.

RF Menu

The RF menu commands provide extensive control over the Telephony

Modem RF interface.

dstatus Syntax: dstatus [channel]

Displays the downstream status for the specified channel. The valid range for
channel is 0 to 7, or an asterisk (*) to display all channels. Do not specify a
channel to see a listing of all channels in table format.
Example:
[ 32] RF> dstatus 0

PHY Status of channel 0

========================
Current PHY status:
RF frequency: 741.001953 MHz
IF frequency: 77998352 Hz
Qam mode : 64 QAM
Annex: ANNEX-A (Euro)
MSE: -36.124 dB
IF AGC -57
RF AGC 4.100 [dB] ( ATTN = 0, RL = 6, DNC = 76 )
Energy backoff: -29.517 dB
Annex A interleaver mode: I=12, J=17
CW Error Rate: 4.15e-07
QAM Lock: YES
FEC Sync: YES
MPEG Sync: YES
Carrier offset is -14524.002 Hz
Timing offset: 11 ppm
Burst counter = 1
Llp up/down counter = 0 / 0
Lost 1/100/500 counters = 1 / 1 / 1
Reported power is 10.9284 dBmv

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 517

Return Status: 0

ustatus Displays the upstream status.

Example:
[ 34] RF> ustat
PGA (ANAD-ARA2017) codeword is 31
PGA current is 7
Digital Att : 3.385223 9.127320 9.127320 9.127320
Frquency : 25.000128 10.000000 10.000000 10.000000
Symbol rate : 2560 5120 5120 5120
modulation : 8QAM ERR ERR ERR
SCDMA mode : 0 0 0 0
rep power : 55.7500 13.0000 13.0000 13.0000
Upstream : 1 0 0 0

Return Status: 0

freqband Displays the downstream frequency band, in Hz.

Example:
[ 3] RF> freqband

Downstream Frequency Band: 91000000 - 999000000

Return Status: 0

tune Syntax: tune {freq}

Tunes to a frequency. The parameter is:
freq
The frequency, in MHz

dfreq Syntax: dfreq {channel} {freq}

Changes the downstream frequency for the specified channel. The parame-
ters are:
channel
The channel to change. Valid range: 0 to 7, or an asterisk (*) to
change all channels.
freq
The frequency, in MHz.

Firmware Guide Release 7.5 Standard 1.2 August 2012

518 Chapter 9

ufreq Syntax: ufreq {channel} {freq}

Changes the upstream frequency for the specified channel. The parameters
are:
channel
The channel to change. Valid range: 0 to 3, or an asterisk (*) to
change all channels.
freq
The frequency, in MHz.

wbdfreq Syntax: wbdfreq {freq0} {freq1} {freq2} {freq3}

Changes all downstream tuners to the specified frequencies, in MHz.

nbdfreq Syntax: nbdfreq {channel} {freq}

Changes the downstream receiver specified by channel to the specified fre-
quency, in MHz.

clearfreq Clears all downstream frequencies.

sweep Syntax: sweep {upstream} {start_freq} {stop_freq} {step} {dwell} {gain}

Sweeps an upstream across the specified range. The parameters are:
upstream
The upstream channel to use for the sweep.
start_freq
The starting upstream frequency, in Hz.
stop_freq
The ending upstream frequency, in Hz.
step
The step, in Hz, between each frequency.
dwell
The dwell time, in milliseconds, that the upstream transmits on the
frequency.
gain
The transmit level, in dB, over dBm0.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 519

trr Syntax: trr {tuner} {reg}

Reads the specified tuner register. The parameters are:
tuner
The tuner number: 1 to 8.
reg
The register to read.

trw Syntax: trw {tuner} {reg} {value}

Writes a value to the specified tuner register. The parameters are:
tuner
The tuner number: 1 to 8.
reg
The register to write.
value
The value to write to the specified register.

dtune Syntax: dtune {freq}

Moves the tuner’s starting CBW to the specified frequency (in MHz).

dlock Syntax: dlock {dschan} {freq}

Attempts to lock the specified downstream channel on a particular frequency.
The parameters are:
dschan
The downstream channel number to affect, or * to attempt to lock
all channels.
freq
The frequency, in MHz, to try.

scanmode Syntax: scanmode {flag}

Sets the scanning mode. Use 1 to start scanning, or 0 to stop scanning.

printscan Displays information about the scanning engine.

Example:

Firmware Guide Release 7.5 Standard 1.2 August 2012

520 Chapter 9

[ 10] RF> printscan

Multi Demod Scan Enabled: 0

Scanning Engine Mode: WB
Scanning State: 0 (QAM Detection)
Next Scan Freq Table [0]:

Tuner 1:
-------------------------------------
Enabled: 1
Center freq: 0 Hz
Bandwidth: 96000000 Hz
Receivers [4]: 1 2 3 4

Tuner 2:
-------------------------------------
Enabled: 0
Center freq: 0 Hz
Bandwidth: 96000000 Hz
Receivers [4]: 5 6 7 8

Return Status: 0

dump Syntax: dump {block}

Dumps the specified block of PHY registers. The block is one of the follow-
ing:
0: global registers
1: downstream registers
2: upstream registers
3: Rx/Tx registers

Example:
[ 42] RF> dump 0
PHY Global Registers:
[C0] 0000
[C1] 0000 [C2] 0006 [C3] 0000 [C4] 0000
[C5] 0000 [C6] 0000 [C7] 0000 [C8] 0000
[C9] 01D0 [CA] 0003 [CB] 2115 [CC] 2121
[CD] 00FF [CE] 0000 [CF] 0000 [D0] 0004
[D1] 0000 [D2] 0000 [D3] 0000 [D4] 0000
[D5] 0000 [D6] 0000 [D7] 0000 [D8] 0000
[D9] 0000 [DA] 0000 [DB] 0000 [DC] 1004
[DD] 0000 [DE] 0000 [DF] 0000

Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 521

read Syntax: read {reg}

Displays the contents of the specified PHY register.
Example:
[ 36] RF> read 0xcc
Value of register 0xcc is:0x5252

Return Status: 0

write Syntax: write {reg} {value}

Writes the specified value to a PHY register.

macread Syntax: macread {reg}

Reads the specified MAC register address.

macwrite Syntax: macwrite {reg} {value}

Writes the specified value to the register.

cache Displays the upstream and downstream frequency caches.

Example:
[ 44] RF> cach
DS frequency db in NVRAM:

Number of cached freq = 2

Head = 3
Tail = 0
Place 0 - DS freq = 0
Place 1 - DS freq = 0
Place 2 - DS freq = 0
Place 3 - DS freq = 741000
Place 4 - DS freq = 112000
Place 5 - DS freq = 0

US frequency db in NVRAM:

Place 0 - UCID = 0 (DS = 0) , gain = 0.000000

Place 1 - UCID = 0 (DS = 0) , gain = 0.000000
Place 2 - UCID = 0 (DS = 0) , gain = 0.000000
Place 3 - UCID = 1 (DS = 741) , gain = 62.180000
Place 4 - UCID = 1 (DS = 112) , gain = 33.750000
Place 5 - UCID = 0 (DS = 0) , gain = 0.000000

Firmware Guide Release 7.5 Standard 1.2 August 2012

522 Chapter 9

Return Status: 0

clearcw Syntax: clearcw {channel}

Clears the codeword error counters for the specified channel. The valid range
for channel is 0 to 3, or an asterisk (*) to display all channels.

dsavg Syntax: dsavg {channel}

Samples and averages the downstream energy for the specified channel.
Valid range: 0 to 7, or * to specify all channels.

[ 45] RF> dsavg *

Average of Last 16 Downstream Samples

MSE -14.094 dB
Carrier Offset 0.000 kHz
CW Error Rate 0.00e+00

ifAGC Gain -23

rfAGC Gain 0.900
Estimated Power 24.631 dBmV

QAM Lock NO
FEC Sync NO
MPEG Sync NO

=== Press any key to stop test ===

Return Status: 0

cert Syntax: cert {channel}

Performs a codeword error rate test on the specified channel. Valid range: 0
to 3.
Example:
[ 13] RF> cert 0
Starting Codeword Error Test on chan 0

=== Press any key to stop test ===

Time CER CORR_CER CORR UNCORR RECVD MER IF_AGC RF_AGC RF_Level

1 0.00e+00 0.00e+00 0 0 25510 -39.346 -25 0.800 6.423

2 0.00e+00 0.00e+00 0 0 26834 -39.346 -21 0.800 6.253

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 523

3 0.00e+00 0.00e+00 0 0 26841 -39.346 -26 0.800 6.438

4 0.00e+00 0.00e+00 0 0 26832 -39.346 -25 0.800 6.290
5 0.00e+00 0.00e+00 0 0 26838 -39.346 -26 0.800 6.327
6 0.00e+00 0.00e+00 0 0 26836 -39.346 -25 0.800 6.357
7 0.00e+00 0.00e+00 0 0 26837 -39.346 -26 0.800 6.408

Return Status: 0

tunerset Syntax: tunerset {tuner} {freq} {bandwidth}

Sets the specified wideband tuner. The parameters are:
tuner
The tuner to set: 1 or 2.
freq
The frequency, in MHz, for the tuner.
bandwidth
The bandwidth, in MHz, for the tuner.

channelset Syntax: channelset {downstream} {freq} {tuner}

Sets the specified downstream channel. The parameters are:
downstream
The downstream to set.
freq
The frequency, in MHz, for the channel.
tuner
The tuner to set: 1 or 2.

printds Prints the downstream calibration tables.

Example:
[ 78] RF> printds

Table refChannel:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000

Firmware Guide Release 7.5 Standard 1.2 August 2012

524 Chapter 9

ifReg - 362.000000
Det - 34.994617

Table capTrimAvrg:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

CapTrimAvg
127.849998

Table ifVga:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

ifReg ifVGA_dB Pin

85.000000 20.000000 40.000000
100.000000 19.000000 39.000000
116.000000 18.000000 38.000000
141.000000 16.000000 36.000000
169.000000 14.000000 34.000000
195.000000 12.000000 32.000000
224.000000 10.000000 30.000000
251.000000 8.000000 28.000000
279.000000 6.000000 26.000000
307.000000 4.000000 24.000000
334.000000 2.000000 22.000000
362.000000 0.000000 20.000000

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 525

Table gcDnc:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

GcDNC GcDNC_dB ifReg

0.000000 -5.931034 196.000000
24.000000 -4.827586 212.000000
66.000000 -3.111111 236.000000
84.000000 -2.000000 251.000000
105.000000 -0.928572 266.000000
127.000000 0.000000 279.000000

Table aaf:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

FrADC AAF_dB Det

30.000000 0.159882 35.154499
36.000000 0.159882 35.154499
42.000000 0.214512 35.209129
48.000000 0.000000 34.994617
54.000000 0.000000 34.994617
60.000000 0.000000 34.994617
66.000000 0.000000 34.994617
72.000000 -0.052010 34.942608
78.000000 -0.052010 34.942608
84.000000 0.000000 34.994617
90.000000 0.000000 34.994617
96.000000 -0.052010 34.942608

Firmware Guide Release 7.5 Standard 1.2 August 2012

526 Chapter 9

102.000000 0.000000 34.994617

108.000000 0.000000 34.994617
114.000000 0.214512 35.209129
120.000000 2.030746 37.025364
126.000000 2.115082 37.109699

Table clearTune:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

FrIN SlopeLow CrossoverLow SlopeHigh CrossoverHigh

Cleartune_dB Det NoiseCor
88.000000 11.737700 76.914558 0.000000 0.000000
3.274406 37.025364 -1.243660
105.182198 11.737700 76.914558 -26.985901 133.449829
2.315369 36.123600 -1.186386
159.313873 10.376100 133.449829 -21.952499 185.177948
0.953938 34.942608 -1.005947
211.003647 11.821000 185.177948 -19.815800 236.816559
1.103447 34.942608 -1.155457
263.294312 14.030700 236.816559 -18.430201 289.759247
1.202691 34.994617 -1.202691
317.029663 15.042400 289.759247 -17.761801 344.300049
1.060740 34.994617 -1.060740
372.209686 15.009700 344.300049 -18.191500 400.132141
0.886143 34.994617 -0.886143
428.246368 14.887500 400.132141 -17.090401 456.360565
0.541331 34.994617 -0.541331
483.937836 13.975900 456.360565 -15.927900 511.502289
0.251285 35.047260 -0.198643
541.866638 13.218500 511.502289 -14.044400 572.231018
0.000000 34.994617 0.000000
604.692139 17.750200 572.231018 -18.449699 637.153259
-0.082806 34.942608 0.030797
664.819946 20.034201 637.153259 -18.277100 692.486755
0.051136 34.942608 -0.103146
720.358032 18.764999 692.486755 -20.194000 748.216553
0.261826 34.994617 -0.261826
775.192932 19.616600 748.216553 -18.550100 802.156433

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 527

0.253118 34.942608 -0.305127

828.672546 19.405701 802.156433 -19.365601 855.201416
0.489780 35.209129 -0.275268
881.410706 22.812799 855.201416 -20.702900 907.632690
1.342358 36.191994 -0.144982
934.251099 22.898500 907.632690 -19.413799 960.869446
1.871715 37.025364 0.159031
986.886902 21.781900 960.869446 -19.142000 1012.917175
1.785198 37.464420 0.684605
1038.576660 28.160400 1012.917175 -28.170099 1064.248901
5.364141 41.175098 0.816340

Table gcAttn:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

FrIN GcATTN GcATTN_dB ifReg

91.043259 0.000000 -8.278325 221.000000
91.043259 32.000000 -6.589947 244.000000
91.043259 128.000000 -3.142857 292.000000
91.043259 200.000000 0.000000 335.000000
372.209686 0.000000 -8.571428 162.000000
372.209686 32.000000 -6.532967 189.000000
372.209686 128.000000 -2.960318 239.000000
372.209686 200.000000 0.000000 280.000000
557.046265 0.000000 -8.642857 159.000000
557.046265 32.000000 -6.467033 188.000000
557.046265 128.000000 -2.891534 238.000000
557.046265 200.000000 0.000000 278.000000
664.819946 0.000000 -9.214286 146.000000
664.819946 32.000000 -6.802197 179.000000
664.819946 128.000000 -2.904761 233.000000
664.819946 200.000000 0.000000 273.000000
848.208008 0.000000 -9.285715 157.000000
848.208008 32.000000 -6.582417 193.000000
848.208008 128.000000 -2.798942 246.000000
848.208008 200.000000 0.000000 285.000000
934.251099 0.000000 -9.181318 175.000000
934.251099 32.000000 -6.539409 211.000000

Firmware Guide Release 7.5 Standard 1.2 August 2012

528 Chapter 9

934.251099 128.000000 -2.857143 262.000000

934.251099 200.000000 0.000000 302.000000

Table gcRl:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

FrIN GcRL GcRL_dB ifReg

91.043259 0.000000 -2.857143 296.000000
91.043259 4.000000 -2.571429 300.000000
91.043259 26.000000 -1.256614 318.000000
91.043259 48.000000 -0.071429 334.000000
91.043259 50.000000 0.000000 335.000000
557.046265 0.000000 -2.661376 244.000000
557.046265 4.000000 -2.439153 247.000000
557.046265 26.000000 -1.142857 265.000000
557.046265 48.000000 -0.142857 279.000000
557.046265 50.000000 0.000000 281.000000
841.937012 0.000000 -2.500000 252.000000
841.937012 4.000000 -2.214285 256.000000
841.937012 26.000000 -1.142857 271.000000
841.937012 48.000000 -0.071428 286.000000
841.937012 50.000000 0.000000 287.000000

Table saw:

Pin - 1.013340
frIN - 541.866638
gcATTN - 200.000000
gcRL - 50.000000
frSAW - 1247.000000
gcDNC - 127.000000
frADC - 74.000000
bo_Ref - 20.009022
ifVGA - 0.000000
ifReg - 362.000000
Det - 34.994617

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 529

FrSAW SAW_dB Det

1193.000000 -0.052010 34.942608
1199.000000 -2.392841 32.601776
1205.000000 -1.881317 33.113300
1211.000000 -2.392841 32.601776
1217.000000 -1.453796 33.540821
1223.000000 -2.362579 32.632038
1229.000000 -1.416195 33.578423
1235.000000 -0.540497 34.454121
1241.000000 -0.052010 34.942608
1247.000000 0.000000 34.994617
1253.000000 -1.223145 33.771473
1259.000000 -1.881317 33.113300
1265.000000 -2.482391 32.512226
1271.000000 -2.511837 32.482780
1277.000000 -1.847256 33.147362
1283.000000 -1.183483 33.811134
1289.000000 -0.852432 34.142185
1295.000000 -0.631931 34.362686
1301.000000 0.159882 35.154499
1307.000000 2.115082 37.109699

Return Status: 0

printus Prints the upstream calibration tables.

Example:
[ 79] RF> printus
PGA Attenuators calibration table:
Table Version: 0
PGA step factor= 2
Current Mode Factor= 7
Actual Power delta= 0.000

Attenuation=0 Power= 61.340 Delta= 0.000

Attenuation= 2 Power=59.090 Delta=0.250
Attenuation= 4 Power=56.960 Delta=0.380
Attenuation= 8 Power=52.780 Delta=0.560
Attenuation=16 Power=44.590 Delta=0.750
Attenuation=32 Power=28.200 Delta=1.140

Current Mode Factor calibration table:

Table Version: 0
PGA step factor=2
Actual Power delta=0.000
PGA Code Word=25

Firmware Guide Release 7.5 Standard 1.2 August 2012

530 Chapter 9

CMF=7 Power=0.000 Delta=0.000

CMF=6 Power=0.000 Delta=0.220
CMF=5 Power=0.000 Delta=0.540
CMF=4 Power=0.000 Delta=0.980
CMF=3 Power=0.000 Delta=2.110
CMF=2 Power=0.000 Delta=4.440
CMF=1 Power=0.000 Delta=7.170

Frequency calibration table:

Table Version: 0
PGA step factor=2
Actual Power delta=0.000
PGA Code Word=25
Current Mode Factor=7

Freq=5.100 Power=48.580 Delta=0.000

Freq=10.000 Power=48.880 Delta=0.300
Freq=20.000 Power=48.750 Delta=0.170
Freq=30.000 Power=48.640 Delta=0.060
Freq=40.000 Power=48.270 Delta=-0.310
Freq=50.000 Power=47.650 Delta=-0.930
Freq=60.000 Power=46.720 Delta=-1.860
Freq=63.000 Power=46.580 Delta=-2.000
Freq=64.900 Power=46.400 Delta=-2.180
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000
Freq=0.000 Power=0.000 Delta=0.000

!appmode Switches the E-UE to application mode and reboots.

!ecache Erases the downstream and upstream frequency caches.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 531

Gateway Commands

The Gateway sub-menu provides commands to provision, monitor, and con-

trol the Wireless Remote Module (WRM).
To enter the Gateway sub-menu, enter gw at the Console prompt. The Gate-
way prompt is gw>

get Syntax: get [variable]

Displays the specified WRM provisioning setting, or all variables if none is
specified. See ‘‘Valid Variables’’ on page 534 for a list of valid variables.
Example:
[ 43] gw> get wifiBssid[0]
wifiBssid[0]=bench39

set Syntax: set {variable} {value}

Sets the value of a WRM variable. If the variable is currently not defined, the
console prints the error message Nvram variable not found. See
‘‘Valid Variables’’ on page 534 for a list of valid variables.
Example:
[ 83] gw> get wifiBssid[0]
wifiBssid[0]=bench39

[ 84] gw> set wifiBssid[0] newSSID

[ 85] gw> get wifiBssid[0]

wifiBssid[0]=newSSID

search Syntax: search {substring}

Displays WRM variables whose names or values contain the specified sub-
string.
Example:

Firmware Guide Release 7.5 Standard 1.2 August 2012

532 Chapter 9

[ 70] gw> search ssid

wifiBssidBroadcast[0]=1
wifiBssidBroadcast[1]=1
wifiBssidBroadcast[2]=1
wifiBssidBroadcast[3]=1
wifiBssid[0]=aaa
wifiBssid[1]=ARRIS_GW
wifiBssid[2]=ARRIS_GW
wifiBssid[3]=ARRIS_GW
wl_ssid=ARRIS
wl0_ssid=ARRIS
guest_ssid=ARRIS_GUEST
interface=wan1,wan2,wan3,wan4,wan5,wan6,wan7,wan8,
vlan1,vlan2,vlan3,vlan4,ssid1,ssid2,ssid3,ssid4,
PhonePort(1&2)

rc Syntax: rc {service} {action}

Controls WRM applications. The parameters are:
service
The service name, one of: wan, firewall, or the AP name.
action
The action to perform, one of: start, stop, restart, or create.
Example:
# restart firewall services
[ 72] gw> rc firewall restart

reset Unconditionally reboots the WRM.

ping Queries the WRM.

Example:
[ 26] Gateway> ping
WRM is alive

tr69Start Starts the TR-069 process.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 533

tr69Update Updates the TR-069 process.

tr69Stop Stops the TR-069 process.

dmz Syntax: dmz [ipaddr]

Controls the DMZ feature. Omit the optional ipaddr to display the current
DMZ settings. To disable DMZ, set the ipaddr to 0.
The IP address should be part of the WAN subnet.
Example:
[ 29] Gateway> dmz
fwDmzEn=0
fwDmzIp4=

commit Commits new settings to the WRM. This command must be used to update
the WRM with changes to the provisioned values. Use this command after
one or more set, create, or delete commands. Multiple commands can be
followed by a single commit.
Note: Using this command restarts the WRM.

!defaults Resets the WRM to factory defaults. This discards all user provisioning.

wrmStatus Shows the status of the WRM.

Example:
[108] gw> wrmStatus
WRM state is: WRM_STATUS_ACTIVE

xmlStatus Displays the XML status.

Example:

Firmware Guide Release 7.5 Standard 1.2 August 2012

534 Chapter 9

[ 47] Gateway> xmlStat

XML CONFIGURATION:

Status = (5)fileNotFound
Url Path = tftp://10.1.50.69/cm0015d13aa54a/loc_mib_format_sample2.x
Req CMD = ’/gw/usr/sbin/tftp
File Size = 0

DNS Servers(s)...
nameserver 10.1.50.69

XML configuration file has not been retrieved

Return Status: 0

xmlRestart Restarts XML provisioning, attempting to download the XML provisioning

file. This may be useful when the TFTP server was unreachable at provision-
ing time, or if the provisioning file is updated.

xmlLog Displays the XML parsing log.

Valid Variables This section defines the variables that are configurable using the Gateway
CLI commands.

WAN Variables

The following variables apply to the WAN (cable) interface.

ID Purpose Type Range / Example Default
0: Dynamic 0
wanConnType WAN port connection type Numeric 1: Static
5: L2TP
wanConnHostname Host name String ‘‘MyHost’’ ‘‘ARRISGW’’
Enable/Disable MAC 0: Disable
wanConnMacClonning Boolean 0
address cloning 1: Enable
wanConnMacAddr Cloned MAC address MAC addr xx:xx:xx:xx:xx:xx N/A
IP address of WAN
wanConnIp4 IP addr xxx.xxx.xxx.xxx N/A
interface (IPv4)
Subnet mask of WAN
wanConnMask4 IP addr xxx.xxx.xxx.xxx N/A
interface (IPv4)
wanConnGw4 Gateway address (IPv4) IP addr xxx.xxx.xxx.xxx N/A
wanConnUsername Username of connection account String ‘‘myusername’’ N/A
wanConnPassword Password of connection account String ‘‘mypassword’’ N/A

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 535

ID Purpose Type Range / Example Default

0: Disable
wanConnIdleEn Enable/Disable idle timeout Boolean 0
1: Enable
wanConnIdleSec Idle timeout seconds Numeric 3600 (seconds) 300
PPTP/L2TP Server
wanConnServerIp4 IP addr xxx.xxx.xxx.xxx N/A
IP address (IPv4)
IP address of physical
wanConnLocalIp4 IP addr xxx.xxx.xxx.xxx N/A
interface (IPv4)
Subnet mask of physical
wanConnLocalMask4 IP addr xxx.xxx.xxx.xxx N/A
interface (IPv4)
Type of IP address 0: Dynamic (DHCP)
wanConnL2tpType Boolean 0
assignment 1: Static
0: Disable
wanConnKeepaliveEn Enable/Disable keep alive Boolean 0
1: Enable
wanConnKeepaliveSec Keep alive seconds Numeric 5 (seconds) 5
Primary DNS server
wanDnsPriIp4 IP addr xxx.xxx.xxx.xxx N/A
IP address (IPv4)
Secondary DNS server
wanDnsSecIp4 IP addr xxx.xxx.xxx.xxx N/A
IP address (IPv4)
0: Disable
wanDnsFromIspEn Get DNS server(s) from ISP Boolean 1
1: Enable
wanSetApply Restart WAN Configuration Boolean 0 N/A
wanDnsApply Restart WAN DNS Configuration Boolean 0 N/A
Restart WAN MAC Cloning
wanMacApply Boolean 0 N/A
Configuration
wanIfName WAN interface name String xxxxxxxxx ‘‘lbr0’’
0: Disable (bridge)
1: IPv4
waneRouteMode eRouter mode 3
2: IPv6
3: IPv4 and IPv6
0–1500
0: Disable
TlvCpeAccess TLV config CPE access SNMP Boolean 1
1: Enable
0: Disable
TlvCmAccess TLV config CM access SNMP Boolean 1
1: Enable
0: Disable
TlvWanAccess TLV config WAN access SNMP Boolean 1
1: Enable

LAN Variables

The following variables apply to the general LAN (wireless and Ethernet)
interfaces.
ID Purpose Type Range / Example Default
lanIndex Index of LAN Numeric 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

536 Chapter 9

ID Purpose Type Range / Example Default

lanIface[n] LAN interface String ‘‘lan’’ ‘‘lan’’
wifiIface[n] Wireless interface String ‘‘ARRIS_GW’’ ‘‘ARRIS_GW’’
IP address of LAN
lanConnIp4[n] IP addr xxx.xxx.xxx.xxx 192.168.2.1
interface (IPv4)
Subnet mask of LAN
lanConnMask4[n] IP addr xxx.xxx.xxx.xxx 255.255.255.0
interface (IPv4)
lanVid 802.1q VLAN ID Numeric 1 1
Enable/Disable DHCP 0: Disable
lanDhcpEn[n] Boolean 1
server on LAN 1: Enable
Start address of DHCP
lanDhcpStart4[n] IP addr xxx.xxx.xxx.xxx 192.168.2.101
pool (IPv4)
End address of DHCP
lanDhcpEnd4[n] IP addr xxx.xxx.xxx.xxx 192.168.2.200
pool (IPv4)
lanDhcpLeaseTimeAmount[n] DHCP lease time Numeric 1
0: Forever
1: Minutes
lanDhcpLeaseTime[n] DHCP lease time units Numeric 2: Hours 4
3: Days
4: Weeks
lanDhcpDomain[n] DHCP domain name String ‘‘arris.com’’ N/A
0: Disable
lanRateLimitEn Enable/Disable Rate limit Boolean 0
1: Enable
lanRateLimitDownlink Downstream rate limit Numeric 40–100000 kb/s 100000
lanRateLimitUplink Upstream rate limit Numeric 40–100000 kb/s 100000
0: Disable
landnsRelay DNS Relay Boolean 1
1: Enable
Index of Fixed DHCP
lanFixedDhcpIndex Numeric 1 N/A
list record
lanFixedDhcpName Client name String ‘‘arris-pc’’ N/A
lanFixedDhcpIp4 Client static IP address IP addr xxx.xxx.xxx.xxx N/A
lanFixedDhcpMac Client MAC address MAC addr xx:xx:xx:xx:xx:xx N/A
Index of DHCP
lanDhcpLeaseIndex Numeric 1 N/A
lease record
Host name of DHCP
lan_dhcp_lease_host[n] String ‘‘myhost’’ N/A
lease record
MAC address of DHCP
lan_dhcp_lease_mac[n] MAC addr xx:xx:xx:xx:xx:xx N/A
lease record
lan_dhcp_lease_comment[n] Lease description String N/A
Connection method of
lan_dhcp_lease_connection[n] String Ethernet, Wifi N/A
DHCP lease record
IP address of DHCP
lan_dhcp_lease_ip4[n] IP addr xxx.xxx.xxx.xxx N/A
lease record
IP Type of DHCP 0: Static
lan_dhcp_lease_type[n] Boolean N/A
lease record 1: DHCP

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 537

ID Purpose Type Range / Example Default

0: Disable
lanRipEn Enable/Disable RIP Boolean 0
1: Enable
RIP advertisement
lanRipUpdateInterval Numeric 30 (seconds) 30
interval
lanRipIndex Index of Lan RIP Numeric 1 N/A
lanRipIface[n] RIP interface String ‘‘lan’’ lan
0: Disable
lanRipIfaceEn[n] Enable/Disable RIP Boolean 0
1: Enable
0: none
lanRipSendVer[n] RIP Send Version Numeric 1: v1 2
2: v2
0: NoAuth
lanRip2Auth[n] RIP-2 Authentication Numeric 1: Plain text 0
2: MD5
lanRipSecret[n] RIP Secret String ‘‘arris’’ N/A
lanRouteIndex Index of LAN Route Numeric 1 N/A
Destination IP of
lanRouteDestIp4 IP addr xxx.xxx.xxx.xxx N/A
route table (IPv4)
Subnet mask of route
lanRouteMask4 IP addr xxx.xxx.xxx.xxx N/A
table (IPv4)
Gateway of route
lanRouteGw4 IP addr xxx.xxx.xxx.xxx N/A
table (IPv4)
LanRouteMetric Metric of route table Numeric 1 N/A
LanRouteIface Interface of route table String br-lan N/A
Index of Lan Route
LanRoutePolicieIndex Numeric 1 N/A
Policy
Destination IP of routing
LanRoutePoliciDestIp4 IP addr xxx.xxx.xxx.xxx N/A
policies (IPv4)
Subnet mask of routing
LanRoutePoliciMask4 IP addr xxx.xxx.xxx.xxx N/A
policies (IPv4)
Gateway of routing
LanRoutePoliciGw4 IP addr xxx.xxx.xxx.xxx N/A
policies (IPv4)
LanRoutePoliciMetric Metric of routing policies Numeric 1 N/A
0: Disable
LanRoutePoliciPrivate Private of routing policies Boolean N/A
1: Enable
lnSetApply Restart LAN configuration Boolean 0 N/A
rpSetApply Restart RIP configuration Boolean 0 N/A
0: Disable
lanDhcpEn6 Boolean N/A
1: Enable
lanConnIP6[n] IPv6 addr N/A
lanConnMask6[n] IPv6 addr N/A
lanDhcpStart6[n] IPv6 addr N/A
lanDhcp6End[n] IPv6 addr N/A
lanDhcpLeaseTimeAmount6[n] Numeric N/A

Firmware Guide Release 7.5 Standard 1.2 August 2012

538 Chapter 9

ID Purpose Type Range / Example Default

lanDhcpLeaseTime6[n] Numeric N/A
lanDhcpMode6[n] Numeric N/A

Wireless Settings

The following variables apply to the wireless interface. The array identifier
[n] specifies the SSID (valid range: 0 to 3, where 0 is the subscriber’s SSID).
ID Purpose Type Range / Example Default
0: Auto
1: Africa
2: Asia
3: Australia
4: Canada
5: Europe
wifiRadioChannel Wireless channel ID Numeric 0
6: France
7: Israel
8: Japan
9: Mexico
10: South America
11: USA
0: B/G mixed
1: B Only
wifiHwmode Wireless mode Numeric 4: G Only 9
6: N Only
9: B/G/N mixed
0: Auto
wifiBGProtected Bgprotected mode Boolean 1: On 0
2: Off
wifiBeaconInterval Beacon interval Numeric 20–1024 100
wifiDtimInterval Dtim interval Numeric 1–255 1
0: Long
wifiTxPreamble Tx Preamble Numeric 0: Long
1: Short
wifiRTSThreshold RTS Threshold Numeric 1–2347 2347
wifiFragment Fragment Threshold Numeric 256–2346 2346
0: Disable
wifiShortSlot Short Slot Boolean 1
1: Enable
0: Disable
wifiBurst Frame Burst Boolean 1
1: Enable
0: Mixed
wifiOpMode HT Operation Mode Numeric 0
1: Greenfield
0: 20 MHz
wifiBandwidth Channel Bandwidth Numeric 0
1: 20/40 MHz
0: 400 ns
wifiGuard Guard Interval Numeric 0
1: 800 ns

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 539

ID Purpose Type Range / Example Default

0: Disable
wifiAmsdu AMSDU Boolean 0
1: Enable
0: Disable
wifiDeclineBA Decline BA Request Boolean 0
1: Enable
0: Disable
wifiBlockAck Auto Block ACK Boolean 1
1: Enable
Enable/Disable BSSID 0: Disable
wifiBssidBroadcast[n] Boolean 1
broadcasting 1: Enable
wifiBssid[n] SSID String ‘‘ARRIS_GW’’
0: None (open)
1: WEP
2: WPAPSKWPA2PSK
3: WPAWPA2
wifiAuth[n] Security Mode Numeric 0
4: WPAPSK
5: WPA2PSK
6: WPA
7: WPA2
0: None
1: WEP
wifiEnc Encryption Mode Numeric 2: TKIP 0: None
3: AES
4: TKIPAES
WifiWepKey1[n] WEP key 1 String N/A
WifiWepKey2[n] WEP key 2 String N/A
WifiWepKey3[n] WEP key 3 String N/A
WifiWepKey4[n] WEP key 4 String N/A
wifiDefaultkey[n] Default WEP key index Numeric 1–4 1
wifiWpapsk[n] WPA/WPA2 PSK String N/A
Radius server IP address
wifiWpaSrv[n] IP addr 192.192.8.254 N/A
of WPA/WPA2
wifiWpaPort[n] Radius server port Numeric 1812 1812
wifiWpaSecret[n] Radius server passphrase String ‘‘secret’’ N/A
wifiWpaRekeyInterval WPA Rekey Interval Numeric 3600 3600
0: Disable
wifiMacPolicy Wifi MAC ACL mode Numeric 1: Allow 0
2: Deny
‘‘xx:xx:xx:xx:xx:xx;
wifiMacList ACL of Wifi MAC String N/A
xx:xx:xx:xx:xx:xx’’
0: Disable
wifiApIsolation AP isolation Boolean 1
1: Enable
0: Disable
wifiWmm[n] WMM Boolean 1
1: Enable
Wifi Radio 0: Off
WifiRadioOnOff Boolean 1
On/Off switch 1: On

Firmware Guide Release 7.5 Standard 1.2 August 2012

540 Chapter 9

ID Purpose Type Range / Example Default

0: Disable
2: Bridge mode
wifiWds Wireless WDS mode Boolean 0
3: Repeater mode
4: Lazy mode
0: CCK
1: OFDM
wifiWdsPhy WDS physical mode Numeric 0
2: HTMIX
3: GREENFIELD
0: None
1: WEP
wifiWdsEnc WDS encryption Numeric 0
2: TKIP
3: AES
0: Disable
wifiApEn Enable/Disable use as AP Boolean 0
1: Enable
wifiWdsKey WDS encryption key String 8–63 ASCII or 64 Hex N/A
Wireless MAC Address ‘‘xx:xx:xx:xx:xx:xx;
wifiWdsList String N/A
of AP to connect xx:xx:xx:xx:xx:xx’’
wifiTxPower Tx Power Numeric 1–100 100
wifiMcs HT MCS Numeric 0–15 Auto
wifiSetApply Restart Wifi Config Boolean 0 N/A
wifiMacAddr Wireless MAC Address MAC addr 00:c0:02:11:22:33 N/A
wifiWpsDevPIN WPS PIN used by DUT String "94229882" "94229882"
wifiWpsMode WPS mode String addER ap-er
0: unconfig
wifiWpsState WPS status Boolean 1
1: config
Update for WPS procedure
wifiWpsProcStatus String 0–39 N/A
status
Update for WPS procedure
wifiWpsProcInfo String TBD N/A
status description
0: Disable
wifiWpsEnable Enable/Disable WPS Boolean 1
1: Enable

Firewall Variables

The following variables apply to the firewall.

ID Purpose Type Range / Example Default value
0: Disable
fwEnable Firewall feature Boolean 1
1: Enable
0: Disable
fwDosEnable DoS support feature Boolean 0
1: Enable
fwVirtualServerIndex[n] Index of virtual server rule Numeric 0–29 0
fwVirtualServer Description of a specific
String ‘‘myVirtualSer’’ N/A
Description[n] virtual server

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 541

ID Purpose Type Range / Example Default value

fwVirtualServerStart
Beginning inbound port no. Numeric 1–65535 N/A
InPort[n]
fwVirtualServerEnd
Ending inbound port no. Numeric 1–65535 N/A
InPort[n]
1: TCP
fwVirtualServerProto[n] Protocol type Numeric 2: UDP N/A
3: BOTH
fwVirtualServerIp4[n] Private IP address IP addr xxx.xxx.xxx.xxx N/A
fwVirtualServerStart
Beginning private port no. Numeric 1–65535 N/A
PrivatePort[n]
fwVirtualServerEnd
Ending private port no. Numeric 1–65535 N/A
PrivatePort[n]
fwAclIndex[n] Index of ACL rule Numeric 0–29 0
Beginning IP address of
fwAclStartIp4[n] IP addr xxx.xxx.xxx.xxx N/A
a specific LAN client
Ending IP address of
fwAclEndtIp4[n] IP addr xxx.xxx.xxx.xxx N/A
a specific LAN client
Destination beginning port no.
fwAclStartPort[n] Numeric 1–65535 N/A
of a specific LAN client
Destination ending port no.
fwAclEndPort[n] Numeric 1–65535 N/A
of a specific LAN client
1: TCP
fwAclProto[n] Protocol type Numeric 2: UDP N/A
3: BOTH
1: All
fwAclBlocktime[n] Block time Numeric N/A
2: Pick
Beginning day of the 0: SUN
1: MON
2: TUE
fwAclStartDay[n] Numeric 3: WED 0
blocking schedule
4: THU
5: FRI
6: SAT
Ending day of the 0: SUN
1: MON
2: TUE
fwAclEndDay[n] Numeric 3: WED 0
blocking schedule
4: THU
5: FRI
6: SAT
Beginning time of the
fwAclStartTime[n] Numeric 0–24: o’clock 0
blocking schedule
Ending time of the
fwAclEndTime[n] Numeric 0–24: o’clock 0
blocking schedule

Firmware Guide Release 7.5 Standard 1.2 August 2012

542 Chapter 9

ID Purpose Type Range / Example Default value

Enable/Disable a 0: Disable
fwDmzEn Boolean 0
specific DMZ rule 1: Enable
IP address of a
fwDmzIp4 IP addr xxx.xxx.xxx.xxx N/A
DMZ rule (IPv4)
Enable/Disable all 0: Disable
fwMacEn Boolean 0
MAC-based blocking 1: Enable
fwMacAclIndex[n] Index of MAC ACL rule Numeric 0–29 0
MAC address of a specific
FwMacAclMac[n] MAC addr xx:xx:xx:xx:xx:xx N/A
MAC ACL rule
fwMacAclHost [n] Host name description String ‘‘myHost’’ N/A
0: Disable
fwPingBlock ICMP PING blocking Boolean 0
1: Enable
1: DynDNS
fwDdnsService DDNS service type Numeric 1
2: TZO
Username of a DDNS
fwDdnsUsername String ‘‘myname’’ N/A
service account
Password of a DDNS
fwDdnsPassword String ‘‘mypassword’’ N/A
service account
Domain name of a DDNS
fwDdnsDomain String ‘‘mydomain.com’’ N/A
service account
0: Disable
fwDdnsEn Enable/Disable DDNS service Boolean 0
1: Enable
0: Disable
fwTrustedIPEn Enable/Disable trusted IP Boolean 0
1: Enable
Start IP address of xxx.xxx.xxx.xxx
fwTrustedIPStartIP IP addr N/A
trusted IP 1: Enable
End IP address of xxx.xxx.xxx.xxx
fwTrustedIPEndIP IP addr N/A
trusted IP 1: Enable
Enable/Disable Java Filtering 0: Disable
fwJavaFilterEn Boolean 0
(Archive and Applets) 1: Enable
Enable/Disable ActiveX 0: Disable
fwActiveXFilterEn Boolean 0
Filtering 1: Enable
fwWordFilterIndex[n] Index of Keyword Filtering Numeric 0–19 0
fwWordFilter[n] Keyword of Keyword Filtering String ‘‘keyword’’ N/A
1: All
fwWordFilterBlocktime[n] Block time Numeric N/A
2: Pick
Beginning day of the 0: SUN
blocking schedule 1: MON
2: TUE
fwWordFilterStartDay[n] Numeric 3: WED 0: SUN
4: THU
5: FRI
6: SAT

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 543

ID Purpose Type Range / Example Default value

Ending day of the 0: SUN
blocking schedule 1: MON
2: TUE
fwWordFilterEndDay[n] Numeric 3: WED 0: SUN
4: THU
5: FRI
6: SAT
Beginning time of the
fwWordFilterStartTime[n] Numeric 0–24: o’clock 0
blocking schedule
Ending time of the
fwWordFilterEndTime[n] Numeric 0–24: o’clock 0
blocking schedule
fwAddrFilterIndex[n] Index of Address Filtering Numeric 0–19 0
fwAddrFilter[n] Address of Address Filtering String ‘‘arris.com’’ N/A
1: All
fwAddrFilterBlocktime[n] Block time Numeric N/A
2: Pick
Beginning day of the 0: SUN
blocking schedule 1: MON
2: TUE
fwAddrFilterStartDay[n] Numeric 3: WED 0: SUN
4: THU
5: FRI
6: SAT
Ending day of the 0: SUN
blocking schedule 1: MON
2: TUE
fwAddrFilterEndDay[n] Numeric 3: WED 0: SUN
4: THU
5: FRI
6: SAT
Beginning time of the
fwAddrFilterStartTime[n] Numeric 0–24: o’clock 0
blocking schedule
Ending time of the
fwAddrFilterEndTime[n] Numeric 0–24: o’clock 0
blocking schedule
fwSetApply Restart Firewall Configuration Boolean 0 N/A
fwDdnsSetApply Restart DDNS Configuration Boolean 0 N/A
fwPortForwardEnable Enable port forwarding Boolean N/A
fwPortTriggerEnable Enable port triggering Boolean N/A
0: Disable
fwPortBlockEnable Enable port blocking Boolean 0
1: Enable
0: No
fwPortBlockAutoNego[n] Port blocking autonegotiation Boolean
1: Yes
0: Half
fwPortBlockMode[n] Port blocking mode Boolean
1: Full

Firmware Guide Release 7.5 Standard 1.2 August 2012

544 Chapter 9

ID Purpose Type Range / Example Default value

10M
fwPortBlockSpeed[n] Port blocking speed Numeric 100M
1G
0: Enable
fwPortBlockDisable[n] Disable port blocking Boolean
1: Disable
0: All
1: Managed Sites
fwPrctlReportType Numeric
2: Managed Services
3: Managed Devices
1: Today
2: Yesterday
fwPrctlReportTime Numeric 3: Last week
4: Last month
5: Last 90 days
Parent Control Managed Device 1: allow all
fwPrctlManageDeviceType Boolean 1
Type 0: block all
0: low
1: Medium
fwSecLevel Firewall Security Level Numeric 0
2: High
3: Custom
0: Disable
fwPptpPassthru PPTP Pass through Boolean 1
1: Enable
0: Disable
fwIpsecPassthru IPsec Pass through Boolean 1
1: Enable
0: Disable
fwPsdEn Port scan detect Boolean 1
1: Enable

System and Management Variables

The following variables control system management functions.

ID Purpose Type Range / Example Default value
nvramVersion NVRAM version String ‘‘1.0.9’’ varies
sysAdmin Administrator name String ‘‘admin’’
sysAdminPassword Administrator password String ‘‘mypassword’’ ‘‘password’’
sysAdminTimeout Login timeout value Numeric 3600 (seconds) 10
GMT-11
GMT-10
sysTmeTz Timezone setting Numeric GMT+0
GMT-9
etc.
Enable/Disable daylight 0: Disable
sysTmeDaylight Boolean 0
saving time 1: Enable
Enable/Disable local 0: Disable
sysLocalMgmtEn Boolean 1
management from LAN PC 1: Enable

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 545

ID Purpose Type Range / Example Default value

Enable/Disable remote 0: Disable
sysRmtMgmtEn Boolean 1
management from WAN PC 1: Enable
IP address of a remote
sysRmtMgmtIp4 IP addr xxx.xxx.xxx.xxx N/A
management PC (IPv4)
0: Disable
sysNatEn Enable/Disable NAT Boolean 1
1: Enable
0: Disable
sysUpnpEn Enable/Disable UPnP Boolean 1
1: Enable
sysUpnpAdvTime UPnP advertisement time Numeric 1–65535 30
sysUpnpTtl Upnp time to live Numeric 1–65535 4
0: Disable
sysZeroConfEn Enable/Disable Zero Config Boolean 0
1: Enable
Diagnostic tool test
sysDiagDstAddr String www.comcast.net www.comcast.net
destination address
sysDiagChkIp Diagnostic tool check IP IP addr xxx.xxx.xxx.xxx 10.0.0.1
The lock of booting 0: Boot unlock
sysBootLock Boolean 0
firmware image 1: Boot lock
0: Disable
sysCliEn Enable/Disable CLI interface Boolean 1
1: Enable
Enable/Disable guest remote 0: Disable
sysRmtMgmtGuest Boolean 0
management from WAN PC 1: Enable
Server port of remote
sysRmtMgmtPort Numeric 1–65535 80
management
sysLanguage Language String ‘‘en’’ ‘‘en’’
0: Disable
sysLogSystem Enable/Disable system logs Boolean 1
1: Enable
0: Disable
sysLogWifi Enable/Disable wireless logs Boolean 0
1: Enable
0: Disable
sysLogFirewall Enable/Disable firewall logs Boolean 0
1: Enable
0: sysLog
sysLogFormat Log format Numeric 0
1: WELF
sysLogEmailFromIp Email From address String [email protected] N/A
sysLogEmailToIp Email To address String [email protected] N/A
sysLogEmailServer Email Server IP address (IPv4) IP addr xxx.xxx.xxx.xxx N/A
sysLogEmailPort Email Server port Numeric 25 25
System log server IP
sysLogSysServerIp String xxx.xxx.xxx.xxx N/A
address (IPv4)
sysLogSysServerFac Log level Numeric 0–7 N/A
0: Disable
sysNtpEn Enable/Disable NTP Boolean 0
1: Enable
0: Disable
sysFactoryReset Factory reset flag Numeric 1: Enable 0
2: Reboot gateway

Firmware Guide Release 7.5 Standard 1.2 August 2012

546 Chapter 9

ID Purpose Type Range / Example Default value

sysFirstRun First boot flag Boolean 0 N/A
Others : Arris
sysCustomId Customer id Numeric 1
2: Comcast
1: System Logs
sysTBHLogType Numeric 2: Event Logs
3: Firewall Logs
1: Today
2: Yesterday
sysTBHLogTime Numeric 3: Last week
4: Last month
5: Last 90 days
sysGwName Home Gateway String N/A
0: Disable
sysRmtTelnetEn Telnet feature Boolean 0
1: Enable
0: Disable
sysRmtSshEn SSH feature Boolean 0
1: Enable

Cable Modem Variables

The following variables display cable modem parameters.

ID Purpose Type Range / Example Default value
cmMacAddr MAC address of CM MAC addr xx:xx:xx:xx:xx:xx N/A
cmFwVersion CM firmware version String N/A
cmFwName CM firmware name String N/A
cmBootVersion CM bootloader version String N/A
cmCoreVersion xx String N/A
cmPacketCableVer PacketCable version String ‘‘1.5’’ N/A
cmHwVersion Hardware version String ‘‘2’’ N/A
cmVendor Vendor name String ‘‘Arris Interactive, L.L.C.’’
cmSerialNum Serial number String N/A

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 547

Speedtest CLI

The Speedtest sub-menu provides commands to configure, control, and dis-

play speed tests.
To enter the Speedtest sub-menu, enter speedtest at the Console> prompt.
The Speedtest prompt is Speedtest>.
Note: Only the server IP address and file name must be configured. Other
settings have reasonable defaults. If you do not select a direction, the Down-
load test is run or configured. For FTP transfers, the Username and Password
must also be configured.

Configure Syntax: Configure { up | down }

Specifies whether the following commands configure the Upload or Down-
load test. For Upload tests, FTP uses PUT, and HTTP uses POST (HTTP
PUT is not supported). For Download testing, both FTP and HTTP use GET.
Note that two configurations are maintained, one for upload, and one for
download. Selecting the direction chooses which configuration to change.

Mode Syntax: Mode {protocol} [ active ]

Sets the protocol to use for the file transfer. The parameters are:
protocol
either ftp or http.
active
For FTP transfers, use this keyword to set the FTP data channel to
active. In active mode, the FTP server opens the data channel to
the client. The default FTP mode is passive, where the modem
opens the data connection to the server.

Address Syntax: Address {ipaddr}

(Required) Sets the FTP or HTTP server address. The ipaddr can be an IP
address (aaa.bbb.ccc.ddd), or a fully qualified domain name (if DNS has been
provisioned).

Port Syntax: Port {port}

Sets the server port. Use this command to connect with servers that do not
use the standard FTP or HTTP ports.

Firmware Guide Release 7.5 Standard 1.2 August 2012

548 Chapter 9

Default: 21 for FTP, 80 for HTTP.

File Syntax: File {pathname}

(Required) The full pathname to the file to upload or download. Note that
for download tests, the modem discards received data. For upload tests, the
modem sends random data to the server.

Username Syntax: Username {userID}

For FTP transfers, the account ID (required).
For HTTP transfers, the user ID used for basic authentication (optional).

Password Syntax: Password {password}

The account password for logging into an FTP server (required), or for
HTTP basic authentication (optional).

UpSize Syntax: UpSize {size}

For Upload tests, specifies the amount of data (in MB) sent to the server.

UpScript Syntax: UpScript {path}

For Upload tests, specifies the script (CGI) used to accept data from the CM.
The script must:
• handle HTTP POST data in accordance with RFC 1867.
• POST the data to a submission form, containing an HTML <input>
element of type FILE.
Example:
UpScript cgi-bin/upload.cgi

UpPostFields Syntax: UpPostFields {fields}

For Upload tests, specifies optional fields to append to the upload script.
This may be required, depending on the script.
The fields are specified as name˜value, separated by semicolon (;) characters.
Example:
UpPostFields oper˜upload;password˜xyz

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 549

UpFileField Syntax: UpFileField {fieldname}

For Upload tests, specifies the field name that receives uploaded data in the
HTML file submission form. This field must be of type FILE.
Example:
UpFileField filename

TCPWindow Syntax: TCPWindow {bufsize}

Sets the size, in KB, of the receive buffer for the socket used for the transfer.
The TCP window is advertised via a window size (1-64k), and a window
scale factor. Linux TCP calculates these values based on the size of the
buffers available.
Valid range: 1 to 2048.
Default: 64.

TCPMSS Syntax: TCPMSS {segsize}

Sets the maximum segment size, in bytes, for TCP.
Valid range: 536 to 1500 bytes.
Default: 1460.

TCPTimeStamp Syntax: TCPTimeStamp { enable | disable }

Enables or disables TCP timestamping.
The default is enabled.

PMTU Syntax: PMTU { enable | disable }

Enables or disables Path MTU Discovery. This is a method to discover the
maximum transmissible unit that can be passed between two IP bosts. This
is used to avoid IP fragmentation.
The default is enabled.

MTU Syntax: MTU {mtusize}

The size, in bytes, of the Maximum Transmissible Unit (MTU). Use this
command to set the MTU size if PMTU is disabled.
The default is 1500 (one Ethernet frame payload size).

Firmware Guide Release 7.5 Standard 1.2 August 2012

550 Chapter 9

CpeAccess Syntax: CpeAccess { enable | disable }

Enables or disables CPE access to the network during a speed test. If dis-
abled, the modem disables Ethernet interfaces used to connect with CPEs,
guaranteeing that no CPE data will be active during the test.
The default is enabled, allowing CPEs to continue operation. Note that
phone lines are not affected by this command.

Lro Syntax: Lro { enable | disable }

Enables or disables the large receive offload patch. This is a kernel optimiza-
tion that accumulates TCP packets in the network interface. It has a large
influence on download speed.
The default is enabled.

Bypass Syntax: Bypass { enable | disable }

Enables or disables bypassing the DOCSIS bridge during speed tests.
When enabled (the default), the modem transfers incoming packets from the
network interface directly to the IP layer, and from the IP layer directly to the
network interface.
When disabled, the modem uses the DOCSIS bridge as it does for regular
traffic, handling all incoming packets to and from the WAN interface. Filters
and packet checks at this layer impact performance.
The default is enabled.

LED Syntax: LED { 1 | 0 }

Enables or disables LED updates during speed tests. The default is 0 (dis-
abled). When updates are disabled, the LED states do not change during the
speed test.
During normal operation, the modem updates the state of the LEDs twice a
second. When a speed test is active, the CPU is at nearly 100% utilization;
enabling LED updates can affect performance.

ShowConfig Displays the value of all of the configuration parameters.

Example:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Command-Line Interface Reference 551

[ 7] Speed Test > ShowConfig

SpeedTest Configuration:
Test Direction: download, then upload
Download test config
Application Layer Settings
Test Mode: ftp (passive)
Server Address: 10.1.59.18
Server Port: 21
Username: speedtest
Password: password
Filename: wolves_hockey.mpg
Transport Layer Settings
TCP Window Size: 2048
TCP Timestamps: enabled
TCP Max Seg Size: 1460
Datalink Layer Settings
Path MTU Discovery: enabled
Optimization Settings
CPE Access: enabled
Large Rcv Offload: enabled
Doc Bridge Bypass: enabled
LED update: disabled
Upload test config
Application Layer Settings
Test Mode: http
Server Address: 10.1.59.18
Server Port: 80
Username: speedtest
Password: password
Filename: test1.dat
Upload File Size: 10
Upload Script: cgi-bin/upload.cgi
Upload POST fields: ac˜upload
Upload file field: file
Transport Layer Settings
TCP Window Size: 2048
TCP Timestamps: enabled
TCP Max Seg Size: 1460
Datalink Layer Settings
Path MTU Discovery: enabled
Optimization Settings
CPE Access: enabled
Large Rcv Offload: enabled
Doc Bridge Bypass: enabled
LED update: disabled
Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

552 Chapter 9

ShowResults Syntax: ShowResults [ test# | all ]

Displays speed test results. The parameters are:
test#
The test to display, 1 (latest) to 3 (oldest).
all
Displays all test results.
Omit the parameters to show the result of the last speedtest run.
Example:
[ 38] Speed Test > ShowResults
Test Results: Complete, status
Test Started at Thu Aug 11 13:18:54 2011
with 0 voice lines active and cpe access enabled.
Test Finished at Thu Aug 11 13:19:04 2011
with 0 voice lines active.
Download Results Upload Results
----------------------------------------------- -------------------------------------------
DNS lookup: 0 ms 0 ms
Connection setup: 60 ms 20 ms
Transfer: 8100 ms 2190 ms
Total time: 8160 ms 2210 ms
Payload: 105541632(bytes) 99.40(Mb/s) 10486058(bytes) 36.52(Mb/s)
Payload (including overhead) 109734528(bytes) 103.33(Mb/s) 72291(pkts) 10874607(bytes) 37.44(Mb/s) 7190(pkts)
Total interface traffic: 109735469(bytes) 103.33(Mb/s) 72302(pkts) 10874607(bytes) 37.44(Mb/s) 7190(pkts)
Error: 0(pkts) 0(pkts)
Dropped: 0(pkts) 0(pkts)

Start Syntax: Start [ down | up ]

Begins the speed test with the specified configuration. Omit the parameter to
run the speed test configured by the Configure command.

Stop Halts a speed test in progress.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 10 MAIN Console
Commands

The MAIN console commands provide a low-level interface to the cable

modem hardware for troubleshooting and diagnostics.

General Information

Every command has two forms: full and short abbreviation (for example, typ-
ing tu is equivalent to typing the full command tuner). The console com-
mands are organized into a number of groups that differ in functionality.
Each group is called a submenu.
In a ‘‘help’’ display, submenus have a > (more) symbol following their name.
To navigate through the submenus, type the submenu name (without the ‘‘>’’
symbol) to enter the submenu. Type exit to return to the main menu. Type
exit at the main menu prompt to return to the Console commands.

All commands are case-sensitive.

Main Menu Commands

Note that several submenus are not documented. For Voice submenu com-
mands, see ‘‘Voice CLI Commands’’ on page 619.
mainMenu> help
Console Commands for this level:
system - Go to system Menu.
docsis - Go to DOCSIS Menu.
pacm - Go to PACM Menu.
voice - Go to Voice Menu.
logger - Go to Logger Menu.

Firmware Guide Release 7.5 Standard 1.2 August 2012

554 Chapter 10

eventm - Go to Event Manager Menu.

version - prints system version.
help - Display menu commands.
shortcuts - Display key shortcuts help.
exit - Exit this sub-menu, go to previous menu.
quit - Quit and terminate CLI.
reboot - Reboot the system.

Common Commands

The following commands are common to all submenus.

help Displays the commands available from the current prompt.

shortcuts Displays help for key shortcuts.

exit Exits the current sub-menu and return to the previous menu.

quit Quits and terminates the CLI.

reboot Reboots the E-UE.

System Submenu Commands

The following commands provide information and control over low-level

system parameters.

network Prints comprehensive networking-related information.

memory Prints comprehensive memory-related information.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 555

timers Prints a list of system timers.

netrxReduce Syntax: netrxReduce {priority}

Sets the net-rx task priority.

netrxRestore Restores the default net-rx task priority.

pp Enters the Packet Processor submenu. The following commands are avail-
able in this submenu.

enable

Enables the Packet Processor.

disable

Disables the Packet Processor.

deinit

De-initializes all the Packet Processor components.

setTimeout

Syntax: setTimeout {time}

Sets the session timeout to the specified value, in seconds.

resetTimeout

Resets the session timeout to the default time of 30 seconds.

resetStats

Resets the HIL Analysis stats.

dbg

Enables Packet Processor debugging.

Firmware Guide Release 7.5 Standard 1.2 August 2012

556 Chapter 10

nodbg

Disables Packet Processor debugging.

global

Displays global Packet Processor statistics.

stats

Displays an HIL Analysis report.

pids

Displays a list of process IDs (PIDs) in use.

vpids

Displays VPID counters.

session

Displays a list of sessions.

devs

Displays network device counters.

brief

Displays global Packet Processor statistics, VPID counters, and a list of ses-
sions.

psm

Places C/Q/M-PDSPs into Power Save mode.

nopsm

Removes C/Q/M-PDSPs from Power Save mode.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 557

qos

Enables the QoS processing scheme (debug purposes only).

noqos

Disables the QoS processing scheme (debug purposes only).

setThreshold

Sets the RTT threshold for TDOX cancellation.

thresholdDisable

Disables the dynamic TDOX cancellation functionality.

sme Enters the State Machine Engine submenu. The following commands are
available in this submenu.

list

Displays all top-level state machines.

lshort

Syntax: lshort [filter]

Displays all state machines, or the state machines whose name matches the
specified filter.
Example:
sme> lshort DSM
(pid=317) [Root] --> DSM_app_DownstreamManager:4
DSM_st_Idle
(pid=318) [Root] --> DSM_app_DownstreamManager:3
DSM_st_Idle
(pid=320) [Root] --> DSM_app_DownstreamManager:1
DSM_st_Locked
(pid=319) [Root] --> DSM_app_DownstreamManager:2
DSM_st_Idle
(pid=320) [DSM_app_DownstreamManager:1] --> DSM_st_Locked
-->
(pid=320) [DSM_st_Locked] --> DsmHandleQfmEvents
DSM_st_QfmConnected
(pid=320) [DSM_st_Locked] --> DsmHandleSyncEvents
DSM_st_SyncConnected
(pid=320) [DSM_st_Locked] --> DsmHandleOtherEvents

Firmware Guide Release 7.5 Standard 1.2 August 2012

558 Chapter 10

DSM_st_MddConnected

sme>

llong

Syntax: llong [filter]

Lists all state machines with the state path, or the state machines whose name
matches the specified filter.

SetModule

Syntax: SetModule {name} {module} [component]

Sets the specified LOG module. The parameters are:
name
The module name. The name may be abbreviated to the shortest
unique string.
module
The module index.
component
(optional) The component index.

SetSeverity

Syntax: SetSeverity {name} {severity}

Sets the severity for the specified log. The parameters are:
name
The log name. The name may be abbreviated to the shortest
unique string.
severity
The severity index.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 559

DOCSIS Submenu Commands

The DOCSIS submenu commands provide information about the DOCSIS

sub-system.

version Prints the version of DOCSIS code running in the Telephony Modem. Note
that this version does not correspond to the supported DOCSIS version.
Example:
docsis> version
DOCSIS VERSION=1.1.1.140
docsis>

phystatus Syntax: phystatus {channel}

Displays the status of the specified PHY channel. The valid range for chan-
nel is 0 to 3.
Example:
docsis> phystatus 0
Current PHY status:
RF frequency: 741.001953 MHz
IF frequency: 77998352 Hz
Qam mode : 64 QAM
Annex: ANNEX-A (Euro)
MSE: -36.124 dB
IF AGC -57
RF AGC 4.100 [dB] ( ATTN = 0, RL = 6, DNC = 76 )
Energy backoff: -29.517 dB
Annex A interleaver mode: I=12, J=17
CW Error Rate: 3.94e-07
QAM Lock: YES
FEC Sync: YES
MPEG Sync: YES
Carrier offset is -14446.798 Hz
Timing offset: 11 ppm
Burst counter = 1
Llp up/down counter = 0 / 0
Lost 1/100/500 counters = 1 / 1 / 1
Reported power is 10.8955 dBmv
docsis>

Firmware Guide Release 7.5 Standard 1.2 August 2012

560 Chapter 10

tuner Syntax: tuner {flag} {freq}

Programs the wideband tuner. The parameters are:
flag
Set to 1 to set the master tuner, or 0 to set the slave tuner.
freq
The frequency, in MHz.

statustuner Displays tuner configuration data:

• In wideband mode, this command displays regular tuner status.
• In narrowband mode, this command displays the status for all tuners.
Example:
docsis> statustuner
IF AGC -57
RF AGC 4.100 [dB] ( ATTN = 0, RL = 6, DNC = 76 )
1st LO freq is 1986000256.000 [Hz] ˜ 1986.000 [MHz]
2nd LO freq is 1166999936.000 [Hz] ˜ 1167.000 [MHz]
Input center frequency is 741000000.000 [Hz] ˜ 741.000 [MHz]
Current 1st IF in use is 1245000192.000 [Hz] ˜ 1245.000 [MHz]
Output center frequency is 77500000.000 [Hz] ˜ 77.500 [MHz]
Output channel bandwidth is 89.000 [MHz]
docsis>

scan Syntax: scan {flag}

Stops or starts scanning. The flag is either 0 to stop scanning, or 1 to start
scanning.
Example:
docsis> scan 0
Halt scan <---- True
docsis>

cerreset Syntax: cerreset {channel}

Resets the CER counter on the specified receive channel. The valid range for
channel is 0 to 3.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 561

cmstatus Displays the CM status.

Example:
docsis> cmstat
The CM status is OPERATIONAL
docsis>

listDocsisModules Show modules list and indicates set/unset for each.

configDocsisMod- Syntax: configDocsisModule {id} {flag}

ule Sets or unsets the specified module. The parameters are:
id
The module ID to enable or disable. The ID is the numeric index
shown by the listDocsisModules command.
flag
Either 1 to set the module, or 0 to unset it.

testDsLoss Syntax: testDsLoss {usport} {time} [recovTech]

Simulates downstream signal loss. The parameters are:
usport
The upstream port to use for the test.
time
The time, in seconds, to simulate the signal loss.
recovTech
The recovery technique to use: 0 for broadcast; omit this parameter
to use the default recovery technique.
Example:
docsis> testDsLoss 1 1
TestDsSignalLoss usPort=1, sec=1, recovTech=117585 (0 for Bcast)
DSLoss sent
DSRecov sent
docsis>

Show Enters the Show submenu. The following commands are available.

Firmware Guide Release 7.5 Standard 1.2 August 2012

562 Chapter 10

cpe

Displays a list of learned DOCSIS CPEs.

Example:
Show> cpe

CPEs List
--------------------
Max CPEs 4
--------------------
Mac Name Learning Source Cpe Num
--- ---- -------- ------ -------
-> 00:15:cf:00:1d:3c esafe0 Static mta0 1
Show>

timeoverversion

Displays the date and time the firmware image was created.

cmstatusmasks

Displays a list of CM-STATUS masks.

Example:
Show> cmstatusmasks

CM-STATUS masks:
===============:
Global mask (level-1) based on MDD TLV-11:
0x0000

Global event control based on MDD TLV-11:

Downstream masks (level-3) based on MDD TLV-1.5:

Upstream masks (level-3) based on MDD TLV-7.2:

Non-channel-specific mask (level-3) based on MDD TLV-15:

0x0000

Downstream override masks (level-2) based on CM-CTRL TLV-5:

Upstream override masks (level-2) based on CM-CTRL TLV-6:

Non-channel-specific override mask (level-2) based on CM-CTRL TLV-7:

Show>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 563

Certification Enters the Certification submenu. The following commands are available.

status

Displays BPI status.

Example:
Certification> status
BPI is enable

accesstime

Displays Access start times for CoSigner and Manufacturing certificates.

Example:
Certification> access
CoSigner Code Access Time 700101000000Z
CoSigner CVC Access Time 700101000000Z
Mfg code Access Time 010920221353Z
Mfg CVC Access Time 010912000000Z

resetaccesstime

Syntax: resetaccesstime
Resets Access start times for CoSigner and Manufacturing certificates.

cmcert

Displays the CM certificate fields.

mfgcert

Displays the Manufacturer certificate fields.

rootpublickey

Displays the Root public key.

Firmware Guide Release 7.5 Standard 1.2 August 2012

564 Chapter 10

General Enters the General submenu. The following commands are available.

ucd

Syntax: ucd {channel}

Displays Upstream Channel Descriptor information for the specified channel.
The valid range is 1 to 4.
Example:
General> ucd 1

UCD of channel 1 parameters

Upstream ID is 0, upstream type is 0 docsis type
UCD frequency is 0, Rate 0 KSym/sec,Mslot size 0
General>

ipcable

Displays the cable modem IP address.

goto

Syntax: goto {freq} {uschan}

Programs the tuner to the specified frequency and upstream channel ID.

tune

Syntax: tune {freq}

Programs the tuner to the specified frequency.

next

Reinitialize the MAC layer with nextFreq.

rem

Syntax: rem {holdoff}

Reinitialize the MAC layer with the current downstream and upstream. The
holdoff is the holdoff time, in milliseconds.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 565

macaddr

Displays the cable MAC address.

hwcounters

Displays a list of hardware counters.

Example:
General> hwcounters
Number of lost syncs 0
Number of invalid maps 0
Number of US MAP bytes 23461452
Number of SYNC bytes 5130756
Number of DS 0 MNG + PDU bytes 85966
Number of DS 1 MNG + PDU bytes 0
Number of DS 2 MNG + PDU bytes 0
Number of DS 3 MNG + PDU bytes 0
Number of accepted bytes for DS Channel 0 is 28678236
Number of accepted bytes for DS Channel 1 is 0
Number of accepted bytes for DS Channel 2 is 0
Number of accepted bytes for DS Channel 3 is 0
Number of unicast packets 157
Number of discard packets 0
Number of MAC error packets 0
General>

Atp Enters the Atp submenu. The following commands are available.

addcpe

Syntax: addcpe {macaddr}

Adds the specified CPE MAC address to the CM MAC table.

triggercmstatus

Syntax: triggercmstatus {evtype} {flag} {channel}

Generates a CM status report. The parameters are:
evtype
The event type. Valid range: 1 to 10.
flag
Either 1 to enable reporting, or 0 to disable.

Firmware Guide Release 7.5 Standard 1.2 August 2012

566 Chapter 10

channel
The channel ID to check when generating the report.

suspendcmstatus

Syntax: suspendcmstatus {flag}

Suspends or resumes CM status reporting. The flag is either 1 to suspend
reporting, or 0 to resume reporting.

printcmstatusevents

Prints CM-status events.

overdsidholdoffovr

Overrides the CM-status DSID.

deldsidholdoff

Deletes the CM-status DSID.

Fw Enters the Fw menu. The following commands are available.

version

Displays the DOCSIS firmware version.

mapperStats

Displays Mapper statistics for all channels.

Example:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 567

Fw> mapperStats

MAPPER statistics:
==================

ch0 ch1 ch2 ch3

--------- --- --- --- ---
Oper: EN DIS DIS DIS
State: 2 0 0 0
Mode: ATDMA ATDMA ATDMA ATDMA
MAPs: 505544 0 0 0
IEs: 4254 0 0 0
IUC1: 4033 0 0 0
IUC3: 3 0 0 0
IUC4: 66 0 0 0
IUCdata: 152 0 0 0
Lost: 0 0 0 0

Legend:
State 0 = Disabled Mode: Map Processor is filtering all IE’s
State 1 = Ranging mode0: MAP processor processes only initial ranging (IUC 3)
State 2 = Normal mode: MAP processor processes all IUCs except IUC 3
State 3 = Ranging mode1: MAP processor processes only initial ranging (IUC 3)
Broadcast and Unicast transmit opportunities (IUC4)

isrStats

Displays ISR statistics.

Example:
Fw> isrStats

ISR statistics:
===============
preProcessing: 157
bestEffort: 153
ugsPackets: 0
managementPackets: 0
mapperFIFO: 525292
mapperUCD: 0
mapperMapLost: 0

mbxStats

Displays Mailbox statistics.

Firmware Guide Release 7.5 Standard 1.2 August 2012

568 Chapter 10

Example:
Fw> mbxStats

Mailbox statistics:
===================
commands: 847
events: 84
illegalCommands: 0
illegalParams: 0

Last mailbox command:

=====================
CmdID = 2 (MBX_CMD_GET_PARAM)
Status = 1 (MBX_STATUS_CMD_COMPLETE)
DataLen = 19
Data:
0x00000003
0x0101630a
0x55475320
0x666c7573
0x683400

errStats

Displays error statistics.

Example:
Fw> errStats

Error statistics:
=================
invalidSF: 0
invalidPHS: 0
shortGuardTime: 0
invalidIEs: 0
droppedPduPktsCounter: 0
droppedMgmtPktsCounter: 0
swQueueFull: 0
MbxIllegalCommands: 0
MbxIllegalParams: 0

sfStats

Syntax: sfStats {sfid}

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 569

Displays statistics for the specified Service Flow. Valid range: 0 to 31.
Example:
Fw> sfStats 1

SF 1 statistics:
=================
totalPduPackets: 29
policedPduPackets: 0
outOfMemoryDropPackets: 0
expiredPackets: 0
mgmtPackets: 0
requestedPackets: 29
------------------------------
requestRetries: 0
requestExceeds: 0
totalPduBytes: 2776
requestedBytes: 3124
concat/segment Packets: 0
fragPackets: 0
dataPDUslots: 266

Legend:
totalPduPackets = number of PDUs packets forwarded to this Service
Flow, excluding policed dropped packets
policedPduPackets = number of packets dropped due to rate-limit/UGS
packet larger than unsolicitedGrantSizeBytes
outOfMemoryDropPackets = number of packets dropped due to lack of FW
resources
expiredPackets = number of packets dropped due to request retries
expiration
mgmtPackets = number of management packets forwarded to this
Service Flow
requestedPackets = number of packets requested to be transmitted
for this service flow
pduBytes = number of PDU octets forwarded in accordance to
pduPackets
requestedBytes = number of bytes requested to be transmitted for
this service flow
dataPDUslots = number of upstream mini-slots which have been
used to transmit data PDUs as a result of a unicast Data Grant

guardTimeStats

Displays guard time statistics.

Example:

Firmware Guide Release 7.5 Standard 1.2 August 2012

570 Chapter 10

Fw> guardTimeStats

Guard time statistics:

======================
maxGrantLatency: 45 ticks (4.394531 usec)
maxTxProcessingTime: 152 ticks (14.843750 usec)
minTimeTillTx: 1851 ticks (180.761719 usec)

Legend:
maxGrantLatency = maximum time between FW reception of grant and
grant in FIFO
maxTxProcessingTime = maximum time between TX push and FW reception of
grant
minTimeTillTx = minimum time between TX push and actual TX time
(negative means need to increase guard time)

rtosStats

Displays RTOS statistics.

Example:
Fw> rtosStats

RTOS statistics:
================
heartBeat_IDLE: 3544838331
heartBeat_MBX: 1037
heartBeat_PreProc: 453
heartBeat_TxScheduler: 1896615

clusterSidTable

Displays the cluster Service ID table.

Example:
Fw> clusterSidTable

Cluster SID table:

==================
cluster ch0 ch1 ch2 ch3
------- --- --- --- ---
0 0xcdd 0x0 0x0 0x0
1 0xced 0x0 0x0 0x0
39 0xcdd 0x0 0x0 0x0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 571

iucEnList

Displays enabled IUCs for each channel.

Example:

Fw> iucEnList

Enabled IUC’s:
==============
Channel 0 - 1 2 3 4 5 6 7
Channel 1 - disabled
Channel 2 - disabled
Channel 3 - disabled

backoffCounters

Displays the backoff counters.

Example:
Fw> backoffCounters

Backoff Counters:
=================
0 1 2 3 4 5 6 7
- - - - - - - -
count 0x3ffff 0x3ffff 0x3ffff 0x3ffff 0x3ffff 0x3ffff 0x3ffff 0x3ffff
bond 0x1 0x1 0x0 0x0 0x0 0x0 0x0 0x1

cppiStats

Displays CPPI statistics.

printAll

Displays all statistics. Equivalent to entering the following commands:

• mapperStats
• isrStats
• mbxStats
• errStats
• sfStats (active Service Flows only)

Firmware Guide Release 7.5 Standard 1.2 August 2012

572 Chapter 10

• guardTimeStats
• rtosStats
• clusterSidTable
• iucEnList
• backoffCounters
• cppiStats

gQosDbFwPrivateArray

Syntax: gQosDbFwPrivateArray {sfid}

Displays the gQosDbFwPrivateArray for the specified Service Flow. Valid
range: 0 to 31.
Example:
Fw> gQosDbFwPrivateArray 0

SF 0 Private Array:
====================
state: DB_QOS_SF_ACTIVE
activeClusterIndex: 0
lastClusterIndex: 0
reqMultShift: 0
rxQueueHighId: 12
rxQueueHighAddr: 0x10600c0
rxQueueHighInfoAddr: 0x10640c0
rxQueueLowId: 13
rxQueueLowAddr: 0x10600d0
rxQueueLowInfoAddr: 0x10640d0
swDescQueue_NumOfPacketsInQueue: 1
swDescQueue_TotalBytesInQueue: 84
swDescQueue_Head: 0x402a88
swDescQueue_Tail: 0x402a88
headerSize: 12
mngHeaderSize: 10
boDataStart[0..1..2..3]: 2..0..0..0
boDataEnd [0..1..2..3]: 8..0..0..0
boRngStart: 0
boRngEnd: 0
bondingBitMap: 0x1
segmentSeqNum: 0
fragmentSeqNum: 0
isBackoffRunning: 0
rateLimit_tokensBits: 4294708552
rateLimit_remainderBits: 0
rateLimit_dividor: 1
rateLimit_prevReqTimestamp: 0x0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 573

ugsPrms_qiFlag: 0
ugsPrms_NoActivityCounter: 0
ugsPrms_LastActiveGrantsValue: 0
ugsPrms_LastActiveGrantsCounter: 0

gQosDbHostConfigArray

Syntax: gQosDbHostConfigArray {sfid}

Displays the gQosDbHostConfigArray for the specified Service Flow. Valid
range: 0 to 31.
Example:
Fw> gQosDbHostConfigArray 0

SF 0 Host Config Array:

========================
schedulingType: BEST_EFFORT
maxUsTrafficBurstBytes: 65535
maxConcatSizeBytes: 65535
maxTrafficRate: Rate Limit Not Applied
clusterLimit_bytes: 0
clusterLimit_bytesOutstanding: 0
clusterLimit_timeMsec: 0
clusterLimit_requests: 0
multToReqBackoff: 12 (150 percent)
multNumBytesToReq: 4
requestPolicy: 0x8a
--------------
MUST NOT use Priority Request multicast request opportunities
MUST NOT use Request/Data opportunities for Data
MUST NOT suppress payload headers
MUST use segment headers

gQosDbClusterArray

Syntax: gQosDbClusterArray {clusterid}

Prints gQosDbClusterArray. for the specified cluster. Valid range: 0 to 38.
Use the gQosDbFwPrivateArray command to find the clusters in use for a
particular Service Flow.

gQosDbPhsInfo

Displays the gQosDbPhsInfo information.

Firmware Guide Release 7.5 Standard 1.2 August 2012

574 Chapter 10

gUsChannelPrivateInfo

Syntax: gUsChannelPrivateInfo {channel}

Prints gUsChannelPrivateInfo for the specified channel. Valid range: 0 to 3.

gUsChannelConfigInfo

Syntax: gUsChannelConfigInfo {channel}

Displays the gUsChannelConfigInfo table for the specified channel. Valid
range: 0 to 3.

gUpstreamBpiInfo

Displays gUpstreamBpiInfo information.

gUgsMaxQueueDepth

Syntax: gUgsMaxQueueDepth {depth}

Sets the UGS maximum queue depth.

dsCounters

Displays a list of downstream data counters.

dsPdsp1Configuration

Prints the downstream PSDP1 configuration.

dsPdsp2Configuration

Prints the downstream PSDP2 configuration.

dsBpi

Prints the downstream BPI configuration.

dsPhs

Prints the downstream PHS configuration.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 575

dsUnicast

Prints the downstream Unicast CAM.

tdoxStats

Prints TurboDox counters.

Qos Enters the Qos menu. The following submenus are available:

database

Enters the QOS database menu. The following commands are available:
Command Description
sid_cluster Displays all of the CM’s assigned SID clusters.
sf Displays all CM Service Flow parameters.
classifiers Displays all CM downstream and upstream classifiers.
phs Displays CM PHS parameters.
dsxstatistics Displays dynamic services transaction statistics.
servstatistics sfid Displays statistics for the specified Service Flow.
trafficflows Displays service flows carrying voice traffic.
cos Displays DOCSIS1.0 CoS parameters.

debug

Enters the QOS debug menu. The following commands are available:
Command Description
printsf index Displays short Service Flow internal data-
base info for the specified Service Flow
database index.
printcl index Displays internal classifier database info
for the specified classifier database index.
printfullsf index Displays full Service Flow internal data-
base info for the specified Service Flow
database index.
printactsf Displays full active upstream Service Flow
internal database info for the specified Ser-
vice Flow database index.
printactphs Displays full active PHS internal database
info for the specified PHS database index.
printta Displays DSX transaction database info.
printmsg index Displays DSX TA REQ/RSP/ACK message
buffers for the specified TA index.

Firmware Guide Release 7.5 Standard 1.2 August 2012

576 Chapter 10

Command Description
printusprimarysf Displays the upstream primary service flow.
senddsxevent index event Sends the specified DSX TA event.
sendeventlog type state code Sends the event log. The parameters are:
type
0: DSA
1: DSC
2: DSD

state
1: REQ
2: RSP

code
The confirmation code.

atp

Enters the ATP debug menu. The following commands are available:
Command Description
dsa100a grant us ds Initiates DSA with 1 or 2 Service Flows.
The parameters are:
grant
The grant size: 100 or 200.
us
The upstream port type:
0: UDP
1: TCP

ds
The downstream port type:
0: UDP
1: TCP

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 577

Command Description
dsc200a usf grant dsf dscls ds Initiates DSA with 1 or 2 Service Flows.
The parameters are:
usf
The upstream Service Flow ID.
grant
The grant size: 100 or 200.
dsf
The downstream Service Flow ID.
dscls
The downstream Classifier.
ds
The downstream port type:
0: UDP
1: TCP
dsa100_abc grant us1 us2 us3 Initiates DSA with 1 upstream Service
Flow. The parameters are:
grant
The grant size: 100 or 200.
us1
The first upstream port type:
0: UDP
1: TCP

us2
The second upstream port type:
0: UDP
1: TCP

us3
The third upstream port type:
0: UDP
1: TCP
dsa300a ipaddr port Initiates DSA with one UGS Service
Flow, two Classifiers, and one PHS.
The parameters are:
ipaddr
The upstream destination IP
address.
port
The upstream port.

Firmware Guide Release 7.5 Standard 1.2 August 2012

578 Chapter 10

Command Description
dsc300a sfid clsid phsid Initiates DSC to activate PHS of the
USF-300a Service Flow. The parame-
ters are:
sfid
The Service Flow ID.
clsid
The Classifier ID.
phsid
The PHS ID.
dsa300b ipaddr port Initiates DSA with one Best Effort Ser-
vice Flow and one classifier. The
parameters are:
ipaddr
The destination IP address.
port
The upstream port.
dsa_scn_4 portA portB Runs DSA with upstream and down-
portC portD stream Service Flows with SCN (test 4).
The four parameters specify each of the
four upstream ports.
dsc_scn_4 ussf portB portC Runs DSC for upstream and down-
dssf clsid portD stream Service Flows (test 4). The
parameters are:
ussf
The upstream Service Flow ID.
portB/C
Two upstream ports.
dssf
The downstream Service Flow ID.
clsid
The Classifier ID.
portD
The downstream port.

Debug Enters the Debug submenu. The following commands are available.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 579

cerreset

Syntax: cerreset {channel}

Resets the CER counter for the specified receive channel. Valid range: 0 to 3.

equadump

Displays equalization coefficients.

Note: Running this command in application mode can cause unexpected
results.

equthresh

Syntax: equthresh {eq}

Displays the specified equalizer threshold.
Example:
Debug> equthresh 0
Equalizer threshold is 0.000050
Debug>

macread

Syntax: macread {addr}

Displays the value of the specified MAC register. The specified addr is offset
from 0x90000000.

macwrite

Syntax: macwrite {val} {addr}

Writes data to the specified MAC register. The specified addr is offset from
0x90000000.

setequthresh

Syntax: setequthresh {val}

Sets the equalizer threshold to the specified value.

Firmware Guide Release 7.5 Standard 1.2 August 2012

580 Chapter 10

temptuner

Syntax: temptuner {tuner} {index}

Displays the tuner temperature. The parameters are:
tuner
Either 0 for the wideband tuner, or 1 for the narrowband tuner.
index
The tuner index.

adcdump

Syntax: adcdump {mode} {type} {length}

Displays or saves an ADC dump. The parameters are:
mode
Either 0 to display the ADC dump on the console, or 1 to write the
dump to a file.
type
One of the following:
0: WBADC
1–3: narrowband ADC
4: wideband ADC as narrowband

length
The length of the dump (in pairs).

dump

Syntax: dump 0
Displays all PHY registers.

read

Syntax: read {reg}

Displays the contents of the specified PHY register.

tunerstatus

Displays tuner configuration data. In wideband mode, this command dis-

plays regular status. In narrowband mode, this command displays the status
for all tuners.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 581

Example:
Debug> tunerstatus
IF AGC -60
RF AGC 4.000 [dB] ( ATTN = 0, RL = 5, DNC = 75 )
1st LO freq is 1986000256.000 [Hz] ˜ 1986.000 [MHz]
2nd LO freq is 1166999936.000 [Hz] ˜ 1167.000 [MHz]
Input center frequency is 741000000.000 [Hz] ˜ 741.000 [MHz]
Current 1st IF in use is 1245000192.000 [Hz] ˜ 1245.000 [MHz]
Output center frequency is 77500000.000 [Hz] ˜ 77.500 [MHz]
Output channel bandwidth is 89.000 [MHz]
Debug>

usstatus

Displays upstream configuration data.

Example:
Debug> uss
PGA (ANAD-ARA2017) codeword is 31
PGA current is 7
Digital Att : 1.739053 9.127320 9.127320 9.127320
Frquency : 24.999454 10.000000 10.000000 10.000000
Symbol rate : 2560 0 0 0
modulation : QPSK ERR ERR ERR
SCDMA mode : 0 0 0 0
rep power : 62.1800 13.0000 13.0000 13.0000
Upstream : 1 0 0 0
Debug>

dsstatus

Displays downstream channel status.

Example:
Debug> dss
Number of receivers : 4
Receiver # : 1 2 3 4
Frequency(MHz) : 441.001 423.002 428.999 435.000
QAM Lock : YES YES YES YES
FEC Lock : YES YES YES YES
MPEG Lock : YES YES YES YES
MSE : -39.855 -38.983 -39.855 -39.855
DCID : 8 5 6 7

Firmware Guide Release 7.5 Standard 1.2 August 2012

582 Chapter 10

write

Syntax: write {value} {reg}

Writes data to the specified PHY register.

mml

Syntax: mml {value} {addr}

Writes a 4-byte value to the specified physical SoC address.

dml

Syntax: dml {addr} {count}

Dumps data beginning at the specified physical SoC address.

phystatus

Syntax: phystatus {channel}

Displays the PHY status of the specified channel. Valid range: 0 to 3.
Example:
Debug> phystatus 0
Current PHY status:
RF frequency: 741.001953 MHz
IF frequency: 77998352 Hz
Qam mode : 64 QAM
Annex: ANNEX-A (Euro)
MSE: -36.124 dB
IF AGC -60
RF AGC 4.000 [dB] ( ATTN = 0, RL = 5, DNC = 75 )
Energy backoff: -29.487 dB
Annex A interleaver mode: I=12, J=17
CW Error Rate: 5.13e-05
QAM Lock: YES
FEC Sync: YES
MPEG Sync: YES
Carrier offset is -14359.943 Hz
Timing offset: 11 ppm
Burst counter = 2
Llp up/down counter = 0 / 3
Lost 1/100/500 counters = 1 / 1 / 1
Reported power is 10.9867 dBmv
Debug>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 583

berstatus

Syntax: berstatus {channel} {time}

Displays the bit error rate (BER) status of the specified channel. The param-
eters are:
channel
The downstream channel. Valid range: 0 to 3.
time
The time, in seconds, over which to measure BER.
Example:
Debug> berstatus 2 5
Sec CER Pre.BER Es.BER Frame Err.F MSE IF-AGC
1 0.00e+00 0.00e+00 0.00e+00 25684 0 -39.85 92
2 0.00e+00 0.00e+00 0.00e+00 25804 0 -39.85 92
3 0.00e+00 0.00e+00 0.00e+00 25805 0 -39.85 92
4 0.00e+00 0.00e+00 0.00e+00 25806 0 -39.85 93
5 0.00e+00 0.00e+00 0.00e+00 25806 0 -39.85 93

isrmask

Syntax: isrmask {mask} {group} {flag}

Masks or unmasks the specified interrupt. The parameters are:
bitmask
The interrupt mask to use.
intGroup
One of the following:
0: MAC_ERR1_INT_GROUP
9: REMOTE_PHY_INT_GROUP

flag
Either 1 to set the mask, or 0 to unset the mask.

clearNvramDsUsFreqDb

Clears the downstream and upstream frequency databases in NVRAM.

clearNvramUsFreqDb

Clears the upstream frequency database in NVRAM.

Firmware Guide Release 7.5 Standard 1.2 August 2012

584 Chapter 10

printNvramDsUsFreqDb

Displays the downstream and upstream frequency database in NVRAM.

initDsUsFreqDb

Initializes the downstream and upstream frequency databases.

allphystatus

Displays the PHY status for all active channels (DOCSIS 3.0 mode only).

ucdCollectStatus

Displays the UCD collect status.

Example:
Debug> ucd
CliCollectUcdRequests status:
usPort 1: ucdCollectMode 3 dsPortId 1 ucId 5
usPort 2: ucdCollectMode 0 dsPortId 0 ucId 0
usPort 3: ucdCollectMode 0 dsPortId 0 ucId 0
usPort 4: ucdCollectMode 0 dsPortId 0 ucId 0

SetDebugOption

Syntax: SetDebugOption {option} {flag}

Sets or clears the specified debug option. The parameters are:
option
The debug option. Use the showDebugOptions command to see
a list of valid options (the ‘‘Num’’ column is the option number).
flag
Either 1 to set the option, or 0 to clear the option.

SetAllDebugOptions

Syntax: SetAllDebugOptions {value}

Sets the value of all debug options at once. The value is the OR’ed sum of
all bit positions to set. Other options are cleared. For example,
SetAllDebugOptions 0x20 is equivalent to SetDebugOption 5 1 when no
debug options are enabled.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 585

showDebugOptions

Syntax: showDebugOptions
Shows a list of debug options.

ForceT4Multiplier

Syntax: ForceT4Multiplier {ucid} {multiplier}

Sets the T4 multiplier. The parameters are:
ucid
The upstream channel ID. Use 0 to specify all upstreams.
multiplier
The T4 multiplier to use. Use 0 to turn off the multiplier, or −1 to
display the current multiplier.
Example:
Debug> ForceT4 0 -1
[INFO] [DOCSIS.US(pid=297)]: US[1] (UCID 5) : Current T4 Multiplier
override == 0 (0 == OFF)
[INFO] [DOCSIS.US(pid=297)]: US[2] (UCID 0) : Current T4 Multiplier
override == 0 (0 == OFF)
[INFO] [DOCSIS.US(pid=297)]: US[3] (UCID 0) : Current T4 Multiplier
override == 0 (0 == OFF)
[INFO] [DOCSIS.US(pid=297)]: US[4] (UCID 0) : Current T4 Multiplier
override == 0 (0 == OFF)

ForceRngRspAbort

Syntax: ForceRngRspAbort {ucid} {flag}

Forces RNG-RSP attempts on the specified upstream to abort. The parame-
ters are:
ucid
The upstream channel ID. Use 0 to specify all upstreams.
flag
Set to 1 to enable abort, 0 to disable abort, or −1 to display the cur-
rent status.

ForceRngRspFreq

Syntax: ForceRngRspFreq {ucid} {timeout}

Ignores RNG-RSP messages received within the specified timeout period.
The parameters are:

Firmware Guide Release 7.5 Standard 1.2 August 2012

586 Chapter 10

ucid
The upstream channel ID. Use 0 to specify all upstreams.
timeout
The timeout period. Use 0 to disable timeout, or −1 to display the
current settings.

ForceRngRspDRW

Syntax: ForceRngRspDRW {action} {value}

Performs the specified action using the DRW (Pload Min Set) TLV in a
RNG-RSP message. The parameters are:
action
One of: Ignore, Override (overrides once with the specified value),
Off, or Print.

value
Used with the Override action; specifies the override value.

ForceRngRspPowerOffset

Syntax: ForceRngRspPowerOffset {ucid} {value}

Uses the specified PowerOffset (TLV2) in the next RNG-RSP message. The
parameters are:
ucid
The UCID to use.
value
The offset value. If ucid is 0, specify four values, one for each
port.

RebootSimulate

Syntax: RebootSimulate {data}

Simulates an internal reset request. The value of data can be either 0 or 1.

SetMimo

Syntax: SetMimo [value]

Sets the MDD IP Mode Override (MIMO) parameter. Using this command
overrides both the docsIf3CmMdCfgIpProvMode and arrisCmDoc30Setup-
MddIpModeOverride objects.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 587

Omit the value to show the current setting.

CAUTION
Potentially service-affecting
Override settings can potentially prevent the eDVA from registering. For
example, setting this object to 2 (IPv6) when no DHCPv6 server is available
causes the eDVA to attempt to register as IPv6 only, ignoring any DHCPv4
servers. Since this setting is stored in non-volatile memory, you must either
change the value using SNMP or the CLI, or reset the Telephony Modem to
factory defaults to clear the setting.

The allowed values are:

• −1: inactivates the override, allowing the MIB objects to determine the
MDD override setting.
• 0: use the IP mode set in the MDD message.
• 1: override the MDD setting and use IPv4.
• 2: override the MDD setting and use IPv6.
• 3: (Alternate Provisioning Mode) override the MDD setting and try
IPv6 provisioning first, then IPv4.
• 4: (Dual-stack Provisioning Mode) override the MDD setting and
attempt to register using IPv4 and IPv6 simultaneously.

SetMdCfgIpProvMode

Syntax: SetMdCfgIpProvMode [value]

Controls MdCfgIpProvMode settings. Omit the value to show the current
setting. The allowed values are:
• 0: IPv4
• 1: IPv6
• 4: use the MDD.

DCC

Displays DCC debug information from the file /share/DCC.

DBC

Displays debug information stored in the file /share/DBC.

Firmware Guide Release 7.5 Standard 1.2 August 2012

588 Chapter 10

ForceUsPSM

Syntax: ForceUsPSM {us} {flag}

Forces PSM on or off, on the specified upstream. The parameters are:
us
The upstream.
flag
Either on or off.

ForceDsPSM

Syntax: ForceDsPSM {ds} {flag}

Forces PSM on or off, on the specified downstream. The parameters are:
ds
The downstream.
flag
Either on or off.

Dsid Enters the Dsid submenu. The following commands are available.

mdfMode

Displays the current MDF mode.

dsidCounters

Displays DSID counters.

Example:
Dsid> dsid

DSID Resequencing number: 2

DSID Multicast number: 0
DSID Total number: 2

confCode

Displays the DSID confirmation code.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 589

reseqDsids

Displays information about resequencing DSIDs.

mcastDsids

Displays information about multicast DSIDs.

allDsids

Displays all DSIDs.

Example:
Dsid> all

DSID Resequencing number: 2

DSID Multicast number: 0
DSID Total number: 2

DSID Information:
-----------------

DsidDbIdx | DsidHwIdx | DSID | MCen | RSQen | PHSen |

-----------|-----------|---------|------|-------|-------|
0 | 0 | 0x0575e | 0 | 1 | 0 |
1 | 1 | 0x057e3 | 0 | 1 | 0 |

printDsidDb

Displays DSID database info.

dbridgeMdfDb

Displays the DOCSIS Bridge MDF database.

dbridgeAlt

Displays the DOCSIS Bridge address lookup table.

dbridgeListCpe

Displays the DOCSIS Bridge CPE MAC address list.

Firmware Guide Release 7.5 Standard 1.2 August 2012

590 Chapter 10

dbridgeCounters

Syntax: dbridgeCounters
Displays DOCSIS Bridge counters.

Pp Enters the Pp submenu. The following commands are available.

enableTdox

Enables TurboDox.

disableTdox

Disables TurboDox.

tdox

Displays the internal TurboDox driver database.

enableL2vpnPromMode

Enables L2VPN promiscuous mode.

disableL2vpnPromMode

Disables L2VPN promiscuous mode.

stats

Displays an HIL analysis.

if

Displays interface counters by network devices.

tpPorts

Displays transparent ports frames counters.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 591

filters

Displays filter match counters by filter ID.

classifiers

Displays QoS Classifier match packet counters by SFID and classifier ID.

all

Displays all DOCSIS Packet Processor counters.

Psm Enters the Psm submenu. The following commands are available.

downstream

Syntax: downstream {flag} {ds}

Enables or disables PSM on the specified downstream. The parameters are:
flag
Either 1 to enable PSM, or 0 to disable.
ds
The downstream channel. Valid range: 2 to 8.

upstream

Syntax: upstream {flag} {us}

Enables or disables PSM on the specified upstream.
flag
Either 1 to enable PSM, or 0 to disable.
us
The upstream channel. Valid range: 2 to 4.

phy-mac

Syntax: phy-mac {flag}

Enables or disables PSM on three MAC and PHY interfaces.

Firmware Guide Release 7.5 Standard 1.2 August 2012

592 Chapter 10

pp

Syntax: pp {flag}
Enables or disables PSM on the Packet Processor.

psm

Syntax: psm {flag}

Enables or disables PSM.

wb-adc

Syntax: wb-adc {flag}

Enables or disables WB-ADC. The value of flag is either 1 to enable WB-
ADC, or 0 to disable.

pompt

Syntax: pompt {flag}

Enables or disables the Downstream Primary over MPEG Tuner (PoMPT).
The value of flag is either 1 to enable the PoMPT, or 0 to disable.

get-pompt

Displays the NVRAM PoMPT mode setting (ON or OFF).

PACM Submenu Commands

The PACM submenu commands provide control over PacketCable-related

settings.

version Prints the PACM version.

Example:
pacm> version
PACM version: 1,1,0,18. (buid at: 2008/08/20 15:55:04)
PACM Friendly release: N/A

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 593

options Displays the PACM compilation options.

provisioning Enters the Provisioning submenu. The following commands are available.

dhcpServersConfig

Syntax: dhcpServersConfig {primary} {secondary}

Sets the IPv4 addresses of the primary and secondary DHCP servers. The
addresses are expressed in dotted notation, such as 192.168.69.4.

sendCMLinkUpEvent

Sends a CM ‘‘link up’’ event to start eDVA provisioning.

sendMSMStartEvent

Sends an ‘‘MSM start’’ event.

sendDHCPLeaseFailEvent

Sends a ‘‘DHCP Lease Fail’’ event.

sendDHCPNewIPEvent

Sends a ‘‘DHCP New IP’’ event.

sendCMLinkDownEvent

Sends a ‘‘CM Link Down’’ event.

sendCMFullScanNoQam

Sends a ‘‘full scan no QAM’’ message to the CM.

sendCMQamRegained

Sends a ‘‘CM QAM Regained’’ event.

sendCMResetEvent

Sends a ‘‘CM Reset’’ event.

Firmware Guide Release 7.5 Standard 1.2 August 2012

594 Chapter 10

sendMTAResetEvent

Sends an ‘‘eDVA Reset’’ event.

sendVoiceRstDoneEvent

Sends a ‘‘Voice reset done’’ event.

sendVoiceRstFailEvent

Sends a ‘‘Voice reset fail’’ event.

sendSecRstDoneEvent

Sends a ‘‘Sec Reset done’’ event.

sendSecRstFailEvent

Sends a ‘‘Sec Reset fail’’ event.

configFile

Syntax: configFile {server} {filename}

Sets the configuration file URL and file name.

hashBypassSet

Sets hash checking bypass.

provDBcontents

Prints the contents of the provisioning database.

setVoiceLoopVoltage

Changes the loop voltage state.

tftpAlwaysOn

Sets the permanent TFTP download status.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 595

provStatus

Prints the eDVA provisioning status.

provFlow

Gets the eDVA provisioning flow.

provDebug

Enters the Provisioning Debug Sub-Menu. The following commands are

available:
display_SME_EventsTable
Displays the SME events table.

security Enters the Security submenu. The following commands are available.

resetTickets

Syntax: resetTickets {ticket}

Deletes the specified ticket from NVRAM. The ticket is one of:
1 PROV-SERVER
2 CMS
3 ALL

overrideCmsTtl

Syntax: overrideCmsTtl {time}

Overrides the CMS TTL with the specified time (in seconds).

timersDisplay

Displays security timers.

smDataDisplay

Displays state machine data.

Firmware Guide Release 7.5 Standard 1.2 August 2012

596 Chapter 10

mtaDisplay

Displays current eDVA data.

displayDB

Prints the contents of the security database.

certificates

Enters the Certificates Sub-Menu. The following commands are available:

Command Description
getMtaCert Syntax: getMtaCert {mode} {cert} {key} {ipaddr}
Gets an eDVA certificate file from the TFTP server.
The parameters are:
mode: 1 for Euro, or 0 for North America.
cert: The certificate file name.
key: The encryption key used to validate the certificate.
ipaddr: The TFTP server IP address.
getAllCerts Syntax: getAllCerts {mode} {mtacert} {mtakey}
{mfrcert} {rootcert} {ipaddr}
Downloads all the certificate files from the TFTP
server. The parameters are:
mode: 1 for Euro, or 0 for North America.
mtacert: The eDVA certificate file name.
mtakey: The encryption key used to validate the eDVA
certificate.
mfrcert: The manufacturer certificate file name.
rootcert: The root certificate file name.
ipaddr The TFTP server IP address.
certMtaSet Syntax: certMtaSet {mode} {mtacert} {mtakey}
Sets eDVA certificate files. The parameters are:
mode: 1 for Euro, or 0 for North America.
mtacert: The eDVA certificate file name.
mtakey: The encryption key used to validate the eDVA
certificate.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 597

Command Description
certManufSet Syntax: certManufSet {mode} {mfrcert} {mfrkey}
Sets the manufacturer certificate files. The parameters
are:
mode: 1 for Euro, or 0 for North America.
mfrcert: The manufacturer certificate file name.
mfrkey: The encryption key used to validate the manu-
facturer certificate.
certIpteleSet Syntax: certIpteleSet {mode} {rootcert}
Sets the Intel root certificate file. The parameters are:
mode: 1 for Euro, or 0 for North America.
rootcert: The root certificate file name.
resetCertsToDefault Resets the manufacturer and Iptel root certificates to
the defaults specified in NVRAM.
displayCertContent Syntax: displayCertContent {mode} {type}
Displays the contents of the specified certificate. The
parameters are:
mode: 1 for Euro, or 0 for North America.
type: One of 1 (eDVA), 2 (Manufacturer), or 3 (Root).
setCertsRootType Syntax: setCertsRootType {zone} {type}
Forces selection of the specified root certificate. The
parameters are:
zone: 1 for Euro, or 0 for North America.
type: The root certificate type, 1 for Test Root or 2 for
Real Root.
displayCertsDir Displays the current root certificate.

vendorSubMenu Enters the Vendor submenu.

CAUTION
Potentially service affecting
These commands change settings in NVRAM and may be service-affecting.
Use these commands only with the guidance of ARRIS Technical Support.

The following commands are available.

Firmware Guide Release 7.5 Standard 1.2 August 2012

598 Chapter 10

vendorSetDhcpServerAddr

Syntax: vendorSetDhcpServerAddr {ipaddr}

Sets the primary eDVA DHCP server address.

vendorModifyDhcpAckParam

Syntax: vendorModifyDhcpAckParam {flow} {MTA24} {MTA25} {down-

load} {filename} {syslog_ipaddr} {realm}
Modifies the parameters received in eDVA DHCP ACK parameters. The
parameters are:
flow
The provisioning flow; one of:
0 (Basic)
1 (Hybrid)
2 (Secure)

MTA24
Send events to a Syslog server: 0 to disable, 1 to enable.
MTA25
Send events using SNMP Inform: 0 to disable, 1 to enable.
download
Specify whether to download the configuration file: 0 to disable, 1
to enable.
local
A string specifying the local configuration file name.
syslog
The IP address of the Syslog server.
realm
A string containing the realm name.

vendorSetTftpData

Syntax: vendorSetTftpData {tftp_ipaddr} {filename}

Sets the eDVA TFTP server IP address and configuration file name.

vendorAddSnmpTarget

Syntax: vendorAddSnmpTarget {ipaddr} {type}

Adds a target for sending SNMP messages (overrides MTA25).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 599

printVendorRegisteredEvents

Prints all vendor-registered events.

VENDOR_STATUS_VENDOR_APP_set

Syntax: VENDOR_STATUS_VENDOR_APP_set {flag}

Sets the status of the vendor app: 0 to disable, or 1 to enable.

VENDOR_AFTER_MSM_INIT_set

Syntax: VENDOR_AFTER_MSM_INIT_set {flag}

Sets the status of the VENDOR_AFTER_MSM_INIT message: 0 to disable,
or 1 to enable.

VENDOR_SET_DHCP_SERVER_ADDR_set

Syntax: VENDOR_SET_DHCP_SERVER_ADDR_set {status}

Sets the status of the VENDOR_SET_DHCP_SERVER_ADDR message:
0 (disable)
1 (auto)
2 (manual)

VENDOR_AFTER_DHCP_ACK_set

Syntax: VENDOR_AFTER_DHCP_ACK_set {status}

Sets the status of the VENDOR_AFTER_DHCP_ACK message:
0 (disable)
1 (auto)
2 (manual)

VENDOR_SET_TFTP_DATA_set

Syntax: VENDOR_SET_TFTP_DATA_set {status}

Sets the status of the VENDOR_SET_TFTP_DATA message:
0 (disable)
1 (auto)
2 (manual)

Firmware Guide Release 7.5 Standard 1.2 August 2012

600 Chapter 10

VENDOR_ADD_SNMP_TARGET_set

Syntax: VENDOR_ADD_SNMP_TARGET_set {status}

Sets the status of the VENDOR_ADD_SNMP_TARGET message:
0 (disable)
1 (auto)
2 (manual)

VENDOR_BEFORE_MTA_RESET_set

Syntax: VENDOR_BEFORE_MTA_RESET_set {flag}

Sets the status of the VENDOR_BEFORE_MTA_RESET message: 0 to dis-
able, or 1 to enable.

VENDOR_ENABLE_EVENTS_set

Syntax: VENDOR_ENABLE_EVENTS_set {flag}

Sets the status of the VENDOR_ENABLE_EVENTS message: 0 to disable,
or 1 to enable.

VENDOR_ENABLE_DHCP_PLUG_IN_set

Syntax: VENDOR_ENABLE_DHCP_PLUG_IN_set {flag}

Sets the status of the vendor DHCP plug-in: 0 to disable, or 1 to enable.

VENDOR_ENABLE_CFM_PLUG_IN_set

Syntax: VENDOR_ENABLE_CFM_PLUG_IN_set {flag}

Sets the status of the vendor configuration file manager plug-in: 0 to disable,
or 1 to enable.

VENDOR_DISABLE_CFM_SPEC_TREE_set

Syntax: VENDOR_DISABLE_CFM_SPEC_TREE_set {flag}

Sets the spec tree status: 0 for active (the default), or 1 for inactive.

restore

Restores parameters to the default values.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 601

save

Saves all parameters to flash memory.

show

Prints the current settings.

production Enters the Production submenu.

CAUTION
Potentially service affecting
These commands change settings in NVRAM and may be service-affecting.
Use these commands only with the guidance of ARRIS Technical Support.

The following commands are available.

prodSet

Sets a parameter by index.

PACM_CONFIG_EURO_set

Sets the operation mode (US or Euro).

PACM_CONFIG_MTA_NUM_LINES_set

Sets the number of lines.

PACM_CONFIG_IP_ADDR_set

Configures the IP Address.

PACM_CONFIG_HW_ADDR_set

Sets the eDVA network device H/W Address.

PACM_CONFIG_MTA_TELE_ID_set

Sets the eDVA SLIC type.

Firmware Guide Release 7.5 Standard 1.2 August 2012

602 Chapter 10

PACM_CONFIG_MTA_BBU_set

Sets the eDVA BBU value.

save

Saves all parameters to flash memory.

show

Prints the current settings.

setDefaultMacAddress

Set the default MAC-Address to the eDVA.

dynamicConfig Enters the Dynamic Configuraion Menu. The following commands are avail-
able.

set

Sets a parameter by index.

PACM_DYN_CONFIG_LOOPV_POLICY_set

Sets the loop voltage policy.

PACM_DYN_CONFIG_LOOPV_STATUS_set

Sets the loop voltage status.

PACM_DYN_CONFIG_LOOPV_RESET_TIMER_set

Sets the loop voltage reset timer value.

PACM_DYN_CONFIG_LOOPV_MAINT_TIMER_CD_set

Sets the loop voltage maintenance timer countdown value.

PACM_DYN_CONFIG_SNMP_ENGIN_BOOT_NUM_set

Displays the number of SNMP engine reboots.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 603

restore

Restores parameters to their default values.

save

Saves all parameters to flash memory.

show

Prints the current settings.

event Enters the Event Menu. The following commands are available.

sendEvent

Syntax: sendEvent {eventID} {flag}

Sends an event. The parameters are:
eventID
The event ID to send.
flag
Either 0 for false, or 1 for true.

displayEventTable

Displays the event table.

printLogFile

Displays the formatted log file.

resetLogFile

Resets the log file.

deleteLogFile

Deletes the log file.

Firmware Guide Release 7.5 Standard 1.2 August 2012

604 Chapter 10

resetTables

Resets all tables.

debugMenu Enters the Debug Menu. The following commands are available.

debugSet

Sets a parameter by index.

PACM_CONFIG_EURO_HASH_SIZE_20_set

Enables a size-20 Euro hash.

PACM_CONFIG_MTA_RESET_WATCH_DOG_set

Enables MTA reset when voice does not answer on cleanup.

PACM_CONFIG_TICKETS_FLASH_SUPPORT_set

Sets tickets support.

PACM_CONFIG_PROV_DHCP_RETRIES_set

Sets the number of DHCP Retries allowed during provisioning.

PACM_CONFIG_IPSEC_ENABLE_set

Enables or disables IPsec. A setting of 0 (false) overrides the configuration

file.

PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set

Syntax: PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set {mask}

Sets the bit mask for supported provisioning flows. The bit mask values are:
0x1 (Secure)
0x2 (Hybrid)
0x4 (Basic)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 605

PACM_CONFIG_CERTIFICATION_MODE_set

Enables or disables Certification mode.

PACM_CONFIG_SNMPV2_ACCESS_set

Enables or disables eDVA SNMPv2 access.

PACM_CONFIG_TLV38_SNMPV1_ENABLE_set

Enables or disables eDVA TLV-38 SNMPv1 Trap sends.

PACM_CONFIG_CFM_FILE_HASH_BYPASS_set

Enables or disables the configuration file hash checking bypass.

PACM_CONFIG_MAS_ROUTE_TO_LOGGER_set

Enables or disables routing of MAS Spy messages to the logger.

ARRIS_PROVISIONING_set

Syntax: ARRIS_PROVISIONING_set {type}

Sets the ARRIS provisioning type:
0 (BASIC1)
1 (BASIC2)
2 (HYBRID1)
3 (HYBRID2)
4 (SECURE)
5 (GUPI)
6 (MINUS_KDC)

restore

Restores parameters to their default settings.

save

Saves all parameters to flash memory.

Firmware Guide Release 7.5 Standard 1.2 August 2012

606 Chapter 10

show

Prints current settings.

managerMenu Enters the Manager Menu. The following commands are available.

PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set

Syntax: PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set {flag}

Sets the status of Voice PSM features: 1 to enable, or 0 to disable.

PACM_MANAGER_VOICE_DECT_IF_set

Syntax: PACM_MANAGER_VOICE_DECT_IF_set {flag}

Sets the DECT interface: 1 to enable, or 0 to disable.

PACM_MANAGER_VOICE_VLM_IF_set

Syntax: PACM_MANAGER_VOICE_VLM_IF_set {flag}

Enables or disables VLM interfaces: 1 to enable, or 0 to disable.

PACM_MANAGER_SNMP_RESTRICT_CONFIG_VIEW_set

Restricts the @mtaconfig view according to the supported zone.

PACM_MANAGER_TOD_DELAY_SEC_PROV_set

Sets the TOD feature status.

PACM_MANAGER_HITLESS_SOFTWARE_DOWNLOAD_set

Sets the hitless software download feature status.

PACM_MANAGER_HITLESS_DHCP_set

Sets the hitless DHCP feature status.

PACM_MANAGER_RANDOM_USM_SPIN_LOCK_set

Sets the random USM spinlock feature status.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 607

PACM_MANAGER_VENDOR_COMMUNITY_NAME_set

Sets the specific vendor community name feature status.

PACM_MANAGER_VENDOR_CMS_AS_IP_set

Enables or disables the ‘‘using CMS as IP’’ flag.

PACM_MANAGER_VENDOR_ENABLE_EVENTS_set

Syntax: PACM_MANAGER_VENDOR_ENABLE_EVENTS_set {flag}

Sets the status of the VENDOR_ENABLE_EVENTS message: 0 (disable) or
1 (enable).

PACM_MANAGER_PSM_ENABLE_set

Sets the PSM feature status.

restore

Restores parameters to the default values.

save

Saves all parameters to flash memory.

show

Prints the current settings.

Firmware Guide Release 7.5 Standard 1.2 August 2012

608 Chapter 10

Logger Submenu Commands

The Logger sub-menu controls logging displays.

ComponentConfig Syntax: ComponentConfig {component} {flag}

Enables or disables the specified component. Use the componentsList com-
mand to display a list of components and their current status.

AllCompo- Syntax: AllComponentsConfig {flag}

nentsConfig Enables or disables all components.

ModuleConfig Syntax: ModuleConfig {component} {module} {flag}

Enables or disables the specified module. Use the modulesList command to
display a list of modules and their current status.

AllModulesConfig Syntax: AllModulesConfig {component} {flag}

Enables or disables all modules for the specified component.

SeverityConfig Syntax: SeverityConfig {severity} {flag}

Enables or disables the specified severity level. Use the severitiesList com-
mand to display a list of severity levels and their current status.

AllSeveritiesCon- Syntax: AllSeveritiesConfig {flag}

fig Enables or disables logging for all severity levels.

SocketConfig Syntax: SocketConfig {ipaddr} {port}

Sets the IP address and port for the Logger UDP target. Use the TargetCon-
fig command to control UDP-based logging. Use the socketShow command
to display the current settings.

FilenameConfig Syntax: FilenameConfig {name}

Sets the file name for a local log file. Use the TargetConfig command to
control file-based logging. Use the filenameShow command to display the
current file name.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 609

QueueLimitConfig Syntax: QueueLimitConfig {msglimit} {size}

Sets the message queue limits. The parameters are:
msglimit
The maximum number of messages to store.
size
The maximum number of bytes allowed in the queue.
For both parameters, a value of 0 removes queue limits, and −1 sets the
default limits.
Use the queueLimitShow command to display the current queue limit set-
tings.

DebugModule- Syntax: DebugModulesConfig {component} {module} {flag}

sConfig Enables or disables debug output for the specified module. Use the mod-
ulesList command to display a list of modules and their current status.

AllDebugModule- Syntax: AllDebugModulesConfig {component} {flag}

sConfig Enables or disables debug output for all modules for the specified compo-
nent.

TimeDisplay Syntax: TimeDisplay {flag}

Enables or disables time display.

ComponentDis- Syntax: ComponentDisplay {flag}

play Enables or disables component display.

ModuleDisplay Syntax: ModuleDisplay {flag}

Enables or disables module display. Use the modulesList command to show
which modules are active.

FunctionLineDis- Enables or disables function and line display.

play

FullDisplay Enables full display.

Firmware Guide Release 7.5 Standard 1.2 August 2012

610 Chapter 10

DefaultDisplay Enables the default display.

ShortDisplay Enables short display.

UserDisplay Syntax: UserDisplay {flag}

Saves or restores the user-defined display. Set the flag to 1 to save the user-
defined display, or 0 to restore to the previous user-defined display.

TargetConfig Syntax: TargetConfig {target} {flag}

Enables or disables the specified output target. Use the targetsList com-
mand to display the valid targets and their current settings.

componentsList Displays the components list and indicates the current status of each compo-
nent.
Example:
logger> componentsList
Logger Components List:
1 DOCSIS Disabled
2 PACM Disabled
3 COMMMON_COMPONENTS Disabled
4 VOICE Disabled
6 ARRIS Disabled

logger>

modulesList Syntax: modulesList {component}

Displays the modules for the specified component, and indicates the status of
each module. Use the componentsList command to display available com-
ponents.
Example:
logger> modulesList 1
Logger Component’s 1 Modules List:
0 INIT Disabled
1 PROVISIONING Disabled
2 BPI Disabled
3 SNMP Disabled
4 SWDL Disabled
5 CVC_VERIFY Disabled
6 CFG_PARSER Disabled
7 DCC Disabled
8 CHM Disabled

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 611

9 DMD Disabled
10 DMG Disabled
11 RCCDB Disabled
12 TCCDB Disabled
13 TCC_PARSER Disabled
14 EVENT_MGR Disabled
15 REGISTRATION Disabled
16 FLTR_CLASS Disabled
17 HAL Disabled
18 DS Disabled
19 SME Disabled
20 UCD Disabled
21 US Disabled
22 NVRAM_DB Disabled
23 IPP Disabled
24 QOS Enabled
25 PROD_DB Disabled
26 REINIT_MAC Disabled
27 DSID Disabled
28 UTILS Disabled
29 CMSTATUS Disabled
30 CMCONTROL Disabled
31 MDD Disabled
32 FREQ_SCAN Disabled
33 LEDD Disabled
34 DOCSIF Disabled
35 MNGT_FLOW Disabled
36 CHDB Disabled
37 SYSCFG_DB Disabled
38 DOCSISCFG_DB Disabled

severitiesList Displays the severities list and indicates the current status of each severity.
Example:
logger> severitiesList
Logger Severities List:
0 FATAL Enabled
1 ERROR Enabled
2 WARNING Enabled
3 INFO Enabled
4 INIT Enabled
5 STATISTICS Enabled
6 ENTER Enabled
7 EXIT Enabled
8 USER_DEFINED Enabled
9 DEBUG Enabled
10 FATAL_BUFFER Enabled
11 ERROR_BUFFER Enabled
12 WARNING_BUFFER Enabled

Firmware Guide Release 7.5 Standard 1.2 August 2012

612 Chapter 10

13 INFO_BUFFER Enabled
14 DEBUG_BUFFER Enabled
15 INFO_VERBOSE Enabled

logger>

displayConfigList Displays the current display configuration.

Example:
logger> displayConfigList

----- Logger Display Format:

[ 0] Time: Disabled | [ 1] Comp+PID: Enabled

[ 2] Mod: Enabled | [ 3] Func+Line: Disabled

logger>

targetsList Displays the target list and indicates the status for each target.
Example:
logger> targetsList
Logger Targets List:
0 Screen Enabled
1 File Disabled
2 UDP Disabled

logger>

socketShow Displays the IP address and port of the Logger UDP target. Use the Socket-
Config command to make changes.

Example:
logger> socketShow
UDP Target Settings:
Destination IP: 192.168.100.100
Destination Port: 4571

logger>

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 613

filenameShow Displays the name of the local log file. Use the FilenameConfig command
to set the log file name.

queueLimitShow Displays the current queue limits.

Example:
logger> queueLimitShow
Logger queue length (Maximum message - 0=unlimited): 100
Logger queue bytes length (Maximum bytes - 0=unlimited): 20000

logger>

setDefaults Restore all logging values to their default settings.

list Shows all components and their modules.

info Shows all logger information (severities, targets, queue, and so on).

enable Enables logger output.

disable Disables logger output.

Event Manager Submenu Commands

The Event Manager submenu commands provides display and control of

event-related functions.

SendEvent Syntax: SendEvent {device} {event_number} {vendor} {must_text} {ven-

dor_text}
Sends the specified event. The parameters are:
device
The device: either cm or mta.
event_number
The Event ID.
vendor
The Vendor ID (4115 for ARRIS, 4491 for PacketCable).

Firmware Guide Release 7.5 Standard 1.2 August 2012

614 Chapter 10

must_text
vendor_text
The text message associated with the event.

SendStdTrap Syntax: SendStdTrap {device} {sub_type} {if_id} {admin_status}

{oper_status}
Sends the specified standard trap. The parameters are:
device
The device: either cm or mta.
sub_type
if_id
The interface number associated with the trap.
admin_status
The administrative status of the interface.
oper_status
The operating status of the interface.

ResetLog Syntax: ResetLog {device}

Resets the Event Manager’s log. for the specified device (cm or mta).

DefaultEventTa- Syntax: DefaultEventTables {device}

bles Resets the Event Manager tables to the default settings (level, mask, and text)
for the specified device (cm or mta).

SetEventLevel Syntax: SetEventLevel {device} {event_id} {new_level}

Sets a new level for the specified event. The parameters are:
device
The device: either cm or mta.
event_id
The Event ID.
new_level
The new level for the event.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 615

SetEventMask Syntax: SetEventMask {device} {event_id} {new_mask}

Sets a new mask for the specified event. The parameters are:
device
The device: either cm or mta.
event_id
The Event ID.
new_mask
The new mask for the event.

SetEventText Syntax: SetEventText {device} {event_id} {new_text}

Sets new text for the specified event. The parameters are:
device
The device: either cm or mta.
event_id
The Event ID of the event to change. Use GetEventsList to see a
list of Event IDs associated with current text.
new_text
The text for the event. Spaces are not allowed in the text.

SetPriorityMask Syntax: SetPriorityMask {device} {priority} {new_mask}

Sets a new mask for the specified priority. The parameters are:
device
The device: either cm or mta.
priority
The priority to affect.
new_mask
The new mask for the specified priority.

GetEventsList Syntax: GetEventsList {device} {vendor}

Displays the events list. The parameters are:
device
The device: either cm or mta.
vendor
Either 0 to display standard events, or 1 to display vendor-defined
events.

Firmware Guide Release 7.5 Standard 1.2 August 2012

616 Chapter 10

SetThrotAdmin Syntax: SetThrotAdmin {device} {status}

Sets the throttling administration status. The parameters are:
device
The device: either cm or mta.
status
The administration status:
1: Unconstrained
2 Throttle below the threshold
3 Stop at the threshold
4 Throttle unconditionally

SetThrotThresh Syntax: SetThrotThresh {device} {threshold}

Sets the throttling threshold. The parameters are:
device
The device: either cm or mta.
threshold
The number of events allowed during the specified interval before
the device stops sending events.

SetThrotInterval Syntax: SetThrotInterval {device} {interval}

Sets the throttling interval. The parameters are:
device
The device: either cm or mta.
interval
The throttling interval, in seconds.

GetThrotParams Syntax: GetThrotParams {device}

Displays the throttling parameter settings for the specified device (cm or
mta).

StartSyslog Syntax: StartSyslog {device} {ipVer} {ipaddr}

Starts the Syslog service. The parameters are:
device
The device: either cm or mta.
ipVer
Use 0 for IPv4, or 1 for IPv6.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

MAIN Console Commands 617

ipaddr
The IP address of the Syslog server.

StopSyslog Syntax: StopSyslog {device}

Stops the Syslog service on the specified device (cm or mta).

GetSyslogServer Syntax: GetSyslogServer {device}

Displays the Syslog server parameters for the specified device (cm or mta).

StartSNMP Syntax: StartSNMP {device}

Starts the SNMP agent for the specified device (cm or mta).

StopSNMP Syntax: StopSNMP {device}

Stops the SNMP agent for the specified device (cm or mta).

ExitManager Syntax: ExitManager {device}

Stops and exits the Event Manager. for the specified device (cm or mta).

Firmware Guide Release 7.5 Standard 1.2 August 2012

618 Chapter 10

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 11 Voice CLI Commands

The Voice CLI provides commands to display and control the eDVA.

Common Voice Commands

The following commands are common to all Voice sub-menus.

!reset Resets the Telephony Modem as if you pushed the Reset button on the back
of the unit.

help Displays the commands available at the current prompt.

quit Quits the CLI.

Top-Level Commands

The following commands are available at the top Voice CLI level.

dsp Enters the DSP sub-menu. See ‘‘Voice DSP Commands’’ on page 620.

callp_cp Enters the Call Processing sub-menu. See ‘‘Voice CallP Commands’’ on
page 666.

Firmware Guide Release 7.5 Standard 1.2 August 2012

620 Chapter 11

mta Enters the MTA sub-menu. See ‘‘MTA Sub-Mode Commands’’ on page 693.

lc Enters the Linecard sub-menu. See ‘‘Voice Linecard Commands’’ on

page 653.

Voice DSP Commands

To enter the DSP sub-menu, enter dsp at the Voice> prompt.

dimdbg Syntax: dimdbg {subcommand} [options]

Displays or sets DSP debugging information. The supported subcommands
are described below.

dimdbg opt

Syntax: dimdbg opt {value}

Sets one or more DSP options. The value is a hexadecimal number consist-
ing of one or more of the following bits, ORed together.
Value Description
1 Don’t reset on DSP failure
8 Disable timeout in DSP download states
10 Use emulator to download code (before Micro’s download)
20 Do not send status requests or expect responses
40 Verify download
80 Initialize DSP memory before download
100 Do dummy access on each block before download
200 DSP Diagnostic Code is running
400 Send only simple messasges to the DSP
800 Disable image checksum verification
1000 Spy all parameters in messages
2000 Treat all error indications from the DSP as fatal
40000 Do not print statistics for REQ or RESP messages

dimdbg ver

Displays DSP version information.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 621

Example:
[ 3] DSP> dimdbg ver
dimdbg ver
Multimedia Application Services: 2.4.6(Build 1)
DSP 0: version = Cap 0xfc2c, AER tail len 0, Rel 2.4.6.1,
Build c21 , Id:0 Oct:22:2009 16:27:20, DSP Unknown Processor!,
Cap2 0x26fa,Cap3 0xb, Chans 8, Security info 0x0,
EC tail len 32, PCM only chans 4, Cap4 0x4120, Cap5 0xc44f,
Cap6 0x15, Cap7 0xae48, Cap8 0xc0, Audio None, frame size 10ms,
Max playout segments 35, Max conference chans 12

dimdbg stats

Syntax: dimdbg stats {dsp} [channel] [clear]

Displays or clears the DSP or channel statistics. The parameters are:
dsp
The DSP affected, always 0.
channel
The channel number. Each DSP supports two channels per line.
Valid range: 0 to 3, or the keyword all to specify all channels.
clear
Clears the statistics on the specified channel.
Example:
[ 6] DSP> dimdbg stats 0
dimdbg stats 0

DIM: DSP 0 Stats:

to_dsp_ctl_msgs = 726190
to_dsp_sig_msgs = 37674
to_dsp_lo_prio_msgs = 281599
from_dsp_ctl_msgs = 207179
from_dsp_sig_msgs = 252867
from_dsp_lo_prio_msgs = 187486
to_dsp_msgs_dropped = 6
from_dsp_msgs_dropped = 1
dsp_not_responding = 0
dsp_download_retries = 0
dsp_dnld_chksum_error = 0
dsp_wait_dnld_ack = 0
to_dsp_dnld_msgs = 0
from_dsp_dnld_acks = 0
dsp_congestions = 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

622 Chapter 11

dimdbg dump

Syntax: dimdbg dump {dsp} {addr} {length} [type] [page]

Displays DSP memory. The parameters are:
dsp
The DSP number, starting from 0.
addr
The starting word address of the memory to display.
length
The number of words to display.
type
(optional) The address type: 0 for data, or 1 for program.
page
(optional) For data blocks, the page number of memory to display.
Example:
[ 9] DSP> dimdbg dump 0 0 8
dimdbg dump 0 0 8
dsp=0, dsp_addr_w=0x0, hpi_offset_b=0x0, len_w=8
00000000: 9749 EBDC 49DA 8B09 5461 78A8 9A46 1276

dimdbg silence

Syntax: dimdbg silence {tcid}

Silence any active sessions on the specified tcid.

dimdbg cfg

Syntax: dimdbg cfg {dsp}

Displays configuration information for the specified DSP. Use the keyword
all to show the configuration for all DSPs.

dimdbg pt

Displays the processor tree.

dimdbg tcids

Syntax: dimdbg tcids [start num]

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 623

Displays a map of active TCIDs. The parameters are:

start
The first TCID to display. Valid range: 0 to 3.
num
The number of TCIDs to display.
Example:
[ 90] DSP> dimdbg tcids
dimdbg tcids
DIM active TCIDs:
TCID DSP Channel Timeslot CP FIFO State
Rx / Tx
1 0 0 2 / 2 none none Voice

Return Status: 0

dimdbg poll stats

Syntax: dimdbg poll stats [dsp | all] [chan | all]

Displays poll period statistics for the specified DSP and channel. The default
is to display statistics for all channels and DSPs.
The parameters are:
dsp
The DSP to display, always 0 or the keyword all to display all
DSPs (default).
chan
The channel number to display. Valid range: 0 to 7. Use the
keyword all to display all channels (default).

dimdbg set_poll

Syntax: dimdbg set_poll {time}

Manually set the polling period, in milliseconds.

dimdbg set_voice_poll

Syntax: dimdbg set_voice_poll {flag}

Enables or disables voice packet polling. The flag is either off or on.

Firmware Guide Release 7.5 Standard 1.2 August 2012

624 Chapter 11

dimdbg gsync

Syntax: dimdbg gsync {tcid} {time}

Sends a grant sync to the DSP. The specified time is in milliseconds.

dimdbg msg

Syntax: dimdbg msg {dsp} {chan} {msgid} {trans_id} [params ...]

Internal use only: sends an arbitrary control message to the specified DSP.

dimdbg sig

Syntax: dimdbg sig {dsp} {chan} {msgid} {trans_id} [params. . .]

Sends an arbitrary signaling message to the specified DSP. The parameters
are:
dsp
The DSP.
chan
The DSP channel. Valid range: 0 to 7, or the keyword * for no
channel association.
msgid
The message ID to send.
trans_id
The transaction ID.
params
Any parameters required by the message.
Note: This command should be used only under the direction of ARRIS
Technical Support.

dimdbg ndu_stat

Syntax: dimdbg ndu_stat {dsp} [clear]

Requests NDU statistics from the specified dsp. Use a value of 1 for the
optional clear parameter to clear statistics after displaying.
Example:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 625

[ 27] DSP> dim ndu_stat 0

[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - DIM: 0:*, Called dimp_proc_stat_ndu()

[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad state: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad length: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad ch_num: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad pkt_cnt: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad in_index: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad out_index: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - Rx Drop, bad dsp_core_id: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - RxPkts Drop, bad chk_sum: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - TxPkts Drop, bad pkt_cnt: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - TxPkts Drop, bad in_index: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - TxPkts Drop, bad out_index: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - TxPkts Drop, out of buf_space: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - Resyncs init by Host: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - Resyncs init by DSP: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - To-Host Sig Msg Drop: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - To-Host Ctrl Msg Drop: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - To-Host Low prio Msg Drop: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - From-Host Sig Msg Drop: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - From-Host Ctrl Msg Drop: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - From-Host Low prio Msg Drop: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - To-Host Sig Msg Count: 3021
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - To-Host Ctrl Msg Count: 3
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - To-Host Low prio Msg Count: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - From-Host Sig Msg Count: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - From-Host Ctrl Msg Count: 3023
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - From-Host Low prio Msg Count: 0
[ERROR] [VOICE.XSPY(pid=494)]: 0000605350 - Rx AAL5 pkts dropped Bad CRC: 0

Return Status: 0

dimdbg prof_define

Syntax: dimdbg prof_define {tcid}

Displays the active profile for the specified TCID. Valid range: 1 to 4.

dimdbg lo_details

Syntax: dimdbg lo_details {dsp}

Displays buffer sizes for the specified dsp: either 0, or the keyword all to dis-
play details for all DSPs.
Example:

Firmware Guide Release 7.5 Standard 1.2 August 2012

626 Chapter 11

[ 22] DSP> dim lo_details all

DIM: 0, Lo_details. max_msglen_b=256, max_hiprio_msglen_b=256

max_loprio_msglen_b=256, dnld_mode=hpi(1)

dimdbg hpi_details

Syntax: dimdbg lo_details {dsp}

Displays HPI layout details for the specified dsp: either 0, or the keyword all
to display details for all DSPs.
Example:
[ 23] DSP> dim hpi_details all

DIM: ------------------------------------
DIM: ---- HPI Layout Details for DSP 0
DIM: ------------------------------------
DIM: ---- Version ID = 1.0 (Version C)
DIM: ---- DSP2MIC FIFOs = 3
DIM: ---- MIC2DSP FIFOs = 3
DIM: ---- ACS Start Address = 0x007b 8040
DIM: ---- HPI Alignment = 32-BIT ALIGNMENT, PADDING ENABLED
DIM: ------------------------------------
DIM: ---- DPS to MICRO FIFOs ------------
DIM: ------------------------------------
DIM: ---- FIFO Type = GENERAL
DIM: ---- Allowed Pkt Types = NORMAL PRIORITY MSG/LOW PRIORITY MSG
DIM: ---- FIFO Start = 0x007b a980
DIM: ---- FIFO Size = 0x0400 (1024)
DIM: ---- ACS Offset = 0x007b 8042
DIM: ------------------------------------
DIM: ---- FIFO Type = GENERAL
DIM: ---- Allowed Pkt Types = HIGH PRIORITY MSG
DIM: ---- FIFO Start = 0x007b a580
DIM: ---- FIFO Size = 0x0200 (512)
DIM: ---- ACS Offset = 0x007b 8046
DIM: ------------------------------------
DIM: ---- FIFO Type = GENERAL
DIM: ---- Allowed Pkt Types = VOICE/FAX/DATA
DIM: ---- FIFO Start = 0x007b 8100
DIM: ---- FIFO Size = 0x1140 (4416)
DIM: ---- ACS Offset = 0x007b 804a
DIM: ------------------------------------
DIM: ---- MICRO to DSP FIFOs ------------
DIM: ------------------------------------
DIM: ---- FIFO Type = GENERAL
DIM: ---- Allowed Pkt Types = NORMAL PRIORITY MSG/LOW PRIORITY MSG
DIM: ---- FIFO Start = 0x007b a780
DIM: ---- FIFO Size = 0x0200 (512)

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 627

DIM: ---- ACS Offset = 0x007b 804e

DIM: ------------------------------------
DIM: ---- FIFO Type = GENERAL
DIM: ---- Allowed Pkt Types = HIGH PRIORITY MSG
DIM: ---- FIFO Start = 0x007b 9240
DIM: ---- FIFO Size = 0x0200 (512)
DIM: ---- ACS Offset = 0x007b 8052
DIM: ------------------------------------
DIM: ---- FIFO Type = GENERAL
DIM: ---- Allowed Pkt Types = VOICE/FAX/DATA
DIM: ---- FIFO Start = 0x007b 9440
DIM: ---- FIFO Size = 0x1140 (4416)
DIM: ---- ACS Offset = 0x007b 8056
DIM: ------------------------------------

Return Status: 0

dimdbg test_poll_period

Syntax: dimdbg test_poll_period {cmd} {thresh}

Controls test polling. The parameters are:
cmd
One of: on (enable polling), off (disable polling), or print (display
the current status)
thresh
The threshold value, in milliseconds. The default is 20.
Example:
[ 9] DSP> dim test_poll_period print
dim test_poll_period print
test_poll_period = on
test_poll_period max = 20 ms
test_poll_period min = 20 ms
test_poll_period thresh = 1000 ms
test_poll_period pass thresh num= 0
<0ms - 2ms> number: 0
<4ms - 6ms> number: 0
<8ms - 10ms> number: 0
<12ms - 14ms> number: 0
<16ms - 18ms> number: 0
<20ms - 22ms> number: 14632135
<24ms - 26ms> number: 0
<28ms - 30ms> number: 0
<32ms - 34ms> number: 0
<36ms - 38ms> number: 0
< >= 40ms > number: 0
Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

628 Chapter 11

dimdbg show_reflection_page

Syntax: dimdbg show_reflection_page {tcid} [-v lvl]

Displays the DSP reflection page. The parameters are:
tcid
The TCID to display (must be active). Valid range: 1 to 4.
lvl
Sets the verbosity level. Valid range: 0 to 9.

dimdbg power

Syntax: dimdbg power {setting}

Controls DSP power management. The valid settings are:
Value Description
0x0000 Disabled
0x0001 Clock Management Control Enabled
0x0002 IDLE2 Control Enabled (VDSP uses clock divide by
and/or GPD)
0x0003 Both Clock Mgmt and IDLE2 Enabled
0x0004 Use divide by factor of 2, instead of default 4
0x0008 If IDLE2 enabled, use Global Powerdown Enabled
0x0010 If IDLE2 enabled, use Clock Divide By Mode
0x001A Enable both IDLE2 GPD and Divide By mode
0x0020 Power Saving Mode Enabled
0x0040 System Clock Scaling Enabled

dim mips_stat

Syntax: dim mips_stat {cmd}

Controls displays of MIPS idle cycle statistics. The cmd is one of the follow-
ing:
on
Enables statistics.
off
Disables statistics.
reset
Resets and enables statistics.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 629

dim set_status_req

Syntax: dim set_status_req {period}

Sets the period, in milliseconds, for sending status request messages to the
DSP.

dim reset_tdm

Syntax: dim reset_tdm {dsp} {flag}

Sends a TDM reset request for the specified dsp. The flag is either on to start
a reset, or off to cancel a reset.

ccudbg CCU debug commands. Not implemented.

dadbg Syntax: dadbg {subcommand}

DSP Allocator debugger. To enable these commands, set Spy level 5 on the
DSPA key as follows: spy 12 5

dadbg usage

Syntax: dadbg usage [dsp]

Displays DSP information and configuration.

dadbg dnld

Syntax: dadbg dnld {dsp} {image} [channels]

Downloads a firmware image to the specified DSP.

dadbg image

Syntax: dadbg image {img#} {num_channels} [num_pcm_only_channels]

Edits parameters for the specified image. You can configure the number of
total channels and the number of PCM-only channels.

dadbg base

Syntax: dadbg base {base_dsp#}

Sets the base DSP number.

Firmware Guide Release 7.5 Standard 1.2 August 2012

630 Chapter 11

dadbg chan

Syntax: dadbg chan {max_chan}

Sets the maximum number of channels.

dadbg overlay_pcm_lbrc

Syntax: dadbg overlay_pcm_lbrc {dsp} {flag}

Sets the Overlay PCM flag for the specified DSP. The parameters are:
dsp
The DSP to display, always 0 or the keyword all.
flag
Specify 1 to enable or 0 to disable.

dadbg chan_alloc_order

Syntax: dadbg chan_alloc_order {flag}

Sets the channel allocation order. Specify 0 for normal order or 1 for reverse
order.

dadbg sec_alloc

Syntax: dadbg sec_alloc {micro_only | dsp_only | micro_dsp |

dsp_micro}

Modifies security parameters for packet handling.

dadbg sec_config

Syntax: dadbg sec_config {dsp | micro} [none | srtp | pktcbl | all] [none |
rtp | rtcp | all] [max_chan_rtp] [max_chan_rtcp]

Modifies the security configuration of the Micro portion of the DSP allocator.

dadbg sec_show

Syntax: dadbg sec_show {dsp}

Shows the security configuration of the specified DSP allocator.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 631

dsimdbg Syntax: dsimdbg {subcommand}

DSP Image commands.

dsimdbg show

Syntax: dsimdbg show [image_id level]

Displays information about the specified image. The parameters are:
level
The amount of information to display. Default: 1 (least informa-
tion). Levels at or above 4 produce highly verbose listings that
may take several minutes to display.
image_id
The image to display.
Example:
[ 35] DSP> dsim show
2 dsp images
Image ID=0xBABEFACE
Build:???? Rel:0.0.0.0, Id:0 unk:00:2000 00:00:00
Image ID=0x00000000
Build:eg1a Rel:11.1.100.9, Id:4830 Nov:03:2005 19:51:48
OK
Return Status: 0

dsimdbg select

Syntax: dsimdbg select {image_id} {flag}

Enables or disables downloading of an image. The parameters are:
image_id
The image to enable or disable.
flag
Use 1 to disable download of a image; 0 to include in the download
list.

rtcpdbg Syntax: rtcpdbg info {tcid}

Displays control block information for the specified TCID. To enable this
command, set Spy level 5 on the RTCP key as follows: spy 4 5

Firmware Guide Release 7.5 Standard 1.2 August 2012

632 Chapter 11

spy Syntax: one of: spy

spy [-l]
spy {key} [level]
spy [default]

Spy debugging commands. The options and parameters are:

(none)
Shows the available subcommands and displays the current debug
table.
-l
Shows the valid debug level settings.
key [level]
With no level specified, shows the level of the specified key. Spec-
ify a level to set the key to that level.
default
Sets all levels to the default.
Examples:
[ 23] DSP> spy -l
0 => General Information
1 => Function Entry
2 => Normal Event
3 => Minor Unexpected Event
4 => Major Unexpected Event
5 => Fatal Error
6 => Spy Trace Off

[ 24] DSP> spy

SPY Debug Commands:
spy -- Show table
spy key -- Show level of key specfied
spy key level -- Set level
spy -l -- Show possible levels
spy default -- Set levels to default
spy dest <logger|dbgport> -- set destination
----- ---------------- ------------------------ ------------------------
Key Level Destination
----- ---------------- ------------------------ ------------------------
( 1) ROOT Minor Unexpected Event logger
( 2) NWIF Minor Unexpected Event logger
( 3) DQMM Minor Unexpected Event logger
( 4) DLMM Minor Unexpected Event logger
( 5) ISU Minor Unexpected Event logger
( 6) ISUCPDET Minor Unexpected Event logger
( 7) VIM Minor Unexpected Event logger
( 8) CCU Minor Unexpected Event logger
( 9) CCUTONE Minor Unexpected Event logger
( 10) CCUCPDET Minor Unexpected Event logger

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 633

( 11) RTCP Minor Unexpected Event logger

( 12) PMA Minor Unexpected Event logger
( 13) DEX Minor Unexpected Event logger
( 14) DIM Minor Unexpected Event logger
( 15) DIM_DNLD Minor Unexpected Event logger
( 16) DIM_STATUS Minor Unexpected Event logger
( 17) DSPA Minor Unexpected Event logger
( 18) MSUIM Minor Unexpected Event logger
( 19) CPMU Minor Unexpected Event logger
( 20) XGCP Minor Unexpected Event logger
( 21) NCS Minor Unexpected Event logger
( 22) CALLP Minor Unexpected Event logger
( 23) NMM Minor Unexpected Event logger
( 24) IPSECMAN Minor Unexpected Event logger
( 25) VSM Minor Unexpected Event logger

dsp Syntax: dsp {line} {subcommand}

DSP debugging commands. The valid range for line is 1 to 2.

download Syntax: download {dsp}

Downloads a core image to the specified DSP.

config Syntax: config {tcid} {callif}

Configures a TCID. The parameters are:
tcid
The TCID to configure. Valid range: 0 to 3.
callif
The callback interface: 0 (manufacturing) or 1 (CallP).

unconfig Syntax: unconfigure {tcid}

Unconfigures a TCID. The valid range for tcid is 0 to 3.

allocChannel Syntax: allocChannel {line}

Allocates a free channel to a line. The valid range for line is 1 to 2.

Firmware Guide Release 7.5 Standard 1.2 August 2012

634 Chapter 11

freeChannel Syntax: freeChannel {line}

Frees a channel allocated to the specified line. The valid range for line is 1 to
2.

reqCoding Syntax: reqCoding {channel}

Requests coding parameters for the specified channel. The valid range for
channel is 0 to 3.

reqNullCoding Syntax: reqNullCoding {channel}

Requests coding with NULL parameters for the specified channel. The valid
range for channel is 0 to 3.

state Syntax: state {channel} {state}

Sets a TCID coding state. The parameters are:
channel
The channel ID to set. Valid range: 0 to 3.
state
The coding state, one of:
0: idle
1: digit collect
2: voice

tone Syntax: tone {channel} {tone} {toNET} {toTELE}

Starts or stops a tone on the specified channel. The parameters are:
channel
The channel number. Valid range: 0 to 3.
tone
0 to stop the tone, 1 to start the tone.

toNET
Starts or stops the tone toward the network (0 or 1).
toTELE
Starts or stops the tone toward the CPE (0 or 1).

setvp Syntax: setvp {tcid} {nom_delay} [max_delay] [min_delay] [conceal]

[adap_po]

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 635

Change voice playout settings only for a standing call. The parameters are:
tcid
The TCID to configure. Valid range: 0 to 3.
nom_delay
The nominal delay, in milliseconds. Valid range: the packetization
rate to 135 ms.
max_delay
The maximum delay, in milliseconds. Valid range: the packetiza-
tion rate to 135 ms.
min_delay
The minimum delay, in milliseconds. Valid range: the packetiza-
tion rate to 135 ms.
conceal
0: none
1: standard
2: G711A1

adap_po
0: fixed
1: silence
2: immediate

jittermode Syntax: jittermode {mode}

Changes the jitter buffer mode. The mode is 1 (adaptive) or 2 (fixed).

nomjitter Syntax: nomjitter {rate}

Change nominal jitter buffer multiplier. The parameters are:
rate
1: 1x packetization rate
2: 2x packetization rate
3: 3x packetization rate
4: 4x packetization rate

Example:
[ 57] DSP> nomjitter 2
11:00:00 RT 13 tCLI Nominal VP buffer set to 2x the packetization
rate.
Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

636 Chapter 11

maxjitter Syntax: maxjitter {rate}

Change the maximum jitter buffer multiplier. The parameters are:
rate
1: 1x packetization rate
2: 2x packetization rate
3: 3x packetization rate
4: 4x packetization rate

Example:
[ 58] DSP> maxjitter 2
11:00:00 RT 13 tCLI Maximum VP buffer set to 2x the packetization rate.
Return Status: 0

reconfig Syntax: reconfig {tcid} {timeslot}

Change the DSP channel’s timeslots. The parameters are:
tcid
The TCID. Valid range: 0 to 3.
timeslot
The starting timeslot for the channel (1-based).

echo Syntax: echo {tcid} {setting}

Changes the echo canceller setting. The parameters are:
tcid
The TCID. Valid range: 0 to 3.
setting
One of the following:
0: disable
1: enable
2: tx_mute
3: NLP disabled

nlplevel Syntax: nlplevel {flag}

Sets or displays the NLP level flag. The flag can be either 0 or 1 (the
default).

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 637

echotail Syntax: echotail {time}

Change echo tail setting. The parameter is:
time
1: 8 ms
2: 32 ms

Example:
[ 69] DSP> echotail 1
echotail 1
Return Status: 0

looprx Syntax: looprx {tcid} {setting}

Enables or disables DSP receive loopback. This loops the network PCM
back to the network. The parameters are:
tcid
The TCID to control. Valid range: 0 to 3.
setting
0: disable loopback
1: enable loopback

looptx Syntax: looptx {tcid} {setting}

Enables or disables DSP transmit loopback. This loops the line card PCM
back to the line card. The parameters are:
tcid
The TCID to control. Valid range: 0 to 3.
setting
0: disable loopback
1: enable loopback

rtcp_info Syntax: rtcp_info {tcid}

Requests RTCP information from the specified TCID.

rxtx_stat Syntax: rxtx_stat {tcid} {clear}

Displays Rx/Tx statistics for the specified channel. To use this command,
enable Debug-level severity in the Main mode Logger menu, using the com-
mand SeverityConfig 9 1.

Firmware Guide Release 7.5 Standard 1.2 August 2012

638 Chapter 11

The parameters are:

tcid
The TCID number. Valid range: 0 to 3.
clear
0: do not clear statistics
1: clear statistics

Example:
[ 14] DSP> rxtx_stat 1 0
rxtx_stat 1 1
Return Status: 0
[ 15] DSP> 10:25:16 RT 13 tMVX_C Rx/Tx Stats for 2
10:25:16 RT 13 tMVX_C Rx Voice Packets = 2875
10:25:16 RT 13 tMVX_C Tx Voice Packets = 2875
10:25:16 RT 13 tMVX_C Tx Silence Suppressed Frames = 0
10:25:16 RT 13 tMVX_C Rx Min Jitter = 0 (ms)
10:25:16 RT 13 tMVX_C Rx Max Jitter = 23 (ms)
10:25:16 RT 13 tMVX_C Rx RTP Avg Jitter = 0 (pcm samples)
10:25:16 RT 13 tMVX_C Tx Grant Sync Dropped Frames = 0
10:25:16 RT 13 tMVX_C Tx Octets = 460000
10:25:16 RT 13 tMVX_C Rx Octets = 460000
10:25:16 RT 13 tMVX_C DTMF Tx Packets = 0
10:25:16 RT 13 tMVX_C DTMF Rx Packets = 0
10:25:16 RT 13 tMVX_C SID Rx Packets = 0
10:25:16 RT 13 tMVX_C SID Tx Packets = 0
10:25:16 RT 13 tMVX_C Tx Last Timestamp = 459800
10:25:16 RT 13 tMVX_C Tx Extended Seq Number = 0
10:25:16 RT 13 tMVX_C Tx Last Seq Number = 2874
10:25:16 RT 13 tMVX_C Tx Last Pkt Type = 0
10:25:16 RT 13 tMVX_C Rx Last Timestamp = 459800
10:25:16 RT 13 tMVX_C Rx Last Ssrc = 123
10:25:16 RT 13 tMVX_C Rx Extended Seq Number = 0
10:25:16 RT 13 tMVX_C Rx Last Seq Number = 2874
10:25:16 RT 13 tMVX_C Rx Last Pkt Type = 0
10:25:16 RT 13 tMVX_C Pkt Lost by Network = 0
10:25:16 RT 13 tMVX_C Rx P2P Packets to Hosts = 0
10:25:16 RT 13 tMVX_C Rx P2P Filtered Packets = 0
10:25:16 RT 13 tMVX_C P2P Squelched Voice Packets = 0
10:25:16 RT 13 tMVX_C Rx Net Packets = 2875
10:25:16 RT 13 tMVX_C Tx Net Packets = 2875
10:25:16 RT 13 tMVX_C Rx Last Voice Prof Idx = 0

err_stat Syntax: err_stat {tcid} {clear}

Displays error statistics for the specified channel. The parameters are:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 639

tcid
The channel number. Valid range: 0 to 3.
clear
0: do not clear statistics
1: clear statistics

Example:
[ 20] DSP> err_stat 1 0
err_stat 1 0
Return Status: 0
[ 21] DSP> 17:02:39 RT 13 tDSP Error Stats for 1
17:02:39 RT 13 tDSP invalid_header_count: 0
17:02:39 RT 13 tDSP to_micro_overflow_count: 0
17:02:39 RT 13 tDSP lost_enh_packet_count: 0
17:02:39 RT 13 tDSP no_core_packet_count: 0
17:02:39 RT 13 tDSP pkt_lost_by_network: 2
17:02:39 RT 13 tDSP invalid_mac_header_count: 0
17:02:39 RT 13 tDSP invalid ssrc count: 0
17:02:39 RT 13 tDSP invalid payload count: 0
17:02:39 RT 13 tDSP rx routing dropped: 0
17:02:39 RT 13 tDSP p2p invalid pkt count: 0
17:02:39 RT 13 tDSP rx seq num discont events: 7
17:02:39 RT 13 tDSP rx aal2 crc10 err count: 0

level_stat Syntax: level_stat {tcid} {clear}

Displays the level statistics for the specified channel. The parameters are:
tcid
The channel number. Valid range: 0 to 3.
clear
0: do not clear statistics
1: clear statistics

Example:
[107] DSP> level_stat 1 0
level_stat 1 0
Return Status: 0
[108] DSP> 14:26:29 RT 13 tDSP Tele levels for 1
14:26:29 RT 13 tDSP rx_level: -400
14:26:29 RT 13 tDSP tx_level: -420
14:26:29 RT 13 tDSP rx_mean: -2
14:26:29 RT 13 tDSP tx_mean: 0
14:26:29 RT 13 tDSP frame_underrun_count: 8

Firmware Guide Release 7.5 Standard 1.2 August 2012

640 Chapter 11

vp_stat Syntax: vp_stat {tcid} {clear}

Displays the voice play-out statistics for the specified channel. The parame-
ters are:
tcid
The channel number. Valid range: 0 to 3.
clear
0: do not clear statistics
1: clear statistics

Example:
[113] DSP> vp_stat 1 0
vp_stat 1 0
Return Status: 0
[114] DSP> 14:31:02 RT 13 tDSP Voice Playout Delay Stats for 1
14:31:02 RT 13 tDSP Avg Playout Delay: 30
14:31:02 RT 13 tDSP Lost Segments: 88644
14:31:02 RT 13 tDSP Replayed Segments: 88644
14:31:02 RT 13 tDSP Idle Segments: 319931
14:31:02 RT 13 tDSP FIFO Dropped Segments: 406947
14:31:02 RT 13 tDSP Rx Segments: 16290412
14:31:02 RT 13 tDSP Rx Avg Pkt Jitter: 0 (pcm samples)
14:31:02 RT 13 tDSP Adpt PO Buf Delay Inc: 41867
14:31:02 RT 13 tDSP Adpt PO Buf Delay Dec: 52393
14:31:02 RT 13 tDSP Cell Starve Evt Cnt: 41914
14:31:02 RT 13 tDSP PO Buf Underflow Cnt: 0

echo_stat Syntax: echo_stat {tcid} {clear}

Displays the echo statistics for the specified channel. The parameters are:
tcid
The channel number. Valid range: 0 to 3.
clear
0: do not clear statistics
1: clear statistics

Example:
[116] DSP> echo_stat 1 0
echo_stat 1 0
Return Status: 0
[117] DSP> 14:33:36 RT 13 tDSP Px Level: -41.6250
14:33:36 RT 13 tDSP Py Level: -39.0625
14:33:36 RT 13 tDSP Pe Level: -39.1250
14:33:36 RT 13 tDSP Estimated ERL: 32.8750
14:33:36 RT 13 tDSP Acom Estimate: 32.8750
14:33:36 RT 13 tDSP P[06,13] 0x0010 0x6dd0 0x0000 0x0000 0x0000 0x0000
0x000d 0x75ef

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 641

14:33:36 RT 13 tDSP P[14,21] 0x004f 0x7a10 0x012e 0xd4b3 0x0000 0x0000

0x0380 0x0002
14:33:36 RT 13 tDSP P[22,29] 0x0000 0x0000 0x0000 0xf26c 0x0030 0x000a
0x0015 0x0006
14:33:36 RT 13 tDSP P[30,37] 0x0020

gain_req Syntax: gain_req {channel}

Displays the gain settings for the specified channel. The parameter is:
channel
The channel number. Valid range: 1 to 4.
Example:
[119] DSP> gain_req 1
gain_req 1
Return Status: 0
[120] DSP> 14:36:23 RT 13 tDSP DSP Gains for 1:
14:36:23 RT 13 tDSP tx_dg: +0
14:36:23 RT 13 tDSP rx_dg: +0
14:36:23 RT 13 tDSP tx_ag: -256
14:36:23 RT 13 tDSP rx_ag: -256
14:36:23 RT 13 tDSP rx_sec_ag: -256
14:36:23 RT 13 tDSP lcd: +0
14:36:23 RT 13 tDSP side_tg: +15

ecpath_coeff Syntax: ecpath_coeff {channel} {filter} {start_index} {num_coeffs}

Displays the echo path coefficients.

traffic Syntax: traffic {flag}

Starts or stops the traffic simulator. Use 0 to stop the simulator, 1 to start it.
Example:
[104] DSP> traffic 1
Traffic started on 1 and 2
Traffic started on 3 and 4
Traffic started on 5 and 6
Traffic started on 7 and 8

restart Syntax: restart {dsp_no}

Reset the DSPs and download a core image.

Firmware Guide Release 7.5 Standard 1.2 August 2012

642 Chapter 11

mft_open Syntax: mft_open {line}

Opens a line with voice coding. The valid range for line is 1 to 4.

mft_close Syntax: mft_close {line}

Closes a line. The valid range for line is 1 to 4.

detect_tone Syntax: detect_tone {line} {flag}

Enables or disables tone detection. The parameters are:
line
The line number. Valid range: 1 to 4.
flag
0 to disable tone detection, 1 to enable it.

dt_setup Syntax: dt_setup {line} {flag}

Enables or disables tone detection. The parameters are:
line
The line number. Valid range: 1 to 24.
flag
0 to disable tone detection, 1 to enable it.

dt_cleanup Cleans up from tone detection.

st_setup Does extra setup then calls dsp.

st_cleanup Cleans up from st_setup.

cps Syntax: cps {setting}

Enables or disables NLP constant power signal detection. This command
affects the arrisMtaDevDspCpsSetting MIB object.
Enter 0 to disable, or 1 to enable. When enabled, the echo canceller disen-
gages immediately when a high-level constant power signal, such as a
fax/modem tone or DTMF digit (used for alarm panel data transmissions), is
detected.
Example:
[ 7] DSP> cps ?
Usage: cps <setting>
<setting> : 0 disable

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 643

: 1 enable
Current setting: Enable

Return Status: 1

[ 10] DSP> cps 1

10:34:59 RT 13 tCLI nlp cps set to Enable.

Return Status: 0

vbdbitmap Syntax: vbdbitmap {lines}

Enables or disables jitter buffer override for the selected lines. The lines
parameter is a 12-bit hexidecimal value; the valid range is 0 to 0xfff. Set
bit 0 to enable jitter buffer override for line 1 and so forth.

vbdmin Syntax: vbdmin {bufsize}

Sets the minimum jitter buffer size for Voice Band Data (fax or modem)
calls. Valid range: 10 to 135; must be less than the nominal jitter buffer size.
Default: 20.

vbdnom Syntax: vbdnom {bufsize}

Sets the nominal jitter buffer size for Voice Band Data (fax or modem) calls.
Valid range: 10 to 135; must be less than the maximum jitter buffer size and
greater than the minimum jitter buffer size. Default: 70.

vbdmax Syntax: vbdmax {bufsize}

Sets the maximum jitter buffer size for Voice Band Data (fax or modem)
calls. Valid range: 10 to 135; must be greater than the nominal jitter buffer
size. Default: 135.

customjitter Syntax: customjitter {flag}

Enables or disables custom jitter buffer settings. The flag is either 1 to enable
custom settings, or 0 to disable.

custommin Syntax: custommin {minjitter}

Displays or sets the minimum custom jitter buffer size, in milliseconds. The
valid range for minjitter is 5 to 135, in multiples of 5ms. Default: 5.

Firmware Guide Release 7.5 Standard 1.2 August 2012

644 Chapter 11

customnom Syntax: customnom {nomjitter}

Displays or sets the nominal custom jitter buffer size, in milliseconds. The
valid range for nomjitter is 5 to 135, in multiples of 5ms. Default: 10.

custommax Syntax: custommax {maxjitter}

Displays or sets the maximum custom jitter buffer size, in milliseconds. The
valid range for maxjitter is 5 to 135, in multiples of 5ms. Default: 60.

info Displays DSP and TCID information.

!reset Reset Modem

jitsim Sub-Mode These commands control the Jitter Simulator. In jitsim sub-mode, the prompt
is Jitter Simulator>.

Returns to the Voice> prompt.

enable

Enables the jitter simulator.

Example:
[ 83] Jitter Simulator> enable
enable
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter
simulator is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with
more than one call up
Return Status: 0

disable

Disables the jitter simulator.

Example:
[ 84] Jitter Simulator> disable
disable

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 645

Jitter Simulator: DISABLED

PLEASE NOTE: MAX delay that can be induced by jitter
simulator is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with
more than one call up
Return Status: 0

settings

Displays the jitter simulator’s current mode and settings.

Example:
[ 87] Jitter Simulator> settings
settings
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 0

drop

Syntax: drop {packets}

Instant RTP packet dropper. The parameter is:
packets
number of packets to drop
Example:
[ 89] Jitter Simulator> drop 2
drop 2
Packet(s) to drop: 2
Return Status: 0

delay

Syntax: delay {time}

Delays the next packet by the specified time. The parameter is:

Firmware Guide Release 7.5 Standard 1.2 August 2012

646 Chapter 11

time
delay time in ms
Example:
[ 91] Jitter Simulator> delay 10
delay 10
Next packet delay: 10 ms
Return Status: 0

loss_off

Disables special loss modes.

Example:
[ 92] Jitter Simulator> loss_off
loss_off
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 91

loss_fixed

Syntax: loss_fixed {packets} {time}

Enables fixed packet loss mode. The parameters are:
packets
number of packets to drop
time
delay time in ms
Example:
[ 94] Jitter Simulator> loss_fixed 2 100
loss_fixed 2 100
Jitter Simulator: ENABLED
Packet Loss Mode: FIXED
Time between packet loss bursts: 100 ms
Number of packets to drop: 2
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 647

Results will vary with more than

one call up
Return Status: 0

loss_random

Syntax: loss_random {percentage}

Enables random packet loss mode. The parameter is:
percentage
percentage of time to drop random packets
Example:
[ 99] Jitter Simulator> loss_random 10
loss_random 10
Jitter Simulator: ENABLED
Packet Loss Mode: RANDOM
% of time that loss will occur: 10%
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 0

jit_off

Disables special jitter modes.

Example:
[101] Jitter Simulator> jit_off
jit_off
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 91

Firmware Guide Release 7.5 Standard 1.2 August 2012

648 Chapter 11

jit_fixed

Syntax: jit_fixed {time}

Enable fixed jitter mode. The parameter is:
time
The induced oscillating delay, in milliseconds.
Example:
[103] Jitter Simulator> jit_fixed 10
jit_fixed 10
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: FIXED
Oscillating delay time: 10 ms
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 0

jit_shift

Syntax: jit_shift {time} {percentage}

Enables shift jitter mode. The parameters are:
time
The time, in milliseconds, to shift a group of packets.
percentage
The percentage of each second to shift the group of packets.
Example:
[106] Jitter Simulator> jit_shift 5 25
jit_shift 5 25
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: SHIFT
Shift delay time: 5 ms
Length of shift (per s): 250 ms
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 649

jit_burst

Syntax: jit_burst {time} {percentage}

Enables burst jitter mode. The parameters are:
time
time in ms of constant delay
percentage
percentage of each second to insert the constant delay
Example:
[109] Jitter Simulator> jit_burst 5 25
jit_burst 5 25
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: BURST
Interpkt delay time: 5 ms
Length of burst (per s): 250 ms
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 0

jit_random

Syntax: jit_random {time} {percentage}

Enables random jitter mode. The parameters are:
time
max time in ms of random delay
percentage
percentage of time to insert the random delay
Example:
[115] Jitter Simulator> jit_random 5 10
jit_random 5 10
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: RANDOM
% of time that jitter will occur: 10%
Max pkt delay: 5 ms
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up

Firmware Guide Release 7.5 Standard 1.2 August 2012

650 Chapter 11

Return Status: 0

jit_random_win

Syntax: jit_random_win {mindelay} {maxdelay} {percentage}

Enables random window jitter mode. The parameters are:
mindelay
minimum time, in millisconds, of random delay
maxdelay
maximum time, in millisconds, of random delay
percentage
percentage of time to insert the random delay

jit_rolling

Syntax: jit_rolling {max_delay} {delta} {percentage}

Enables rolling jitter mode. The parameters are:
max_delay
maximum rolling delay value
delta
time in ms that the rolling delay is increased by
percentage
percentage of each second the rolling delay is increased by the
delta
Example:
[119] Jitter Simulator> jit_rolling 10
2 25
jit_rolling 10 2 25
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: ROLLING
Max pkt delay: 10 ms
Delay delta per pkt: 2 ms
Length of roll (per s): 250 ms
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 651

debug

Debug jitter simulator.

Example:
[121] Jitter Simulator> debug
debug
Jitter Simulator: ENABLED
Packet Loss Mode: INSTANT ONLY
Packet Jitter Mode: INSTANT ONLY
PLEASE NOTE: MAX delay that can be induced by jitter simulator
is 35*pkt_rate ms
Simulator is single-threaded.
Results will vary with more than
one call up
Toggle: 0
Timer: 0
Tick: 0
Instant Pkts 2 Drop: 2
Instant Delay: 10 ms
Delay Calc: 0 ms
Current ms of delay: 0 ms
Return Status: 0

setvp

Syntax: setvp {tcid} {nom_delay} [max_delay] [min_delay] [conceal]

[adap_po]
Change voice playout settings only for a standing call. The parameters are:
tcid
The TCID to configure. Valid range: 0 to 3.
nom_delay
The nominal delay, in milliseconds. Valid range: the packetization
rate to 135 ms.
max_delay
The maximum delay, in milliseconds. Valid range: the packetiza-
tion rate to 135 ms.
min_delay
The minimum delay, in milliseconds. Valid range: the packetiza-
tion rate to 135 ms.
conceal
0: none
1: standard
2: G711A1

Firmware Guide Release 7.5 Standard 1.2 August 2012

652 Chapter 11

adap_po
0: fixed
1: silence
2: immediate

vp_stat

Syntax: vp_stat {tcid} {clear}

Displays the voice play-out statistics for the specified channel. The parame-
ters are:
tcid
The channel number. Valid range: 0 to 23.
clear
0: do not clear statistics
1: clear statistics

Example:
[113] DSP> vp_stat 1 0
vp_stat 1 0
Return Status: 0
[114] DSP> 14:31:02 RT 13 tDSP Voice Playout Delay Stats for 1
14:31:02 RT 13 tDSP Avg Playout Delay: 30
14:31:02 RT 13 tDSP Lost Segments: 88644
14:31:02 RT 13 tDSP Replayed Segments: 88644
14:31:02 RT 13 tDSP Idle Segments: 319931
14:31:02 RT 13 tDSP FIFO Dropped Segments: 406947
14:31:02 RT 13 tDSP Rx Segments: 16290412
14:31:02 RT 13 tDSP Rx Avg Pkt Jitter: 0 (pcm samples)
14:31:02 RT 13 tDSP Adpt PO Buf Delay Inc: 41867
14:31:02 RT 13 tDSP Adpt PO Buf Delay Dec: 52393
14:31:02 RT 13 tDSP Cell Starve Evt Cnt: 41914
14:31:02 RT 13 tDSP PO Buf Underflow Cnt: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 653

Voice Linecard Commands

To enter the Linecard sub-menu, enter lc at the Voice> prompt.

read Syntax: read {line} {addr} [len]

Internal use only: Reads line card memory.

write Syntax: write {line} {address} {byte1} {byte2} {...}

Internal use only: Writes LC memory.

CAUTION
Potentially service affecting
Writing directly to memory can cause the Telephony Modem to reset or lose
communication with the headend.

regdump Syntax: regdump {line} [-l]

Dumps all registers in the line card. Use the -l option to generate a long for-
mat dump.
Example:
[ 12] Linecard> reg 1
System State 0x56 rw 24
Read Signaling 0x4D g r 00 00
Interrupt Mask 0x6C g rw 00 80
Operating Conditions 0x70 rw 00
Operating Functions 0x60 rw FF
System State Config 0x68 rw 20
GX Filter Coefficients 0x80 rw A2 B0
GR Filter Coefficients 0x82 rw 42 A0
B Filter FIR Coefficients 0x86 rw AA 42 A1 2B 1A A3 39 73 - AF 3C FA 9F A9 F0
B Filter IIR Coefficients 0x96 rw 2E 01
X Filter Coefficients 0x88 rw CD F0 CD 46 22 3E 7A 8F - 23 36 22 EE
R Filter Coefficients 0x8A rw 1D 01 01 11 01 90 01 90 - 01 90 01 90 01 90
Z Filter FIR Coefficients 0x98 rw 97 AB AD 8F B5 A4 22 F5 - AA 2D
Z Filter IIR Coefficients 0x9A rw 62 2B A6 9F 01
Loop Supervision 0xC2 rw 1A 85 0E 09
DC Feed 0xC6 rw 33 05
Voice Path Gains 0x50 rw 00
Dig Imp Scaling Network 0xCA rw E8
Signal Gen A, B and Bias 0xD2 rw 01 09 E9 00 CA 39 CF 01 - 90 00 00
Signal Gen Control 0xDE rw 00
Switching Reg Params 0xE4 g rw 00 40 0B
Switching Reg Control 0xE6 g rw 09

Firmware Guide Release 7.5 Standard 1.2 August 2012

654 Chapter 11

Transmit Time Slot 0x40 rw 00

Receive Time Slot 0x42 rw 00

rread Syntax: rread {line} {addr}

Reads the specified LC register.
Example:
[ 16] Linecard> rread 1 0x56
System State 0x56 rw 24
Return Status: 0
[ 17] Linecard> rread 1 42
Receive Time Slot 0x42 rw 00
Return Status: 0
[ 18] Linecard> rread 1 0xc6
DC Feed 0xC6 rw 33 05
Return Status: 0

objdump Syntax: objdump {line}

Internal use only: Displays line object.

CAUTION
Potentially service affecting
The provision and deprovision commands may disable telephone service if
used on a deployed Telephony Modem.

provision Syntax: provision [line]

Provisions the specified line, or all lines if not specified.

deprovision Deprovisions all lines.

diag Syntax: diag {line}

Runs diagnostics on the specified line. The valid range for line is 1 to 2.
Example:
[ 70] Linecard> diag 2
diag 2
Return Status: 0
[ 71] Linecard> 10:12:30 RT 53 tCALLP dspChannelOpened: no tcid structure
10:12:30 RT 53 tCALLP dspChannelOpened: no tcid structure
Default values used.
On_Count 2, Off_Count 200

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 655

10:12:31 RT 53 tCALLP 1:DSP Chan Closed: no pTcid (tcid = 2)

10:12:31 RT 53 tCALLP dspChannelClosed: got redundant dsp closed message
for line 1, tcid 2
10:12:31 RT 53 tCALLP 1:DSP Chan Closed: no pTcid (tcid = 1)
10:12:31 RT 53 tCALLP dspChannelClosed: got redundant dsp closed message
for line 1, tcid 1
Diag result: 0
Stby result: 0
Feed result: 0

Responses:
Loop diags request sent for line n
The eDVA has started loop diagnostics on the specified line.
Warning: Action is Service Affecting. Use ’diagForce’ to force diagnos-
tics
The line is in service. You can take the line out of service manu-
ally, using the CallP oos command, or use the diagForce com-
mand to force the line out of service and start the diagnostics.
Loop diags request already in queue
A diagnostics test is already in progress for the specified line. Wait
10 to 20 seconds for the current tests to complete before starting
another test.
Loop diags test ended for line n
The loop diagnostics have completed for the specified line. Use
the dresults command to view the test results.

diagForce Syntax: diagForce {line}

Forces the line out-of-service, runs diagnostics on the line, then restore the
previous service state.
Use the dresults command to view the test results.

dresults Displays diagnostic results.

Example:
[ 74] Linecard> dresults
dresults
FV Test: ---DC--- ---AC---
Tip : ffffff92 00000000
Ring: ffffffab 00000000

Hook Test: --VSAB-- --VIMT-- --VILG--

Stby1: ---- 00000000 00000000
Stby2: ---- 00000000 00000000
Feed1: ffffe62c 00000053 ffffffe8
Feed2: 00000000 00000000 00000000

Firmware Guide Release 7.5 Standard 1.2 August 2012

656 Chapter 11

Ring Test: 00000000 00000000

VF Result: 0

Return Status: 17

lpdiag Syntax: lpdiag {line}

Starts diagnostics on the specified line. The parameter is:
line
The line number. Valid range: 1 to 2.
Note: You must take the line out of service before starting loop diagnostics.
Running loop diagnostics on a line in service results in a ‘‘Invalid State’’ fail-
ure.
From any interface, you can start loop diagnostics on a second line while
diagnostics are running on another line. However, you cannot start another
loop diagnostics run on a line already running loop diagnostics until the tests
have completed.
Use the lpresults command to see the results of the last loop diagnostics test.
Responses:
Loop diags request sent for line n
The eDVA has started loop diagnostics on the specified line.
Warning: Action is Service Affecting. Use ’lpdiagForce’ to force diag-
nostics
The line is in service. You can take the line out of service manu-
ally, using the CallP oos command, or use the lpdiagForce com-
mand to force the line out of service and start the diagnostics.
Loop diags request already in queue
A diagnostics test is already in progress for the specified line. Wait
10 to 20 seconds for the current tests to complete before starting
another test. Note that you can start a loop diagnostics test on a
different line while the test is running on the current line.
Loop diags test ended for line n
The loop diagnostics have completed for the specified line. Use
the lpresults command to view the test results.

lpdiagForce Syntax: lpdiagForce {line}

Forces the specified line out of service, starts diagnostics on the specified
line, then restores the previous line service state. The parameter is:
line
The line number. Valid range: 1 to 2.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 657

Use the lpresults command to view the test results.

lpresults Syntax: lpresults [line]

Displays the results of the last loop diagnostics test. The line is the line num-
ber to display; omit this parameter to display the results for all lines.
For details about loop diagnostics results, see ‘‘Running Loop Diagnostics’’
on page 420.
In the following example, line 1 had no phones attached during the diagnos-
tics run (therefore, the Ringer Equivalency test failed); line 2 has not has
diagnostics run since the Telephony Modem was started.
[ 9] Linecard> lpresults
lpresults
Line Number 1 on TUE JAN 17 17:50:40 2006
Hazardous Potential PASS
T-G AC volts = 2, R-G AC volts = 3, T-G DC volts = 5, R-G DC volts = 6
Foreign EMF PASS
T-G AC volts = 2, R-G AC volts = 3, T-G DC volts = 5, R-G DC volts = 6
Resistive Faults PASS
T-G DC kohms = 1000, R-G DC kohms = 1000, T-R DC kohms = 1000
Receiver Off Hook PASS
T-R DC kohms = 1638, % non-linearity = 100
Ringer Equivalency FAIL
Ringer Equiv = 0.03

Line Number 2 on THU JAN 01 00:00:00 1970

Hazardous Potential Not Started
Foreign EMF Not Started
Resistive Faults Not Started
Receiver Off Hook Not Started
Ringer Equivalency Not Started

CAUTION
Potentially service affecting
Using the ring command may impact subscriber service.

ring Syntax: ring {line} {reverse} {flag}

Rings the specified line. The parameters are:
line
The line number. Valid range: 1 to 2, or * to ring all lines.
reverse
Specify 0 for forward ringing or 1 for reverse ringing.

Firmware Guide Release 7.5 Standard 1.2 August 2012

658 Chapter 11

flag
Select 0 for off or 1 for on.
Example:
[ 82] Linecard> ring 1 1 1
ring 1 1 1
Reverse ringing ON
Return Status: 0

CAUTION
Potentially service affecting
Using the polarity command may cause problems when used with subscriber
equipment.

polarity Syntax: polar {line} {reverse}

Sets Tip/Ring polarity. The parameters are:
line
The line number. Valid range: 1 to 2.
reverse
Specify 0 for forward ringing or 1 for reverse ringing.
Example:
[ 80] Linecard> polarity 1 1
polarity 1 1
Setting reverse t-r polarity
Return Status: 0

loopc Syntax: loopc [line [boost]]

Displays or sets loop current for the specified line. The parameters are:
line
The line number. Valid range: 1 to 2, or * to set all lines.
boost
Specify 0 for normal loop current or 1 for boost current.
With no parameters specified, the loopc command displays the loop current
settings for each line.
Example:
[ 91] Linecard> loopc 1 1
loopc 1 1
Setting boosted loop current
Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 659

[ 92] Linecard> loopc

loopc
usage: loopc <1-based line> <boost>
boost: 0=normal, 1=boost

Present Status:
Line 1 - Loop Current Setting is Boosted
Line 2 - Loop Current Setting is Normal

Return Status: 0

hook Syntax: hook {line}

Displays hook status for a specified line. The valid range for line is 1 to 2, or
* to display all lines.

Example:
[ 34] Linecard> hook *
hook *
line 1 is offhook
line 2 is onhook
line 3 is onhook
line 4 is onhook

Return Status: 0

CAUTION
Potentially service affecting
Using the tone command on a subscriber line may cause undesired behavior.

tone Syntax: tone {line} {flag}

Generates PCM tone for the specified line. Not supported on all products.
The parameters are:
line
The line number. Valid range: 1 to 2.
Iflag
Specify 0 to stop tone or 1 to start tone.
Example:
[ 12] Linecard> tone 1 1
tone 1 1
Started tone PCM
Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

660 Chapter 11

idle Not supported: Generate PCM idle.

CAUTION
Potentially service affecting
Using the xconnect command on a subscriber line may cause undesired
behavior. If you are using this command to diagnose a trouble call, remem-
ber to disable cross-connect after completing the testing.

xconnect Syntax: xconnect {line1} {line2} {enable}

Enables/disables cross connection on the two lines specified. The parameters
are:
line1/line2
The line numbers. Valid range: 1 to 2, or * to specify all lines.
enable
Specify 0 to disable cross-connect or 1 to enable cross-connect.
Example:
[ 23] Linecard> xconnect 1 2 1
xconnect 1 2 1
Started 1 2 PCM XConnect
Return Status: 0

errors Displays line card errors.

Example:
[ 25] Linecard> errors
errors
Description Count Data Last Occurrence
- - - -
AMD clock fail 00000 0 0000:00:00.000
AMD protection 00000 0 0000:00:00.000
DC Feed Change 00000 0 0000:00:00.000
Le88 CFAIL On 00000 0 0000:00:00.000
Le88 CFAIL No Shutdown 00000 0 0000:00:00.000
Le88 Short CFAIL 00000 0 0000:00:00.000

Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 661

tos Displays the status of the eDVA operating system.

Example:
[ 6] Linecard> tos

ID | pri | events | #run | en | name

--------------------------------------------------
01 | 6 | 0x0000 | 6 | ** | L2 AMD
02 | 6 | 0x0000 | 11 | ** | L2 CP
03 | 6 | 0x0000 | 6 | ** | L1 AMD
04 | 6 | 0x0000 | 11 | ** | L1 CP
05 | 5 | 0x0000 | 0 | ** | AMD SLAC
06 | 2 | 0x0000 | 0 | ** | Diags

Return Status: 0

template Syntax: template {line} {template}

Sets the line card template. The parameters are:
line
The line number. Valid range: 1 to 2.
template
The template number:
0 : North America57 Standard

1 : Chile

2 : Japan1

3 : Germany

4 : Netherlands

5 : North America33 High

6 : Australia

7 : Austria/France/Hungary/Slovakia

8 : North America09 Med

9 : Netherlands09

10 : Israel

11 : Japan 600 −4/ −8

12 : Japan 600 −4 /−12

Firmware Guide Release 7.5 Standard 1.2 August 2012

662 Chapter 11

13 : Mexico/MexicoC

14 : Germany2

15 : NorthAmerica66

Note: Setting this object is not the same as setting the Country Template
value—it only changes the line card template.
Example:
[ 10] Linecard> template 1 0
template 1 0
Setting line 1 to template 0.
Return Status: 0

state Syntax: state {flags} {machineID} {setting}

Enables/disables various line card tracing. The parameters are:
flags
Optional flags, used to print various information:
none: Display a list of machine IDs and their current states (the ID
is the leftmost -column).
-e: event printing

-s: state change printing

-u: unexpected event printing

-A: turn on all printing on all machines

-D: disable all printing on all machines

machineID
The machine ID to trace.
setting
Use 0 to disable printing or 1 to enable printing.
Example:
[ 3] Linecard> state
state
ID FSM Name State
-- -------- -----
1 Line 2 AMD Standby
2 Line 2 CallP CSCIdle
3 Line 1 AMD Standby
4 Line 1 CallP CSCIdle
5 LC Diags Diag Idle

Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 663

[ 11] Linecard> state -A

state -A
Activating all state machine prints.
Return Status: 0

quecp Syntax: quecp {line} {event}

Internal use only. Sends a Call Processing event to the CallP state machine.

CAUTION
Potentially service affecting
Using the vbat command may cause certain subscriber equipment to not
detect ring voltage.

vbat Syntax: vbat {setting}

Sets the line card battery voltage. Use 0 to set the voltage to −50V or 1 to set
the voltage to −95V.
Example:
[122] Linecard> vbat 0
vbat 0
Vbat set to -50V

Return Status: 0

ringfreq Syntax: ringfreq {line} {index}

Overwrites the ringing frequency. The parameters are:
line
The line number. Valid range: 1 to 2.
index
The ring frequency. The allowed values are:
0 : 20 Hz
1 : 25 Hz
2 : 33.33 Hz
3 : 50 Hz
4 : 15 Hz
5 : 16 Hz
6 : 22 Hz
7 : 23 Hz
8 : 45 Hz

Firmware Guide Release 7.5 Standard 1.2 August 2012

664 Chapter 11

Example:
[ 25] Linecard> ringfreq 2 1
ringfreq 2 1
line 2 set to index 1
Return Status: 0

lcstatus Displays the current line card status.

Example:
[ 36] Linecard> lcstat
lcstat
---------------- LE88 Global Registers------------------

Global Registers for SLAC: 1.

SLAC revision Code Number: 0x02 0xb6

Revision Code: 0x02
Product Code: 0xb6 : LE 88241
SLAC state is marked as : Initialized.
TX/RX Clock Slot Register: 0x40
Transmit Edge: Positive edge of PCLK
Receive Clock Slot number: 0
Transmit Clock Slot number: 0
Device Configuration Register: 0x82
Open Drain Output
No Signaling on PCM Highway
PCM Clock Frequency is: 2.048000 Mhz
Channel Enable Register: 0x01
Channel one: Enabled
Channel two: Disabled
Signalling Register: 0x0000
...
Input/Output Direction Register: 0x00
IO2 is an Input
IO1 is an Input
--------------------------------------------------------

----------------Channel Specific Registers------------------

Status for Line: 01

Transmit/Receive Timeslot:
TX Timeslot: 0x00 Receive Timeslot: 0x00
Voicepath Gains: 0x00
Transmit Analog Gain: 0 dB gain
Receive Analog Loss: 0 dB loss
Digital Receive Loss: 0 dB loss in receive path

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 665

Input / Output Register: 0x00

IO2 : Low
IO1 : Low
System State: 0x24
Ringing State: Not Ringing
Metering State: Off
Codec State: Activated
Polarity Feed: Normal Polarity
System State : Idle
Operating Functions: 0xff
...
----------------Channel Specific Registers------------------

Status for Line: 02

Transmit/Receive Timeslot:
TX Timeslot: 0x02 Receive Timeslot: 0x02
Voicepath Gains: 0x00
Transmit Analog Gain: 0 dB gain
Receive Analog Loss: 0 dB loss
Digital Receive Loss: 0 dB loss in receive path
...
----------------Other Linecard Parameters------------------

Linecard State Machine states:

ID FSM Name State

-- -------- -----
1 L2 AMD Standby
2 L2 CP CSCIdle
3 L1 AMD Standby
4 L1 CP CSCIdle
5 LC Diags Diag Idle

cal_dump Dumps the line card calibration table.

enableidle Syntax: enableidle {line} {state}

Enables idle state on the specified line. The parameters are:
line
The line number to set: 1 to 2, or * to set all lines.
state
0: standby; 1: idle

Firmware Guide Release 7.5 Standard 1.2 August 2012

666 Chapter 11

CAUTION
Potentially service affecting
Avoid using the batcal and polling commands unless instructed by ARRIS
Technical Support.

batcal Writes data to the battery calibration tracker.

polling Toggles line card internal polling.

Voice CallP Commands

To enter the CallP sub-menu, enter callp at the Voice> prompt.

dds Displays the size of CallP data structures.

Example:
[ 5] Call Processing> dds
dds

Size of lines[0] = 112612

Size of cxPool[0] = 3680
Size of tcidPool[0] = 2000
Size of nePool[0] = 312

dlr Syntax: dlr {line} {n}

Prints some or all of the contents of the line record. The parameters are:
line
The line number. Valid range: 1 to 2.
n
0 (default): dump basic line state information.

1: dump all call processing information related to the line

2: dump all call processing and non call processing (line card, DSP,
datapath) information related to the line
Example:
[ 19] Call Processing> dlr 1 0
dlr 1 0
Line Number (1-based) = 1
Endpoint State = In Service

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 667

Linecard State = Talk

Have A-Link = TRUE
Dialing Method Override = No Dialing Method override
Onhook Transmission Enabled = FALSE
Onhook Transmission Pending = FALSE
My IP Address = 10.1.35.170

Return Status: 0

dst Prints the call processing and administrative states of all lines. The state is
one of the following:
State Description
EP_IS In Service
EP_RST Restart in progress
EP_DISC Disconnected
EP_OOS Out of Service

Example:
[ 20] Call Processing> dst
Line State ifIndex ifAdminStatus operStatus
------------------------------------------------------------
1 2 (EP_RST ) 9 UP UP
2 2 (EP_OOS ) 10 UP DOWN

chst Syntax: chst {line} {state} [force]

Changes the CallP state of the line. The parameters are:
line
The line number. Valid range: 1 to 2.
state
The new state for the line; one of:

Firmware Guide Release 7.5 Standard 1.2 August 2012

668 Chapter 11

Value State
0 No state change
1 Out of Service
2 Intermediate state for taking In Service
3 Null (idle)
4 Call Init
5 Call Received
6 Call Inactive
7 Call Active
8 QoS Create
9 QoS Modify
10 Remote Disconnect
11 Local Disconnect

force
Use 1 to force the line to change to the new state, 0 otherwise.

callpEnblLog Syntax: callpEnblLog {flag}

Enables or disables CallP signalling logging. The flag is either 1 to enable
logging, or 0 to disable logging.

callpDispLog Displays the CallP signalling log.

Example:
[ 11] Call Processing > callpDispLog
callpDispLog
************** MGCP LOG 1 **************
2007-1-23,16:33:46.0
RSIP 1 aaln/[email protected] MGCP 1.0 NCS 1.0
RM: restart

************** MGCP LOG 2 **************

2007-1-23,16:33:46.0
200 1 OK

************** MGCP LOG 3 **************

2007-1-23,16:33:46.0
RSIP 2 aaln/[email protected] MGCP 1.0 NCS 1.0
RM: restart

************** MGCP LOG 4 **************

2007-1-23,16:33:46.0
rqnt 1 aaln/[email protected] mgcp 1.0 ncs 1.0
x: 0
q: loop

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 669

r: hf(i), hd(n)

************** MGCP LOG 5 **************

2007-1-23,16:33:46.0
200 1 OK

************** MGCP LOG 6 **************

2007-1-23,16:33:46.0
200 2 OK

************** MGCP LOG 7 **************

2007-1-23,16:33:46.0
rqnt 2 aaln/[email protected] mgcp 1.0 ncs 1.0
x: 1
q: loop
r: hf(i), hd(n)

callpClrLog Erases the CallP signalling log.

dsxEnblLog Syntax: dsxEnblLog {flag}

Enables or disables DSx logging. The flag is either 1 to enable logging, or 0
to disable logging.

dsxDispLog Displays the DSx log.

dsxClrLog Erases the DSx log.

trace Syntax: trace {component} {enable}

Enables or disables CallP tracing of the selected component.

CAUTION
Loss of service
Enabling multiple traces during extremely high call volumes, such as bulk
call testing, can cause the E-UE to lock up. Contact ARRIS Technical Sup-
port before enabling tracing during call testing.

The parameters are:

component
One of the following:

Firmware Guide Release 7.5 Standard 1.2 August 2012

670 Chapter 11

Value Description
0 Callp Connection FSM Trace
1 Japanese Caller ID State Trace
2 Traffic Debugging State Trace
3 Signals Processing State Trace
4 CMS-initiated VMWI State Trace
5 CMS-initiated Caller ID State Trace
6 Fax or Modem Detection State Trace
7 Quarantine Buffer Processing Trace
8 DSP Handling Trace
9 Echo Cancellation Processing Trace
10 Call Processing Message (i.e. NCS) Trace
11 Trace dialed digits
12 Trace RFC2833 event processing
13 Trace RTP/RTCP Statistics Gathering
14 Trace Ring Generation
15 Trace Gain Control Adjustments
16 Trace Signaling (SIP/NCS) Errors
17 Trace NCS Msg Round Trip Delay
18 Trace SIP/NCS Registration
19 Trace NCS Message History
20 Trace SIP Callleg Messages
21 Trace SIP Subscription Messages
22 Trace SIP Transaction Messages
23 Trace CallP Message Queue Processing
24 Trace SIP Error Messages
25 Trace SIP Publish Messages
26 Trace DSX [0]
27 Trace SIP DNS Records
28 Trace SIP P-CSCF Selection
99 ALL Traces

enable
0: off
1: on

Example:
[ 33] Call Processing> trace 1 1
trace 1 1
Japanese CID trace enabled
Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 671

mgcp Syntax: mgcp {bitmap}

Controls NCS call tracing. The parameter is:
bitmap
One or more bit values that select the messages to trace:
0x0000 = off
0x0001 = full NCS message trace
0x0002 = CX messages and responses only (reduced)
0x0004 = incoming non-CX messages only (reduced)
0x0008 = outgoing non-CX messages only (reduced)
0x0010 = RX/TX ACK messages only (reduced)
0x0100 = use LOG_it

Example:
[ 37] Call Processing> mgcp 1
mgcp 1
MGCP message trace enabled
Return Status: 0

dsxtrace Controls DSX tracing.

change_ne Syntax: change_ne {line}

(NCS only) Changes the notified entity for the specified line.

setgain Syntax: setgain {tone} [val]

Sets or displays the gain of the specified tone. This command affects the
arrisMtaDevGainControl MIB object. The parameters are:

tone
One of the following:
• lt (local tones)
• nt (ringback and other network tones)
• fsk (CID and VMWI tones)
• cas (CAS tones)
• ldtmf (DTMF tones toward the CPE)
• ndtmf (DTMF tones toward the network)
• rx (receive audio)

Firmware Guide Release 7.5 Standard 1.2 August 2012

672 Chapter 11

• tx (transmitted audio)
val
The change to the tone, in dBm. Omit this parameter to show the
current gain setting for the specified tone.
Example:
[ 4] Call Processing> setgain nt
setgain nt
MIB value for nt is 0

Return Status: 0

ftrsw Syntax: ftrsw [bitmap]

Displays or sets the Call Processing feature switch. If you do not specify a
bitmap value, the ftrsw command displays the current settings.
Example:
[ 44] Call Processing> ftrsw
ftrsw
0x20000000: Allow MTA to automatically generate OSI: DISABLED
0x10000000: Delay DLCX response against connection on onhook only line (for VMWI): DISABLED
0x08000000: Use alternate (non sequential) Caller ID delivery order: DISABLED
0x01000000: Send dtmf digits via RFC2833 with payload 101 without request: DISABLED
0x00800000: Add brackets to IP for MTA FQDN when communicating with call server: DISABLED
0x00400000: Allow NCS Redirect without IPsec: DISABLED
0x00100000: Disable RTP/RTCP authentication/encryption (bit = 0): ENABLED
0x00080000: LUCENT RFC-2833 messaging without request using payload 94: DISABLED
0x00010000: Payload Header Suppression: DISABLED
0x00008000: Disable endpoint from sending provisional responses: DISABLED
0x00004000: DSX (access only) DQoS: DISABLED
0x00001000: NUERA RFC-2833 messaging without request using payload 127: DISABLED
0x00000800: Force the use of DQoS. Reject service if not used: DISABLED
0x00000400: Ignore format-specific SDP attribute lines referring to payload types not listed in m
0x00000100: Omit capability parameters in returned SDP: DISABLED
0x00000080: Omit mptime parameter in returned SDP: DISABLED
0x00000040: Apply auto OSI to both originating and terminating side for NCS calls: DISABLED
0x00000008: Reduce the capability descriptor in the SDP to T38 only: DISABLED
0x00000004: If line is not provisioned show 0(OOS) rather than IDLE for arrisMtaDevLineCardState.
0x00000002: Prevent endpoint from entering the Lockstep quarantine mode: DISABLED
0x00000001: Prevent piggybacked transmissions of NCS messages: DISABLED

CallpFeatureSwitch is currently 0x00000000

adjustCallpFeatureSwitch is currently disabled

Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 673

dtmf Syntax: dtmf [value]

Sets or (with no parameter) displays the current CallP DTMF relay setting.
The value may be one of the following:
1 RFC2833, no CallP reporting
2 RFC2833, with CallP reporting
3 DTMF voice with CallP reporting
4 DTMF burst with CallP reporting
Example:
[ 45] Call Processing> dtmf
dtmf
CALLP_DTMF_RELAY_SETTING is currently 3
Return Status: 0

dmon Displays information about event messages between the eDVA and the CMS.
Example:
[ 99] Call Processing> dmon
dmon
Call Agent Socket information:
callp_netifp_ca_open = 1
CPInitRetries = 0
CountofInitFailed = 0
CountofSuccessiveInitFailed = 0

RF Communications up = TRUE
MTA Registration Complete = TRUE
MTA IP Address Lost = FALSE

Last NCS message received from CMS ...

AUEP 40708 *@mta133.dev216 MGCP 1.0 NCS 1.0

Last NCS message attempted to send to CMS ...

200 40708 OK
Z: aaln/[email protected]
Z: aaln/[email protected]
Message Delay...
Message Sample Size: 1
Average Response Delay: 30 ms
Average Deviation: 0 ms
Num Successful Msgs to CMS 1
Num Unsuccessful Msgs to CMS 0
Num Successful Msgs from CMS 991
Num Unsuccessful Msgs from CMS 0
Num Times Lost MTA IP Address 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

674 Chapter 11

Largest NCS message sent = 93 bytes

Largest NCS message received = 45 bytes

Total Potential No/Slow Dialtone...

Line 1 = 0
Line 2 = 0

Total Potential No/Slow Answer...

Line 1 = 0
Line 2 = 0

QUARANTINED EVENT COUNTS...

Num Quarantined Events - NOTIFICATIION 0
Num Quarantined Events - DISC_NOTIFICATION 0
Num Quarantined Events - LOCKSTEP 0
Num Quarantined Events - PROC_LOCKSTEP_LINE 0
Num Quarantined Events - PROC_LOCKSTEP_CX 0
Num Quarantined Events - TDMIN 0
Num Quarantined Events - PERM_ERROR 0
Num DSP Resets[1] 0
Num Times Lost MTA IP Address 0

Total Potential No/Slow Dialtone...

Line 1 = 0
Line 2 = 0

Total Potential No/Slow Answer...

Line 1 = 0
Line 2 = 0

Total Potential IPDT No Alert Due To No RFC2833 Ring Request...

Line 1 = 0
Line 2 = 0

Total Potential IPDT No Alert Due To Wrong RFC2833 Message Received before Ring Request...
Line 1 = 0
Line 2 = 0

Total Potential IPDT No Alert Due To DLCX Received (may be VMWI)...

Line 1 = 0
Line 2 = 0

Total Potential IPDT No Alert Due To Offhook (glare)...

Line 1 = 0
Line 2 = 0

Total Potential IPDT Slow Answer Due To Late Ring Request...

Line 1 = 0
Line 2 = 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 675

Total Attempted IPDT Originations...

Line 1 = 0
Line 2 = 0

Total Attempted IPDT Terminations...

Line 1 = 0
Line 2 = 0

Dialed Number History...

Line 1:
There is no data to display for line 1

Line 2:
There is no data to display for line 2

QUARANTINED EVENT COUNTS...

Num Quarantined Events - NOTIFICATION 0
Num Quarantined Events - DISC_NOTIFICATION 0
Num Quarantined Events - LOCKSTEP 0
Num Quarantined Events - PROC_LOCKSTEP_LINE 0
Num Quarantined Events - PROC_LOCKSTEP_CX 0
Num Quarantined Events - TDMIN 0
Num Quarantined Events - PERM_ERROR 0

Error codes sent to CMS...

Error Code Count (max = 255)
-------------------------------
200 255
250 1

Error codes received from CMS...

Error Code Count (max = 255)
-------------------------------
200 1

Reason codes sent to CMS via MTA initiated DLCX...

Reason Code Count (max = 255)
-------------------------------
Line 1 is onhook and idle...
Line 2 is onhook and idle...

Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

676 Chapter 11

conn_rec Syntax: conn_rec {conNum}

Displays the connection record structure for a connection. The parameter is:
conNum
The connection number. Valid range: 1 to 4, or 0 to specify all
connections.
Example:
[ 49] Call Processing> conn_rec 4
conn_rec 4
Connection Related Info...
Connection Number (0 based) = 3
Owned by line (1-based) = 1
Connection State = 5: QOS_CX_ACT
Connection ID = 0x3
pMsg = NULL
qos_pMsg = NULL
Bandwidth Lost Reason = NONE
Stale Connection Flag = FALSE
DSP Related Info...
Connection owns pTcid resource...
tcid = 1
line (verified) = 1
My RTP Port = 59584
DSP Line Mode = 2: DSP_digit_collect_state
DSP Net Mode = 3: DSP_voice_state
Actual DSP Mode = 3: DSP_voice_state
DSP Closing = FALSE
DSP Opening = FALSE
DSP Resetting = FALSE
DSP Reset Pending = FALSE
Target DSP Mode = 0: DSP_closed_state
DSP TONE Detected = no dsp tones detected
Echo Cancellation Status = Enabled
TX Mute = FALSE
Active Tone On Network (on) = FALSE
Active DTMF Tone On Network = FALSE
Tone On Network in progress = FALSE
Network Tone On Both DSPs = FALSE
Active Tone On Endpoint = FALSE
DTMF Caller ID IN Progress = FALSE
CAS Tone In Progress = FALSE
Am I In Use = TRUE
Associated = TRUE
Tied to line = TRUE
Last DTMF Digit = No Digit
Waiting For Connection Statistics = FALSE
Waiting For DLCX Resp Delay Timer = FALSE
Requested Info mask = 0x0
Connection Mode = 4: SENDRECV

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 677

Provisional Response Sent = FALSE

LCD Changed On Prov Response = FALSE
Call ID = 35000F35000B54FD5F2D
txRtpPayLoadType = 0
rxRtpPayLoadType = 0
Local Connection Options String = p:20, a:PCMU, dq-gi:9F41AFA3,
sc-rtp:60/50,
sc-rtcp:80/70
Remote Connection Descriptor...
remoteRtpp = 0xa0123ac (10.1.35.172)
remoteRtpStr = 10.1.35.172
remoteSdp = ...
v=0
o=- 86967192 86967192 IN IP4 10.1.35.172
s=-
c=IN IP4 10.1.35.172
t=0 0
m=audio 57984 RTP/AVP 0
b=AS:80
a=mptime:20
a=ptime: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 100
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:100 telephone-event/8000/1
a=cpar: a=fmtp:100 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
Multiple Connection Data...
connection data = 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
connections = 0
tcid_connect_mode = 0: NO MODE
Internal Flags...
Connection Active (send/receive) = TRUE
Transmitting RTP To Network = TRUE
Muting RX for FAX = FALSE
OK to Modify CX = TRUE
LCO Info...
Got Local ptime = FALSE
Got Remove ptime = FALSE
Codec Negotiated = FALSE
Type Of Service Byte = 0
Echo Cancellation (NONE/ON/OFF) = 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

678 Chapter 11

Silence Supression (NONE/ON/OFF) = 0

Stat Request Active flag = STAT_IDLE
Fax Stats Request Active = FALSE
QoS Related Info...
Down Stream SFID = 0
UP Stream SFID = 0
Got Gate ID Flag = TRUE
Gate ID = 9f41afa3
Got Resourcd ID Flag = FALSE
Resource ID = 0
Resource Reservation = 0
Processing QoS Flag = FALSE
T38..................
T38 Capability Negotiated = NO_FAX
T38 Switch Pending = FALSE
CA Controlled T38 Possible = FALSE
T38 Media Mode = VOICE
T38 LS Redundancy Level = 4
T38 HS Redundancy Level = 1
FAX Stats Request Counter = 0
fax_stat_req_active = FALSE
Return Status: 0

tcid_rec Syntax: tcid_rec {tcid}

Displays the TCID record information. The parameter is:
tcid
The TCID to display. Valid range: 1 to 8, or 0 to display all
TCIDs.
Example:
[ 54] Call Processing> tcid 1
TCID Number : 0
tcid = 1
line (verified) = 1
My RTP Port = 58680
DSP Line Mode = 2: DSP_digit_collect_state
DSP Net Mode = 3: DSP_voice_state
Actual DSP Mode = 3: DSP_voice_state
DSP Closing = FALSE
DSP Opening = FALSE
DSP Channel Coding = FALSE
DSP Channel Configured = TRUE
DSP Channel Coding Pending = FALSE
Sending RTCP BYE = FALSE
DSP Failed = FALSE
DSP Failed Counter = 0
DSP Failed Error = 0
Target DSP Mode = 0: DSP_closed_state

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 679

DSP TONE Detected = no dsp tones detected

Echo Cancellation Status = Enabled
TX Mute = FALSE
Active DTMF Tone On Network = FALSE
Active DTMF Tone On Line = FALSE
Tone On Network in progress = FALSE
DTMF Caller ID IN Progress = FALSE
CAS Tone In Progress = FALSE
Am I In Use = TRUE
BR Local Tone Active = FALSE
BR Network Tone Active = FALSE
Modify Datapath during BYE = FALSE
setupDspStuff during BYE = FALSE
dsp_coding_type = VOICE
Last DTMF Digit = No Digit
FAILURE INDICATORS...
Num BR tone interruptions = 0
Num TO tone restarts = 0

rtcp_info Syntax: rtcp_info {conNum}

Display the RTCP information for the specified connection. The parameter
is:
conNum
The connection number. Valid range: 1 to 8, or 0 to specify all
connections.
Example:
[ 57] Call Processing> rtcp_info 4
rtcp_info 4
our ssrc : 0
update_rate : 0
n_pkts_to_net : 0
n_pkts_to_port : 0
n_pkts_to_dsp : 0
n_pkts_seen_before_dsp : 0
n_pkts_seen_after_last_dsp 0
pkts_to_dsp_since_last_reset : 0
n_pkts_lost_before_last_reset : 0
n_pkts_drop_s : 0
n_bytes_to_net : 0
n_bytes_to_port : 0
n_bytes_to_dsp : 0
n_rtcp_sent : 0
n_rtcp_recv : 0
n_rtcp_bad : 0
n_rtcp_rb_seen : 0
n_rtcp_rb_seen_bad_delay : 0
est_delay : 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

680 Chapter 11

cum_delay : 0
est_jitter : 0
n_pkts_lost : 0
seq_num : 0
ts : 0
n_pkts_drop_cb : 0
n_pkts_drop_cb_rtcp : 0
n_pkts_drop_udp_send : 0
n_pkts_drop_lbt_send : 0
last count for p_sent : 0
last count for p_recv : 0
last count for b_sent : 0
last count for b_recv : 0
last ts : 0
last average jitter : 0
last max jitter : 0
last last_seq : 0
last count for lost : 0
stat_req_active : 0
ntp_sec : 0
ntp_fract : 0
other_ssrc : 0
other p_sent : 0
other b_sent : 0
other lost : 0
other jitter : 0

Return Status: 0

chg_template Syntax: chg_template [template]

Displays or sets the current country template. The template is the country
code template value as described in the ppCfgMtaCountryTemplate object.
Omitting the template displays the current setting and available templates.

chg_dialing Syntax: chg_dialing {line} {method}

Changes the dialing method. The parameters are:
line
Valid range: 1 to 2.
method
The dialing method; one of:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 681

Value Description
1 Tone only
2 Pulse only
3 Tone and pulse
4 Pulse only with DTMF relay
5 Tone and pulse with DTMF relay

For more information, see ‘‘Dial Pulse Support’’ on page 121.

sec Syntax: sec {line}

(NCS only) Displays security parameters. The parameter is:
line
The line number. Valid range: 1 to 2.
Example:
[ 59] Call Processing> sec 1
sec 1
Local Secret = NULL
Local Pad = NULL
Remote Secret = NULL
Remote Pad = NULL
Rtp Rx Key = NULL
Rtp Tx Key = NULL
Rtp Rx IV = NULL
Rtp Tx IV = NULL
Mmh Rx Key = NULL
Mmh Tx Key = NULL
Rtcp Auth Rx Key = NULL
Rtcp Auth Tx Key = NULL
Rtcp Encr Rx Key = NULL
Rtcp Encr Tx Key = NULL
Rx TimeStamp = 0
Tx TimeStamp = 0
Have Rx Keys = 0
Have Tx Keys = 0
Return Status: 21

cpq Displays the CallP message queue, when enabled.

Example:
[ 64] Call Processing> cpq
cpq
LINENUM SOURCE EVENT
------------------------
0, 0, 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

682 Chapter 11

0, 0, 0
0, 0, 0
0, 0, 0
...

Return Status: 0

ipsec_ready Syntax: ipsec_ready {line}

(NCS only) Injects an IPsec READY message to the specified line. The
parameter is:
line
The line number. Valid range: 1 to 2.

parser Syntax: parser {logtype}

Enables/disables parser debug logs. The parameter is:
logtype
0: all off
1: all on
2: NCS only
3: SDP only

Example:
[ 70] Call Processing> parser 1
parser 1
Return Status: 0

lineInfo Syntax: lineInfo {line}

Displays customer visible line information. The parameter is:
line
The line number. Valid range: 1 to 2.
Example:
[ 73] Call Processing> lineInfo 1
Line Number : 2
Loop Reversal State : 2: STATE_OFF
Connection Number : 1
Packetization Rate : 10
CODEC : PCMU
RX PAYLOAD : 0
TX PAYLOAD : 0
Echo Cancellation : TX Mute
TX Mute: TRUE
Return Status: 0

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 683

ring Syntax: ring {line} {cadence}

Rings the phone on line with the specified ring cadence. The parameters are:
line
The line number. Valid range: 1 to 2.
cadence
The ring cadence. See ‘‘Country Code Templates’’ on page 464
for a list of default ring cadences.

lcquery Syntax: lcquery {line}

Queries line card hook status and reports to Call Processing. The parameter
is:
line
The line number. Valid range: 1 to 2.
Example:
[ 76] Call Processing> lcquery 1
lcquery 1
Return Status: 0

chg_state Syntax: chg_state {line} {state}

Changes the line card state. The parameters are:
line
The line number. Valid range: 1 to 2.
state
One of the following states:

Firmware Guide Release 7.5 Standard 1.2 August 2012

684 Chapter 11

Value State
0 CSC_OOS
1 CSC_Idle
2 CSC_Addr
3 CSC_Talk
5 CSC_FDisc
6 CSC_Ring
7 CSC_OnHookTx
8 CSC_TipOpen
11 CSC_TrunkC
12 CSC_Prot
13 CSC_Diags
14 CSC_PLO

chg_polarity Syntax: chg_polarity {line} {polarity}

Changes the polarity of the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
polarity
0: normal
1: reversed

chg_alink Syntax: chg_alink {line} {state}

Changes the Alink state of the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
state
0: release
1: get

chg_power Syntax: chg_power {line} {state}

Changes the power state of the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
state
0: release
1: set

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 685

set_cadence Syntax: set_cadence {line} {on1 off1} [on2 off2 ...]

Sets a custom ring cadence for the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
on1 off1 ...
The ring on/off times, in milliseconds. You can specify up to four
on/off times.

scwidTest Syntax: scwidTest {line} {num}

Test SCWID on the specified line num times. This command requires that a
call is in progress on the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
num
The number of times to test SCWID.
Example:
[ 97] Call Processing> scwidTest 1 2
scwidTest 1 2
SCWID test started...
Return Status: 0

cid Syntax: cid {line} [type]

Tests Caller ID on the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
type
0 (default) - Normal name and number
1: Private caller
2: Out of area

etsi Syntax: etsi {flag}

Enables or disables ETSI functionality (Caller ID and tones). Specify 1 to
enable ETSI or 0 to disable it.

Firmware Guide Release 7.5 Standard 1.2 August 2012

686 Chapter 11

vmwi Syntax: vmwi {line} {flag}

Tests VMWI on the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
flag
0: Stop the test
1: Start the test

dsp_reset Syntax: dsp_reset {line} [resource]

Resets a DSP channel resource on the specified line. The parameters are:
line
The line number. Valid range: 1 to 2.
resource
0 (default): Reset the pTcid resource
1: Reset the pTcidConf resource

eoc_stats Syntax: eoc_stats {val}

Enables or disables Syslog reporting of end-of-call statistics. This command
sets the arrisMtaDevEnableCallStatsSyslogRpt object.
The valid range of val is:
• 0 (no reporting)
• 1 (report end-of-call statistics)
• 2 (report end-of-call statistics and dump the signaling buffer)
• 3 (no reporting)
Omitting val prints a usage and description of the command, and displays the
current object setting.
See ‘‘End of Call Connection Statistics’’ on page 364 for details about end-
of-call statistics.

buf_store Syntax: buf_store [flag]

Enables or disables signaling buffer storing.
The flag is 0 or 1, to disable or enable buffer storing. Omitting the flag prints
a usage and description of the command, and displays the current setting.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 687

sig_trace Syntax: sig_trace {flag}

(NCS only) Enables or disables signaling trace. This command sets the
arrisMtaDevEnableCallpSigTrace object.

The flag is 0 or 1, to disable or enable tracing. Omitting the flag prints a

usage and description of the command, and displays the current object set-
ting.

mdfy_rtp Syntax: mdfy_rtp {conn}

Modifies the specified RTP connection. The conn parameter specifies the
connection to modify, or 0 to modify all connections.

ddly Syntax: ddly [time]

Sets or (with no parameter) displays the time (in milliseconds) to delay pro-
cessing the DLCX for VMWI.

tones Syntax: tones {country} [signal]

Displays the template for the specified country code and tone signal. The
information displayed includes frequencies, amplitudes, and durations. The
parameters are:
country
The country code for the specified tone. Valid range: 1 to 32, or 0
to display all countries, or a to display the active country code.
signal
The tone signal to display. Valid range: 1 to 50, or 0 (or omitted)
to display all tones for the specified country.
See ‘‘Country Code Templates’’ on page 464 for a list of valid country codes
and common tones.
Example:
[ 6] Call Processing> tones a 22
Country : NorthAmerica33(17), tone template : 10
Element Freq1 Amp1 Freq2 Amp2 Freq3 Amp3 Freq4 Amp4 Duration
TT:10, t=BR Signal : 22 (cf) = TSG Signal of 25, NMM Sig of 9, Total Duration= 600ms :
Following to be repeated 3 times:
0 350 -130 440 -130 0 0 0 0 100
1 0 0 0 0 0 0 0 0 100
End of repeat group

Firmware Guide Release 7.5 Standard 1.2 August 2012

688 Chapter 11

is Syntax: is {line}
Puts the specified line in service by setting the ifAdminStatus MIB object.
The valid range for line is 1 to 2.
Example:
[ 63] Call Processing> is 2
is 2
Putting line 2 in-service (ifAdminStatus UP)

Return Status: 0

oos Syntax: oos {line}

Takes the specified line out of service by setting the ifAdminStatus MIB
object. The valid range for line is 1 to 2.
Example:
[ 64] Call Processing> oos 2
oos 2
Taking line 2 out-of-service (ifAdminStatus DOWN)

Return Status: 0

rng_cad Syntax: rng_cad {country}

rng_cad {country} {default [signal]}

Displays ring cadences for the specified country. The parameters are:
country
One of the country code numbers listed in ‘‘Country Code Tem-
plates’’ on page 464, or a to display all ring cadences for the active
country template, or A to display all ring cadences for all countries.
default
Use 0 to read cadences from the current MIB values, or 1 to use the
default cadences. This may be useful for debugging purposes.
signal
Displays the selected signal instead of all cadences.
Note: Only the ring cadences that have names beginning with ‘‘l/’’ can be
changed through SNMP.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 689

auto_osi Syntax: auto_osi [[delay] [flag]]

Displays or changes automatic OSI (Open Switch Interval) settings. The
parameters are:
delay
The delay, in 100 ms increments. Valid range: 0 to 100 (0 ms to
10 seconds).
flag
Use 0 to disable automatic OSI generation, or 1 to enable it.
With no parameters, displays the current settings.

SG3FaxRelay Syntax: SG3FaxRelay [flag]

Enables or disables SuperG3 FAX relay support for T.38 connections. The
parameter is:
flag
Set to 1 to enable SuperG3, or 0 to disable SuperG3. Setting this
flag is equivalent to setting the arrisMtaDevSuperG3FaxRelay
object. Omit this parameter to display the current setting.

sip_callleg (SIP only) Toggles SIP callleg message tracing. Messages printed include
SIP Invite and INFO messages.

sip_error (SIP only) Toggles SIP error reporting. Messages printed include error mes-
sage responses.

sip_reg (SIP only) Toggles SIP registration message tracing.

sip_subs (SIP only) Toggles SIP subscription message (VMVI) tracing. This com-
mand requires the ‘‘RFC3842 handshake’’ SIP feature switch to be set.

sip_trans (SIP only) Toggles SIP transaction message (VMWI) tracing. This command
requires the ‘‘RFC3842 handshake’’ SIP feature switch to be cleared.

sip_rv (SIP only) Toggles RV SIP stack logging.

sip_pub (SIP only) Toggles SIP PUBLISH message tracing.

Firmware Guide Release 7.5 Standard 1.2 August 2012

690 Chapter 11

sip_digitmap (SIP only) Toggles SIP digit map message tracing.

sip_ftr Syntax: sip_ftr [value]

(SIP only) Displays or modifies the SIP Feature Switch setting.

sip_ftr2 Syntax: sip_ftr2 [value]

(SIP only) Displays or modifies the second SIP Feature Switch setting.

sip_stack_ver (SIP only) Displays the SIP stack version.

penalty_box (SIP only) Displays proxies listed in the SIP penalty box.

checkStackRes (SIP only) Displays SIP stack resource data.

gettimers (SIP only) Displays SIP timer values.

serviceRoutes (SIP only) Displays a list of active Service-Routes.

dumpdm (SIP only) Displays the contents of the digit map.

cotdump (SIP only) Displays Customer-Originated Trace (COT) data.

regevent_timer (SIP only) Sets the Registration Event Outgoing Expires Timer.

sip_display_agp- (SIP only) Displays the auto-generated SIP password.

wd

sip_dns (SIP only) Displays DNS IP records discovered in DNS lookups.

sip_impu (SIP only) Displays the primary and implicitly registered IMPU.

spls Syntax: spls {line} {status}

Sets the persistent line status. The parameters are:

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 691

line
The line number to set, beginning with 1.
status
Either 0 to enable the line, or 1 to force-disable the line. This value
is stored in non-volatile memory and persists across reboots.

sdqm Shows the states of DQM Context entries.

Example:
[ 54] Call Processing> sdqm
sdqm

Return Status: 0

[ 55] Call Processing> [ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - DQM: dqmapi: CNTXT_STATE IDL
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 0 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 1 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 2 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 3 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 4 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 5 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 6 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 7 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 8 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 9 is in state 0, SHUTDOWN state count 0
[ERROR] [VOICE.XSPY(pid=494)]: 0001832377 - cntxt # 10 is in state 0, SHUTDOWN state count 0

taskwatch Syntax: taskwatch {cmd} {state}

Periodically displays the status of the specified voice threads. The parame-
ters are:
cmd
One of the following:
• start: start watching
• stop: stop watching
• status: display the current watch status
state
The thread states to watch:
• A: watch all thread states
• R watch running thread states

Firmware Guide Release 7.5 Standard 1.2 August 2012

692 Chapter 11

• S watch sleeping thread states

The state is not case-sensitive (for example, a and A are both
accepted).

procwatch Periodically displays the status of the each running process.

dmp_stack Syntax: dmp_stack {ptr}

Displays the thread stack. The ptr is the stack pointer address, in hexadeci-
mal.

dnsTools Debugging tools for CMS DNS lookup utilities. In dnsTools sub-mode, the
prompt is Debug tools for CMS DNS lookup utilities>.

requery_dns

Sends a ‘‘requery request’’ message to CallP.

force_lkup

Sets the DNS Lookup state:

• 0: Unforced
Check the local DNS table first, only query the DNS server if neces-
sary.
• 1: Forced
Do not check the local DNS table, always query the DNS server.

pne_print

Displays the pNe table.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 693

MTA Sub-Mode Commands

You can enter an MTA sub-mode command without entering MTA sub-mode
by preceding any of the following commands with / mta. In MTA sub-mode,
the prompt is MTA>.

config Displays the contents of the CallP provisioning database.

showconfig Displays the eDVA configuration file.

Example:
[152] MTA> showconfig
showconfig
MTA Configuration File Parameters:
******************************
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.1.1.1.7.0 1
SNMP_MIB_Object = 1.3.6.1.4.1.7432.1.1.1.6.0 1
SNMP_MIB_Object = 1.3.6.1.2.1.140.1.1.6.0 1
SNMP_MIB_Object = 1.3.6.1.4.1.7432.1.1.3.8.1.2.1
0x6777632d30352e73776c61622e61746c2e6172726973
"gwc-05.swlab.atl.arris"
SNMP_MIB_Object = 1.3.6.1.4.1.4115.10.1.14.0 9
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.1.1.2.7.0
0x90e719c8ee60d834e58c3ea2aa5b47e9d799097a
SNMP_MIB_Object = 1.3.6.1.2.1.140.1.2.11.0
0xfd3d8a75b0b83e0fddec043bc9e7865bd9354f63
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.2.1.2.1.1.1.9
0x63614070632d616c707336302e6465763530
"[email protected]"
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.2.1.2.1.1.2.9 2427
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.2.1.2.1.1.18.9 3
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.2.1.2.1.1.1.10
0x63614070632d616c707336302e6465763530 "[email protected]"
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.2.1.2.1.1.2.10 2427
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.2.1.2.1.1.18.10 3
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.3.1.1.2.1.2.1
0x27696d732e766f69702e68726e6476612e72722e636f6d27
"’ims.voip.hrndva.rr.com’"
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.3.1.1.2.1.11.1 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.3.1.1.4.1.2.1.1 16
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.3.1.1.4.1.3.1.1
0x2770637363662e696d732e766f69702e68726e6476612e72722e636f6d27
"’pcscf.ims.voip.hrndva.rr.com’"
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.3.1.1.4.1.12.1.1 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.3.1.2.1 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.3.1.3.1
0x273531323636363930313440696d732e766f69702e68726e6476612e72722e636f6d27

Firmware Guide Release 7.5 Standard 1.2 August 2012

694 Chapter 11

"’[email protected]’"
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.3.1.6.1 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.2.1.2.1 6
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.2.1.3.1
0x273531323636363930313440696d732e766f69702e68726e6476612e72722e636f6d27
"’[email protected]’"
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.2.1.4.1 1
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.2.1.13.1 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.4.1.2.1.1 4491
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.4.1.3.1.1 1
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.4.1.4.1.1 1
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.10.4.1.1.4.1.9.1.1 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.8.2.1.1.2.1.3.1.3 3
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.8.2.1.1.2.1.4.1.3 1
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.8.2.1.1.2.1.5.1.3 1
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.8.2.1.1.2.1.9.1.3 4
SNMP_MIB_Object = 1.3.6.1.4.1.4491.2.2.8.2.1.2.1.2.1.13.1 26
SNMP_MIB_Object = 1.3.6.1.2.1.2.2.1.7.10 1
SNMP_MIB_Object = 1.3.6.1.2.1.2.2.1.7.9 1

Return Status: 0

[ 5] MTA>

getSig Syntax: getSig {param}

Displays signalling configuration parameters. The param can be one of the
following:
--help Shows a list of valid parameters.
R0Cadence Shows ring cadence 0.
R1Cadence Shows ring cadence 1.
R2Cadence Shows ring cadence 2.
R3Cadence Shows ring cadence 3.
R4Cadence Shows ring cadence 4.
R5Cadence Shows ring cadence 5.
R6Cadence Shows ring cadence 6.
R7Cadence Shows ring cadence 7.
RtCadence Shows ring cadence Rt.
RsCadence Shows ring cadence Rs.
RgCadence Shows ring cadence Rg.
SigTos Shows the ToS value for call signalling.
MediaTos Shows the ToS value for media stream packets.
TosFormat Shows the format of the default signalling and
media ToS values.
SigPort Shows the receive port used for NCS call sig-
nalling.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Voice CLI Commands 695

Example:
[ 53] MTA> getSig R0Cadence
getSig R0Cadence
SigDevR0Cadence=ff ff f0 0 0 0 0 0
Arris Cadence=28 50 0 0 0 0 0 0 len=6000ms

Return Status: 0

provmethod Displays the ARRIS eDVA provisioning method.

Example:
[154] MTA> provmethod
provmethod
Mta Device Provisioning Method Indicator = packetCableMinusKDC(2)
Return Status: 0

mtaftrsw Displays the current eDVA feature switch value.

Example:
[ 9] MTA> mtaftrsw
mtaftrsw
MTA Feature Switch is currently 0x0

codecs Displays the available CODECs.

Example:
[165] MTA> codecs
codecs
Following is the list of supported CODECs.
Index TSGCodecID MaxAvail NCS/SIP CodecType
1 0x9 4 PCMU
2 0x8 4 PCMA
3 0x42 2 G728
4 0x43 2 G729
5 0x45 2 G729E
6 0xa 2 G726-16
7 0xb 2 G726-24
8 0xc 2 G726-32
9 0xd 2 G726-40

Return Status: 0

Firmware Guide Release 7.5 Standard 1.2 August 2012

696 Chapter 11

resetMTA Resets the eDVA portion of the device.

Voice VQM Commands

To enter the VQM sub-menu, enter vqm at the Voice> prompt.

vqMetrics Displays VQM metrics for stored calls.

vqClear Clears stored data for Voice Quality Metrics

vqLocEnable Syntax: vqLocEnable {flag}

Enables or disables recording local Voice Metrics.

vqRemEnable Syntax: vqRemEnable [policy]

Displays or sets VQM RTCP-XR policy. The policy is one of:
allbox; cb cb n l . Value Description _ 0 Normal operation 1 Force
disable RTCP-XR 2 Force enable RTCP-XR omitted Displays the
current setting

tapi Syntax: tapi [[cmd] [value]

Performs VQM MIB testing. The parameters are:
cmd
The index corresponding to the object you want to write. Use the
tapi command with no parameters to see a list of command indexes
and their current settings.
value
The value to set.

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

 12 Index

allDsids, DOCSIS Dsid commands 589

AllModulesConfig, Logger commands 608
allocChannel, DSP commands 633
allphystatus, DOCSIS Debug commands 584
2.0 compatibility feature switch, DOCSIS 75 AllSeveritiesConfig, Logger commands 608
and IP address, hiding FQDN 217, 444
anonymous call rejection 188, 196
A !appmode, RF commands 530
AC power loss 206 ARRIS, events 222
access arris, MIB 361
enabling SNMP 245 ARRIS_PROVISIONING_set, PACM Debug commands 605
levels, CLI 398 arrisCmDevClearCachedFrequencies, MIB 118
levels, WebGUI 398 arrisCmDevClearPresetFrequencies, MIB 118
mode, SNMP 246 arrisCmDevDualModeDiscoveredMarket, MIB 59
troubleshooting interface, controlling 439 arrisCmDevHttpClientSeed, MIB 433
accessing arrisCmDevPresetFrequency, MIB 118
SSH 438 arrisCmDevProvMethodIndicator, MIB 38
Telnet 437 arrisCmDoc30, MIB 271
access-only DQos feature switch 75 arrisCmDoc30AccessClientSeed, MIB 271, 440
accesstime, DOCSIS Certification commands 563 arrisCmDoc30AccessHttpLan, MIB 272, 439
adaptive jitter buffers 90 arrisCmDoc30AccessHttpPwCtrl, MIB 272, 439
adcdump, DOCSIS Debug commands 580 arrisCmDoc30AccessHttpTimeout, MIB 272, 440
addcpe, DOCSIS Atp commands 565 arrisCmDoc30AccessHttpWan, MIB 272, 439
adding snmpCommunityTable 249 arrisCmDoc30AccessSinglePassword, MIB 272, 440
Adding arrisCmDoc30AccessSSHEnable, MIB 272, 436–437
vacmAccessTable 255 arrisCmDoc30AccessTelnetEnable, MIB 271, 398, 436–437
vacmSecurityToGroupTable 252 arrisCmDoc30AccessTelnetPassword, MIB 271–272, 436–437
adjusting arrisCmDoc30BaseReportDuplex, MIB 271
CW-CID tones 114 arrisCmDoc30BondingMode, MIB 56, 271
time offset 20 arrisCmDoc30CLITimeout, MIB 272, 437
Advanced flash feature switch 85 arrisCmDoc30DhcpCmConfigFile, MIB 214, 278
advanced screens 446 arrisCmDoc30DhcpCmGatewayIpAddr, MIB 214, 278
AES arrisCmDoc30DhcpCmIpAddr, MIB 214, 278
encryption for RTP/RTCP feature switch 75 arrisCmDoc30DhcpCmIpAddrType, MIB 213, 278
encryption parameters, SDP 75 arrisCmDoc30DhcpCmParameters, MIB 213, 277
affecting SDP, feature switch 79, 94 arrisCmDoc30DhcpCmSubNetMask, MIB 214, 278
alarm arrisCmDoc30DhcpCmTimeOffset, MIB 278
Gateway has reset 230 arrisCmDoc30DhcpExtendedActiveMode, MIB 279
Power Supply Telemetry 230 arrisCmDoc30DhcpExtendedCmConfigFile, MIB 281
SIP Authentication Failure 225 arrisCmDoc30DhcpExtendedCmGatewayIpAddr, MIB 281
SIP General Failure 224 arrisCmDoc30DhcpExtendedCmIpAddr, MIB 281
SIP Network Failure 225 arrisCmDoc30DhcpExtendedCmParametersType, MIB 281
SIP Proxy Loss of Communications 226 arrisCmDoc30DhcpExtendedCmPrefix, MIB 281
SIP Registration Timeout 225 arrisCmDoc30DhcpExtendedCmSubNetMask, MIB 281
Speedtest Results 231 arrisCmDoc30DhcpExtendedCmTimeOffset, MIB 280
Unit has been restored to factory defaults 231 arrisCmDoc30DhcpExtendedLeaseParametersType, MIB 279
all, DOCSIS Pp commands 591 arrisCmDoc30DhcpExtendedLeaseTimeRemaining, MIB 279
all_off, LED commands 506 arrisCmDoc30DhcpExtendedOfferedLeaseTime, MIB 279
all_on, LED commands 506 arrisCmDoc30DhcpExtendedPreferredMode, MIB 279
all_on_green, LED commands 506 arrisCmDoc30DhcpExtendedPrimaryDhcpServerIpAddr, MIB 280
AllComponentsConfig, Logger commands 608 arrisCmDoc30DhcpExtendedPrimaryTeleDhcpSvr, MIB 281
AllDebugModulesConfig, Logger commands 609 arrisCmDoc30DhcpExtendedProvisionedMode, MIB 279

Firmware Guide Release 7.5 Standard 1.2 August 2012

698 Chapter 12

arrisCmDoc30DhcpExtendedSecondaryTeleDhcpSvr, MIB 281 arrisCmDoc30SwTable, MIB 47–48, 50, 53

arrisCmDoc30DhcpExtendedState, MIB 280 arrisMtaCfgRTPDynPortEnd, MIB 190, 192, 293–294
arrisCmDoc30DhcpExtendedSvrParametersType, MIB 280 arrisMtaCfgRTPDynPortStart, MIB 190, 192, 293–294
arrisCmDoc30DhcpExtendedTftpSvrIpAddr, MIB 280 arrisMtaDevActiveConnections, MIB 289
arrisCmDoc30DhcpExtendedTimeSvrIpAddr, MIB 280 arrisMtaDevAutomaticCallResourceRecovery, MIB 297
arrisCmDoc30DhcpExtendedTimeUntilRebind, MIB 279 arrisMtaDevAutomaticOsiDelay, MIB 75, 296
arrisCmDoc30DhcpExtendedTimeUntilRenew, MIB 279 arrisMtaDevBase, MIB 240, 369
arrisCmDoc30DhcpLeaseParameters, MIB 277 arrisMtaDevBatteryChargerFWRev, MIB 302
arrisCmDoc30DhcpLeaseTimeRemaining, MIB 277 arrisMtaDevBatteryEprom, MIB 307
arrisCmDoc30DhcpMtaOpt60Override, MIB 279 arrisMtaDevBatteryLastStateChange, MIB 307
arrisCmDoc30DhcpMtaParameters, MIB 277 arrisMtaDevBatteryOperState, MIB 220, 306–307
arrisCmDoc30DhcpPrimaryDhcpServerIpAddr, MIB 278 arrisMtaDevBatteryOperSubState, MIB 307
arrisCmDoc30DhcpPrimaryTeleDhcpSvr, MIB 278 arrisMtaDevBatteryOrderingCode, MIB 307
arrisCmDoc30DhcpSecondaryTeleDhcpSvr, MIB 278 arrisMtaDevCallStatsAvgJitter, MIB 288, 367–368
arrisCmDoc30DhcpState, MIB 277 arrisMtaDevCallStatsAvgLatency, MIB 288, 368
arrisCmDoc30DhcpSvrParameters, MIB 277 arrisMtaDevCallStatsEndPntOpStatus, MIB 289, 368
arrisCmDoc30DhcpTftpSvrIpAddr, MIB 278 arrisMtaDevCallStatsEntry, MIB 365
arrisCmDoc30DhcpTimeSvrIpAddr, MIB 278 arrisMtaDevCallStatsHookStatus, MIB 288, 368
arrisCmDoc30DhcpTimeUntilRebind, MIB 277 arrisMtaDevCallStatsLineSubState, MIB 289
arrisCmDoc30DhcpTimeUntilRenew, MIB 277 arrisMtaDevCallStatsMaxJitter, MIB 288, 368
arrisCmDoc30FwImageBuildTime, MIB 271 arrisMtaDevCallStatsRtpPercentPktsLost, MIB 288, 368
arrisCmDoc30FwImageName, MIB 271 arrisMtaDevCallStatsRtpRxPkts, MIB 288, 368
arrisCmDoc30LastHwResetReason, MIB 281 arrisMtaDevCallStatsRtpTxPkts, MIB 288, 368
arrisCmDoc30MfgCertCommunityName, MIB 271 arrisMtaDevCallStatsSLICStatus, MIB 289, 368
arrisCmDoc30ProvisionedChannelIDs, MIB 267, 271 arrisMtaDevClearDHCPLog, MIB 297
arrisCmDoc30ResetAccessTime, MIB 271 arrisMtaDevClearMGCPLog, MIB 297
arrisCmDoc30ResetFactoryDefaults, MIB 271 arrisMtaDevControl, MIB 284, 365
arrisCmDoc30ResetReasonLogText, MIB 281 arrisMtaDevCustomJitterBufferEnabled, MIB 105, 107, 296
arrisCmDoc30RestoreFactoryDefaults, MIB 429 arrisMtaDevCustomMaxJitterBuffer, MIB 105, 107, 296
arrisCmDoc30SetupAdvancedWebPageAccess, MIB 275 arrisMtaDevCustomMinJitterBuffer, MIB 105, 107, 296
arrisCmDoc30SetupDhcpRetries, MIB 274 arrisMtaDevCustomNomJitterBuffer, MIB 105, 107, 296
arrisCmDoc30SetupDsBonding, MIB 56, 272 arrisMtaDevDefaultReasonNoCIDName, MIB 22, 295
arrisCmDoc30SetupDSTPolicy, MIB 21, 273 arrisMtaDevDhcpNoSvcImpact, MIB 229–230
arrisCmDoc30SetupEthernetLinkBounce, MIB 276 arrisMtaDevDhcpOptionOverride, MIB 40, 295
arrisCmDoc30SetupIgnoreMddSymbolClockIndicator, MIB 277 arrisMtaDevDhcpSubOpt3Immediate, MIB 32, 298
arrisCmDoc30SetupInvertMulticolorLEDs, MIB 66, 274 arrisMtaDevDiagLoopForeignEmfTest, MIB 302
arrisCmDoc30SetupKeepCpeOnIfDisconnect, MIB 276 arrisMtaDevDiagLoopHazardousPotentialTest, MIB 302
arrisCmDoc30SetupL2VPNPromiscuousMode, MIB 277 arrisMtaDevDiagLoopLastResult, MIB 301, 424
arrisCmDoc30SetupMddIpModeOverride, MIB 41–43, 274, 586 arrisMtaDevDiagLoopReceiverOffHookTest, MIB 302
arrisCmDoc30SetupMdfSupportOverride, MIB 275 arrisMtaDevDiagLoopRequest, MIB 301, 424
arrisCmDoc30SetupMultiColorLedBitmap, MIB 66, 272, 401, 403 arrisMtaDevDiagLoopResistiveFaultsTest, MIB 302
arrisCmDoc30SetupPacketCableRegion, MIB 58, 274 arrisMtaDevDiagLoopRingerTest, MIB 302
arrisCmDoc30SetupPacketProcessorEnable, MIB 272 arrisMtaDevDiagLoopTable, MIB 423, 425
arrisCmDoc30SetupPartServiceFallback20, MIB 268, 273 arrisMtaDevDiagLoopTime, MIB 301, 424
arrisCmDoc30SetupPowerSaveMode, MIB 269, 275 arrisMtaDevDocsQosParamUpSvcFlowSchedulingType, MIB 291
arrisCmDoc30SetupPowerSaveOption, MIB 269, 276 arrisMtaDevDocsQosParamUpSvcFlowSFID, MIB 290
arrisCmDoc30SetupPowerSaveWifiShutdownOnly, MIB 269, 276 arrisMtaDevDspCpsSetting, MIB 294, 642
arrisCmDoc30SetupReducedOORThreshold, MIB 275 arrisMtaDevDspHandleBellModemTone, MIB 297
arrisCmDoc30SetupSecDsLossReinitEnable, MIB 268, 273 arrisMtaDevDspHandleNonPhaseReversedTone, MIB 292
arrisCmDoc30SetupSWDLFilenameCheckOverride, MIB 50, 276 arrisMtaDevDTMFEndEventForceAscending, MIB 297
arrisCmDoc30SetupTCPAckSuppression, MIB 277 arrisMtaDevEchoCancellerTailLength, MIB 91, 292
arrisCmDoc30SetupTodDelaySecProv, MIB 274 arrisMtaDevEnableCallpSigTrace, MIB 240, 284, 687
arrisCmDoc30SetupTODSyncTimeout, MIB 276 arrisMtaDevEnableCallSigLastMsgRpt, MIB 236, 284–285, 287,
arrisCmDoc30SetupTODTimeOffset, MIB 20, 274 364, 367, 369
arrisCmDoc30SetupTurboDoxEnable, MIB 67, 275 arrisMtaDevEnableCallStatsSyslogRpt, MIB 284, 364, 369
arrisCmDoc30SetupUdcAllowed, MIB 274 arrisMtaDevEnableDHCPLog, MIB 235, 297
arrisCmDoc30SpeedtestConfigEndUserGui, MIB 454 arrisMtaDevEnableIndexTenEleven, MIB 84, 294
arrisCmDoc30SpeedtestConfigSyslogReports, MIB 231 arrisMtaDevEnableLogging, MIB 235
arrisCmDoc30SwAdminStatus, MIB 47, 50, 52–54, 228 arrisMtaDevEnableMGCPLog, MIB 235, 297
arrisCmDoc30SwCustomerLoadId, MIB 50, 53 arrisMtaDevEndPntCallWaitingRepeatSteady, MIB 299
arrisCmDoc30SwCvc1, MIB 54 arrisMtaDevEndPntCIDDateTimeEnable, MIB 299
arrisCmDoc30SwCvc2, MIB 54 arrisMtaDevEndPntCIDEnable, MIB 299
arrisCmDoc30SwCvc3, MIB 54 arrisMtaDevEndPntCIDNameEnable, MIB 299
arrisCmDoc30SwCvc4, MIB 54 arrisMtaDevEndPntDialingMethod, MIB 121–122, 181, 298
arrisCmDoc30SwCvcStatus, MIB 54 arrisMtaDevEndPntFaxOnlyLineTimeout, MIB 101–102, 188, 298
arrisCmDoc30SwFilename, MIB 48, 50, 53 arrisMtaDevEndPntGainControlRxVoice, MIB 116, 299
arrisCmDoc30SwHwModel, MIB 48, 50–51, 53 arrisMtaDevEndPntGainControlTxVoice, MIB 116, 299
arrisCmDoc30SwHwRev, MIB 48, 50, 53 arrisMtaDevEndPntLoopReversal, MIB 299
arrisCmDoc30SwOperStatus, MIB 50 arrisMtaDevEndPntRingingWaveform, MIB 68, 298
arrisCmDoc30SwServerAddress, MIB 48, 50, 53 arrisMtaDevEventFormat, MIB 289
arrisCmDoc30SwServerAddressType, MIB 48, 50, 53 arrisMtaDevEventHideFQDNandIPAddress, MIB 295

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 699

arrisMtaDevEventHideMacFQDNandIPAddress, MIB 217, 444 arrisMtaDevQosMode, MIB 289

arrisMtaDevGainControl, MIB 671 arrisMtaDevResetCallStats, MIB 284–288, 365–366
arrisMtaDevGainControlCAS, MIB 114–115, 300 arrisMtaDevRestoreNvmFactoryDefault, MIB 285
arrisMtaDevGainControlFSK, MIB 114–115, 300 arrisMtaDevRtcpTosValue, MIB 66, 296
arrisMtaDevGainControlLocalDTMF, MIB 115, 300 arrisMtaDevRtpPercentPktsLostTotal, MIB 284, 286, 365–366
arrisMtaDevGainControlLocalTone, MIB 115, 300 arrisMtaDevRtpPktsLostTotal, MIB 287, 366
arrisMtaDevGainControlNetworkDTMF, MIB 115, 300 arrisMtaDevRtpRxPktsTotal, MIB 284–285, 365–366
arrisMtaDevGainControlNetworkTone, MIB 115, 300 arrisMtaDevRtpTxPktsTotal, MIB 284–285, 365–366
arrisMtaDevGainControlRxVoice, MIB 115, 299–300 arrisMtaDevRTPTxQueueSize, MIB 292
arrisMtaDevGainControlTxVoice, MIB 115, 299–300 arrisMtaDevSignalingAvgLatency, MIB 284, 287, 365–366
arrisMtaDevInterfaceIndex, MIB 289 arrisMtaDevSignalingLastMsg1, MIB 234, 236, 285, 287, 367
arrisMtaDevLastCallEndTime, MIB 288, 366 arrisMtaDevSignalingLastMsg16, MIB 234, 236, 285, 367
arrisMtaDevLastCallStartTime, MIB 288, 366 arrisMtaDevSignalingRxNAKCnt, MIB 284, 287, 366–367
arrisMtaDevLevelControlCAS, MIB 301 arrisMtaDevSignalingRxNoACKCnt, MIB 284, 287, 366–367
arrisMtaDevLevelControlFSK, MIB 301 arrisMtaDevSignalingRxSuccessfulMsgCnt, MIB 284, 287,
arrisMtaDevLevelControlOffHookCAS, MIB 114–115, 301 365–366
arrisMtaDevLevelControlOffHookEnable, MIB 114–115, 301 arrisMtaDevSignalingTxNAKCnt, MIB 284, 287, 366–367
arrisMtaDevLevelControlOffHookFSK, MIB 114–115, 301 arrisMtaDevSignalingTxSuccessfulMsgCnt, MIB 284, 287,
arrisMtaDevLineCardState, MIB 75 365–366
arrisMtaDevLineMWIActive, MIB 290 arrisMtaDevSipConfigFileURL, MIB 147, 295
arrisMTADevLineRTCPXR, MIB 290 arrisMtaDevSipDwnldConfig, MIB 147, 295
arrisMtaDevLineRTCPXR, MIB 290 arrisMtaDevSpecialConfigurationOverrideEnable, MIB 296
arrisMtaDevLineRTCPXRNegotiatedConnectionA, MIB 290 arrisMtaDevSuperG3FaxRelay, MIB 104, 297, 689
arrisMtaDevLineRTCPXRNegotiatedConnectionB, MIB 290 arrisMtaDevSwDnldNoSvcImpact, MIB 48, 229, 284–285
arrisMtaDevMaxCallPServiceFlows, MIB 298 arrisMtaDevSWUpgradeStatus, MIB 286
arrisMtaDevMaxCpeAllowed, MIB 289 arrisMtaDevT38Timeout, MIB 101, 104, 297
arrisMtaDevNetworkAccess, MIB 289 arrisMtaDevTDDReportToCMS, MIB 297
arrisMtaDevNsadSwDnldStatus, MIB 285 arrisMtaDevTFTPServerAddrOverrideFQDN, MIB 293, 295
arrisMtaDevOffHookFskDelay, MIB 22, 297 arrisMtaDevTrace, MIB 365
arrisMtaDevPacketcableProvisioningFlow, MIB 293–294 arrisMtaDevVbdOverwriteLineBitmap, MIB 105–106, 294–295
arrisMtaDevPersistentLineStatus, MIB 65, 299 arrisMtaDevVbdOverwriteMaxJitterBuffer, MIB 105–106, 295
arrisMtaDevPktcDevEvEndpointName, MIB 289 arrisMtaDevVbdOverwriteMinJitterBuffer, MIB 105–106, 294
arrisMtaDevProvMethodIndicator, MIB 37, 292 arrisMtaDevVbdOverwriteNomJitterBuffer, MIB 105–106, 295
arrisMtaDevProvState, MIB 286 arrisMtaDevVPJitterBufferMode, MIB 105–106, 292
arrisMtaDevPwrSupplyAlarm, MIB 302 arrisMtaDevVPMaxJitterBuffer, MIB 105–106, 294, 296
arrisMtaDevPwrSupplyBase, MIB 302 arrisMtaDevVPNomJitterBuffer, MIB 105–106, 292, 296
arrisMtaDevPwrSupplyBatAvailableMinutes, MIB 304, 306 arrisMtaDevVqm, MIB 378
arrisMtaDevPwrSupplyBatAvailableMinutes2, MIB 306 arrisMtaDevVqmCallNumberIdentifier, MIB 291, 379, 381–382
arrisMtaDevPwrSupplyBatRatedMinutes, MIB 306 arrisMtaDevVqmCallNumberIdentifierLastCall, MIB 292, 379,
arrisMtaDevPwrSupplyBatRatedMinutes2, MIB 306 381
arrisMtaDevPwrSupplyBatStateOfCharge, MIB 306 arrisMtaDevVqmCallNumberIds, MIB 291, 378–379
arrisMtaDevPwrSupplyBatteryTest, MIB 303 arrisMtaDevVqmCallNumberTable, MIB 291, 378, 381
arrisMtaDevPwrSupplyBatteryTestTime, MIB 305 arrisMtaDevVqmClear, MIB 291, 387
arrisMtaDevPwrSupplyChargeState, MIB 303, 305 arrisMtaDevVqmEnable, MIB 291, 380
arrisMtaDevPwrSupplyConfigReplaceBatTime, MIB 304 arrisMtaDevVqmEnableRemote, MIB 290–291, 379–380
arrisMtaDevPwrSupplyConfigReplaceBatTime2, MIB 304 arrisMtaDevVqmHistorySize, MIB 292, 379–380
arrisMtaDevPwrSupplyConfigRunTime, MIB 304 arrisMtaDevVqmLine, MIB 291, 378, 381, 387
arrisMtaDevPwrSupplyControl, MIB 302 arrisMtaDevVqmMetricIndex, MIB 292
arrisMtaDevPwrSupplyControlChargerReset, MIB 305 arrisMtaDevVqmMetricTable, MIB 291, 379, 381–382
arrisMtaDevPwrSupplyDataShutdownTime, MIB 206, 269, 305 arrisMtaDevVqmMetricValues, MIB 379
arrisMtaDevPwrSupplyEnableDataShutdown, MIB 206, 269, 303 arrisMtaDevVqmThresholdEnable, MIB 291, 379, 387
arrisMtaDevPwrSupplyFullChargeTime, MIB 305 arrisMtaDevVqmThresholds, MIB 371, 379, 387
arrisMtaDevPwrSupplyHighestTemperature, MIB 207, 305 arrisMtaDoc30AdjustCallpFeatureSwitch, MIB 23
arrisMtaDevPwrSupplyHighestTemperatureClear, MIB 207, 305 arrisMtaDoc30DhcpOfferedLeaseTime, MIB 277
arrisMtaDevPwrSupplyHighestTemperatureTime, MIB 207, 305 arrisRouterAdminPassword, MIB 349
arrisMtaDevPwrSupplyHiTempBatteryShutdownControl, MIB 304 arrisRouterAdminTimeout, MIB 349
arrisMtaDevPwrSupplyLowBatteryThresh, MIB 220, 303 arrisRouterApplyAllSettings, MIB 128
arrisMtaDevPwrSupplyOverTempAlarmControl, MIB 207, arrisRouterAuthPassword, MIB 353
304–305 arrisRouterAuthType, MIB 353
arrisMtaDevPwrSupplyOverTempAlarmThreshold, MIB 304 arrisRouterAuthUserName, MIB 353
arrisMtaDevPwrSupplyRatedBatCapacity, MIB 305 arrisRouterBlackListClear, MIB 345
arrisMtaDevPwrSupplyReadBatteryPwr, MIB 306 arrisRouterBlackListCount, MIB 345
arrisMtaDevPwrSupplyReplaceBatThresh, MIB 303 arrisRouterBlackListDomain, MIB 346
arrisMtaDevPwrSupplySecondsOnBattery, MIB 306 arrisRouterBlackListFreeIdx, MIB 345
arrisMtaDevPwrSupplySecondsOnBattery2, MIB 306 arrisRouterBlackListStatus, MIB 347
arrisMtaDevPwrSupplyStats, MIB 302 arrisRouterBlackListTable, MIB 345
arrisMtaDevPwrSupplyTelemetryValues, MIB 306 arrisRouterBlackListTOD, MIB 346
arrisMtaDevPwrSupplyTemperature, MIB 304 arrisRouterBootCodeVersion, MIB 349
arrisMtaDevPwrSupplyTestedBatCapacity, MIB 306 arrisRouterBssAccessMode, MIB 329, 332
arrisMtaDevPwrSupplyTimers, MIB 302 arrisRouterBssActive, MIB 329
arrisMtaDevPwrSupplyTypicalIdlePwr, MIB 303 arrisRouterBssID, MIB 329

Firmware Guide Release 7.5 Standard 1.2 August 2012

700 Chapter 12

arrisRouterBssMACAccessClear, MIB 330 arrisRouterFWIPFilterPortEnd, MIB 341

arrisRouterBssMACAccessCount, MIB 330 arrisRouterFWIPFilterPortStart, MIB 341
arrisRouterBssNetworkIsolate, MIB 330 arrisRouterFWIPFilterProtoType, MIB 341
arrisRouterBssSecurityMode, MIB 329 arrisRouterFWIPFilterRowStatus, MIB 342
arrisRouterBssSSID, MIB 329 arrisRouterFWIPFilterStartAddr, MIB 341
arrisRouterBssSSIDBroadcast, MIB 329 arrisRouterFWIPFilterStartType, MIB 341
arrisRouterChangeLogInfo, MIB 352 arrisRouterFWIPFilterTOD, MIB 341
arrisRouterChangeLogTable, MIB 352 arrisRouterFWIPFloodDetect, MIB 343
arrisRouterChangeLogTime, MIB 352 arrisRouterFWIPSecPassThru, MIB 344
arrisRouterClearMSOLogs, MIB 352 arrisRouterFWL2TPPassThru, MIB 344
arrisRouterCurrentTime, MIB 350 arrisRouterFWLogInfo, MIB 352
arrisRouterCustomID, MIB 350 arrisRouterFWLogTime, MIB 352
arrisRouterCustomSettings, MIB 349 arrisRouterFWMACFilterAddr, MIB 342
arrisRouterDebugLogInfo, MIB 352 arrisRouterFWMACFilterHostName, MIB 342
arrisRouterDebugLogTable, MIB 352 arrisRouterFWMACFilterRowStatus, MIB 342
arrisRouterDebugLogTime, MIB 352 arrisRouterFWMACFilterTable, MIB 340
arrisRouterDefaults, MIB 349 arrisRouterFWMACFilterTOD, MIB 342
arrisRouterDeviceUpDownEnd, MIB 320 arrisRouterFWPortScanProtect, MIB 343
arrisRouterDeviceUpDownIPAddr, MIB 319 arrisRouterFWPortTargPortEnd, MIB 343
arrisRouterDeviceUpDownIPType, MIB 319 arrisRouterFWPortTargPortStart, MIB 343
arrisRouterDeviceUpDownStart, MIB 319 arrisRouterFWPortTrigDesc, MIB 342
arrisRouterDeviceUpDownStatus, MIB 320 arrisRouterFWPortTrigPortEnd, MIB 343
arrisRouterDSLiteWanEnable, MIB 129, 312 arrisRouterFWPortTrigPortStart, MIB 343
arrisRouterDSLiteWanLSNATAddr, MIB 130, 312 arrisRouterFWPortTrigProtoType, MIB 343
arrisRouterDSLiteWanLSNATAddrType, MIB 130, 312 arrisRouterFWPortTrigRowStatus, MIB 343
arrisRouterEmailAddress, MIB 351 arrisRouterFWPortTrigTableEnabled, MIB 340
arrisRouterEmailApplySettings, MIB 351 arrisRouterFWPPTPPassThru, MIB 344
arrisRouterEmailServerName, MIB 351 arrisRouterFWResetDefaults, MIB 339
arrisRouterEmailServerPW, MIB 351 arrisRouterFWSecurityLevel, MIB 339
arrisRouterEmailServerUser, MIB 351 arrisRouterFWVirtSrvDesc, MIB 340
arrisRouterEnableLogEmail, MIB 351 arrisRouterFWVirtSrvIPAddr, MIB 340
arrisRouterEnableParentalCont, MIB 345 arrisRouterFWVirtSrvIPAddrType, MIB 340
arrisRouterEnableSNTP, MIB 350 arrisRouterFWVirtSrvLocalPortEnd, MIB 341
arrisRouterFirewallLogTable, MIB 352 arrisRouterFWVirtSrvLocalPortStart, MIB 341
arrisRouterFirmwareVersion, MIB 349 arrisRouterFWVirtSrvPortEnd, MIB 340
arrisRouterFWAllowAll, MIB 340 arrisRouterFWVirtSrvPortStart, MIB 340
arrisRouterFWAllowICMP, MIB 339 arrisRouterFWVirtSrvProtoType, MIB 340
arrisRouterFWApplySettings, MIB 339 arrisRouterFWVirtSrvRowStatus, MIB 341
arrisRouterFWBlockFragIPPkts, MIB 343 arrisRouterFWVirtSrvTableEnabled, MIB 340
arrisRouterFWBlockHTTP, MIB 339 arrisRouterFWVirtSrvTOD, MIB 340
arrisRouterFWBlockICMP, MIB 339 arrisRouterFWVSSrcPortExclude, MIB 340
arrisRouterFWBlockIdent, MIB 339 arrisRouterHardwareVersion, MIB 349
arrisRouterFWBlockMulticast, MIB 340 arrisRouterHostAccess, MIB 308
arrisRouterFWBlockP2P, MIB 339 arrisRouterInboundTrafficLogData, MIB 353
arrisRouterFWCfg, MIB 308 arrisRouterKeywordBlkStatus, MIB 346
arrisRouterFWDDNSDomainName, MIB 344 arrisRouterKeywordBlkTable, MIB 345
arrisRouterFWDDNSEnable, MIB 343 arrisRouterKeywordBlkTOD, MIB 346
arrisRouterFWDDNSIPAddr, MIB 344 arrisRouterKeywordBlkWord, MIB 346
arrisRouterFWDDNSIPAddrType, MIB 344 arrisRouterKeywordClear, MIB 345
arrisRouterFWDDNSPassword, MIB 344 arrisRouterKeywordCount, MIB 345
arrisRouterFWDDNSStatus, MIB 344 arrisRouterKeywordTableFreeIdx, MIB 345
arrisRouterFWDDNSType, MIB 344 arrisRouterLanClientAdapterType, MIB 318
arrisRouterFWDDNSUserHame, MIB 344 arrisRouterLanClientComment, MIB 319
arrisRouterFWEnabled, MIB 338 arrisRouterLanClientCount, MIB 318
arrisRouterFWEnableDMZ, MIB 338 arrisRouterLanClientCustom, MIB 319
arrisRouterFWEnableMulticast, MIB 344 arrisRouterLanClientCustomTable, MIB 318
arrisRouterFWEnableRemoteMgmt, MIB 344 arrisRouterLanClientHostName, MIB 318
arrisRouterFWEnableRGPassThru, MIB 344 arrisRouterLanClientInfLease, MIB 319
arrisRouterFWEnableWanBlocking, MIB 344 arrisRouterLanClientIPAddr, MIB 318
arrisRouterFWEnableWanSNMP, MIB 344 arrisRouterLanClientIPAddrType, MIB 318
arrisRouterFWEnableWanSSH, MIB 345 arrisRouterLanClientLeaseEnd, MIB 319
arrisRouterFWFilterActiveX, MIB 343 arrisRouterLanClientLeaseStart, MIB 319
arrisRouterFWFilterCookies, MIB 343 arrisRouterLanClientLeaseState, MIB 319
arrisRouterFWFilterJavaApplets, MIB 343 arrisRouterLanClientMAC, MIB 318
arrisRouterFWFilterPopupWnds, MIB 343 arrisRouterLanClientMACMfg, MIB 318
arrisRouterFWFilterProxy, MIB 343 arrisRouterLanClientOnline, MIB 319
arrisRouterFWIPAddrDMZ, MIB 338 arrisRouterLanClientRowStatus, MIB 319
arrisRouterFWIPAddrTypeDMZ, MIB 338 arrisRouterLanClientStatus, MIB 319
arrisRouterFWIPFilterDesc, MIB 341 arrisRouterLanClientType, MIB 318–319
arrisRouterFWIPFilterEndAddr, MIB 341 arrisRouterLanConfig, MIB 308
arrisRouterFWIPFilterEndType, MIB 341 arrisRouterLanCPEAging, MIB 315

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 701

arrisRouterLanCurrentClientAdapterType, MIB 321 arrisRouterLanStaticClientRowStatus, MIB 323

arrisRouterLanCurrentClientConnectionInfo, MIB 322 arrisRouterLanStaticClientTable, MIB 320–321
arrisRouterLanCurrentClientFirstSeen, MIB 322 arrisRouterLanSubnetMask, MIB 313
arrisRouterLanCurrentClientHostName, MIB 321 arrisRouterLanSubnetMaskType, MIB 313
arrisRouterLanCurrentClientInfLease, MIB 322 arrisRouterLanTable, MIB 313
arrisRouterLanCurrentClientIPAddr, MIB 321 arrisRouterLanUPnPEnable, MIB 315
arrisRouterLanCurrentClientIPAddrTextual, MIB 321 arrisRouterLanUpRateLimit, MIB 314
arrisRouterLanCurrentClientIPAddrType, MIB 321 arrisRouterLanUseDHCP, MIB 314
arrisRouterLanCurrentClientLastSeen, MIB 322 arrisRouterLanUseDHCPV6, MIB 129, 316
arrisRouterLanCurrentClientLeaseEnd, MIB 321 arrisRouterLanVLanID, MIB 314
arrisRouterLanCurrentClientLeaseStart, MIB 321–322 arrisRouterLogLevel, MIB 349
arrisRouterLanCurrentClientLeaseState, MIB 322 arrisRouterMACAccessAddr, MIB 332
arrisRouterLanCurrentClientLeaseTime, MIB 322 arrisRouterMACAccessStatus, MIB 332
arrisRouterLanCurrentClientMAC, MIB 321 arrisRouterMACAccessTable, MIB 329–330
arrisRouterLanCurrentClientMACMfg, MIB 321 arrisRouterManagedDevicesEnabled, MIB 346
arrisRouterLanCurrentClientStatus, MIB 321 arrisRouterManagedServicesEnabled, MIB 346
arrisRouterLanCurrentClientTable, MIB 318 arrisRouterManagedSitesEnabled, MIB 346
arrisRouterLanCurrentClientType, MIB 321–322 arrisRouterMib, MIB 131, 363
arrisRouterLanCustomComments, MIB 320 arrisRouterMSOChgLogInfo, MIB 352
arrisRouterLanCustomCount, MIB 318 arrisRouterMSOChgLogTable, MIB 352
arrisRouterLanCustomFriendName, MIB 320 arrisRouterMSOChgLogTime, MIB 352
arrisRouterLanCustomHostName, MIB 320 arrisRouterName, MIB 349
arrisRouterLanCustomIPAddr, MIB 320 arrisRouterParentalContLogTable, MIB 352
arrisRouterLanCustomIPAddrType, MIB 320 arrisRouterPCLogInfo, MIB 352
arrisRouterLanCustomMAC, MIB 320 arrisRouterPCLogTime, MIB 352
arrisRouterLanCustomMACMfg, MIB 320 arrisRouterPingIcmpErrors, MIB 355
arrisRouterLanCustomRowStatus, MIB 320 arrisRouterPingInterval, MIB 354
arrisRouterLanDNSIPAddr, MIB 317 arrisRouterPingIpStackNumber, MIB 354
arrisRouterLanDNSIPAddrType, MIB 317 arrisRouterPingLastIcmpError, MIB 355
arrisRouterLanDNSOverrideV6, MIB 129, 317 arrisRouterPingMgmt, MIB 308
arrisRouterLanDNSRelayV6, MIB 129, 317 arrisRouterPingNumPkts, MIB 354
arrisRouterLanDNSRowStatus, MIB 317 arrisRouterPingOctetsReceived, MIB 355
arrisRouterLanDNSTable, MIB 128–129, 315, 317 arrisRouterPingOctetsSent, MIB 355
arrisRouterLanDomainName, MIB 314 arrisRouterPingPktSize, MIB 354
arrisRouterLanDownRateLimit, MIB 314 arrisRouterPingPktsSent, MIB 355
arrisRouterLanEndDHCP, MIB 314 arrisRouterPingRepliesReceived, MIB 355
arrisRouterLanEndDHCPType, MIB 314 arrisRouterPingRepliesVerified, MIB 355
arrisRouterLanEndDHCPV6, MIB 129, 316 arrisRouterPingStartStop, MIB 355
arrisRouterLanEnvironmentControl, MIB 316 arrisRouterPingTargetAddress, MIB 354
arrisRouterLanEtherPortAuto, MIB 318 arrisRouterPingTargetAddrType, MIB 353
arrisRouterLanEtherPortDuplex, MIB 317–318 arrisRouterPingTimeout, MIB 354
arrisRouterLanEtherPortEnabled, MIB 317 arrisRouterPingVerifyReply, MIB 354
arrisRouterLanEtherPortIFIndex, MIB 317 arrisRouterRadiusAddress, MIB 332
arrisRouterLanEtherPortSpeed, MIB 317–318 arrisRouterRadiusAddressType, MIB 332
arrisRouterLanFirewallOn, MIB 315 arrisRouterRadiusKey, MIB 332
arrisRouterLanGatewayIp, MIB 313 arrisRouterRadiusPort, MIB 332
arrisRouterLanGatewayIp2, MIB 314 arrisRouterRadiusReAuthInterval, MIB 332
arrisRouterLanGatewayIp2Type, MIB 314 arrisRouterReboot, MIB 349
arrisRouterLanGatewayIpType, MIB 313 arrisRouterRIPAuthEnable, MIB 323
arrisRouterLanguage, MIB 349 arrisRouterRIPAuthKeyChain, MIB 323
arrisRouterLanIPv6Mode, MIB 314 arrisRouterRIPAuthKeyID, MIB 323
arrisRouterLanLeaseTime, MIB 314 arrisRouterRIPAuthKeyString, MIB 323
arrisRouterLanLeaseTimeV6, MIB 129, 317 arrisRouterRIPEnable, MIB 323
arrisRouterLanLinkLocalAddressV6, MIB 317 arrisRouterRIPIPAddr, MIB 323
arrisRouterLanMappedInterface, MIB 316 arrisRouterRIPIPAddrType, MIB 323
arrisRouterLanName, MIB 313 arrisRouterRIPPrefixLen, MIB 323–325
arrisRouterLanNatAlgsEnabled, MIB 315 arrisRouterRIPReportTime, MIB 323
arrisRouterLanOverrideDNS, MIB 128, 315 arrisRouterRIPRoutedNetIP, MIB 323–325
arrisRouterLanPassThru, MIB 128, 314 arrisRouterRIPRoutedSubnetDHCP, MIB 324
arrisRouterLanPrefixLengthV6, MIB 129, 316 arrisRouterRIPRoutedSubnetEnabled, MIB 324
arrisRouterLanRateLimit, MIB 314 arrisRouterRIPRoutedSubnetGWNetIP, MIB 324
arrisRouterLanRelayDNS, MIB 128, 314 arrisRouterRIPRoutedSubnetGWNetIPType, MIB 324
arrisRouterLanSettings, MIB 313 arrisRouterRIPRoutedSubnetIP, MIB 323
arrisRouterLanSrvTable, MIB 313 arrisRouterRIPRoutedSubnetIPType, MIB 323
arrisRouterLanStartDHCP, MIB 314 arrisRouterRIPRoutedSubnetMask, MIB 324
arrisRouterLanStartDHCPType, MIB 314 arrisRouterRIPRoutedSubnetNAT, MIB 324
arrisRouterLanStartDHCPV6, MIB 129, 316 arrisRouterRIPRoutedSubnetTableDHCP, MIB 325
arrisRouterLanStaticClientHostName, MIB 322 arrisRouterRIPRoutedSubnetTableEnabled, MIB 325
arrisRouterLanStaticClientIPAddr, MIB 322 arrisRouterRIPRoutedSubnetTableGWNetIP, MIB 325
arrisRouterLanStaticClientIPAddrType, MIB 322 arrisRouterRIPRoutedSubnetTableGWNetIPType, MIB 325
arrisRouterLanStaticClientMAC, MIB 323 arrisRouterRIPRoutedSubnetTableIP, MIB 324

Firmware Guide Release 7.5 Standard 1.2 August 2012

702 Chapter 12

arrisRouterRIPRoutedSubnetTableIPType, MIB 324 arrisRouterWanPassword, MIB 310

arrisRouterRIPRoutedSubnetTableMask, MIB 325 arrisRouterWanReleaseLease, MIB 312
arrisRouterRIPRoutedSubnetTableNAT, MIB 325 arrisRouterWanReleaseLeaseV6, MIB 312
arrisRouterRIPSendCMInterface, MIB 324 arrisRouterWanRenewLease, MIB 312
arrisRouterRIPSubnetGWNetIP, MIB 324–325 arrisRouterWanRenewLeaseV6, MIB 312
arrisRouterRIPSubnetMask, MIB 323 arrisRouterWanStaticDNSFreeIdx, MIB 311
arrisRouterRIPTableSendCMInterface, MIB 325 arrisRouterWanStaticDNSIPAddr, MIB 311
arrisRouterSerialNumber, MIB 349 arrisRouterWanStaticDNSIPAddrType, MIB 311
arrisRouterSNTPServerAddr, MIB 351 arrisRouterWanStaticDNSRowStatus, MIB 311
arrisRouterSNTPServerAddrType, MIB 351 arrisRouterWanStaticDNSTable, MIB 311
arrisRouterSNTPServerName, MIB 351 arrisRouterWanStaticFreeIdx, MIB 308
arrisRouterSNTPServerStatus, MIB 351 arrisRouterWanStaticGateway, MIB 310
arrisRouterSysCfg, MIB 308 arrisRouterWanStaticGatewayType, MIB 310
arrisRouterTACACSAddr, MIB 350, 399, 436, 440 arrisRouterWanStaticIPAddr, MIB 310
arrisRouterTACACSPort, MIB 350, 399, 436, 440 arrisRouterWanStaticIPAddrType, MIB 310
arrisRouterTACACSSecretKey, MIB 350 arrisRouterWanStaticPrefix, MIB 310
arrisRouterTACACSServerKey, MIB 399, 437, 440 arrisRouterWanStaticRowStatus, MIB 310
arrisRouterTraceRtBasePort, MIB 356 arrisRouterWanStaticTable, MIB 308
arrisRouterTraceRtDataSize, MIB 355 arrisRouterWanTunnelAddr, MIB 310–311
arrisRouterTraceRtLog, MIB 356 arrisRouterWanTunnelAddrType, MIB 310
arrisRouterTraceRtMaxHops, MIB 355 arrisRouterWanTunnelHostName, MIB 310–311
arrisRouterTraceRtMgmt, MIB 308 arrisRouterWanUseAutoDNS, MIB 311
arrisRouterTraceRtResolveHosts, MIB 355 arrisRouterWanUserName, MIB 310
arrisRouterTraceRtStart, MIB 356 arrisRouterWebAccessLevel, MIB 353
arrisRouterTraceRtTargAddrType, MIB 355 arrisRouterWebAccessPage, MIB 353
arrisRouterTraceRtTargetAddr, MIB 355 arrisRouterWebAccessRowStatus, MIB 353
arrisRouterTrustedDeviceAddr, MIB 348 arrisRouterWEP128BitKeyStatus, MIB 331
arrisRouterTrustedDeviceAddrType, MIB 348 arrisRouterWEP128BitKeyTable, MIB 330
arrisRouterTrustedDeviceClear, MIB 345 arrisRouterWEP128BitKeyValue, MIB 331
arrisRouterTrustedDeviceCount, MIB 345 arrisRouterWEP64BitKeyStatus, MIB 330
arrisRouterTrustedDeviceFreeIdx, MIB 345 arrisRouterWEP64BitKeyTable, MIB 330
arrisRouterTrustedDeviceMAC, MIB 348 arrisRouterWEP64BitKeyValue, MIB 330–331
arrisRouterTrustedDeviceManagedServicesAddr, MIB 349 arrisRouterWEPCurrentKey, MIB 330
arrisRouterTrustedDeviceManagedServicesAddrType, MIB 348 arrisRouterWEPDefaultKey, MIB 331
arrisRouterTrustedDeviceManagedServicesMAC, MIB 348 arrisRouterWEPEncryptionMode, MIB 330–331
arrisRouterTrustedDeviceManagedServicesName, MIB 348 arrisRouterWEPPassPhrase, MIB 330
arrisRouterTrustedDeviceManagedServicesStatus, MIB 348 arrisRouterWhiteListClear, MIB 345
arrisRouterTrustedDeviceName, MIB 348 arrisRouterWhiteListCount, MIB 345
arrisRouterTrustedDeviceStatus, MIB 348 arrisRouterWhiteListDomain, MIB 347
arrisRouterTrustedDeviceTable, MIB 345 arrisRouterWhiteListFreeIdx, MIB 345
arrisRouterWanConfig, MIB 308 arrisRouterWhiteListStatus, MIB 347
arrisRouterWanConnDomainName, MIB 308 arrisRouterWhiteListTable, MIB 345
arrisRouterWanConnHostName, MIB 308 arrisRouterWhiteListTOD, MIB 347
arrisRouterWanConnType, MIB 308 arrisRouterWiFi80211NBand, MIB 336
arrisRouterWanConnTypeV6, MIB 308 arrisRouterWiFi80211NSideBand, MIB 337
arrisRouterWanCurrentDNSIPAddr, MIB 311 arrisRouterWiFiAllow40MHzOnlyOperation, MIB 338
arrisRouterWanCurrentDNSIPAddrType, MIB 311 arrisRouterWiFiAMSDUEnable, MIB 338
arrisRouterWanCurrentGW, MIB 309 arrisRouterWiFiBasicRateSet, MIB 327
arrisRouterWanCurrentGWType, MIB 309 arrisRouterWiFiBeaconInterval, MIB 326
arrisRouterWanCurrentIPAddr, MIB 309 arrisRouterWiFiBGProtect, MIB 326
arrisRouterWanCurrentIPAddrType, MIB 309 arrisRouterWiFiBlockAck, MIB 338
arrisRouterWanCurrentIPType, MIB 309 arrisRouterWiFiChannel, MIB 128, 325
arrisRouterWanCurrentNetMask, MIB 309 arrisRouterWiFiChannelBW, MIB 337
arrisRouterWanCurrentPreferredLifetimeV6, MIB 309 arrisRouterWiFiCountry, MIB 325
arrisRouterWanCurrentPrefix, MIB 309 arrisRouterWiFiCustomSSIDStr, MIB 328
arrisRouterWanCurrentPrefixDelegationV6, MIB 309 arrisRouterWiFiDeclinePeerBA, MIB 338
arrisRouterWanCurrentPrefixDelegationV6Len, MIB 309 arrisRouterWiFiDTIMInterval, MIB 326
arrisRouterWanCurrentValidLifetimeV6, MIB 309 arrisRouterWiFiEnableRadio, MIB 128, 327
arrisRouterWanDelegatedPrefix, MIB 310 arrisRouterWiFiEnableRadioNow, MIB 328
arrisRouterWanDelegatedPrefixLength, MIB 310 arrisRouterWiFiFragmentThresh, MIB 326
arrisRouterWanDHCPDuration, MIB 312 arrisRouterWiFiFrameBurst, MIB 327
arrisRouterWanDHCPDurationV6, MIB 312 arrisRouterWiFiGuardInterval, MIB 336–337
arrisRouterWanDHCPExpire, MIB 312 arrisRouterWiFiHTMCS, MIB 336
arrisRouterWanDHCPExpireV6, MIB 312 arrisRouterWiFiHTMode, MIB 337
arrisRouterWanEnableIdleTimeout, MIB 310 arrisRouterWiFiLongRetryLimit, MIB 327
arrisRouterWanEnableKeepAlive, MIB 311 arrisRouterWiFiMode, MIB 326
arrisRouterWanIdleTimeout, MIB 310 arrisRouterWiFiMulticastA, MIB 327
arrisRouterWanIFMacAddr, MIB 308 arrisRouterWiFiMulticastBG, MIB 327
arrisRouterWanIPProvMode, MIB 308 arrisRouterWiFiNProtection, MIB 338
arrisRouterWanKeepAliveTimeout, MIB 311 arrisRouterWiFiOutputPower, MIB 327
arrisRouterWanMTUSize, MIB 308 arrisRouterWiFiRadioControlMode, MIB 328

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 703

arrisRouterWiFiResetDefaults, MIB 328 battery

arrisRouterWiFiRTSThreshold, MIB 326 boot from 206
arrisRouterWiFiSecurityMode, MIB 330–331 charger, display status 512
arrisRouterWiFiShortRetryLimit, MIB 327 mismatch 445
arrisRouterWiFiShortSlot, MIB 326 E-UE 220
arrisRouterWiFiShortSlotEnhanced, MIB 327 telemetry 206
arrisRouterWiFiTxPower, MIB 327 verify EPROM checksums 514
arrisRouterWiFiTxPreamble, MIB 326 behavior, DHCP IPv6 43
arrisRouterWiFiTxRate, MIB 328 berstatus, DOCSIS Debug commands 583
arrisRouterWirelessCfg, MIB 308, 313 bonding, channel 56
arrisRouterWMMAPSD, MIB 333 boost mode 68
arrisRouterWMMEDCAAPAdmitCont, MIB 334 boot from battery 206
arrisRouterWMMEDCAAPAIFSN, MIB 334 BootROM image version 360
arrisRouterWMMEDCAAPCWmax, MIB 333 bracketed IP address feature switch 75
arrisRouterWMMEDCAAPCWmin, MIB 333 brief, System PP commands 556
arrisRouterWMMEDCAAPDiscardOld, MIB 334 buf_store, Voice CallP commands 686
arrisRouterWMMEDCAAPTxOpAGLimit, MIB 334 buffer
arrisRouterWMMEDCAAPTxOpBLimit, MIB 334 custom jitter 107
arrisRouterWMMEDCASTAAIFSN, MIB 335 override, jitter 643
arrisRouterWMMEDCASTACWmax, MIB 334 provisioning jitter 105
arrisRouterWMMEDCASTACWmin, MIB 334 signaling 686
arrisRouterWMMEDCASTATxAGLimit, MIB 335 System sub-mode commands 504
arrisRouterWMMEDCASTATxOpBLimit, MIB 335 buffers, adaptive jitter 90
arrisRouterWMMEnable, MIB 333 busy
arrisRouterWMMNoAck, MIB 333 indication dialing, SIP 200
arrisRouterWPAAlgorithm, MIB 331 tone, SIP local 85
arrisRouterWPAGroupRekeyInterval, MIB 331 bye delay 151
arrisRouterWPAPreAuthEnable, MIB 332 bypass
arrisRouterWPAPreSharedKey, MIB 331 feature switch, MTA maxCpeAllowed 84
arrisRouterWPAReAuthInterval, MIB 332 hash checking feature switch 84
arrisRouterWpsBoardNum, MIB 336 KDC load balancer checks feature switch 84
arrisRouterWpsConfigState, MIB 335 SNMP INFORM checks feature switch 84
arrisRouterWpsConfigTimeout, MIB 336 byte, RTCP ToS 66
arrisRouterWpsDeviceName, MIB 335 byteget, Database commands 516
arrisRouterWpsDevicePIN, MIB 335
arrisRouterWpsMfg, MIB 335
arrisRouterWpsMode, MIB 335
C
arrisRouterWpsModelName, MIB 335 cable modem status screen 440
arrisRouterWpsModelNum, MIB 336 cache, RF commands 521
arrisRouterWpsPushButton, MIB 336 cadence, ring 685
arrisRouterWpsResultStatus, MIB 335 cadences
arrisRouterWpsSTAPin, MIB 336 displaying ring 688
arrisRouterWpsStatus, MIB 335 provisioning ring 465
arrisRouterWpsUUID, MIB 336 cal_dump, Voice Linecard commands commands 665
arrisRouterXmlProvisioningFile, MIB 131, 350 Call Management Server 25
arrisRouterXmlProvisioningStatus, MIB 131–132, 350 call
arrisSipMib, MIB 149 anonymous 188, 196
arrisSpeedTestConfigCpeAccess, MIB 357 rejection handling, SIP 85
arrisSpeedTestConfigDownlinkURL, MIB 357, 392 Call
arrisSpeedTestConfigEndUserGui, MIB 357 screen 450
arrisSpeedTestConfigStartStopTest, MIB 358, 393 disabling 188, 196
arrisSpeedTestConfigSyslogReports, MIB 357–358 Caller
arrisSpeedTestConfigUplinkURL, MIB 357, 393 feature switch, non-sequential 75
arrisSpeedTestMib, MIB 357 outbound method 188, 196
arrisSpeedTestResultsStatus, MIB 358, 393 support 22
arrisTR69EnableCWMP, MIB 133 caller ID test 685
arrisTR69PersistEnable, MIB 133 CallP
atp, DOCSIS Qos commands 576 commands, auto_osi, Voice 689
Atp, Main DOCSIS commands 565 commands, buf_store, Voice 686
Authentication Failure, alarm, SIP 225 commands, callpClrLog, Voice 669
authorization headers, remove 85 commands, callpDispLog, Voice 668
auto_osi, Voice CallP commands 689 commands, callpEnblLog, Voice 668
automatic OSI 75 commands, change_ne, Voice 671
generation 689 commands, checkStackRes, Voice 690
commands, chg_alink, Voice 684
commands, chg_dialing, Voice 680
B commands, chg_polarity, Voice 684
backoffCounters, DOCSIS Fw commands 571 commands, chg_power, Voice 684
band, downstream frequency 517 commands, chg_state, Voice 683
bandwidth considerations, G.729 63 commands, chg_template, Voice 680
batcal, Voice Linecard commands 666 commands, chst, Voice 667
commands, cid, Voice 685

Firmware Guide Release 7.5 Standard 1.2 August 2012

704 Chapter 12

commands, conn_rec, Voice 676 callpClrLog, Voice CallP commands 669

commands, cotdump, Voice 690 callpDispLog, Voice CallP commands 668
commands, cpq, Voice 681 callpEnblLog, Voice CallP commands 668
commands, ddly, Voice 687 capability
commands, dds, Voice 666 descriptor, CallP feature switch, disabling 93
commands, dlr, Voice 666 feature switch, T.38 75
commands, dmon, Voice 673 T.38-only, SDP 75
commands, dmp_stack, Voice 692 CAS gain level 114
commands, dnsTools sub-mode, force_lkup, Voice 692 ccudbg, DSP commands 629
commands, dnsTools sub-mode, pne_print, Voice 692 center, firmware download 6
commands, dnsTools sub-mode, requery_dns, Voice 692 cerreset
commands, dnsTools Sub-Mode, Voice 692 DOCSIS Debug commands 579
commands, dsp_reset, Voice 686 Main DOCSIS commands 560
commands, dst, Voice 667 cert, RF commands 522
commands, dsxClrLog, Voice 669 certificates, PACM Security commands 596
commands, dsxDispLog, Voice 669 Certification, Main DOCSIS commands 563
commands, dsxEnblLog, Voice 669 change_ne, Voice CallP commands 671
commands, dsxtrace, Voice 671 changes, MIBs, PacketCable OID 28
commands, dtmf, Voice 673 changing the password seed 433
commands, dumpdm, Voice 690 channel
commands, eoc_stats, Voice 686 bonding 56
commands, etsi, Voice 685 lists, downstream 27
commands, ftrsw, Voice 672 channelset, RF commands 523
commands, gettimers, Voice 690 charger, display status, battery 512
commands, is, Voice 688 checking feature
commands, lcquery, Voice 683 bypass hash 84
commands, lineInfo, Voice 682 disable hash 84
commands, mdfy_rtp, Voice 687 checks feature
commands, mgcp, Voice 671 bypass KDC load balancer 84
commands, oos, Voice 688 bypass SNMP INFORM 84
commands, parser, Voice 682 checkStackRes, Voice CallP commands 690
commands, penalty_box, Voice 690 checksums, battery, verify EPROM 514
commands, procwatch, Voice 692 chg_alink, Voice CallP commands 684
commands, regevent_timer, Voice 690 chg_dialing, Voice CallP commands 680
commands, ring, Voice 683 chg_polarity, Voice CallP commands 684
commands, rng_cad, Voice 688 chg_power, Voice CallP commands 684
commands, rtcp_info, Voice 679 chg_state, Voice CallP commands 683
commands, scwidTest, Voice 685 chg_template, Voice CallP commands 680
commands, sdqm, Voice 691 chgrStatus, Telemetry commands 512
commands, sec, Voice 681 chst, Voice CallP commands 667
commands, serviceRoutes, Voice 690 cid, Voice CallP commands 685
commands, set_cadence, Voice 685 classifiers, DOCSIS Pp commands 591
commands, setgain, Voice 671 clear
commands, SG3FaxRelay, Voice 689 CallP logs 239
commands, sig_trace, Voice 687 DHCP logs 239
commands, sip_callleg, Voice 689 clearcw, RF commands 522
commands, sip_digitmap, Voice 690 clearfreq, RF commands 518
commands, sip_display_agpwd, Voice 690 clearing counters, end of call connection statistics 365
commands, sip_dns, Voice 690 clearNvramDsUsFreqDb, DOCSIS Debug commands 583
commands, sip_error, Voice 689 clearNvramUsFreqDb, DOCSIS Debug commands 583
commands, sip_ftr, Voice 690 CLI
commands, sip_ftr2, Voice 690 access levels 398
commands, sip_impu, Voice 690 default passwords 398
commands, sip_pub, Voice 689 inactivity timer 503
commands, sip_reg, Voice 689 SSH, accessing 438
commands, sip_rv, Voice 689 Telnet, accessing 437
commands, sip_stack_ver, Voice 690 clusterSidTable, DOCSIS Fw commands 570
commands, sip_subs, Voice 689 CM states 444
commands, sip_trans, Voice 689 cmcert, DOCSIS Certification commands 563
commands, spls, Voice 690 cmClrLog, DHCP commands 507
commands, tapi, Voice 696 cmDispLog, DHCP commands 507
commands, taskwatch, Voice 691 cmEnblLog, DHCP commands 507
commands, tcid_rec, Voice 678 CMS see Call Management Server.
commands, tones, Voice 687 cmstatus, Main DOCSIS commands 561
commands, trace, Voice 669 CM-STATUS support 268
commands, vmwi, Voice 686 cmstatusmasks, DOCSIS Show commands 562
commands, vqClear, Voice 696 CODEC
commands, vqLocEnable, Voice 696 G.729 61
commands, vqMetrics, Voice 696 G.729 60
commands, vqRemEnable, Voice 696 CODECs
feature switch, disabling the capability descriptor 93 supported 60
logs, clear 239 supported by SIP 63, 192

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 705

codecs, Voice MTA commands 695 commands, deprovision, Voice Linecard 654
coexistence commands, diag, Voice Linecard 654
configuring SNMP 245 commands, diagForce, Voice Linecard 655
feature switch, MTA 84 commands, dresults, Voice Linecard 655
IPv6 SNMP 212 commands, enableidle, Voice Linecard 665
SNMP 245 commands, errors, Voice Linecard 660
SNMP, configuration for 246 commands, hook, Voice Linecard 659
color, controlling, LED 66 commands, idle, Voice Linecard 660
commands commands, lcstatus, Voice Linecard 664
accesstime, DOCSIS Certification 563 commands, loopc, Voice Linecard 658
adcdump, DOCSIS Debug 580 commands, lpdiag, Voice Linecard 656
addcpe, DOCSIS Atp 565 commands, lpdiagForce, Voice Linecard 656
all, DOCSIS Pp 591 commands, lpresults, Voice Linecard 657
all_off, LED 506 commands, objdump, Voice Linecard 654
all_on, LED 506 commands, polarity, Voice Linecard 658
all_on_green, LED 506 commands, provision, Voice Linecard 654
AllComponentsConfig, Logger 608 commands, read, Voice Linecard 653
AllDebugModulesConfig, Logger 609 commands, regdump, Voice Linecard 653
allDsids, DOCSIS Dsid 589 commands, ring, Voice Linecard 657
AllModulesConfig, Logger 608 commands, ringfreq, Voice Linecard 663
allocChannel, DSP 633 commands, rread, Voice Linecard 654
allphystatus, DOCSIS Debug 584 commands, state, Voice Linecard 662
AllSeveritiesConfig, Logger 608 commands, template, Voice Linecard 661
!appmode, RF 530 commands, tone, Voice Linecard 659
ARRIS_PROVISIONING_set, PACM Debug 605 commands, vbat, Voice Linecard 663
atp, DOCSIS Qos 576 commands, write, Voice Linecard 653
Atp, Main DOCSIS 565 commands, xconnect, Voice Linecard 660
auto_osi, Voice CallP 689 commit, Gateway sub-mode 533
backoffCounters, DOCSIS Fw 571 commit, Technician 512
batcal, Voice Linecard 666 ComponentConfig, Logger 608
berstatus, DOCSIS Debug 583 ComponentDisplay, Logger 609
brief, System PP 556 componentsList, Logger 610
buf_store, Voice CallP 686 confCode, DOCSIS Dsid 588
buffer, System sub-mode 504 config, DSP 633
byteget, Database 516 config, Voice MTA 693
cache, RF 521 configDocsisModule, Main DOCSIS 561
cal_dump, Voice Linecard commands 665 conn_rec, Voice CallP 676
callpClrLog, Voice CallP 669 cotdump, Voice CallP 690
callpDispLog, Voice CallP 668 cpe, DOCSIS Show 562
callpEnblLog, Voice CallP 668 cppiStats, DOCSIS Fw 571
ccudbg, DSP 629 cpq, Voice CallP 681
cerreset, DOCSIS Debug 579 cps, DSP 642
cerreset, Main DOCSIS 560 customjitter, DSP 643
cert, RF 522 custommax, DSP 644
certificates, PACM Security 596 custommin, DSP 643
Certification, Main DOCSIS 563 customnom, DSP 644
change_ne, Voice CallP 671 dadbg base, DSP 629
channelset, RF 523 dadbg chan, DSP 630
checkStackRes, Voice CallP 690 dadbg chan_alloc_order, DSP 630
chg_alink, Voice CallP 684 dadbg dnld, DSP 629
chg_dialing, Voice CallP 680 dadbg, DSP 629
chg_polarity, Voice CallP 684 dadbg image, DSP 629
chg_power, Voice CallP 684 dadbg overlay_pcm_lbrc, DSP 630
chg_state, Voice CallP 683 dadbg sec_alloc, DSP 630
chg_template, Voice CallP 680 dadbg sec_config, DSP 630
chgrStatus, Telemetry 512 dadbg sec_show, DSP 630
chst, Voice CallP 667 dadbg usage, DSP 629
cid, Voice CallP 685 database, DOCSIS Qos 575
classifiers, DOCSIS Pp 591 DBC, DOCSIS Debug 587
clearcw, RF 522 dbg, System PP 555
clearfreq, RF 518 dbridgeAlt, DOCSIS Dsid 589
clearNvramDsUsFreqDb, DOCSIS Debug 583 dbridgeCounters, DOCSIS Dsid 590
clearNvramUsFreqDb, DOCSIS Debug 583 dbridgeListCpe, DOCSIS Dsid 589
clusterSidTable, DOCSIS Fw 570 dbridgeMdfDb, DOCSIS Dsid 589
cmcert, DOCSIS Certification 563 DCC, DOCSIS Debug 587
cmClrLog, DHCP 507 ddly, Voice CallP 687
cmDispLog, DHCP 507 dds, Voice CallP 666
cmEnblLog, DHCP 507 debug, DOCSIS Qos 575
cmstatus, Main DOCSIS 561 debug, DSP jitsim 651
cmstatusmasks, DOCSIS Show 562 Debug, Main DOCSIS 578
codecs, Voice MTA 695 debugMenu, Main PACM 604
commands, cal_dump, Voice Linecard 665 DebugModulesConfig, Logger 609

Firmware Guide Release 7.5 Standard 1.2 August 2012

706 Chapter 12

debugSet, PACM Debug 604 dsp, DSP 633

DefaultDisplay, Logger 610 DSP jitsim 644
DefaultEventTables, Event Manager 614 dsp_reset, Voice CallP 686
!defaults, Gateway sub-mode 533 dsPdsp1Configuration, DOCSIS Fw 574
deinit, System PP 555 dsPdsp2Configuration, DOCSIS Fw 574
delay, DSP jitsim 645 dsPhs, DOCSIS Fw 574
deldsidholdoff, DOCSIS Atp 566 dsstatus, DOCSIS Debug 581
deleteLogFile, PACM Event 603 dst, Voice CallP 667
deprovision, Voice Linecard commands 654 dstatus, RF 516
detect_tone, DSP 642 dsUnicast, DOCSIS Fw 575
devs, System PP 556 dsxClrLog, Voice CallP 669
dfreq, RF 517 dsxDispLog, Voice CallP 669
dhcp, System sub-mode 502 dsxEnblLog, Voice CallP 669
diag, Voice Linecard commands 654 dsxtrace, Voice CallP 671
diagForce, Voice Linecard commands 655 dt_cleanup, DSP 642
dim mips_stat, DSP 628 dt_setup, DSP 642
dim reset_tdm, DSP 629 dtmf, Voice CallP 673
dim set_status_req, DSP 629 dtune, RF 519
dimdbg cfg, DSP 622 dump, DOCSIS Debug 580
dimdbg, DSP 620 dump, RF 520
dimdbg dump, DSP 622 dumpdm, Voice CallP 690
dimdbg gsync, DSP 624 dynamicConfig, Main PACM 602
dimdbg hpi_details, DSP 626 !ecache, RF 530
dimdbg lo_details, DSP 625 echo, DSP 636
dimdbg msg, DSP 624 echo_stat, DSP 640
dimdbg ndu_stat, DSP 624 echotail, DSP 637
dimdbg opt, DSP 620 ecpath_coeff, DSP 641
dimdbg poll stats, DSP 623 enable, DSP jitsim 644
dimdbg power, DSP 628 enable, Logger 613
dimdbg prof_define, DSP 625 enable, System PP 555
dimdbg pt, DSP 622 enableidle, Voice Linecard commands 665
dimdbg set_poll, DSP 623 enableL2vpnPromMode, DOCSIS Pp 590
dimdbg set_voice_poll, DSP 623 enableTdox, DOCSIS Pp 590
dimdbg show_reflection_page, DSP 628 eoc_stats, Voice CallP 686
dimdbg sig, DSP 624 eprom, Telemetry 514
dimdbg silence, DSP 622 equadump, DOCSIS Debug 579
dimdbg stats, DSP 621 equthresh, DOCSIS Debug 579
dimdbg tcids, DSP 622 err_stat, DSP 638
dimdbg test_poll_period, DSP 627 errors, Voice Linecard commands 660
dimdbg ver, DSP 620 errStats, DOCSIS Fw 568
disable, DSP jitsim 644 etsi, Voice CallP 685
disable, Logger 613 event, Main PACM 603
disable, System PP 555 exception, System sub-mode 504
disableL2vpnPromMode, DOCSIS Pp 590 ExitManager, Event Manager 617
disableTdox, DOCSIS Pp 590 FilenameConfig, Logger 608
display, Database 515 filenameShow, Logger 613
displayConfigList, Logger 612 filters, DOCSIS Pp 591
displayDB, PACM Security 596 flash, LED 506
displayEventTable, PACM Event 603 ForceDsPSM, DOCSIS Debug 588
dlock, RF 519 ForceRngRspAbort, DOCSIS Debug 585
dlr, Voice CallP 666 ForceRngRspDRW, DOCSIS Debug 586
dml, DOCSIS Debug 582 ForceRngRspFreq, DOCSIS Debug 585
dmon, Voice CallP 673 ForceRngRspPowerOffset, DOCSIS Debug 586
dmp_stack, Voice CallP 692 ForceT4Multiplier, DOCSIS Debug 585
dmz, Gateway sub-mode 533 ForceUsPSM, DOCSIS Debug 588
dnsTools sub-mode, force_lkup, Voice CallP 692 freeChannel, DSP 634
dnsTools sub-mode, pne_print, Voice CallP 692 freqband, RF 517
dnsTools sub-mode, requery_dns, Voice CallP 692 ftrsw, Voice CallP 672
dnsTools Sub-Mode, Voice CallP 692 FullDisplay, Logger 609
download, DSP 633 FunctionLineDisplay, Logger 609
downstream, DOCSIS Psm 591 Fw, Main DOCSIS 566
dpacm, System sub-mode 504 gain_req, DSP 641
dresults, Voice Linecard commands 655 General, Main DOCSIS 564
drop, DSP jitsim 645 get, Gateway sub-mode 531
dsavg, RF 522 GetEventsList, Event Manager 615
dsBpi, DOCSIS Fw 574 get-pompt, DOCSIS Psm 592
dsCounters, DOCSIS Fw 574 getSig, Voice MTA 694
Dsid, Main DOCSIS 588 GetSyslogServer, Event Manager 617
dsidCounters, DOCSIS Dsid 588 GetThrotParams, Event Manager 616
dsimdbg, DSP 631 gettimers, Voice CallP 690
dsimdbg select, DSP 631 global, System PP 556
dsimdbg show, DSP 631 goto, DOCSIS General 564

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 707

gQosDbClusterArray, DOCSIS Fw 573 mtaClrLog, DHCP 507

gQosDbFwPrivateArray, DOCSIS Fw 572 mtaDisplay, PACM Security 596
gQosDbHostConfigArray, DOCSIS Fw 573 mtaDispLog, DHCP 507
gQosDbPhsInfo, DOCSIS Fw 573 mtaEnblLog, DHCP 507
guardTimeStats, DOCSIS Fw 569 mtaftrsw, Voice MTA 695
gUpstreamBpiInfo, DOCSIS Fw 574 mtaSubOpt3Immediate, DHCP 507
gUsChannelConfigInfo, DOCSIS Fw 574 nbdfreq, RF 518
gUsChannelPrivateInfo, DOCSIS Fw 574 netrxReduce, Main System 555
gw_diag, System sub-mode 504 netrxRestore, Main System 555
help, Voice common 619 network, Main System 554
hook, Voice Linecard commands 659 next, DOCSIS General 564
hwcounters, DOCSIS General 565 nlplevel, DSP 636
idle, Voice Linecard commands 660 nodbg, System PP 556
if, DOCSIS Pp 590 nomjitter, DSP 635
info, DSP 644 nopsm, System PP 556
info, Logger 613 noqos, System PP 557
initDsUsFreqDb, DOCSIS Debug 584 objdump, Voice Linecard commands 654
intget, Database 516 oos, Voice CallP 688
ipcable, DOCSIS General 564 options, Main PACM 593
is, Voice CallP 688 overdsidholdoffovr, DOCSIS Atp 566
isrmask, DOCSIS Debug 583 overrideCmsTtl, PACM Security 595
isrStats, DOCSIS Fw 567 PACM_CONFIG_CERTIFICATION_MODE_set, PACM
iucEnList, DOCSIS Fw 571 Debug 605
jit_burst, DSP jitsim 649 PACM_CONFIG_CFM_FILE_HASH_BYPASS_set, PACM
jit_fixed, DSP jitsim 648 Debug 605
jit_off, DSP jitsim 647 PACM_CONFIG_EURO_HASH_SIZE_20_set, PACM
jit_random, DSP jitsim 649 Debug 604
jit_random_win, DSP jitsim 650 PACM_CONFIG_EURO_set, PACM Production 601
jit_rolling, DSP jitsim 650 PACM_CONFIG_HW_ADDR_set, PACM Production 601
jit_shift, DSP jitsim 648 PACM_CONFIG_IP_ADDR_set, PACM Production 601
jittermode, DSP 635 PACM_CONFIG_IPSEC_ENABLE_set, PACM Debug 604
lastreset, System sub-mode 503 PACM_CONFIG_MAS_ROUTE_TO_LOGGER_set, PACM
lcquery, Voice CallP 683 Debug 605
lcstatus, Voice Linecard commands 664 PACM_CONFIG_MTA_BBU_set, PACM Production 602
level_stat, DSP 639 PACM_CONFIG_MTA_NUM_LINES_set, PACM
lineInfo, Voice CallP 682 Production 601
list, Logger 613 PACM_CONFIG_MTA_RESET_WATCH_DOG_set, PACM
list, System SME 557 Debug 604
listDocsisModules, Main DOCSIS 561 PACM_CONFIG_MTA_TELE_ID_set, PACM Production
llong, System SME 558 601
loopc, Voice Linecard commands 658 PACM_CONFIG_PROV_DHCP_RETRIES_set, PACM
looprx, DSP 637 Debug 604
looptx, DSP 637 PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set,
loss_fixed, DSP jitsim 646 PACM Debug 604
loss_off, DSP jitsim 646 PACM_CONFIG_SNMPV2_ACCESS_set, PACM Debug
loss_random, DSP jitsim 647 605
lpdiag, Voice Linecard commands 656 PACM_CONFIG_TICKETS_FLASH_SUPPORT_set,
lpdiagForce, Voice Linecard commands 656 PACM Debug 604
lpresults, Voice Linecard commands 657 PACM_CONFIG_TLV38_SNMPV1_ENABLE_set, PACM
lshort, System SME 557 Debug 605
macaddr, DOCSIS General 565 PACM_DYN_CONFIG_LOOPV_MAINT_TIMER_CD_set,
macread, DOCSIS Debug 579 PACM Dynamic Config 602
macread, RF 521 PACM_DYN_CONFIG_LOOPV_POLICY_set, PACM
macwrite, DOCSIS Debug 579 Dynamic Config 602
macwrite, RF 521 PACM_DYN_CONFIG_LOOPV_RESET_TIMER_set,
Main menu 553 PACM Dynamic Config 602
managerMenu, Main PACM 606 PACM_DYN_CONFIG_LOOPV_STATUS_set, PACM
mapperStats, DOCSIS Fw 566 Dynamic Config 602
maxjitter, DSP 636 PACM_DYN_CONFIG_SNMP_ENGIN_BOOT_NUM_set,
mbxStats, DOCSIS Fw 567 PACM Dynamic Config 602
mcastDsids, DOCSIS Dsid 589 PACM_MANAGER_HITLESS_DHCP_set, PACM Manager
mdfMode, DOCSIS Dsid 588 606
mdfy_rtp, Voice CallP 687
memory, Main System 554 PACM_MANAGER_HITLESS_SOFTWARE_DOWNLOAD_set,
mfgcert, DOCSIS Certification 563 PACM Manager 606
mft_close, DSP 642 PACM_MANAGER_PSM_ENABLE_set, PACM Manager
mft_open, DSP 642 607
mgcp, Voice CallP 671 PACM_MANAGER_RANDOM_USM_SPIN_LOCK_set,
mml, DOCSIS Debug 582 PACM Manager 606
ModuleConfig, Logger 608
ModuleDisplay, Logger 609 PACM_MANAGER_SNMP_RESTRICT_CONFIG_VIEW_set,
modulesList, Logger 610 PACM Manager 606

Firmware Guide Release 7.5 Standard 1.2 August 2012

708 Chapter 12

PACM_MANAGER_TOD_DELAY_SEC_PROV_set, PACM resetMTA, Voice MTA 696

Manager 606 resetStats, System PP 555
PACM_MANAGER_VENDOR_CMS_AS_IP_set, PACM resetTables, PACM Event 604
Manager 607 resetTickets, PACM Security 595
resetTimeout, System PP 555
PACM_MANAGER_VENDOR_COMMUNITY_NAME_set, restart, DSP 641
PACM Manager 607 restore, PACM Debug 605
PACM_MANAGER_VENDOR_ENABLE_EVENTS_set, restore, PACM Dynamic Config 603
PACM Manager 607 restore, PACM Manager 607
PACM_MANAGER_VOICE_DECT_IF_set, PACM restore, PACM Vendor 600
Manager 606 resume, LED 506
PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set, rf_diag, System sub-mode 505
PACM Manager 606 ring, Voice CallP 683
PACM_MANAGER_VOICE_VLM_IF_set, PACM Manager ring, Voice Linecard commands 657
606 ringfreq, Voice Linecard commands 663
parser, Voice CallP 682 rng_cad, Voice CallP 688
penalty_box, Voice CallP 690 rootpublickey, DOCSIS Certification 563
phy-mac, DOCSIS Psm 591 rread, Voice Linecard commands 654
phystatus, DOCSIS Debug 582 rtcp_info, DSP 637
phystatus, Main DOCSIS 559 rtcp_info, Voice CallP 679
pids, System PP 556 rtcpdbg, DSP 631
ping, Gateway sub-mode 532 rtosStats, DOCSIS Fw 570
polarity, Voice Linecard commands 658 rxtx_stat, DSP 637
polling, Voice Linecard 666 save, PACM Debug 605
pompt, DOCSIS Psm 592 save, PACM Dynamic Config 603
pp, DOCSIS Psm 592 save, PACM Manager 607
Pp, Main DOCSIS 590 save, PACM Production 602
pp, Main System 555 save, PACM Vendor 601
printAll, DOCSIS Fw 571 scan, Main DOCSIS 560
printcmstatusevents, DOCSIS Atp 566 scanmode, RF 519
printds, RF 523 scwidTest, Voice CallP 685
printDsidDb, DOCSIS Dsid 589 sdqm, Voice CallP 691
printLogFile, PACM Event 603 search, Gateway sub-mode 531
printNvramDsUsFreqDb, DOCSIS Debug 584 sec, Voice CallP 681
printscan, RF 519 security, Main PACM 595
printus, RF 529 SendEvent, Event Manager 613
printVendorRegisteredEvents, PACM Vendor 599 sendEvent, PACM Event 603
procwatch, Voice CallP 692 SendStdTrap, Event Manager 614
prodSet, PACM Production 601 serviceRoutes, Voice CallP 690
production, Main PACM 601 session, System PP 556
provision, Voice Linecard commands 654 set, Gateway sub-mode 531
provisioning, Main PACM 593 set, PACM Dynamic Config 602
provmethod, Voice MTA 695 set_cadence, Voice CallP 685
psm, DOCSIS Psm 592 SetAllDebugOptions, DOCSIS Debug 584
Psm, Main DOCSIS 591 SetDebugOption, DOCSIS Debug 584
psm, System PP 556 setDefaultMacAddress, PACM Production 602
Qos, Main DOCSIS 575 setDefaults, Logger 613
qos, System PP 557 setDhcpEnable, Technician 509
QueueLimitConfig, Logger 609 setDhcpPool, Technician 509
queueLimitShow, Logger 613 setequthresh, DOCSIS Debug 579
quit, Voice common 619 setEthernet, Technician 511
rc, Gateway sub-mode 532 SetEventLevel, Event Manager 614
read, DOCSIS Debug 580 SetEventMask, Event Manager 615
read, RF 521 SetEventText, Event Manager 615
read, Voice Linecard commands 653 setgain, Voice CallP 671
RebootSimulate, DOCSIS Debug 586 setHttpLanAccess, Technician 511
reconfig, DSP 636 setHttpWanAccess, Technician 511
regdump, Voice Linecard commands 653 setLanIp, Technician 509
regevent_timer, Voice CallP 690 SetMdCfgIpProvMode, DOCSIS Debug 587
rem, DOCSIS General 564 SetMimo, DOCSIS Debug 586
reqCoding, DSP 634 SetModule, System SME 558
reqNullCoding, DSP 634 SetPriorityMask, Event Manager 615
reseqDsids, DOCSIS Dsid 589 setRipAuth, Technician 510
!reset, DSP 644 setRipDhcpEnable, Technician 510
reset, Gateway sub-mode 532 setRipEnable, Technician 510
!reset, Technician 512 setRipIp, Technician 510
!reset, Voice common 619 setRipKeyId, Technician 510
resetaccesstime, DOCSIS Certification 563 setRipLogMask, Technician 510
resetChrgr, Telemetry 514 setRouteMode, Technician 508
resetDefaults, Technician 512 SetSeverity, System SME 558
ResetLog, Event Manager 614 setTACACSSecret, Technician 509
resetLogFile, PACM Event 603 setTACACSServer, Technician 509

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 709

setThreshold, System PP 557 taskwatch, Voice CallP 691

SetThrotAdmin, Event Manager 616 tcid_rec, Voice CallP 678
SetThrotInterval, Event Manager 616 tdox, DOCSIS Pp 590
SetThrotThresh, Event Manager 616 tdoxStats, DOCSIS Fw 575
setTimeout, System PP 555 Telemetry 512
settings, DSP jitsim 645 telnet_timer, System sub-mode 503
setvp, DSP 634 template, Voice Linecard commands 661
setvp, DSP jitsim 651 temptuner, DOCSIS Debug 580
setWanDns, Technician 509 testDsLoss, Main DOCSIS 561
setWanGateway, Technician 508 thresholdDisable, System PP 557
setWanIp, Technician 508 TimeDisplay, Logger 609
severitiesList, Logger 611 timeoverversion, DOCSIS Show 562
SeverityConfig, Logger 608 timers, Main System 555
sfStats, DOCSIS Fw 568 timersDisplay, PACM Security 595
SG3FaxRelay, Voice CallP 689 tlmStatus, Telemetry 512
ShortDisplay, Logger 610 tone, DSP 634
Show, Main DOCSIS 561 tone, Voice Linecard commands 659
show, PACM Debug 606 tones, Voice CallP 687
show, PACM Dynamic Config 603 tpPorts, DOCSIS Pp 590
show, PACM Manager 607 tr69Start, Database 532
show, PACM Production 602 tr69Stop, Database 533
show, PACM Vendor 601 tr69Update, Database 533
showconfig, Voice MTA 693 trace, Voice CallP 669
showDebugOptions, DOCSIS Debug 585 traffic, DSP 641
showEthernet, Technician 511 triggercmstatus, DOCSIS Atp 565
showHttpAccess, Technician 511 trr, RF 519
showRip, Technician 510 trw, RF 519
showRipLog, Technician 510 tune, DOCSIS General 564
showStatus, Technician 511 tune, RF 517
showTACACS, Technician 510 tuner, Main DOCSIS 560
showWan, Technician 509 tunerset, RF 523
sig_trace, Voice CallP 687 tunerstatus, DOCSIS Debug 580
sip_callleg, Voice CallP 689 ucd, DOCSIS General 564
sip_digitmap, Voice CallP 690 ucdCollectStatus, DOCSIS Debug 584
sip_display_agpwd, Voice CallP 690 ufreq, RF 518
sip_dns, Voice CallP 690 unconfig, DSP 633
sip_error, Voice CallP 689 upstream, DOCSIS Psm 591
sip_ftr, Voice CallP 690 UserDisplay, Logger 610
sip_ftr2, Voice CallP 690 usstatus, DOCSIS Debug 581
sip_impu, Voice CallP 690 ustatus, RF 517
sip_pub, Voice CallP 689 vbat, Voice Linecard commands 663
sip_reg, Voice CallP 689 vbdbitmap, DSP 643
sip_rv, Voice CallP 689 vbdmax, DSP 643
sip_stack_ver, Voice CallP 690 vbdmin, DSP 643
sip_subs, Voice CallP 689 vbdnom, DSP 643
sip_trans, Voice CallP 689 VENDOR_ADD_SNMP_TARGET_set, PACM Vendor 600
smDataDisplay, PACM Security 595 VENDOR_AFTER_DHCP_ACK_set, PACM Vendor 599
sme, Main System 557 VENDOR_AFTER_MSM_INIT_set, PACM Vendor 599
SocketConfig, Logger 608 VENDOR_BEFORE_MTA_RESET_set, PACM Vendor 600
socketShow, Logger 612 VENDOR_DISABLE_CFM_SPEC_TREE_set, PACM
spls, Voice CallP 690 Vendor 600
spy, DSP 632 VENDOR_ENABLE_CFM_PLUG_IN_set, PACM Vendor
st_cleanup, DSP 642 600
st_setup, DSP 642 VENDOR_ENABLE_DHCP_PLUG_IN_set, PACM Vendor
StartSNMP, Event Manager 617 600
StartSyslog, Event Manager 616 VENDOR_ENABLE_EVENTS_set, PACM Vendor 600
state, DSP 634 VENDOR_SET_DHCP_SERVER_ADDR_set, PACM
state, Voice Linecard commands 662 Vendor 599
stats, DOCSIS Pp 590 VENDOR_SET_TFTP_DATA_set, PACM Vendor 599
stats, System PP 556 VENDOR_STATUS_VENDOR_APP_set, PACM Vendor
status, DOCSIS Certification 563 599
status, Technician 512 vendorAddSnmpTarget, PACM Vendor 598
statustuner, Main DOCSIS 560 vendorModifyDhcpAckParam, PACM Vendor 598
StopSNMP, Event Manager 617 vendorSetDhcpServerAddr, PACM Vendor 598
StopSyslog, Event Manager 617 vendorSetTftpData, PACM Vendor 598
suspendcmstatus, DOCSIS Atp 566 vendorSubMenu, Main PACM 597
sweep, RF 518 version, DOCSIS Fw 566
sysinfo, System sub-mode 502 version, Main DOCSIS 559
tapi, Telemetry 513 version, Main PACM 592
tapi, Voice CallP 696 vmwi, Voice CallP 686
TargetConfig, Logger 610 Voice MTA 693
targetsList, Logger 612 vp_stat, DSP 640

Firmware Guide Release 7.5 Standard 1.2 August 2012

710 Chapter 12

vp_stat, DSP jitsim 652 country

vpids, System PP 556 template 687
vqClear, Voice CallP 696 templates 464
vqLocEnable, Voice CallP 696 cpe, DOCSIS Show commands 562
vqMetrics, Voice CallP 696 CPE list 21
vqRemEnable, Voice CallP 696 cppiStats, DOCSIS Fw commands 571
wb-adc, DOCSIS Psm 592 cpq, Voice CallP commands 681
wbdfreq, RF 518 cps, DSP commands 642
write, DOCSIS Debug 582 current, configuring loop 68
write, RF 521 custom jitter buffer 107
write, Voice Linecard commands 653 customer-originated trace 150
wrmStatus, Gateway sub-mode 533 customjitter, DSP commands 643
xconnect, Voice Linecard commands 660 custommax, DSP commands 644
xmlLog, Database 534 custommin, DSP commands 643
xmlRestart, Database 534 customnom, DSP commands 644
xmlStatus, Database 533 CW-CID
commit feature switch, disable 85
Gateway sub-mode commands 533 tones, adjusting 114
Technician commands 512
common commands
help, Voice 619
D
quit, Voice 619 dadbg
!reset, Voice 619 DSP commands 629
comparison feature switch, skip USM user name 84 DSP commands 630
compatibility feature switch, DOCSIS 2.0 75 DSP commands 630
ComponentConfig, Logger commands 608 DSP commands 629
ComponentDisplay, Logger commands 609 DSP commands 629
componentsList, Logger commands 610 DSP commands 629
concepts, PacketCable 2.0 137 DSP commands 630
confCode, DOCSIS Dsid commands 588 DSP commands 630
config DSP commands 630
DSP commands 633 DSP commands 630
Voice MTA commands 693 DSP commands 629
configDocsisModule, Main DOCSIS commands 561 Database commands
configFile, PACM Provisioning sub-commands 594 byteget 516
configuration display 515
file, XML 495 intget 516
for coexistence, SNMP 246 tr69Start 532
parameters, display signalling 694 tr69Stop 533
Configuration Parameters screen 451 tr69Update 533
configuration xmlLog 534
SIP, T.38 103, 201 xmlRestart 534
T.38 102 xmlStatus 533
configuring database
distinctive ringing 202 DOCSIS Qos commands 575
loop current 68 TurboDox 590
MWI support 169 DBC, DOCSIS Debug commands 587
Payload header Suppression 75 dbg, System PP commands 555
ring frequency 108 dbridgeAlt, DOCSIS Dsid commands 589
SIP failure response tones 167 dbridgeCounters, DOCSIS Dsid commands 590
SNMP coexistence 245 dbridgeListCpe, DOCSIS Dsid commands 589
trap servers 258 dbridgeMdfDb, DOCSIS Dsid commands 589
conn_rec, Voice CallP commands 676 DCC, DOCSIS Debug commands 587
connection statistics ddly, Voice CallP commands 687
clearing counters, end of call 365 dds, Voice CallP commands 666
device level, end of call 366 Debug commands
end of call 364 ARRIS_PROVISIONING_set, PACM 605
line level, end of call 367 debugSet, PACM 604
considerations PACM_CONFIG_CERTIFICATION_MODE_set, PACM
European loads, provisioning 28 605
IPv6 eRouter 29 PACM_CONFIG_CFM_FILE_HASH_BYPASS_set, PACM
SDP parameter list 100 605
synchronous upstreams 269 PACM_CONFIG_EURO_HASH_SIZE_20_set, PACM 604
constant power signal 642 PACM_CONFIG_IPSEC_ENABLE_set, PACM 604
controlling PACM_CONFIG_MAS_ROUTE_TO_LOGGER_set, PACM
access, troubleshooting interface 439 605
LED color 66 PACM_CONFIG_MTA_RESET_WATCH_DOG_set, PACM
cotdump, Voice CallP commands 690 604
counters PACM_CONFIG_PROV_DHCP_RETRIES_set, PACM 604
end of call connection statistics, clearing 365 PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set,
TurboDox 575 PACM 604
PACM_CONFIG_SNMPV2_ACCESS_set, PACM 605

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 711

PACM_CONFIG_TICKETS_FLASH_SUPPORT_set, SIP, repeat 200

PACM 604 digit map objects, SIP 191
PACM_CONFIG_TLV38_SNMPV1_ENABLE_set, PACM dim
605 mips_stat, DSP commands 628
restore, PACM 605 reset_tdm, DSP commands 629
save, PACM 605 set_status_req, DSP commands 629
show, PACM 606 dimdbg
debug DSP commands 622
DOCSIS Qos commands 575 DSP commands 620
DSP jitsim commands 651 DSP commands 622
Debug, Main DOCSIS commands 578 DSP commands 624
debugMenu, Main PACM commands 604 DSP commands 626
DebugModulesConfig, Logger commands 609 DSP commands 625
debugSet, PACM Debug commands 604 DSP commands 624
default DSP commands 624
hook flash timings 464 DSP commands 620
passwords, CLI 398 DSP commands 623
passwords, WebGUI 398 DSP commands 628
DefaultDisplay, Logger commands 610 DSP commands 625
DefaultEventTables, Event Manager commands 614 DSP commands 622
defaults, alarm, Unit has been restored to factory 231 DSP commands 623
!defaults, Gateway sub-mode commands 533 DSP commands 623
defaults, reset to factory 429 DSP commands 628
deinit, System PP commands 555 DSP commands 624
delay DSP commands 622
bye 151 DSP commands 621
DLCX feature switch 75 DSP commands 622
DSP jitsim commands 645 DSP commands 627
time 687 DSP commands 620
deldsidholdoff, DOCSIS Atp commands 566 disable
deleteLogFile, PACM Event commands 603 CW-CID feature switch 85
deprovision, Voice Linecard commands commands 654 DSP jitsim commands 644
descriptor, CallP feature switch, disabling the capability 93 hash checking feature switch 84
detect_tone, DSP commands 642 Logger commands 613
detection, tone 642 System PP commands 555
device level, end of call connection statistics 366 TurboDox 590
devs, System PP commands 556 disableL2vpnPromMode, DOCSIS Pp commands 590
dfreq, RF commands 517 disableTdox, DOCSIS Pp commands 590
DHCP disabling
commands, cmClrLog 507 Call Waiting 188, 196
commands, cmDispLog 507 capability descriptor, CallP feature switch 93
commands, cmEnblLog 507 display
commands, mtaClrLog 507 Database commands 515
commands, mtaDispLog 507 DHCP 502
commands, mtaEnblLog 507 downstream status 516
commands, mtaSubOpt3Immediate 507 linecard status 664
display 502 logs 236
IPv6 behavior 43 message logs 237
lease time request 30 signalling configuration parameters 694
logs, clear 239 status, battery charger 512
message trace logs 234 Display upstream status 517
sub-option 3, overriding 32 displayConfigList, Logger commands 612
option 43 support 30 displayDB, PACM Security commands 596
option 51 support 30 displayEventTable, PACM Event commands 603
option 60 support 30–31 displaying
option 67 support 32 DSx log 669
options required 39 ring cadences 688
parameters, provisioning modes 39 signalling log 668
screen 448 distinctive ringing, configuring 202
dhcp, System sub-mode commands 502 DLCX feature switch, delay 75
dhcpServersConfig, PACM Provisioning sub-commands 593 dlock, RF commands 519
diag, Voice Linecard commands commands 654 dlr, Voice CallP commands 666
diagForce, Voice Linecard commands commands 655 dml, DOCSIS Debug commands 582
diagnostics dmon, Voice CallP commands 673
line card 654 dmp_stack, Voice CallP commands 692
loop 656–657 dmz, Gateway sub-mode commands 533
running line card 419 DNS
running loop 420 override 128
dial pulse support 122 relay 128
dialing dnsTools
features supported, SIP 197 force_lkup, Voice CallP commands 692
SIP, busy indication 200 pne_print, Voice CallP commands 692

Firmware Guide Release 7.5 Standard 1.2 August 2012

712 Chapter 12

requery_dns, Voice CallP commands 692 commands, equadump 579

Sub-Mode, Voice CallP commands 692 commands, equthresh 579
docsDevEvControl, MIB 215 commands, ForceDsPSM 588
docsDevEventTable, MIB 215, 218 commands, ForceRngRspAbort 585
docsDevEvSyslogAddress, MIB 213 commands, ForceRngRspDRW 586
docsDevEvSyslogAddressType, MIB 213 commands, ForceRngRspFreq 585
docsDevNmAccessInterfaces, MIB 245 commands, ForceRngRspPowerOffset 586
docsDevResetNow, MIB 49, 53 commands, ForceT4Multiplier 585
docsDevServerConfigTftpAddress, MIB 213 commands, ForceUsPSM 588
docsDevServerConfigTftpAddressType, MIB 213 commands, initDsUsFreqDb 584
docsDevServerDhcpAddress, MIB 213 commands, isrmask 583
docsDevServerDhcpAddressType, MIB 213 commands, macread 579
docsDevServerTimeAddress, MIB 213 commands, macwrite 579
docsDevServerTimeAddressType, MIB 213 commands, mml 582
docsDevSoftware, MIB 46–47 commands, phystatus 582
docsDevSwAdminStatus, MIB 46–47, 49–50, 276 commands, printNvramDsUsFreqDb 584
docsDevSwCurrentVers, MIB 360 commands, read 580
docsDevSwFilename, MIB 46 commands, RebootSimulate 586
docsDevSwOperStatus, MIB 46 commands, SetAllDebugOptions 584
docsDevSwServerAddress, MIB 46 commands, SetDebugOption 584
docsDevSwServerAddressType, MIB 46 commands, setequthresh 579
docsIf3CmMdCfgIpProvMode, MIB 41–43, 274, 586 commands, SetMdCfgIpProvMode 587
docsIf3CmMdCfgIpProvModeResetOnChange, MIB 41–42 commands, SetMimo 586
docsIf3CmMdCfgIpProvModeResetOnChangeHoldOffTimer, MIB commands, showDebugOptions 585
41–42 commands, temptuner 580
docsIf3CmMdCfgIpProvModeStorageType, MIB 41, 43 commands, tunerstatus 580
docsIf3CmMdCfgTable, MIB 42 commands, ucdCollectStatus 584
DOCSIS commands, usstatus 581
2.0 compatibility feature switch 75 commands, write 582
commands, addcpe 565 commands, allDsids 589
commands, deldsidholdoff 566 commands, confCode 588
commands, overdsidholdoffovr 566 commands, dbridgeAlt 589
commands, printcmstatusevents 566 commands, dbridgeCounters 590
commands, suspendcmstatus 566 commands, dbridgeListCpe 589
commands, triggercmstatus 565 commands, dbridgeMdfDb 589
commands, accesstime 563 commands, dsidCounters 588
commands, cmcert 563 commands, mcastDsids 589
commands, mfgcert 563 commands, mdfMode 588
commands, resetaccesstime 563 commands, printDsidDb 589
commands, rootpublickey 563 commands, reseqDsids 589
commands, status 563 commands, backoffCounters 571
commands, Atp, Main 565 commands, clusterSidTable 570
commands, cerreset, Main 560 commands, cppiStats 571
commands, Certification, Main 563 commands, dsBpi 574
commands, cmstatus, Main 561 commands, dsCounters 574
commands, configDocsisModule, Main 561 commands, dsPdsp1Configuration 574
commands, Debug, Main 578 commands, dsPdsp2Configuration 574
commands, Dsid, Main 588 commands, dsPhs 574
commands, Fw, Main 566 commands, dsUnicast 575
commands, General, Main 564 commands, errStats 568
commands, listDocsisModules, Main 561 commands, gQosDbClusterArray 573
commands, phystatus, Main 559 commands, gQosDbFwPrivateArray 572
commands, Pp, Main 590 commands, gQosDbHostConfigArray 573
commands, Psm, Main 591 commands, gQosDbPhsInfo 573
commands, Qos, Main 575 commands, guardTimeStats 569
commands, scan, Main 560 commands, gUpstreamBpiInfo 574
commands, Show, Main 561 commands, gUsChannelConfigInfo 574
commands, statustuner, Main 560 commands, gUsChannelPrivateInfo 574
commands, testDsLoss, Main 561 commands, isrStats 567
commands, tuner, Main 560 commands, iucEnList 571
commands, version, Main 559 commands, mapperStats 566
commands, adcdump 580 commands, mbxStats 567
commands, allphystatus 584 commands, printAll 571
commands, berstatus 583 commands, rtosStats 570
commands, cerreset 579 commands, sfStats 568
commands, clearNvramDsUsFreqDb 583 commands, tdoxStats 575
commands, clearNvramUsFreqDb 583 commands, version 566
commands, DBC 587 commands, goto 564
commands, DCC 587 commands, hwcounters 565
commands, dml 582 commands, ipcable 564
commands, dsstatus 581 commands, macaddr 565
commands, dump 580 commands, next 564

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 713

commands, rem 564 dadbg chan 630

commands, tune 564 dadbg chan_alloc_order 630
commands, ucd 564 dadbg dnld 629
commands, all 591 dadbg image 629
commands, classifiers 591 dadbg overlay_pcm_lbrc 630
commands, disableL2vpnPromMode 590 dadbg sec_alloc 630
commands, disableTdox 590 dadbg sec_config 630
commands, enableL2vpnPromMode 590 dadbg sec_show 630
commands, enableTdox 590 dadbg usage 629
commands, filters 591 detect_tone 642
commands, if 590 dim mips_stat 628
commands, stats 590 dim reset_tdm 629
commands, tdox 590 dim set_status_req 629
commands, tpPorts 590 dimdbg 620
commands, downstream 591 dimdbg cfg 622
commands, get-pompt 592 dimdbg dump 622
commands, phy-mac 591 dimdbg gsync 624
commands, pompt 592 dimdbg hpi_details 626
commands, pp 592 dimdbg lo_details 625
commands, psm 592 dimdbg msg 624
commands, upstream 591 dimdbg ndu_stat 624
commands, wb-adc 592 dimdbg opt 620
commands, atp 576 dimdbg poll stats 623
commands, database 575 dimdbg power 628
commands, debug 575 dimdbg prof_define 625
commands, cmstatusmasks 562 dimdbg pt 622
commands, cpe 562 dimdbg set_poll 623
commands, timeoverversion 562 dimdbg set_voice_poll 623
domain override dimdbg show_reflection_page 628
feature switch 85 dimdbg sig 624
SIP 195 dimdbg silence 622
dot1dBaseBridgeAddress, MIB 362 dimdbg stats 621
dot1dBaseNumPorts, MIB 362 dimdbg tcids 622
dot1dBaseType, MIB 362 dimdbg test_poll_period 627
dot1dBridge, MIB 362 dimdbg ver 620
dot1dTpFdbTable, MIB 362 download 633
download dsimdbg 631
center, firmware 6 dsimdbg select 631
DSP commands 633 dsimdbg show 631
downstream dsp 633
channel lists 27 dt_cleanup 642
DOCSIS Psm commands 591 dt_setup 642
frequency band 517 echo 636
status, display 516 echo_stat 640
DownstreamPacketClassification, MIB 190 echotail 637
dpacm, System sub-mode commands 504 ecpath_coeff 641
DQos see Dynamic Quality of Service. err_stat 638
DQos feature switch, access-only 75 freeChannel 634
DQoS feature switch, DSx 75 gain_req 641
DQos feature switch, Force 75 info 644
dresults, Voice Linecard commands commands 655 jittermode 635
drop, DSP jitsim commands 645 level_stat 639
dsavg, RF commands 522 looprx 637
dsBpi, DOCSIS Fw commands 574 looptx 637
dsCounters, DOCSIS Fw commands 574 maxjitter 636
Dsid, Main DOCSIS commands 588 mft_close 642
dsidCounters, DOCSIS Dsid commands 588 mft_open 642
dsimdbg nlplevel 636
DSP commands 631 nomjitter 635
DSP commands 631 reconfig 636
DSP commands 631 reqCoding 634
DSP commands reqNullCoding 634
allocChannel 633 !reset 644
ccudbg 629 restart 641
config 633 rtcp_info 637
cps 642 rtcpdbg 631
customjitter 643 rxtx_stat 637
custommax 644 setvp 634
custommin 643 spy 632
customnom 644 st_cleanup 642
dadbg 629 st_setup 642
dadbg base 629 state 634

Firmware Guide Release 7.5 Standard 1.2 August 2012

714 Chapter 12

tone 634 602

traffic 641 commands, PACM_DYN_CONFIG_LOOPV_STATUS_set,
unconfig 633 PACM 602
vbdbitmap 643 commands,
vbdmax 643 PACM_DYN_CONFIG_SNMP_ENGIN_BOOT_NUM_set, PACM
vbdmin 643 602
vbdnom 643 commands, restore, PACM 603
vp_stat 640 commands, save, PACM 603
dsp, DSP commands 633 commands, set, PACM 602
DSP jitsim commands, show, PACM 603
commands 644 Quality of Service 57
commands, debug 651 dynamicConfig, Main PACM commands 602
commands, delay 645
commands, disable 644
commands, drop 645
E
commands, enable 644 !ecache, RF commands 530
commands, jit_burst 649 echo cancellation 90
commands, jit_fixed 648 DSP commands 636
commands, jit_off 647 Echo Quality Index 372
commands, jit_random 649 echo_stat, DSP commands 640
commands, jit_random_win 650 echotail, DSP commands 637
commands, jit_rolling 650 ecpath_coeff, DSP commands 641
commands, jit_shift 648 eDVA
commands, loss_fixed 646 FQDN feature switch 85
commands, loss_off 646 line states 219
commands, loss_random 647 parameters, general 65
commands, settings 645 provisioning, SIP, refresh 146
commands, setvp 651 states 219
commands, vp_stat 652 eMTA see E-UE.
dsp_reset, Voice CallP commands 686 enable
dsPdsp1Configuration, DOCSIS Fw commands 574 DSP jitsim commands 644
dsPdsp2Configuration, DOCSIS Fw commands 574 ifIndex shift feature switch 84
dsPhs, DOCSIS Fw commands 574 Logger commands 613
dsstatus, DOCSIS Debug commands 581 message tracing 235
DST policy 273 System PP commands 555
setting 21 TurboDox 590
dst, Voice CallP commands 667 enableidle, Voice Linecard commands commands 665
dstatus, RF commands 516 enableL2vpnPromMode, DOCSIS Pp commands 590
dsUnicast, DOCSIS Fw commands 575 enableTdox, DOCSIS Pp commands 590
DSx enabling
DQoS feature switch 75 DSx log 669
log, displaying 669 signalling log 668
log, enabling 669 SNMP access 245
log, erasing 669 encryption
message trace logs 234 RTP/RTCP feature switch, AES 75
QoS 57 parameters, SDP, AES 75
dsxClrLog, Voice CallP commands 669 end
dsxDispLog, Voice CallP commands 669 connection statistics 364
dsxEnblLog, Voice CallP commands 669 connection statistics, clearing counters 365
dsxtrace, Voice CallP commands 671 connection statistics, device level 366
dt_cleanup, DSP commands 642 connection statistics, line level 367
dt_setup, DSP commands 642 statistics 686
DTMF endpoint, lockstep quarantine 75
with, RFC2833 83, 99 Enhanced Firmware Loading 47
relay 60, 92 enterprise numbers 215
transmission, inband 121 Entity, overriding, SNMP 32
RFC2833 feature switch, send 75, 92 eoc_stats, Voice CallP commands 686
dtmf, Voice CallP commands 673 EPROM checksums, battery, verify 514
dtune, RF commands 519 eprom, Telemetry commands 514
dual-mode 58 equadump, DOCSIS Debug commands 579
dump equthresh, DOCSIS Debug commands 579
DOCSIS Debug commands 580 erasing
RF commands 520 DSx log 669
dumpdm, Voice CallP commands 690 signalling log 669
Dynamic eRouter see gateway.
commands, eRouter considerations, IPv6 29
PACM_DYN_CONFIG_LOOPV_MAINT_TIMER_CD_set, err_stat, DSP commands 638
PACM 602 errors, Voice Linecard commands commands 660
commands, PACM_DYN_CONFIG_LOOPV_POLICY_set, errStats, DOCSIS Fw commands 568
PACM 602 etsi, Voice CallP commands 685
commands, E-UE battery states 220
PACM_DYN_CONFIG_LOOPV_RESET_TIMER_set, PACM

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 715

European disabling the capability descriptor, CallP 93

flash support 85 DOCSIS 2.0 compatibility 75
provisioning considerations for 28 domain override 85
Event see Alarms; Logs. DSx DQoS 75
Event eDVA FQDN 85
commands, deleteLogFile, PACM 603 enable ifIndex shift 84
commands, displayEventTable, PACM 603 Force DQos 75
commands, printLogFile, PACM 603 halt on no ToD 84
commands, resetLogFile, PACM 603 ignore unlisted payloads 75
commands, resetTables, PACM 604 lockstep quarantine mode 75
commands, sendEvent, PACM 603 MTA 84
screen 442 MTA coexistence 84
event, Main PACM commands 603 MTA maxCpeAllowed bypass 84
Event mtaFilterBypass 84
DefaultEventTables 614 NCS piggyback 75
ExitManager 617 NCS redirect 75
GetEventsList 615 non-sequential Caller ID 75
GetSyslogServer 617 omit MPTIME parameter 75
GetThrotParams 616 Payload Header Suppression 75
ResetLog 614 provisional response 75
SendEvent 613 RFC2833 payload type 94 75, 92
SendStdTrap 614 RFC2833, related 82, 98
SetEventLevel 614 RFC3323 privacy header 85
SetEventMask 615 RFC3842 handshake 85
SetEventText 615 send DTMF via RFC2833 75, 92
SetPriorityMask 615 SIP 85
SetThrotAdmin 616 SIP proxy penalty box 85
SetThrotInterval 616 skip USM user name comparison 84
SetThrotThresh 616 SRV lookup 85
StartSNMP 617 T.38 capability descriptor 75
StartSyslog 616 features
StopSNMP 617 SIP hybrid 199
StopSyslog 617 supported, SIP dialing 197
events field, hardware revision 360
ARRIS 222 file, XML configuration 495
PacketCable 232 FilenameConfig, Logger commands 608
reporting 215 filenameShow, Logger commands 613
exception, System sub-mode commands 504 filtering, IPv6 traffic 211
ExitManager, Event Manager commands 617 filters, DOCSIS Pp commands 591
extended firmware
offhook processing 146 download center 6
signaling, PacketCable 1.5 100 functionality 6
upgrade, from NCS loads to SIP 45
upgrade, from SIP loads to NCS 45
F upgrade, MIB 50
factory defaults upgrade options 49
alarm, Unit has been restored to 231 upgrade, process 47
reset to 429 upgrading 47
failure upgrading, through provisioning 45
operation, power 206 upgrading, through SNMP 46
recovery, network 233 version 360
response tones, configuring SIP 167 flash
FAX relay, SuperG3 689 feature switch, Advanced 85
fax relay, T.38 93 LED commands 506
FAX, SuperG3 104 processing, hook 188, 196
fax support, G.729 63 support, European 85
fax/modem support 90 provisioning hook 123
fax-only timings, default hook 464
line 101, 188 for coexistence, SNMP, configuration 246
mode 102–103, 201 Force DQos feature switch 75
feature force_lkup, Voice CallP commands, dnsTools sub-mode 692
access-only DQos 75 ForceDsPSM, DOCSIS Debug commands 588
Advanced flash 85 ForceRngRspAbort, DOCSIS Debug commands 585
AES encryption for RTP/RTCP 75 ForceRngRspDRW, DOCSIS Debug commands 586
affecting SDP 79, 94 ForceRngRspFreq, DOCSIS Debug commands 585
bracketed IP address 75 ForceRngRspPowerOffset, DOCSIS Debug commands 586
bypass hash checking 84 ForceT4Multiplier, DOCSIS Debug commands 585
bypass KDC load balancer checks 84 ForceUsPSM, DOCSIS Debug commands 588
bypass SNMP INFORM checks 84 FQDN
delay DLCX 75 and IP address, hiding 217, 444
disable CW-CID 85 feature switch, eDVA 85
disable hash checking 84

Firmware Guide Release 7.5 Standard 1.2 August 2012

716 Chapter 12

freeChannel, DSP commands 634 gQosDbHostConfigArray, DOCSIS Fw commands 573

freqband, RF commands 517 gQosDbPhsInfo, DOCSIS Fw commands 573
frequencies, provisioning, preset 118 guardTimeStats, DOCSIS Fw commands 569
frequency gUpstreamBpiInfo, DOCSIS Fw commands 574
band, downstream 517 gUsChannelConfigInfo, DOCSIS Fw commands 574
configuring ring 108 gUsChannelPrivateInfo, DOCSIS Fw commands 574
from gw_diag, System sub-mode commands 504
NCS loads to SIP, firmware upgrade 45
SIP loads to NCS, firmware upgrade 45
FSK gain level 114
H
ftrsw, Voice CallP commands 672 halt on no ToD feature switch 84
FullDisplay, Logger commands 609 handling, SIP call rejection 85
functionality, firmware 6 handshake feature switch, RFC3842 85
FunctionLineDisplay, Logger commands 609 hardware
Fw, Main DOCSIS commands 566 model number 360
field 360
Hardware/Firmware Versions screen 441
G hash checking
G.729 feature switch, bypass 84
bandwidth considerations 63 feature switch, disable 84
CODEC negotiation 61 hashBypassSet, PACM Provisioning sub-commands 594
CODEC support 60 header feature switch, RFC3323 privacy 85
fax support 63 headers, remove authorization 85
modem support 63 help
gain General Console Commands 500
tone generation 114 Voice common commands 619
provisioning 114 hiding FQDN and IP address 217, 444
level, CAS 114 hook
level, FSK 114 flash processing 188, 196
off-hook 114 flash timing, provisioning 123
gain_req, DSP commands 641 flash timings, default 464
Gateway has reset, alarm 230 Voice Linecard commands commands 659
gateway, IPv6 129 hotline 199
Gateway hwcounters, DOCSIS General commands 565
commit 533 hybrid features, SIP 199
!defaults 533
dmz 533
get 531
I
ping 532 IDLE for unprovisioned lines, show OOS instead of 75
rc 532 idle, Voice Linecard commands commands 660
reset 532 if, DOCSIS Pp commands 590
search 531 ifAdminOperStatus, MIB 289, 368
set 531 ifAdminStatus, MIB 191, 299, 424, 688
wrmStatus 533 ifIndex
General MIB 26–27, 72–73, 84, 164, 289, 294, 317, 325, 332, 362
help 500 shift feature switch, enable 84
persist 500 ifPhysAddress, MIB 29
!reset 500 ifSpeed, MIB 318
status 499 ifTable, MIB 27
general ignore unlisted payloads feature switch 75
eDVA parameters 65 image version, BootROM 360
Main mode 553 inactivity timer, CLI 503
General, Main DOCSIS commands 564 inband DTMF transmission 121
generating index scheme, interface 26
list of passwords 432 indication dialing, SIP, busy 200
single password 432 Indicator, Message Waiting 85
passwords, PWoD tool 432 info
generation DSP commands 644
automatic OSI 689 Logger commands 613
gain compensated tone 114 INFORM checks feature switch, bypass SNMP 84
get, Gateway sub-mode commands 531 initDsUsFreqDb, DOCSIS Debug commands 584
GetEventsList, Event Manager commands 615 in-service, line 688
get-pompt, DOCSIS Psm commands 592 interface
getSig, Voice MTA commands 694 controlling access, troubleshooting 439
GetSyslogServer, Event Manager commands 617 interface index 424
GetThrotParams, Event Manager commands 616 index scheme 26
gettimers, Voice CallP commands 690 intget, Database commands 516
global, System PP commands 556 IP
goto, DOCSIS General commands 564 feature switch, bracketed 75
gQosDbClusterArray, DOCSIS Fw commands 573 hiding FQDN and 217, 444
gQosDbFwPrivateArray, DOCSIS Fw commands 572 ports 26
security 25, 67

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 717

ipcable, DOCSIS General commands 564 lease time request, DHCP 30

IPsec 25, 67 LED
IPv4/IPv6 override 41 color, controlling 66
IPv6 commands, all_off 506
behavior, DHCP 43 commands, all_on 506
eRouter considerations 29 commands, all_on_green 506
gateway 129 commands, flash 506
management 211 commands, resume 506
multicast support 208 level
provisioning modes 42 CAS gain 114
provisioning notes 42 end of call connection statistics, line 367
SNMP coexistence 212 FSK gain 114
traffic filtering 211 level_stat, DSP commands 639
is, Voice CallP commands 688 levels
isrmask, DOCSIS Debug commands 583 CLI access 398
isrStats, DOCSIS Fw commands 567 WebGUI access 398
iucEnList, DOCSIS Fw commands 571 limitations, service flow 20
line
diagnostics 654
J diagnostics, running 419
jit_burst, DSP jitsim commands 649 over temperature 368
jit_fixed, DSP jitsim commands 648 over-current protection state 207
jit_off, DSP jitsim commands 647 over-temperature 368
jit_random, DSP jitsim commands 649 polarity 684
jit_random_win, DSP jitsim commands 650 fax-only 101, 188
jit_rolling, DSP jitsim commands 650 in-service 688
jit_shift, DSP jitsim commands 648 level, end of call connection statistics 367
jitsim commands out of service 688
debug, DSP 651 ports, voice 26
delay, DSP 645 eDVA 219
disable, DSP 644 status, persistent 65, 690
drop, DSP 645 Linecard
DSP 644 commands, batcal, Voice 666
enable, DSP 644 commands commands, cal_dump, Voice 665
jit_burst, DSP 649 commands commands, deprovision, Voice 654
jit_fixed, DSP 648 commands commands, diag, Voice 654
jit_off, DSP 647 commands commands, diagForce, Voice 655
jit_random, DSP 649 commands commands, dresults, Voice 655
jit_random_win, DSP 650 commands commands, enableidle, Voice 665
jit_rolling, DSP 650 commands commands, errors, Voice 660
jit_shift, DSP 648 commands commands, hook, Voice 659
loss_fixed, DSP 646 commands commands, idle, Voice 660
loss_off, DSP 646 commands commands, lcstatus, Voice 664
loss_random, DSP 647 commands commands, loopc, Voice 658
settings, DSP 645 commands commands, lpdiag, Voice 656
setvp, DSP 651 commands commands, lpdiagForce, Voice 656
vp_stat, DSP 652 commands commands, lpresults, Voice 657
jitter commands commands, objdump, Voice 654
buffer, custom 107 commands commands, polarity, Voice 658
buffer override 643 commands commands, provision, Voice 654
buffer, provisioning 105 commands commands, read, Voice 653
buffers, adaptive 90 commands commands, regdump, Voice 653
measurement 368 commands commands, ring, Voice 657
jittermode, DSP commands 635 commands commands, ringfreq, Voice 663
commands commands, rread, Voice 654
commands commands, state, Voice 662
K commands commands, template, Voice 661
KDC see Key Distribution Center. commands commands, tone, Voice 659
KDC load balancer checks feature switch, bypass 84 commands commands, vbat, Voice 663
Kerberos through DHCP 40 commands commands, write, Voice 653
commands commands, xconnect, Voice 660
commands, polling, Voice 666
L linecard
L2VPN provisioning 54 set template 661
last status, display 664
reset reason log 503 lineInfo, Voice CallP commands 682
sent, signaling message 367 lines
lastreset, System sub-mode commands 503 post-provisioning SIP 146
latency, measured 368 show OOS instead of IDLE for unprovisioned 75
lcquery, Voice CallP commands 683 list
lcstatus, Voice Linecard commands commands 664 considerations, SDP parameter 100
CPE 21

Firmware Guide Release 7.5 Standard 1.2 August 2012

718 Chapter 12

Logger commands 613 targetsList 612

passwords, generating 432 TimeDisplay 609
System SME commands 557 UserDisplay 610
listDocsisModules, Main DOCSIS commands 561 logging, Persistent 500
lists, downstream channel 27 logs
llong, System SME commands 558 clear CallP 239
load balancer checks feature switch, bypass KDC 84 clear DHCP 239
loads, upgrading DHCP message trace 234
upgrading, NCS 45 display 236
upgrading, SIP 45 display message 237
local busy tone, SIP 85 DSx message trace 234
lockstep MGCP message trace 234
quarantine, endpoint 75 SNMP, view 236
quarantine mode feature switch 75 loop
log current, configuring 68
displaying, DSx 669 diagnostics 656–657
displaying, signalling 668 diagnostics, running 420
enabling, DSx 669 management 70
enabling, signalling 668 management, plant maintenance timer 71
erasing, DSx 669 voltage management, setting 73
erasing, signalling 669 loopback test
last reset reason 503 remote 460
MTA PROV: Successful 224 SIP 460
MTA TFTP: Successful 224 loopc, Voice Linecard commands commands 658
Power Supply Telemetry 224 looprx, DSP commands 637
SSH LOGIN ACCEPTED 226 looptx, DSP commands 637
SSH LOGIN REJECTED 226 loss, AC power 206
Touchstone Firmware Upgrade Failed 228 loss_fixed, DSP jitsim commands 646
Touchstone Firmware Upgrade Failed Before Download loss_off, DSP jitsim commands 646
Attempt 227 loss_random, DSP jitsim commands 647
Touchstone Firmware Upgrade Successful 228 lpdiag, Voice Linecard commands commands 656
Touchstone SW Upgrade Aborted due to Battery AC-FAIL lpdiagForce, Voice Linecard commands commands 656
condition 229 lpresults, Voice Linecard commands commands 657
Touchstone SW Upgrade Aborted due to Call in Progress lshort, System SME commands 557
229
Touchstone SW Upgrade Reboot Delayed due to Call in
Progress 229
M
Voice Line Diag Failed 222 macaddr, DOCSIS General commands 565
Voice Line Diag Passed 223 macread
Voice Line Protection State Change 223 DOCSIS Debug commands 579
Voice Line State Change 223 RF commands 521
Logger commands macwrite
AllComponentsConfig 608 DOCSIS Debug commands 579
AllDebugModulesConfig 609 RF commands 521
AllModulesConfig 608 Main
AllSeveritiesConfig 608 DOCSIS commands, Atp 565
ComponentConfig 608 DOCSIS commands, cerreset 560
ComponentDisplay 609 DOCSIS commands, Certification 563
componentsList 610 DOCSIS commands, cmstatus 561
DebugModulesConfig 609 DOCSIS commands, configDocsisModule 561
DefaultDisplay 610 DOCSIS commands, Debug 578
disable 613 DOCSIS commands, Dsid 588
displayConfigList 612 DOCSIS commands, Fw 566
enable 613 DOCSIS commands, General 564
FilenameConfig 608 DOCSIS commands, listDocsisModules 561
filenameShow 613 DOCSIS commands, phystatus 559
FullDisplay 609 DOCSIS commands, Pp 590
FunctionLineDisplay 609 DOCSIS commands, Psm 591
info 613 DOCSIS commands, Qos 575
list 613 DOCSIS commands, scan 560
ModuleConfig 608 DOCSIS commands, Show 561
ModuleDisplay 609 DOCSIS commands, statustuner 560
modulesList 610 DOCSIS commands, testDsLoss 561
QueueLimitConfig 609 DOCSIS commands, tuner 560
queueLimitShow 613 DOCSIS commands, version 559
setDefaults 613 commands 553
severitiesList 611 general information 553
SeverityConfig 608 PACM commands, debugMenu 604
ShortDisplay 610 PACM commands, dynamicConfig 602
SocketConfig 608 PACM commands, event 603
socketShow 612 PACM commands, managerMenu 606
TargetConfig 610 PACM commands, options 593

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 719

PACM commands, production 601 MGCP message trace logs 234

PACM commands, provisioning 593 mgcp, Voice CallP commands 671
PACM commands, security 595 MIB
PACM commands, vendorSubMenu 597 arris 361
PACM commands, version 592 arrisCmDevClearCachedFrequencies 118
commands, memory 554 arrisCmDevClearPresetFrequencies 118
commands, netrxReduce 555 arrisCmDevDualModeDiscoveredMarket 59
commands, netrxRestore 555 arrisCmDevHttpClientSeed 433
commands, network 554 arrisCmDevPresetFrequency 118
commands, pp 555 arrisCmDevProvMethodIndicator 38
commands, sme 557 arrisCmDoc30 271
commands, timers 555 arrisCmDoc30AccessClientSeed 271, 440
management arrisCmDoc30AccessHttpLan 272, 439
IPv6 211 arrisCmDoc30AccessHttpPwCtrl 272, 439
loop voltage 70 arrisCmDoc30AccessHttpTimeout 272, 440
Model 8 power 269 arrisCmDoc30AccessHttpWan 272, 439
plant maintenance timer, loop voltage 71 arrisCmDoc30AccessSinglePassword 272, 440
setting, loop voltage 73 arrisCmDoc30AccessSSHEnable 272, 436–437
Manager commands arrisCmDoc30AccessTelnetEnable 271, 398, 436–437
PACM_MANAGER_HITLESS_DHCP_set, PACM 606 arrisCmDoc30AccessTelnetPassword 271–272, 436–437
arrisCmDoc30BaseReportDuplex 271
PACM_MANAGER_HITLESS_SOFTWARE_DOWNLOAD_set, arrisCmDoc30BondingMode 56, 271
PACM 606 arrisCmDoc30CLITimeout 272, 437
PACM_MANAGER_PSM_ENABLE_set, PACM 607 arrisCmDoc30DhcpCmConfigFile 214, 278
PACM_MANAGER_RANDOM_USM_SPIN_LOCK_set, arrisCmDoc30DhcpCmGatewayIpAddr 214, 278
PACM 606 arrisCmDoc30DhcpCmIpAddr 214, 278
arrisCmDoc30DhcpCmIpAddrType 213, 278
PACM_MANAGER_SNMP_RESTRICT_CONFIG_VIEW_set, arrisCmDoc30DhcpCmParameters 213, 277
PACM 606 arrisCmDoc30DhcpCmSubNetMask 214, 278
PACM_MANAGER_TOD_DELAY_SEC_PROV_set, PACM arrisCmDoc30DhcpCmTimeOffset 278
606 arrisCmDoc30DhcpExtendedActiveMode 279
PACM_MANAGER_VENDOR_CMS_AS_IP_set, PACM arrisCmDoc30DhcpExtendedCmConfigFile 281
607 arrisCmDoc30DhcpExtendedCmGatewayIpAddr 281
arrisCmDoc30DhcpExtendedCmIpAddr 281
PACM_MANAGER_VENDOR_COMMUNITY_NAME_set, arrisCmDoc30DhcpExtendedCmParametersType 281
PACM 607 arrisCmDoc30DhcpExtendedCmPrefix 281
PACM_MANAGER_VENDOR_ENABLE_EVENTS_set, arrisCmDoc30DhcpExtendedCmSubNetMask 281
PACM 607 arrisCmDoc30DhcpExtendedCmTimeOffset 280
PACM_MANAGER_VOICE_DECT_IF_set, PACM 606 arrisCmDoc30DhcpExtendedLeaseParametersType 279
PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set, arrisCmDoc30DhcpExtendedLeaseTimeRemaining 279
PACM 606 arrisCmDoc30DhcpExtendedOfferedLeaseTime 279
PACM_MANAGER_VOICE_VLM_IF_set, PACM 606 arrisCmDoc30DhcpExtendedPreferredMode 279
restore, PACM 607 arrisCmDoc30DhcpExtendedPrimaryDhcpServerIpAddr 280
save, PACM 607 arrisCmDoc30DhcpExtendedPrimaryTeleDhcpSvr 281
show, PACM 607 arrisCmDoc30DhcpExtendedProvisionedMode 279
managerMenu, Main PACM commands 606 arrisCmDoc30DhcpExtendedSecondaryTeleDhcpSvr 281
managing Voice Quality Monitoring 371 arrisCmDoc30DhcpExtendedState 280
mapperStats, DOCSIS Fw commands 566 arrisCmDoc30DhcpExtendedSvrParametersType 280
maxCpeAllowed bypass feature switch, MTA 84 arrisCmDoc30DhcpExtendedTftpSvrIpAddr 280
maximum UDP packet size, SIP 192 arrisCmDoc30DhcpExtendedTimeSvrIpAddr 280
maxjitter, DSP commands 636 arrisCmDoc30DhcpExtendedTimeUntilRebind 279
mbxStats, DOCSIS Fw commands 567 arrisCmDoc30DhcpExtendedTimeUntilRenew 279
mcastDsids, DOCSIS Dsid commands 589 arrisCmDoc30DhcpLeaseParameters 277
MDD override 41 arrisCmDoc30DhcpLeaseTimeRemaining 277
mdfMode, DOCSIS Dsid commands 588 arrisCmDoc30DhcpMtaOpt60Override 279
mdfy_rtp, Voice CallP commands 687 arrisCmDoc30DhcpMtaParameters 277
measured latency 368 arrisCmDoc30DhcpPrimaryDhcpServerIpAddr 278
measurement, jitter 368 arrisCmDoc30DhcpPrimaryTeleDhcpSvr 278
memory, Main System commands 554 arrisCmDoc30DhcpSecondaryTeleDhcpSvr 278
message arrisCmDoc30DhcpState 277
last sent, signaling 367 arrisCmDoc30DhcpSvrParameters 277
logs, display 237 arrisCmDoc30DhcpTftpSvrIpAddr 278
trace logs, DHCP 234 arrisCmDoc30DhcpTimeSvrIpAddr 278
trace logs, DSx 234 arrisCmDoc30DhcpTimeUntilRebind 277
trace logs, MGCP 234 arrisCmDoc30DhcpTimeUntilRenew 277
tracing, enable 235 arrisCmDoc30FwImageBuildTime 271
Message Waiting Indicator 85 arrisCmDoc30FwImageName 271
metrics, remote 379 arrisCmDoc30LastHwResetReason 281
mfgcert, DOCSIS Certification commands 563 arrisCmDoc30MfgCertCommunityName 271
mft_close, DSP commands 642 arrisCmDoc30ProvisionedChannelIDs 267, 271
mft_open, DSP commands 642 arrisCmDoc30ResetAccessTime 271
arrisCmDoc30ResetFactoryDefaults 271

Firmware Guide Release 7.5 Standard 1.2 August 2012

720 Chapter 12

arrisCmDoc30ResetReasonLogText 281 arrisMtaDevCustomMaxJitterBuffer 105, 107, 296

arrisCmDoc30RestoreFactoryDefaults 429 arrisMtaDevCustomMinJitterBuffer 105, 107, 296
arrisCmDoc30SetupAdvancedWebPageAccess 275 arrisMtaDevCustomNomJitterBuffer 105, 107, 296
arrisCmDoc30SetupDhcpRetries 274 arrisMtaDevDefaultReasonNoCIDName 22, 295
arrisCmDoc30SetupDsBonding 56, 272 arrisMtaDevDhcpNoSvcImpact 229–230
arrisCmDoc30SetupDSTPolicy 21, 273 arrisMtaDevDhcpOptionOverride 40, 295
arrisCmDoc30SetupEthernetLinkBounce 276 arrisMtaDevDhcpSubOpt3Immediate 32, 298
arrisCmDoc30SetupIgnoreMddSymbolClockIndicator 277 arrisMtaDevDiagLoopForeignEmfTest 302
arrisCmDoc30SetupInvertMulticolorLEDs 66, 274 arrisMtaDevDiagLoopHazardousPotentialTest 302
arrisCmDoc30SetupKeepCpeOnIfDisconnect 276 arrisMtaDevDiagLoopLastResult 301, 424
arrisCmDoc30SetupL2VPNPromiscuousMode 277 arrisMtaDevDiagLoopReceiverOffHookTest 302
arrisCmDoc30SetupMddIpModeOverride 41–43, 274, 586 arrisMtaDevDiagLoopRequest 301, 424
arrisCmDoc30SetupMdfSupportOverride 275 arrisMtaDevDiagLoopResistiveFaultsTest 302
arrisCmDoc30SetupMultiColorLedBitmap 66, 272, 401, 403 arrisMtaDevDiagLoopRingerTest 302
arrisCmDoc30SetupPacketCableRegion 58, 274 arrisMtaDevDiagLoopTable 423, 425
arrisCmDoc30SetupPacketProcessorEnable 272 arrisMtaDevDiagLoopTime 301, 424
arrisCmDoc30SetupPartServiceFallback20 268, 273 arrisMtaDevDocsQosParamUpSvcFlowSchedulingType 291
arrisCmDoc30SetupPowerSaveMode 269, 275 arrisMtaDevDocsQosParamUpSvcFlowSFID 290
arrisCmDoc30SetupPowerSaveOption 269, 276 arrisMtaDevDspCpsSetting 294, 642
arrisCmDoc30SetupPowerSaveWifiShutdownOnly 269, 276 arrisMtaDevDspHandleBellModemTone 297
arrisCmDoc30SetupReducedOORThreshold 275 arrisMtaDevDspHandleNonPhaseReversedTone 292
arrisCmDoc30SetupSecDsLossReinitEnable 268, 273 arrisMtaDevDTMFEndEventForceAscending 297
arrisCmDoc30SetupSWDLFilenameCheckOverride 50, 276 arrisMtaDevEchoCancellerTailLength 91, 292
arrisCmDoc30SetupTCPAckSuppression 277 arrisMtaDevEnableCallpSigTrace 240, 284, 687
arrisCmDoc30SetupTodDelaySecProv 274 arrisMtaDevEnableCallSigLastMsgRpt 236, 284–285, 287,
arrisCmDoc30SetupTODSyncTimeout 276 364, 367, 369
arrisCmDoc30SetupTODTimeOffset 20, 274 arrisMtaDevEnableCallStatsSyslogRpt 284, 364, 369
arrisCmDoc30SetupTurboDoxEnable 67, 275 arrisMtaDevEnableDHCPLog 235, 297
arrisCmDoc30SetupUdcAllowed 274 arrisMtaDevEnableIndexTenEleven 84, 294
arrisCmDoc30SpeedtestConfigEndUserGui 454 arrisMtaDevEnableLogging 235
arrisCmDoc30SpeedtestConfigSyslogReports 231 arrisMtaDevEnableMGCPLog 235, 297
arrisCmDoc30SwAdminStatus 47, 50, 52–54, 228 arrisMtaDevEndPntCallWaitingRepeatSteady 299
arrisCmDoc30SwCustomerLoadId 50, 53 arrisMtaDevEndPntCIDDateTimeEnable 299
arrisCmDoc30SwCvc1 54 arrisMtaDevEndPntCIDEnable 299
arrisCmDoc30SwCvc2 54 arrisMtaDevEndPntCIDNameEnable 299
arrisCmDoc30SwCvc3 54 arrisMtaDevEndPntDialingMethod 121–122, 181, 298
arrisCmDoc30SwCvc4 54 arrisMtaDevEndPntFaxOnlyLineTimeout 101–102, 188, 298
arrisCmDoc30SwCvcStatus 54 arrisMtaDevEndPntGainControlRxVoice 116, 299
arrisCmDoc30SwFilename 48, 50, 53 arrisMtaDevEndPntGainControlTxVoice 116, 299
arrisCmDoc30SwHwModel 48, 50–51, 53 arrisMtaDevEndPntLoopReversal 299
arrisCmDoc30SwHwRev 48, 50, 53 arrisMtaDevEndPntRingingWaveform 68, 298
arrisCmDoc30SwOperStatus 50 arrisMtaDevEventFormat 289
arrisCmDoc30SwServerAddress 48, 50, 53 arrisMtaDevEventHideFQDNandIPAddress 295
arrisCmDoc30SwServerAddressType 48, 50, 53 arrisMtaDevEventHideMacFQDNandIPAddress 217, 444
arrisCmDoc30SwTable 47–48, 50, 53 arrisMtaDevGainControl 671
arrisMtaCfgRTPDynPortEnd 190, 192, 293–294 arrisMtaDevGainControlCAS 114–115, 300
arrisMtaCfgRTPDynPortStart 190, 192, 293–294 arrisMtaDevGainControlFSK 114–115, 300
arrisMtaDevActiveConnections 289 arrisMtaDevGainControlLocalDTMF 115, 300
arrisMtaDevAutomaticCallResourceRecovery 297 arrisMtaDevGainControlLocalTone 115, 300
arrisMtaDevAutomaticOsiDelay 75, 296 arrisMtaDevGainControlNetworkDTMF 115, 300
arrisMtaDevBase 240, 369 arrisMtaDevGainControlNetworkTone 115, 300
arrisMtaDevBatteryChargerFWRev 302 arrisMtaDevGainControlRxVoice 115, 299–300
arrisMtaDevBatteryEprom 307 arrisMtaDevGainControlTxVoice 115, 299–300
arrisMtaDevBatteryLastStateChange 307 arrisMtaDevInterfaceIndex 289
arrisMtaDevBatteryOperState 220, 306–307 arrisMtaDevLastCallEndTime 288, 366
arrisMtaDevBatteryOperSubState 307 arrisMtaDevLastCallStartTime 288, 366
arrisMtaDevBatteryOrderingCode 307 arrisMtaDevLevelControlCAS 301
arrisMtaDevCallStatsAvgJitter 288, 367–368 arrisMtaDevLevelControlFSK 301
arrisMtaDevCallStatsAvgLatency 288, 368 arrisMtaDevLevelControlOffHookCAS 114–115, 301
arrisMtaDevCallStatsEndPntOpStatus 289, 368 arrisMtaDevLevelControlOffHookEnable 114–115, 301
arrisMtaDevCallStatsEntry 365 arrisMtaDevLevelControlOffHookFSK 114–115, 301
arrisMtaDevCallStatsHookStatus 288, 368 arrisMtaDevLineCardState 75
arrisMtaDevCallStatsLineSubState 289 arrisMtaDevLineMWIActive 290
arrisMtaDevCallStatsMaxJitter 288, 368 arrisMTADevLineRTCPXR 290
arrisMtaDevCallStatsRtpPercentPktsLost 288, 368 arrisMtaDevLineRTCPXR 290
arrisMtaDevCallStatsRtpRxPkts 288, 368 arrisMtaDevLineRTCPXRNegotiatedConnectionA 290
arrisMtaDevCallStatsRtpTxPkts 288, 368 arrisMtaDevLineRTCPXRNegotiatedConnectionB 290
arrisMtaDevCallStatsSLICStatus 289, 368 arrisMtaDevMaxCallPServiceFlows 298
arrisMtaDevClearDHCPLog 297 arrisMtaDevMaxCpeAllowed 289
arrisMtaDevClearMGCPLog 297 arrisMtaDevNetworkAccess 289
arrisMtaDevControl 284, 365 arrisMtaDevNsadSwDnldStatus 285
arrisMtaDevCustomJitterBufferEnabled 105, 107, 296 arrisMtaDevOffHookFskDelay 22, 297

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 721

arrisMtaDevPacketcableProvisioningFlow 293–294 arrisMtaDevVbdOverwriteLineBitmap 105–106, 294–295

arrisMtaDevPersistentLineStatus 65, 299 arrisMtaDevVbdOverwriteMaxJitterBuffer 105–106, 295
arrisMtaDevPktcDevEvEndpointName 289 arrisMtaDevVbdOverwriteMinJitterBuffer 105–106, 294
arrisMtaDevProvMethodIndicator 37, 292 arrisMtaDevVbdOverwriteNomJitterBuffer 105–106, 295
arrisMtaDevProvState 286 arrisMtaDevVPJitterBufferMode 105–106, 292
arrisMtaDevPwrSupplyAlarm 302 arrisMtaDevVPMaxJitterBuffer 105–106, 294, 296
arrisMtaDevPwrSupplyBase 302 arrisMtaDevVPNomJitterBuffer 105–106, 292, 296
arrisMtaDevPwrSupplyBatAvailableMinutes 304, 306 arrisMtaDevVqm 378
arrisMtaDevPwrSupplyBatAvailableMinutes2 306 arrisMtaDevVqmCallNumberIdentifier 291, 379, 381–382
arrisMtaDevPwrSupplyBatRatedMinutes 306 arrisMtaDevVqmCallNumberIdentifierLastCall 292, 379,
arrisMtaDevPwrSupplyBatRatedMinutes2 306 381
arrisMtaDevPwrSupplyBatStateOfCharge 306 arrisMtaDevVqmCallNumberIds 291, 378–379
arrisMtaDevPwrSupplyBatteryTest 303 arrisMtaDevVqmCallNumberTable 291, 378, 381
arrisMtaDevPwrSupplyBatteryTestTime 305 arrisMtaDevVqmClear 291, 387
arrisMtaDevPwrSupplyChargeState 303, 305 arrisMtaDevVqmEnable 291, 380
arrisMtaDevPwrSupplyConfigReplaceBatTime 304 arrisMtaDevVqmEnableRemote 290–291, 379–380
arrisMtaDevPwrSupplyConfigReplaceBatTime2 304 arrisMtaDevVqmHistorySize 292, 379–380
arrisMtaDevPwrSupplyConfigRunTime 304 arrisMtaDevVqmLine 291, 378, 381, 387
arrisMtaDevPwrSupplyControl 302 arrisMtaDevVqmMetricIndex 292
arrisMtaDevPwrSupplyControlChargerReset 305 arrisMtaDevVqmMetricTable 291, 379, 381–382
arrisMtaDevPwrSupplyDataShutdownTime 206, 269, 305 arrisMtaDevVqmMetricValues 379
arrisMtaDevPwrSupplyEnableDataShutdown 206, 269, 303 arrisMtaDevVqmThresholdEnable 291, 379, 387
arrisMtaDevPwrSupplyFullChargeTime 305 arrisMtaDevVqmThresholds 371, 379, 387
arrisMtaDevPwrSupplyHighestTemperature 207, 305 arrisMtaDoc30AdjustCallpFeatureSwitch 23
arrisMtaDevPwrSupplyHighestTemperatureClear 207, 305 arrisMtaDoc30DhcpOfferedLeaseTime 277
arrisMtaDevPwrSupplyHighestTemperatureTime 207, 305 arrisRouterAdminPassword 349
arrisMtaDevPwrSupplyHiTempBatteryShutdownControl arrisRouterAdminTimeout 349
304 arrisRouterApplyAllSettings 128
arrisMtaDevPwrSupplyLowBatteryThresh 220, 303 arrisRouterAuthPassword 353
arrisMtaDevPwrSupplyOverTempAlarmControl 207, arrisRouterAuthType 353
304–305 arrisRouterAuthUserName 353
arrisMtaDevPwrSupplyOverTempAlarmThreshold 304 arrisRouterBlackListClear 345
arrisMtaDevPwrSupplyRatedBatCapacity 305 arrisRouterBlackListCount 345
arrisMtaDevPwrSupplyReadBatteryPwr 306 arrisRouterBlackListDomain 346
arrisMtaDevPwrSupplyReplaceBatThresh 303 arrisRouterBlackListFreeIdx 345
arrisMtaDevPwrSupplySecondsOnBattery 306 arrisRouterBlackListStatus 347
arrisMtaDevPwrSupplySecondsOnBattery2 306 arrisRouterBlackListTable 345
arrisMtaDevPwrSupplyStats 302 arrisRouterBlackListTOD 346
arrisMtaDevPwrSupplyTelemetryValues 306 arrisRouterBootCodeVersion 349
arrisMtaDevPwrSupplyTemperature 304 arrisRouterBssAccessMode 329, 332
arrisMtaDevPwrSupplyTestedBatCapacity 306 arrisRouterBssActive 329
arrisMtaDevPwrSupplyTimers 302 arrisRouterBssID 329
arrisMtaDevPwrSupplyTypicalIdlePwr 303 arrisRouterBssMACAccessClear 330
arrisMtaDevQosMode 289 arrisRouterBssMACAccessCount 330
arrisMtaDevResetCallStats 284–288, 365–366 arrisRouterBssNetworkIsolate 330
arrisMtaDevRestoreNvmFactoryDefault 285 arrisRouterBssSecurityMode 329
arrisMtaDevRtcpTosValue 66, 296 arrisRouterBssSSID 329
arrisMtaDevRtpPercentPktsLostTotal 284, 286, 365–366 arrisRouterBssSSIDBroadcast 329
arrisMtaDevRtpPktsLostTotal 287, 366 arrisRouterChangeLogInfo 352
arrisMtaDevRtpRxPktsTotal 284–285, 365–366 arrisRouterChangeLogTable 352
arrisMtaDevRtpTxPktsTotal 284–285, 365–366 arrisRouterChangeLogTime 352
arrisMtaDevRTPTxQueueSize 292 arrisRouterClearMSOLogs 352
arrisMtaDevSignalingAvgLatency 284, 287, 365–366 arrisRouterCurrentTime 350
arrisMtaDevSignalingLastMsg1 234, 236, 285, 287, 367 arrisRouterCustomID 350
arrisMtaDevSignalingLastMsg16 234, 236, 285, 367 arrisRouterCustomSettings 349
arrisMtaDevSignalingRxNAKCnt 284, 287, 366–367 arrisRouterDebugLogInfo 352
arrisMtaDevSignalingRxNoACKCnt 284, 287, 366–367 arrisRouterDebugLogTable 352
arrisMtaDevSignalingRxSuccessfulMsgCnt 284, 287, arrisRouterDebugLogTime 352
365–366 arrisRouterDefaults 349
arrisMtaDevSignalingTxNAKCnt 284, 287, 366–367 arrisRouterDeviceUpDownEnd 320
arrisMtaDevSignalingTxSuccessfulMsgCnt 284, 287, arrisRouterDeviceUpDownIPAddr 319
365–366 arrisRouterDeviceUpDownIPType 319
arrisMtaDevSipConfigFileURL 147, 295 arrisRouterDeviceUpDownStart 319
arrisMtaDevSipDwnldConfig 147, 295 arrisRouterDeviceUpDownStatus 320
arrisMtaDevSpecialConfigurationOverrideEnable 296 arrisRouterDSLiteWanEnable 129, 312
arrisMtaDevSuperG3FaxRelay 104, 297, 689 arrisRouterDSLiteWanLSNATAddr 130, 312
arrisMtaDevSwDnldNoSvcImpact 48, 229, 284–285 arrisRouterDSLiteWanLSNATAddrType 130, 312
arrisMtaDevSWUpgradeStatus 286 arrisRouterEmailAddress 351
arrisMtaDevT38Timeout 101, 104, 297 arrisRouterEmailApplySettings 351
arrisMtaDevTDDReportToCMS 297 arrisRouterEmailServerName 351
arrisMtaDevTFTPServerAddrOverrideFQDN 293, 295 arrisRouterEmailServerPW 351
arrisMtaDevTrace 365 arrisRouterEmailServerUser 351

Firmware Guide Release 7.5 Standard 1.2 August 2012

722 Chapter 12

arrisRouterEnableLogEmail 351 arrisRouterFWVirtSrvIPAddrType 340

arrisRouterEnableParentalCont 345 arrisRouterFWVirtSrvLocalPortEnd 341
arrisRouterEnableSNTP 350 arrisRouterFWVirtSrvLocalPortStart 341
arrisRouterFirewallLogTable 352 arrisRouterFWVirtSrvPortEnd 340
arrisRouterFirmwareVersion 349 arrisRouterFWVirtSrvPortStart 340
arrisRouterFWAllowAll 340 arrisRouterFWVirtSrvProtoType 340
arrisRouterFWAllowICMP 339 arrisRouterFWVirtSrvRowStatus 341
arrisRouterFWApplySettings 339 arrisRouterFWVirtSrvTableEnabled 340
arrisRouterFWBlockFragIPPkts 343 arrisRouterFWVirtSrvTOD 340
arrisRouterFWBlockHTTP 339 arrisRouterFWVSSrcPortExclude 340
arrisRouterFWBlockICMP 339 arrisRouterHardwareVersion 349
arrisRouterFWBlockIdent 339 arrisRouterHostAccess 308
arrisRouterFWBlockMulticast 340 arrisRouterInboundTrafficLogData 353
arrisRouterFWBlockP2P 339 arrisRouterKeywordBlkStatus 346
arrisRouterFWCfg 308 arrisRouterKeywordBlkTable 345
arrisRouterFWDDNSDomainName 344 arrisRouterKeywordBlkTOD 346
arrisRouterFWDDNSEnable 343 arrisRouterKeywordBlkWord 346
arrisRouterFWDDNSIPAddr 344 arrisRouterKeywordClear 345
arrisRouterFWDDNSIPAddrType 344 arrisRouterKeywordCount 345
arrisRouterFWDDNSPassword 344 arrisRouterKeywordTableFreeIdx 345
arrisRouterFWDDNSStatus 344 arrisRouterLanClientAdapterType 318
arrisRouterFWDDNSType 344 arrisRouterLanClientComment 319
arrisRouterFWDDNSUserHame 344 arrisRouterLanClientCount 318
arrisRouterFWEnabled 338 arrisRouterLanClientCustom 319
arrisRouterFWEnableDMZ 338 arrisRouterLanClientCustomTable 318
arrisRouterFWEnableMulticast 344 arrisRouterLanClientHostName 318
arrisRouterFWEnableRemoteMgmt 344 arrisRouterLanClientInfLease 319
arrisRouterFWEnableRGPassThru 344 arrisRouterLanClientIPAddr 318
arrisRouterFWEnableWanBlocking 344 arrisRouterLanClientIPAddrType 318
arrisRouterFWEnableWanSNMP 344 arrisRouterLanClientLeaseEnd 319
arrisRouterFWEnableWanSSH 345 arrisRouterLanClientLeaseStart 319
arrisRouterFWFilterActiveX 343 arrisRouterLanClientLeaseState 319
arrisRouterFWFilterCookies 343 arrisRouterLanClientMAC 318
arrisRouterFWFilterJavaApplets 343 arrisRouterLanClientMACMfg 318
arrisRouterFWFilterPopupWnds 343 arrisRouterLanClientOnline 319
arrisRouterFWFilterProxy 343 arrisRouterLanClientRowStatus 319
arrisRouterFWIPAddrDMZ 338 arrisRouterLanClientStatus 319
arrisRouterFWIPAddrTypeDMZ 338 arrisRouterLanClientType 318–319
arrisRouterFWIPFilterDesc 341 arrisRouterLanConfig 308
arrisRouterFWIPFilterEndAddr 341 arrisRouterLanCPEAging 315
arrisRouterFWIPFilterEndType 341 arrisRouterLanCurrentClientAdapterType 321
arrisRouterFWIPFilterPortEnd 341 arrisRouterLanCurrentClientConnectionInfo 322
arrisRouterFWIPFilterPortStart 341 arrisRouterLanCurrentClientFirstSeen 322
arrisRouterFWIPFilterProtoType 341 arrisRouterLanCurrentClientHostName 321
arrisRouterFWIPFilterRowStatus 342 arrisRouterLanCurrentClientInfLease 322
arrisRouterFWIPFilterStartAddr 341 arrisRouterLanCurrentClientIPAddr 321
arrisRouterFWIPFilterStartType 341 arrisRouterLanCurrentClientIPAddrTextual 321
arrisRouterFWIPFilterTOD 341 arrisRouterLanCurrentClientIPAddrType 321
arrisRouterFWIPFloodDetect 343 arrisRouterLanCurrentClientLastSeen 322
arrisRouterFWIPSecPassThru 344 arrisRouterLanCurrentClientLeaseEnd 321
arrisRouterFWL2TPPassThru 344 arrisRouterLanCurrentClientLeaseStart 321–322
arrisRouterFWLogInfo 352 arrisRouterLanCurrentClientLeaseState 322
arrisRouterFWLogTime 352 arrisRouterLanCurrentClientLeaseTime 322
arrisRouterFWMACFilterAddr 342 arrisRouterLanCurrentClientMAC 321
arrisRouterFWMACFilterHostName 342 arrisRouterLanCurrentClientMACMfg 321
arrisRouterFWMACFilterRowStatus 342 arrisRouterLanCurrentClientStatus 321
arrisRouterFWMACFilterTable 340 arrisRouterLanCurrentClientTable 318
arrisRouterFWMACFilterTOD 342 arrisRouterLanCurrentClientType 321–322
arrisRouterFWPortScanProtect 343 arrisRouterLanCustomComments 320
arrisRouterFWPortTargPortEnd 343 arrisRouterLanCustomCount 318
arrisRouterFWPortTargPortStart 343 arrisRouterLanCustomFriendName 320
arrisRouterFWPortTrigDesc 342 arrisRouterLanCustomHostName 320
arrisRouterFWPortTrigPortEnd 343 arrisRouterLanCustomIPAddr 320
arrisRouterFWPortTrigPortStart 343 arrisRouterLanCustomIPAddrType 320
arrisRouterFWPortTrigProtoType 343 arrisRouterLanCustomMAC 320
arrisRouterFWPortTrigRowStatus 343 arrisRouterLanCustomMACMfg 320
arrisRouterFWPortTrigTableEnabled 340 arrisRouterLanCustomRowStatus 320
arrisRouterFWPPTPPassThru 344 arrisRouterLanDNSIPAddr 317
arrisRouterFWResetDefaults 339 arrisRouterLanDNSIPAddrType 317
arrisRouterFWSecurityLevel 339 arrisRouterLanDNSOverrideV6 129, 317
arrisRouterFWVirtSrvDesc 340 arrisRouterLanDNSRelayV6 129, 317
arrisRouterFWVirtSrvIPAddr 340 arrisRouterLanDNSRowStatus 317

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 723

arrisRouterLanDNSTable 128–129, 315, 317 arrisRouterPingPktSize 354

arrisRouterLanDomainName 314 arrisRouterPingPktsSent 355
arrisRouterLanDownRateLimit 314 arrisRouterPingRepliesReceived 355
arrisRouterLanEndDHCP 314 arrisRouterPingRepliesVerified 355
arrisRouterLanEndDHCPType 314 arrisRouterPingStartStop 355
arrisRouterLanEndDHCPV6 129, 316 arrisRouterPingTargetAddress 354
arrisRouterLanEnvironmentControl 316 arrisRouterPingTargetAddrType 353
arrisRouterLanEtherPortAuto 318 arrisRouterPingTimeout 354
arrisRouterLanEtherPortDuplex 317–318 arrisRouterPingVerifyReply 354
arrisRouterLanEtherPortEnabled 317 arrisRouterRadiusAddress 332
arrisRouterLanEtherPortIFIndex 317 arrisRouterRadiusAddressType 332
arrisRouterLanEtherPortSpeed 317–318 arrisRouterRadiusKey 332
arrisRouterLanFirewallOn 315 arrisRouterRadiusPort 332
arrisRouterLanGatewayIp 313 arrisRouterRadiusReAuthInterval 332
arrisRouterLanGatewayIp2 314 arrisRouterReboot 349
arrisRouterLanGatewayIp2Type 314 arrisRouterRIPAuthEnable 323
arrisRouterLanGatewayIpType 313 arrisRouterRIPAuthKeyChain 323
arrisRouterLanguage 349 arrisRouterRIPAuthKeyID 323
arrisRouterLanIPv6Mode 314 arrisRouterRIPAuthKeyString 323
arrisRouterLanLeaseTime 314 arrisRouterRIPEnable 323
arrisRouterLanLeaseTimeV6 129, 317 arrisRouterRIPIPAddr 323
arrisRouterLanLinkLocalAddressV6 317 arrisRouterRIPIPAddrType 323
arrisRouterLanMappedInterface 316 arrisRouterRIPPrefixLen 323–325
arrisRouterLanName 313 arrisRouterRIPReportTime 323
arrisRouterLanNatAlgsEnabled 315 arrisRouterRIPRoutedNetIP 323–325
arrisRouterLanOverrideDNS 128, 315 arrisRouterRIPRoutedSubnetDHCP 324
arrisRouterLanPassThru 128, 314 arrisRouterRIPRoutedSubnetEnabled 324
arrisRouterLanPrefixLengthV6 129, 316 arrisRouterRIPRoutedSubnetGWNetIP 324
arrisRouterLanRateLimit 314 arrisRouterRIPRoutedSubnetGWNetIPType 324
arrisRouterLanRelayDNS 128, 314 arrisRouterRIPRoutedSubnetIP 323
arrisRouterLanSettings 313 arrisRouterRIPRoutedSubnetIPType 323
arrisRouterLanSrvTable 313 arrisRouterRIPRoutedSubnetMask 324
arrisRouterLanStartDHCP 314 arrisRouterRIPRoutedSubnetNAT 324
arrisRouterLanStartDHCPType 314 arrisRouterRIPRoutedSubnetTableDHCP 325
arrisRouterLanStartDHCPV6 129, 316 arrisRouterRIPRoutedSubnetTableEnabled 325
arrisRouterLanStaticClientHostName 322 arrisRouterRIPRoutedSubnetTableGWNetIP 325
arrisRouterLanStaticClientIPAddr 322 arrisRouterRIPRoutedSubnetTableGWNetIPType 325
arrisRouterLanStaticClientIPAddrType 322 arrisRouterRIPRoutedSubnetTableIP 324
arrisRouterLanStaticClientMAC 323 arrisRouterRIPRoutedSubnetTableIPType 324
arrisRouterLanStaticClientRowStatus 323 arrisRouterRIPRoutedSubnetTableMask 325
arrisRouterLanStaticClientTable 320–321 arrisRouterRIPRoutedSubnetTableNAT 325
arrisRouterLanSubnetMask 313 arrisRouterRIPSendCMInterface 324
arrisRouterLanSubnetMaskType 313 arrisRouterRIPSubnetGWNetIP 324–325
arrisRouterLanTable 313 arrisRouterRIPSubnetMask 323
arrisRouterLanUPnPEnable 315 arrisRouterRIPTableSendCMInterface 325
arrisRouterLanUpRateLimit 314 arrisRouterSerialNumber 349
arrisRouterLanUseDHCP 314 arrisRouterSNTPServerAddr 351
arrisRouterLanUseDHCPV6 129, 316 arrisRouterSNTPServerAddrType 351
arrisRouterLanVLanID 314 arrisRouterSNTPServerName 351
arrisRouterLogLevel 349 arrisRouterSNTPServerStatus 351
arrisRouterMACAccessAddr 332 arrisRouterSysCfg 308
arrisRouterMACAccessStatus 332 arrisRouterTACACSAddr 350, 399, 436, 440
arrisRouterMACAccessTable 329–330 arrisRouterTACACSPort 350, 399, 436, 440
arrisRouterManagedDevicesEnabled 346 arrisRouterTACACSSecretKey 350
arrisRouterManagedServicesEnabled 346 arrisRouterTACACSServerKey 399, 437, 440
arrisRouterManagedSitesEnabled 346 arrisRouterTraceRtBasePort 356
arrisRouterMib 131, 363 arrisRouterTraceRtDataSize 355
arrisRouterMSOChgLogInfo 352 arrisRouterTraceRtLog 356
arrisRouterMSOChgLogTable 352 arrisRouterTraceRtMaxHops 355
arrisRouterMSOChgLogTime 352 arrisRouterTraceRtMgmt 308
arrisRouterName 349 arrisRouterTraceRtResolveHosts 355
arrisRouterParentalContLogTable 352 arrisRouterTraceRtStart 356
arrisRouterPCLogInfo 352 arrisRouterTraceRtTargAddrType 355
arrisRouterPCLogTime 352 arrisRouterTraceRtTargetAddr 355
arrisRouterPingIcmpErrors 355 arrisRouterTrustedDeviceAddr 348
arrisRouterPingInterval 354 arrisRouterTrustedDeviceAddrType 348
arrisRouterPingIpStackNumber 354 arrisRouterTrustedDeviceClear 345
arrisRouterPingLastIcmpError 355 arrisRouterTrustedDeviceCount 345
arrisRouterPingMgmt 308 arrisRouterTrustedDeviceFreeIdx 345
arrisRouterPingNumPkts 354 arrisRouterTrustedDeviceMAC 348
arrisRouterPingOctetsReceived 355 arrisRouterTrustedDeviceManagedServicesAddr 349
arrisRouterPingOctetsSent 355 arrisRouterTrustedDeviceManagedServicesAddrType 348

Firmware Guide Release 7.5 Standard 1.2 August 2012

724 Chapter 12

arrisRouterTrustedDeviceManagedServicesMAC 348 arrisRouterWEPPassPhrase 330

arrisRouterTrustedDeviceManagedServicesName 348 arrisRouterWhiteListClear 345
arrisRouterTrustedDeviceManagedServicesStatus 348 arrisRouterWhiteListCount 345
arrisRouterTrustedDeviceName 348 arrisRouterWhiteListDomain 347
arrisRouterTrustedDeviceStatus 348 arrisRouterWhiteListFreeIdx 345
arrisRouterTrustedDeviceTable 345 arrisRouterWhiteListStatus 347
arrisRouterWanConfig 308 arrisRouterWhiteListTable 345
arrisRouterWanConnDomainName 308 arrisRouterWhiteListTOD 347
arrisRouterWanConnHostName 308 arrisRouterWiFi80211NBand 336
arrisRouterWanConnType 308 arrisRouterWiFi80211NSideBand 337
arrisRouterWanConnTypeV6 308 arrisRouterWiFiAllow40MHzOnlyOperation 338
arrisRouterWanCurrentDNSIPAddr 311 arrisRouterWiFiAMSDUEnable 338
arrisRouterWanCurrentDNSIPAddrType 311 arrisRouterWiFiBasicRateSet 327
arrisRouterWanCurrentGW 309 arrisRouterWiFiBeaconInterval 326
arrisRouterWanCurrentGWType 309 arrisRouterWiFiBGProtect 326
arrisRouterWanCurrentIPAddr 309 arrisRouterWiFiBlockAck 338
arrisRouterWanCurrentIPAddrType 309 arrisRouterWiFiChannel 128, 325
arrisRouterWanCurrentIPType 309 arrisRouterWiFiChannelBW 337
arrisRouterWanCurrentNetMask 309 arrisRouterWiFiCountry 325
arrisRouterWanCurrentPreferredLifetimeV6 309 arrisRouterWiFiCustomSSIDStr 328
arrisRouterWanCurrentPrefix 309 arrisRouterWiFiDeclinePeerBA 338
arrisRouterWanCurrentPrefixDelegationV6 309 arrisRouterWiFiDTIMInterval 326
arrisRouterWanCurrentPrefixDelegationV6Len 309 arrisRouterWiFiEnableRadio 128, 327
arrisRouterWanCurrentValidLifetimeV6 309 arrisRouterWiFiEnableRadioNow 328
arrisRouterWanDelegatedPrefix 310 arrisRouterWiFiFragmentThresh 326
arrisRouterWanDelegatedPrefixLength 310 arrisRouterWiFiFrameBurst 327
arrisRouterWanDHCPDuration 312 arrisRouterWiFiGuardInterval 336–337
arrisRouterWanDHCPDurationV6 312 arrisRouterWiFiHTMCS 336
arrisRouterWanDHCPExpire 312 arrisRouterWiFiHTMode 337
arrisRouterWanDHCPExpireV6 312 arrisRouterWiFiLongRetryLimit 327
arrisRouterWanEnableIdleTimeout 310 arrisRouterWiFiMode 326
arrisRouterWanEnableKeepAlive 311 arrisRouterWiFiMulticastA 327
arrisRouterWanIdleTimeout 310 arrisRouterWiFiMulticastBG 327
arrisRouterWanIFMacAddr 308 arrisRouterWiFiNProtection 338
arrisRouterWanIPProvMode 308 arrisRouterWiFiOutputPower 327
arrisRouterWanKeepAliveTimeout 311 arrisRouterWiFiRadioControlMode 328
arrisRouterWanMTUSize 308 arrisRouterWiFiResetDefaults 328
arrisRouterWanPassword 310 arrisRouterWiFiRTSThreshold 326
arrisRouterWanReleaseLease 312 arrisRouterWiFiSecurityMode 330–331
arrisRouterWanReleaseLeaseV6 312 arrisRouterWiFiShortRetryLimit 327
arrisRouterWanRenewLease 312 arrisRouterWiFiShortSlot 326
arrisRouterWanRenewLeaseV6 312 arrisRouterWiFiShortSlotEnhanced 327
arrisRouterWanStaticDNSFreeIdx 311 arrisRouterWiFiTxPower 327
arrisRouterWanStaticDNSIPAddr 311 arrisRouterWiFiTxPreamble 326
arrisRouterWanStaticDNSIPAddrType 311 arrisRouterWiFiTxRate 328
arrisRouterWanStaticDNSRowStatus 311 arrisRouterWirelessCfg 308, 313
arrisRouterWanStaticDNSTable 311 arrisRouterWMMAPSD 333
arrisRouterWanStaticFreeIdx 308 arrisRouterWMMEDCAAPAdmitCont 334
arrisRouterWanStaticGateway 310 arrisRouterWMMEDCAAPAIFSN 334
arrisRouterWanStaticGatewayType 310 arrisRouterWMMEDCAAPCWmax 333
arrisRouterWanStaticIPAddr 310 arrisRouterWMMEDCAAPCWmin 333
arrisRouterWanStaticIPAddrType 310 arrisRouterWMMEDCAAPDiscardOld 334
arrisRouterWanStaticPrefix 310 arrisRouterWMMEDCAAPTxOpAGLimit 334
arrisRouterWanStaticRowStatus 310 arrisRouterWMMEDCAAPTxOpBLimit 334
arrisRouterWanStaticTable 308 arrisRouterWMMEDCASTAAIFSN 335
arrisRouterWanTunnelAddr 310–311 arrisRouterWMMEDCASTACWmax 334
arrisRouterWanTunnelAddrType 310 arrisRouterWMMEDCASTACWmin 334
arrisRouterWanTunnelHostName 310–311 arrisRouterWMMEDCASTATxAGLimit 335
arrisRouterWanUseAutoDNS 311 arrisRouterWMMEDCASTATxOpBLimit 335
arrisRouterWanUserName 310 arrisRouterWMMEnable 333
arrisRouterWebAccessLevel 353 arrisRouterWMMNoAck 333
arrisRouterWebAccessPage 353 arrisRouterWPAAlgorithm 331
arrisRouterWebAccessRowStatus 353 arrisRouterWPAGroupRekeyInterval 331
arrisRouterWEP128BitKeyStatus 331 arrisRouterWPAPreAuthEnable 332
arrisRouterWEP128BitKeyTable 330 arrisRouterWPAPreSharedKey 331
arrisRouterWEP128BitKeyValue 331 arrisRouterWPAReAuthInterval 332
arrisRouterWEP64BitKeyStatus 330 arrisRouterWpsBoardNum 336
arrisRouterWEP64BitKeyTable 330 arrisRouterWpsConfigState 335
arrisRouterWEP64BitKeyValue 330–331 arrisRouterWpsConfigTimeout 336
arrisRouterWEPCurrentKey 330 arrisRouterWpsDeviceName 335
arrisRouterWEPDefaultKey 331 arrisRouterWpsDevicePIN 335
arrisRouterWEPEncryptionMode 330–331 arrisRouterWpsMfg 335

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 725

arrisRouterWpsMode 335 pktcEDVADtmfRelay 60, 63

arrisRouterWpsModelName 335 pktcEnNcsEndPntFaxDetection 101–102
arrisRouterWpsModelNum 336 pktcEnNcsEndPntHookState 101
arrisRouterWpsPushButton 336 pktcEnNcsEndPntLVMgmtMaintTimer 71–72, 74
arrisRouterWpsResultStatus 335 pktcEnNcsEndPntLVMgmtPolicy 70, 72–73
arrisRouterWpsSTAPin 336 pktcEnNcsEndPntLVMgmtResetTimer 71–73
arrisRouterWpsStatus 335 pktcEnNcsEndPntLVMgmtTable 72
arrisRouterWpsUUID 336 pktcEnNcsEndPntQuarantineState 100
arrisRouterXmlProvisioningFile 131, 350 pktcEnNcsMinimumDtmfPlayout 100, 102
arrisRouterXmlProvisioningStatus 131–132, 350 pktcEUEDevOpDomain 144
arrisSipMib 149 pktcEUEDevOpRowStatus 145
arrisSpeedTestConfigCpeAccess 357 pktcEUEDevOpTable 164
arrisSpeedTestConfigDownlinkURL 357, 392 pktcEUEDevPCSCFAddr 145
arrisSpeedTestConfigEndUserGui 357 pktcEUEDevPCSCFAddrType 145
arrisSpeedTestConfigStartStopTest 358, 393 pktcEUEDevPCSCFRowStatus 145
arrisSpeedTestConfigSyslogReports 357–358 pktcEUEDevPCSCFSipPort 145
arrisSpeedTestConfigUplinkURL 357, 393 pktcEUEDevPCSCFTimerT1 145
arrisSpeedTestMib 357 pktcEUEDevPCSCFTimerT2 145
arrisSpeedTestResultsStatus 358, 393 pktcEUEDevPCSCFTimerT4 145
arrisTR69EnableCWMP 133 pktcEUEDevPCSCFTimerTD 145
arrisTR69PersistEnable 133 pktcEUERSTAppAdminStat 165
docsDevEvControl 215 pktcEUERSTAppFeatID 148, 165
docsDevEventTable 215, 218 pktcEUERSTAppFeatIndexRef 165
docsDevEvSyslogAddress 213 pktcEUERSTAppProfileToFeatTable 148, 165–166
docsDevEvSyslogAddressType 213 pktcEUERSTAppStatus 165
docsDevNmAccessInterfaces 245 pktcEUERSTAutoCbTable 149
docsDevResetNow 49, 53 pktcEUERSTAutoRclTable 149
docsDevServerConfigTftpAddress 213 pktcEUERSTBasicCallTable 151
docsDevServerConfigTftpAddressType 213 pktcEUERSTBCallPrefCodecList 60, 62, 85, 151
docsDevServerDhcpAddress 213 pktcEUERSTBCallStatus 151
docsDevServerDhcpAddressType 213 pktcEUERSTCIDDisCIDCWActStat 153
docsDevServerTimeAddress 213 pktcEUERSTCIDDisDefCountry 153
docsDevServerTimeAddressType 213 pktcEUERSTCIDDisDSTFlag 153
docsDevSoftware 46–47 pktcEUERSTCIDDisDSTInfo 89, 153
docsDevSwAdminStatus 46–47, 49–50, 276 pktcEUERSTCIDDisStatus 153
docsDevSwCurrentVers 360 pktcEUERSTCIDDisTable 153
docsDevSwFilename 46 pktcEUERSTCIDDisTimeAdj 153
docsDevSwOperStatus 46 pktcEUERSTCIDPPS 153
docsDevSwServerAddress 46 pktcEUERSTCIDStatus 153
docsDevSwServerAddressType 46 pktcEUERSTCIDTable 153
docsIf3CmMdCfgIpProvMode 41–43, 274, 586 pktcEUERSTDMValue 159
docsIf3CmMdCfgIpProvModeResetOnChange 41–42 pktcEUERSTDnDTable 149
docsIf3CmMdCfgIpProvModeResetOnChangeHoldOffTimer pktcEUERSTHotlineDestAddress 150
41–42 pktcEUERSTHotlineOffhookTimer 150
docsIf3CmMdCfgIpProvModeStorageType 41, 43 pktcEUERSTKeepAlive 144
docsIf3CmMdCfgTable 42 pktcEUERSTNfAncMapRspCode 168
dot1dBaseBridgeAddress 362 pktcEUERSTNfAncMapStatus 168
dot1dBaseNumPorts 362 pktcEUERSTNfAncMapURI 167–168
dot1dBaseType 362 pktcEUERSTNfBasicCallTable 151
dot1dBridge 362 pktcEUERSTNfBCallByeDelay 151
dot1dTpFdbTable 362 pktcEUERSTNfBCallOrigDTTimer 141, 146, 155, 158, 172
DownstreamPacketClassification 190 pktcEUERSTNFBCallOrigModLongIntDig 146, 152, 155,
firmware upgrade 50 158
ifAdminOperStatus 289, 368 pktcEUERSTNfBCallOrigModLongIntDig 141, 172
ifAdminStatus 191, 299, 424, 688 pktcEUERSTNfBCallPermSeqTimer1 146, 152
ifIndex 26–27, 72–73, 84, 164, 289, 294, 317, 325, 332, 362 pktcEUERSTNfBCallPermSeqTimer2 146, 152
ifPhysAddress 29 pktcEUERSTNfBCallPermSeqTimer3 146, 152
ifSpeed 318 pktcEUERSTNfBCallPermSeqTimer4 152
ifTable 27 pktcEUERSTNfBCallPermSeqTimer4s 146
modemAgentDocsis20 362 pktcEUERSTNfBCallPermSeqTone1 146, 152
PcIpClassification 190 pktcEUERSTNfBCallPermSeqTone2 146, 152
PcIpSourcePortEnd 190 pktcEUERSTNfBCallPermSeqTone3 146, 152
PcIpSourcePortStart 190 pktcEUERSTNfBCallPermSeqTone4 146, 152
pktcDevEvControl 216 pktcEUERSTNfBCallStatus 152
pktcDevEventNotify 215, 219 pktcEUERSTNfEmSvcDSCPValMedia 154
pktcDevEventTable 215, 218 pktcEUERSTNfEmSvcDSCPValSig 154
pktcDevEvFixedText 216 pktcEUERSTNfEmSvcHowlTimer 154
pktcDevEvProgrammableText 216 pktcEUERSTNfEmSvcNwHoldTimer 154
pktcDevEvSyslogAddress 215, 218 pktcEUERSTNfEmSvcStatus 154
pktcEDVACodecPubRepAddr 365 pktcEUERSTNfEmSvcTable 149, 154
pktcEDVACodecPubRepAddrType 365 pktcEUERSTNfMWISubDuration 169
pktcEDVACodecRTCPXR 290, 365 pktcEUERSTNoAnsTODuration 152

Firmware Guide Release 7.5 Standard 1.2 August 2012

726 Chapter 12

pktcEUERSTNoAnsTOStatus 153 pktcSigDevToneType 111–112

pktcEUERSTUEActStatChgRegExp 152 pktcSigDevToneWholeToneRepeatCount 111–113
pktcEUERSTUEActStatChgStatus 152 pktcSigDevVmwiDTASAfterLR 110
pktcEUERSTUEActStatChgTable 152 pktcSigDevVmwiFskAfterDTAS 110
pktcEUEUsrAppMapAppAdminStat 166 pktcSigDevVmwiFskAfterRPAS 109
pktcEUEUsrAppMapAppIdentifier 166 pktcSigDevVmwiMode 109
pktcEUEUsrAppMapAppIndexRef 166 pktcSigPowerRingFrequency 108
pktcEUEUsrAppMapAppOrgID 166 ppCfgMtaCallpFeatureSwitch 74, 92, 190, 283, 296
pktcEUEUsrAppMapRowStatus 166 ppCfgMtaCountryTemplate 68, 111, 283, 464, 680
pktcEUEUsrAppMapTable 166 ppcfgMtaCountryTemplate 191
pktcEUEUsrIMPICredentials 163 ppCfgMtaFeatureSwitch 24, 84, 283
pktcEUEUsrIMPICredsType 163 ppCfgPortLocUserIndication 283
pktcEUEUsrIMPIId 163 ppCfgPortLoopCurrent 69, 283
pktcEUEUsrIMPIIdType 163 ppCfgPortT38MaxDatagram 103, 283
pktcEUEUsrIMPIRowStatus 163 ppCfgRfc2833DigitPayloadType 75, 84, 92, 283
pktcEUEUsrIMPITable 164 ppSurvMtaMaintState 219
pktcEUEUsrIMPUAdditionalInfo 139, 164 ppSurvPortLcDiagLastResult 283
pktcEUEUsrIMPUAdminStat 164 ppSurvPortMaintState 219, 283
pktcEUEUsrIMPUDispInfo 164 rip2 362
pktcEUEUsrIMPUId 163 rip2IfConfTable 362
pktcEUEUsrIMPUIdType 163 rip2IfStatTable 362
pktcEUEUsrIMPUIMPIIndexRef 164 sipCfgAlertInfoR0 143, 174, 182, 202
pktcEUEUsrIMPUOpIndexRefs 164 sipCfgAlertInfoR1 202
pktcEUEUsrIMPURowStatus 164 sipCfgAlertInfoR2 202
pktcMtaDevCmsIpsecCtrl 25, 33, 67 sipCfgAlertInfoR3 202
pktcMtaDevCmsTable 125 sipCfgAlertInfoR4 202
pktcMtaDevConfigFile 29 sipCfgAlertInfoR5 202
pktcMtaDevCorrelationId 29–30 sipCfgAlertInfoR6 202
pktcMtaDevEnabled 191 sipCfgAlertInfoR7 143, 174, 182, 202
pktcMtaDevMacAddress 29 sipCfgAnonCallRejectionCapability 184, 189
pktcMtaDevProvConfigHash 29, 36 sipCfgBusyDigitMap 192, 201
pktcMtaDevProvConfigKey 29 sipCfgCallerIdDisplayCapability 184, 189
pktcMtaDevProvisioningEnrollment 29 sipCfgCallerIdSendCapability 184, 189
pktcMtaDevProvisioningState 39, 71 sipCfgCallForwardCapability 184, 189
pktcMtaDevProvisioningStatus 29 sipCfgCallForwardForbiddenNumbers 179
pktcMtaDevRealmTable 125 sipCfgCallHoldCapability 184, 189
pktcMtaDevSwCurrentVers 29 sipCfgCallRedialCapability 184, 189
pktcMtaDevTypeIdentifier 29 sipCfgCallReturnCapability 184, 189
pktcNcsEndPntConfigCallWaitingDelay 113 sipCfgCallTransferCapability 184, 189
pktcNcsEndPntConfigCallWaitingMaxRep 113 sipCfgCallWaitingCapability 184, 189
pktcNcsEndPntConfigCriticalDialTO 192 sipCfgCallWaitingStarCodeSurvivesReset 180, 189
pktcNcsEndPntConfigMaxHookFlash 123 sipCfgDefaultG711 60, 180
pktcNcsEndPntConfigMinHookFlash 123 sipCfgDialFeatActive 199–200
pktcNcsEndPntConfigMWD 177 sipCfgDialFeatCode 198
pktcNcsEndPntConfigPartialDialTO 192 sipCfgDialFeatMap 198
pktcNcsEndPntConfigTable 125 sipCfgDialFeatMode 199
pktcNcsEndPntStatusError 39 sipCfgDialFeatName 198
pktcSigDevCallerIdSigProtocol 108 sipCfgDialFeatTable 182, 199–200
pktcSigDevCIDDTASAfterLR 109 sipCfgDialFeatTone 198
pktcSigDevCIDFskAfterDTAS 109 sipCfgDialProxyActive 197
pktcSigDevCIDFskAfterRing 109 sipCfgDialProxyCode 197
pktcSigDevCIDFskAfterRPAS 109 sipCfgDialProxyMap 197
pktcSigDevCIDMode 108 sipCfgDialProxyMessageType 197
pktcSigDevCIDRingAfterFSK 109 sipCfgDialProxyMethod 197
pktcSigDevMultiFreqToneTable 111, 113 sipCfgDialProxyNumber 197
pktcSigDevR0Cadence 124, 466 sipCfgDialProxyTable 182
pktcSigDevR7Cadence 124, 466 sipCfgDialProxyTone 197
pktcSigDevRgCadence 124, 466 sipCfgDigitMap 191
pktcSigDevRsCadence 124, 466–467 sipCfgDistinctiveRingingForCallHold 202
pktcSigDevToneDbLevel 112 sipCfgDomainOverride 180, 195
pktcSigDevToneFirstFrequency 111 sipCfgEmergencyNumber 180
pktcSigDevToneFourthFrequency 111 sipCfgEmergencyServiceURN 143, 154, 174
pktcSigDevToneFreqAmpModePrtg 111 sipCfgFeatureSettings 183
pktcSigDevToneFreqMode 111 sipCfgGenLinger 146, 185
pktcSigDevToneFreqRepeatCount 112 sipCfgInviteLinger 185
pktcSigDevToneNumber 111 sipCfgMaxRetrans 184, 193
pktcSigDevToneOffDuration 112 sipCfgMaxUDPSize 192
pktcSigDevToneOnDuration 112 sipCfgMediaLoopbackNumber 141, 171, 460
pktcSigDevToneSecondFrequency 111 sipCfgMWITargetAddr 169
pktcSigDevToneSteady 111–112 sipCfgMWITargetAddrType 169
pktcSigDevToneTable 111, 113 sipCfgMWITargetPort 169
pktcSigDevToneThirdFrequency 111 sipCfgPacketizationRate 192

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 727

sipCfgPacketLoopbackNumber 141, 171, 460 vacmSecurityModel 247

sipCfgPenaltyBoxTimeout 85 vacmSecurityModel 248
sipCfgPortDisplayName 191 vacmSecurityName 247
sipCfgPortFaxOnlyTimeout 101–103, 201 vacmSecurityName 248
sipCfgPortFeatureSettings 181, 188, 192, 196 vacmSecurityToGroupStatus 248, 252
sipCfgPortLogin 191 vacmSecurityToGroupStorageType 248, 252
sipCfgPortMaxT38HSRedLevel 101, 188 vacmSecurityToGroupTable 245, 247–248, 252
sipCfgPortMWIClear 169 VbdOverwriteJitterBuffer 294
sipCfgPortPassword 191 MIBs
sipCfgPortProxyAdr 187, 194 PacketCable OID changes 28
sipCfgPortProxyPort 187, 194 Voice Quality Monitoring 378
sipCfgPortProxyType 187, 194 mips_stat, DSP commands, dim 628
sipCfgPortRegistrarAdr 187, 194 mismatch, battery 445
sipCfgPortRegistrarPort 187, 194 mml, DOCSIS Debug commands 582
sipCfgPortRegistrarType 187, 194 mode
sipCfgPortT38Mode 101, 103, 188, 201 boost 68
sipCfgPortUserName 191 fax-only 102–103, 201
sipCfgPortWarmLineTimeout 150, 199–200 feature switch, lockstep quarantine 75
sipCfgPortWarmOrHotlineEnable 150 SNMP, access 246
sipCfgPortWarmOrHotlineNumber 150, 199–200 Model 8 power management 269
sipCfgProvisionedCodecArray 62, 151, 192 model number, hardware 360
sipCfgProxyAdr 187 modem support, G.729 63
sipCfgProxyType 187 modemAgentDocsis20, MIB 362
sipCfgRegExpires 177, 194 modes
sipCfgRegistrarAdr 187 DHCP parameters, provisioning 39
sipCfgRegistrarType 187 IPv6, provisioning 42
sipCfgRegTimerMax 177, 193 provisioning 33
sipCfgRegTimerMin 177, 193 modify RTP session 687
sipCfgRepeatDialingInterval 179, 201 ModuleConfig, Logger commands 608
sipCfgRepeatDialingSessionProgressTimer 179, 201 ModuleDisplay, Logger commands 609
sipCfgRepeatDialingTimeout 179, 201 modulesList, Logger commands 610
sipCfgResetCallWaitingStarCode 180, 189 Monitoring
sipCfgSessionExpires 193 managing Voice Quality 371
sipCfgSipFeatureSwitch 85, 142–143, 153–154, 167, MIBs, Voice Quality 378
173–174, 192 monitoring, status 439
sipCfgSipFeatureSwitch2 89 MPTIME parameter
sipCfgT1 177, 184, 193 feature switch, omit 75
sipCfgThreeWayCallCapability 184, 189 SDP 75
sipCfgTimerB 184 MTA see eDVA.
sipCfgTimerF 147, 177, 184 MTA
sipCfgWarmLineTimeout 150 coexistence feature switch 84
sipCfgWarmOrHotlineNumber 150 commands, codecs, Voice 695
snmpCommunityContextEngineID 247 commands, config, Voice 693
snmpCommunityContextName 247 commands, getSig, Voice 694
snmpCommunityName 247, 250 commands, mtaftrsw, Voice 695
snmpCommunitySecurityName 247 commands, provmethod, Voice 695
snmpCommunitySecurityName 247, 250 commands, resetMTA, Voice 696
snmpCommunityStatus 247, 250 commands, showconfig, Voice 693
snmpCommunityStorageType 247 commands, Voice 693
snmpCommunityTable 245, 247, 249 feature switch 84
snmpCommunityTransportTag 247 maxCpeAllowed bypass feature switch 84
sysDescr 29, 360–361 log 224
sysObjectID 361 log 224
sysORDescr 362 mtaClrLog, DHCP commands 507
sysORID 362 mtaDisplay, PACM Security commands 596
sysORTable 362 mtaDispLog, DHCP commands 507
system 360 mtaEnblLog, DHCP commands 507
sysUpTime 307 mtaFilterBypass feature switch 84
true 191 mtaftrsw, Voice MTA commands 695
UpstreamPacketClassification 190 mtaSubOpt3Immediate, DHCP commands 507
vacmAccessContentPrefix 248 multicast support, IPv6 208
vacmAccessContextMatch 248, 255 MWI support, configuring 169
vacmAccessNotifyViewName 248, 255
vacmAccessReadViewName 248, 255
vacmAccessSecurityLevel 248
N
vacmAccessSecurityModel 248 nbdfreq, RF commands 518
vacmAccesssStorageType 248, 255 NCS
vacmAccessStatus 248, 255 firmware upgrade, from SIP loads to 45
vacmAccessTable 245, 248, 255 SIP, firmware upgrade, from 45
vacmAccessWriteViewName 248, 255 loads, upgrading 45
vacmGroupName 248 piggyback feature switch 75
vacmGroupName 248, 252 redirect feature switch 75

Firmware Guide Release 7.5 Standard 1.2 August 2012

728 Chapter 12

netrxReduce, Main System commands 555 concepts 137

netrxRestore, Main System commands 555 events 232
netwloop, SIP 460 OID changes, MIBs 28
network provisioning 33
failure recovery 233 packetization rates 60
Main System commands 554 PACM
netwtest, SIP 460 commands, debugMenu, Main 604
next, DOCSIS General commands 564 commands, dynamicConfig, Main 602
nlplevel, DSP commands 636 commands, event, Main 603
no ToD feature switch, halt on 84 commands, managerMenu, Main 606
nodbg, System PP commands 556 commands, options, Main 593
nomjitter, DSP commands 635 commands, production, Main 601
non-sequential Caller ID feature switch 75 commands, provisioning, Main 593
nopsm, System PP commands 556 commands, security, Main 595
noqos, System PP commands 557 commands, vendorSubMenu, Main 597
numbers, enterprise 215 commands, version, Main 592
Debug commands, ARRIS_PROVISIONING_set 605
Debug commands, debugSet 604
O Debug commands,
objdump, Voice Linecard commands commands 654 PACM_CONFIG_CERTIFICATION_MODE_set 605
objects Debug commands,
SIP digit map 191 PACM_CONFIG_CFM_FILE_HASH_BYPASS_set 605
system 360 Debug commands,
off-hook gain 114 PACM_CONFIG_EURO_HASH_SIZE_20_set 604
offhook processing 141, 172 Debug commands, PACM_CONFIG_IPSEC_ENABLE_set
extended 146 604
offset, adjusting time 20 Debug commands,
OID changes, MIBs, PacketCable 28 PACM_CONFIG_MAS_ROUTE_TO_LOGGER_set 605
omit MPTIME parameter feature switch 75 Debug commands,
OOS instead of IDLE for unprovisioned lines, show 75 PACM_CONFIG_MTA_RESET_WATCH_DOG_set 604
oos, Voice CallP commands 688 Debug commands,
Open Switch Interval 75, 689 PACM_CONFIG_PROV_DHCP_RETRIES_set 604
operation, power failure 206 Debug commands,
operator-defined, password 434 PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set 604
option Debug commands,
support, DHCP 30 PACM_CONFIG_SNMPV2_ACCESS_set 605
support, DHCP 30 Debug commands,
support, DHCP 30–31 PACM_CONFIG_TICKETS_FLASH_SUPPORT_set 604
support, DHCP 32 Debug commands,
options PACM_CONFIG_TLV38_SNMPV1_ENABLE_set 605
firmware upgrade 49 Debug commands, restore 605
Main PACM commands 593 Debug commands, save 605
required, DHCP 39 Debug commands, show 606
OSI Dynamic Config commands,
automatic 75 PACM_DYN_CONFIG_LOOPV_MAINT_TIMER_CD_set 602
generation, automatic 689 Dynamic Config commands,
OUI ranges 20 PACM_DYN_CONFIG_LOOPV_POLICY_set 602
out of service, line 688 Dynamic Config commands,
outbound method, Caller ID 188, 196 PACM_DYN_CONFIG_LOOPV_RESET_TIMER_set 602
over temperature, line card 368 Dynamic Config commands,
over-current protection state, line card 207 PACM_DYN_CONFIG_LOOPV_STATUS_set 602
overdsidholdoffovr, DOCSIS Atp commands 566 Dynamic Config commands,
override PACM_DYN_CONFIG_SNMP_ENGIN_BOOT_NUM_set 602
DNS 128 Dynamic Config commands, restore 603
feature switch, domain 85 Dynamic Config commands, save 603
IPv4/IPv6 41 Dynamic Config commands, set 602
jitter buffer 643 Dynamic Config commands, show 603
MDD 41 Event commands, deleteLogFile 603
SIP domain 195 Event commands, displayEventTable 603
overrideCmsTtl, PACM Security commands 595 Event commands, printLogFile 603
overriding Event commands, resetLogFile 603
DHCP option 122 sub-option 3 32 Event commands, resetTables 604
SNMP Entity 32 Event commands, sendEvent 603
over-temperature, line card 368 Manager commands,
PACM_MANAGER_HITLESS_DHCP_set 606
Manager commands,
P PACM_MANAGER_HITLESS_SOFTWARE_DOWNLOAD_set
packet size, SIP, maximum UDP 192 606
PacketACE 49 Manager commands,
PacketCable PACM_MANAGER_PSM_ENABLE_set 607
extended signaling 100 Manager commands,
support 84 PACM_MANAGER_RANDOM_USM_SPIN_LOCK_set 606

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 729

Manager commands, Vendor commands, VENDOR_BEFORE_MTA_RESET_set

PACM_MANAGER_SNMP_RESTRICT_CONFIG_VIEW_set 600
606 Vendor commands,
Manager commands, VENDOR_DISABLE_CFM_SPEC_TREE_set 600
PACM_MANAGER_TOD_DELAY_SEC_PROV_set 606 Vendor commands,
Manager commands, VENDOR_ENABLE_CFM_PLUG_IN_set 600
PACM_MANAGER_VENDOR_CMS_AS_IP_set 607 Vendor commands,
Manager commands, VENDOR_ENABLE_DHCP_PLUG_IN_set 600
PACM_MANAGER_VENDOR_COMMUNITY_NAME_set 607 Vendor commands, VENDOR_ENABLE_EVENTS_set 600
Manager commands, Vendor commands,
PACM_MANAGER_VENDOR_ENABLE_EVENTS_set 607 VENDOR_SET_DHCP_SERVER_ADDR_set 599
Manager commands, Vendor commands, VENDOR_SET_TFTP_DATA_set 599
PACM_MANAGER_VOICE_DECT_IF_set 606 Vendor commands,
Manager commands, VENDOR_STATUS_VENDOR_APP_set 599
PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set 606 Vendor commands, vendorAddSnmpTarget 598
Manager commands, Vendor commands, vendorModifyDhcpAckParam 598
PACM_MANAGER_VOICE_VLM_IF_set 606 Vendor commands, vendorSetDhcpServerAddr 598
Manager commands, restore 607 Vendor commands, vendorSetTftpData 598
Manager commands, save 607 PACM_CONFIG_CERTIFICATION_MODE_set, PACM Debug
Manager commands, show 607 commands 605
Production commands, PACM_CONFIG_EURO_set 601 PACM_CONFIG_CFM_FILE_HASH_BYPASS_set, PACM Debug
Production commands, PACM_CONFIG_HW_ADDR_set commands 605
601 PACM_CONFIG_EURO_HASH_SIZE_20_set, PACM Debug
Production commands, PACM_CONFIG_IP_ADDR_set 601 commands 604
Production commands, PACM_CONFIG_MTA_BBU_set PACM_CONFIG_EURO_set, PACM Production commands 601
602 PACM_CONFIG_HW_ADDR_set, PACM Production commands
Production commands, 601
PACM_CONFIG_MTA_NUM_LINES_set 601 PACM_CONFIG_IP_ADDR_set, PACM Production commands
Production commands, 601
PACM_CONFIG_MTA_TELE_ID_set 601 PACM_CONFIG_IPSEC_ENABLE_set, PACM Debug commands
Production commands, prodSet 601 604
Production commands, save 602 PACM_CONFIG_MAS_ROUTE_TO_LOGGER_set, PACM
Production commands, setDefaultMacAddress 602 Debug commands 605
Production commands, show 602 PACM_CONFIG_MTA_BBU_set, PACM Production commands
Provisioning sub-commands, configFile 594 602
Provisioning sub-commands, dhcpServersConfig 593 PACM_CONFIG_MTA_NUM_LINES_set, PACM Production
Provisioning sub-commands, hashBypassSet 594 commands 601
Provisioning sub-commands, provDBcontents 594 PACM_CONFIG_MTA_RESET_WATCH_DOG_set, PACM
Provisioning sub-commands, provDebug 595 Debug commands 604
Provisioning sub-commands, provFlow 595 PACM_CONFIG_MTA_TELE_ID_set, PACM Production
Provisioning sub-commands, provStatus 595 commands 601
Provisioning sub-commands, sendCMFullScanNoQam 593 PACM_CONFIG_PROV_DHCP_RETRIES_set, PACM Debug
Provisioning sub-commands, sendCMLinkDownEvent 593 commands 604
Provisioning sub-commands, sendCMLinkUpEvent 593 PACM_CONFIG_PROVISION_FLOWS_SUPPORT_set, PACM
Provisioning sub-commands, sendCMQamRegained 593 Debug commands 604
Provisioning sub-commands, sendCMResetEvent 593 PACM_CONFIG_SNMPV2_ACCESS_set, PACM Debug
Provisioning sub-commands, sendDHCPLeaseFailEvent 593 commands 605
Provisioning sub-commands, sendDHCPNewIPEvent 593 PACM_CONFIG_TICKETS_FLASH_SUPPORT_set, PACM
Provisioning sub-commands, sendMSMStartEvent 593 Debug commands 604
Provisioning sub-commands, sendMTAResetEvent 594 PACM_CONFIG_TLV38_SNMPV1_ENABLE_set, PACM Debug
Provisioning sub-commands, sendSecRstDoneEvent 594 commands 605
Provisioning sub-commands, sendSecRstFailEvent 594 PACM_DYN_CONFIG_LOOPV_MAINT_TIMER_CD_set,
Provisioning sub-commands, sendVoiceRstDoneEvent 594 PACM Dynamic Config commands 602
Provisioning sub-commands, sendVoiceRstFailEvent 594 PACM_DYN_CONFIG_LOOPV_POLICY_set, PACM Dynamic
Provisioning sub-commands, setVoiceLoopVoltage 594 Config commands 602
Provisioning sub-commands, tftpAlwaysOn 594 PACM_DYN_CONFIG_LOOPV_RESET_TIMER_set, PACM
Security commands, certificates 596 Dynamic Config commands 602
Security commands, displayDB 596 PACM_DYN_CONFIG_LOOPV_STATUS_set, PACM Dynamic
Security commands, mtaDisplay 596 Config commands 602
Security commands, overrideCmsTtl 595 PACM_DYN_CONFIG_SNMP_ENGIN_BOOT_NUM_set, PACM
Security commands, resetTickets 595 Dynamic Config commands 602
Security commands, smDataDisplay 595 PACM_MANAGER_HITLESS_DHCP_set, PACM Manager
Security commands, timersDisplay 595 commands 606
Vendor commands, printVendorRegisteredEvents 599 PACM_MANAGER_HITLESS_SOFTWARE_DOWNLOAD_set,
Vendor commands, restore 600 PACM Manager commands 606
Vendor commands, save 601 PACM_MANAGER_PSM_ENABLE_set, PACM Manager
Vendor commands, show 601 commands 607
Vendor commands, VENDOR_ADD_SNMP_TARGET_set PACM_MANAGER_RANDOM_USM_SPIN_LOCK_set, PACM
600 Manager commands 606
Vendor commands, VENDOR_AFTER_DHCP_ACK_set PACM_MANAGER_SNMP_RESTRICT_CONFIG_VIEW_set,
599 PACM Manager commands 606
Vendor commands, VENDOR_AFTER_MSM_INIT_set 599

Firmware Guide Release 7.5 Standard 1.2 August 2012

730 Chapter 12

PACM_MANAGER_TOD_DELAY_SEC_PROV_set, PACM pktcEDVACodecPubRepAddrType, MIB 365

Manager commands 606 pktcEDVACodecRTCPXR, MIB 290, 365
PACM_MANAGER_VENDOR_CMS_AS_IP_set, PACM Manager pktcEDVADtmfRelay, MIB 60, 63
commands 607 pktcEnNcsEndPntFaxDetection, MIB 101–102
PACM_MANAGER_VENDOR_COMMUNITY_NAME_set, pktcEnNcsEndPntHookState, MIB 101
PACM Manager commands 607 pktcEnNcsEndPntLVMgmtMaintTimer, MIB 71–72, 74
PACM_MANAGER_VENDOR_ENABLE_EVENTS_set, PACM pktcEnNcsEndPntLVMgmtPolicy, MIB 70, 72–73
Manager commands 607 pktcEnNcsEndPntLVMgmtResetTimer, MIB 71–73
PACM_MANAGER_VOICE_DECT_IF_set, PACM Manager pktcEnNcsEndPntLVMgmtTable, MIB 72
commands 606 pktcEnNcsEndPntQuarantineState, MIB 100
PACM_MANAGER_VOICE_SLIC_PSM_STATUS_set, PACM pktcEnNcsMinimumDtmfPlayout, MIB 100, 102
Manager commands 606 pktcEUEDevOpDomain, MIB 144
PACM_MANAGER_VOICE_VLM_IF_set, PACM Manager pktcEUEDevOpRowStatus, MIB 145
commands 606 pktcEUEDevOpTable, MIB 164
page, reflection 628 pktcEUEDevPCSCFAddr, MIB 145
parameter pktcEUEDevPCSCFAddrType, MIB 145
feature switch, omit MPTIME 75 pktcEUEDevPCSCFRowStatus, MIB 145
list considerations, SDP 100 pktcEUEDevPCSCFSipPort, MIB 145
SDP, MPTIME 75 pktcEUEDevPCSCFTimerT1, MIB 145
parameters pktcEUEDevPCSCFTimerT2, MIB 145
display signalling configuration 694 pktcEUEDevPCSCFTimerT4, MIB 145
general eDVA 65 pktcEUEDevPCSCFTimerTD, MIB 145
provisioning modes, DHCP 39 pktcEUERSTAppAdminStat, MIB 165
SDP, AES encryption 75 pktcEUERSTAppFeatID, MIB 148, 165
vacmAccessTable 248 pktcEUERSTAppFeatIndexRef, MIB 165
parser, Voice CallP commands 682 pktcEUERSTAppProfileToFeatTable, MIB 148, 165–166
partial service 267 pktcEUERSTAppStatus, MIB 165
password, generating a single 432 pktcEUERSTAutoCbTable, MIB 149
Password of the Day tool 431 pktcEUERSTAutoRclTable, MIB 149
using 431 pktcEUERSTBasicCallTable, MIB 151
password pktcEUERSTBCallPrefCodecList, MIB 60, 62, 85, 151
operator-defined 434 pktcEUERSTBCallStatus, MIB 151
seed, changing 433 pktcEUERSTCIDDisCIDCWActStat, MIB 153
passwords pktcEUERSTCIDDisDefCountry, MIB 153
CLI default 398 pktcEUERSTCIDDisDSTFlag, MIB 153
generating a list of 432 pktcEUERSTCIDDisDSTInfo, MIB 89, 153
PWoD tool, generating 432 pktcEUERSTCIDDisStatus, MIB 153
WebGUI default 398 pktcEUERSTCIDDisTable, MIB 153
Payload pktcEUERSTCIDDisTimeAdj, MIB 153
configuring 75 pktcEUERSTCIDPPS, MIB 153
feature switch 75 pktcEUERSTCIDStatus, MIB 153
payload type 94 feature switch, RFC2833 75, 92 pktcEUERSTCIDTable, MIB 153
payloads feature switch, ignore unlisted 75 pktcEUERSTDMValue, MIB 159
PcIpClassification, MIB 190 pktcEUERSTDnDTable, MIB 149
PcIpSourcePortEnd, MIB 190 pktcEUERSTHotlineDestAddress, MIB 150
PcIpSourcePortStart, MIB 190 pktcEUERSTHotlineOffhookTimer, MIB 150
penalty box feature switch, SIP proxy 85 pktcEUERSTKeepAlive, MIB 144
penalty_box, Voice CallP commands 690 pktcEUERSTNfAncMapRspCode, MIB 168
per-call Syslog reporting 369 pktcEUERSTNfAncMapStatus, MIB 168
per-line proxy/registrar prohibited, post-provisioning 187 pktcEUERSTNfAncMapURI, MIB 167–168
persist, General Console Commands 500 pktcEUERSTNfBasicCallTable, MIB 151
persistent pktcEUERSTNfBCallByeDelay, MIB 151
line status 690 pktcEUERSTNfBCallOrigDTTimer, MIB 141, 146, 155, 158, 172
line status 65 pktcEUERSTNFBCallOrigModLongIntDig, MIB 146, 152, 155,
Persistent logging 500 158
phantom pulse 122 pktcEUERSTNfBCallOrigModLongIntDig, MIB 141, 172
PHS see Payload Header Suppression. pktcEUERSTNfBCallPermSeqTimer1, MIB 146, 152
phy-mac, DOCSIS Psm commands 591 pktcEUERSTNfBCallPermSeqTimer2, MIB 146, 152
phystatus pktcEUERSTNfBCallPermSeqTimer3, MIB 146, 152
DOCSIS Debug commands 582 pktcEUERSTNfBCallPermSeqTimer4, MIB 152
Main DOCSIS commands 559 pktcEUERSTNfBCallPermSeqTimer4s, MIB 146
pids, System PP commands 556 pktcEUERSTNfBCallPermSeqTone1, MIB 146, 152
piggyback feature switch, NCS 75 pktcEUERSTNfBCallPermSeqTone2, MIB 146, 152
ping, Gateway sub-mode commands 532 pktcEUERSTNfBCallPermSeqTone3, MIB 146, 152
pktcDevEvControl, MIB 216 pktcEUERSTNfBCallPermSeqTone4, MIB 146, 152
pktcDevEventNotify, MIB 215, 219 pktcEUERSTNfBCallStatus, MIB 152
pktcDevEventTable, MIB 215, 218 pktcEUERSTNfEmSvcDSCPValMedia, MIB 154
pktcDevEvFixedText, MIB 216 pktcEUERSTNfEmSvcDSCPValSig, MIB 154
pktcDevEvProgrammableText, MIB 216 pktcEUERSTNfEmSvcHowlTimer, MIB 154
pktcDevEvSyslogAddress, MIB 215, 218 pktcEUERSTNfEmSvcNwHoldTimer, MIB 154
pktcEDVACodecPubRepAddr, MIB 365 pktcEUERSTNfEmSvcStatus, MIB 154

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 731

pktcEUERSTNfEmSvcTable, MIB 149, 154 pktcSigDevToneSecondFrequency, MIB 111

pktcEUERSTNfMWISubDuration, MIB 169 pktcSigDevToneSteady, MIB 111–112
pktcEUERSTNoAnsTODuration, MIB 152 pktcSigDevToneTable, MIB 111, 113
pktcEUERSTNoAnsTOStatus, MIB 153 pktcSigDevToneThirdFrequency, MIB 111
pktcEUERSTUEActStatChgRegExp, MIB 152 pktcSigDevToneType, MIB 111–112
pktcEUERSTUEActStatChgStatus, MIB 152 pktcSigDevToneWholeToneRepeatCount, MIB 111–113
pktcEUERSTUEActStatChgTable, MIB 152 pktcSigDevVmwiDTASAfterLR, MIB 110
pktcEUEUsrAppMapAppAdminStat, MIB 166 pktcSigDevVmwiFskAfterDTAS, MIB 110
pktcEUEUsrAppMapAppIdentifier, MIB 166 pktcSigDevVmwiFskAfterRPAS, MIB 109
pktcEUEUsrAppMapAppIndexRef, MIB 166 pktcSigDevVmwiMode, MIB 109
pktcEUEUsrAppMapAppOrgID, MIB 166 pktcSigPowerRingFrequency, MIB 108
pktcEUEUsrAppMapRowStatus, MIB 166 plant maintenance timer, loop voltage management 71
pktcEUEUsrAppMapTable, MIB 166 PMT 71
pktcEUEUsrIMPICredentials, MIB 163 pne_print, Voice CallP commands, dnsTools sub-mode 692
pktcEUEUsrIMPICredsType, MIB 163 polarity
pktcEUEUsrIMPIId, MIB 163 line card 684
pktcEUEUsrIMPIIdType, MIB 163 Voice Linecard commands commands 658
pktcEUEUsrIMPIRowStatus, MIB 163 policy
pktcEUEUsrIMPITable, MIB 164 DST 273
pktcEUEUsrIMPUAdditionalInfo, MIB 139, 164 setting DST 21
pktcEUEUsrIMPUAdminStat, MIB 164 polling 627–628
pktcEUEUsrIMPUDispInfo, MIB 164 Voice Linecard commands 666
pktcEUEUsrIMPUId, MIB 163 pompt, DOCSIS Psm commands 592
pktcEUEUsrIMPUIdType, MIB 163 ports
pktcEUEUsrIMPUIMPIIndexRef, MIB 164 IP 26
pktcEUEUsrIMPUOpIndexRefs, MIB 164 signaling 26
pktcEUEUsrIMPURowStatus, MIB 164 voice line 26
pktcMtaDevCmsIpsecCtrl, MIB 25, 33, 67 post-provisioning 125
pktcMtaDevCmsTable, MIB 125 per-line proxy/registrar prohibited 187
pktcMtaDevConfigFile, MIB 29 SIP lines 146
pktcMtaDevCorrelationId, MIB 29–30 power
pktcMtaDevEnabled, MIB 191 failure operation 206
pktcMtaDevMacAddress, MIB 29 loss, AC 206
pktcMtaDevProvConfigHash, MIB 29, 36 management, Model 8 269
pktcMtaDevProvConfigKey, MIB 29 signal, constant 642
pktcMtaDevProvisioningEnrollment, MIB 29 Power
pktcMtaDevProvisioningState, MIB 39, 71 alarm 230
pktcMtaDevProvisioningStatus, MIB 29 Telemetry log 224
pktcMtaDevRealmTable, MIB 125 pp, DOCSIS Psm commands 592
pktcMtaDevSwCurrentVers, MIB 29 Pp, Main DOCSIS commands 590
pktcMtaDevTypeIdentifier, MIB 29 pp, Main System commands 555
pktcNcsEndPntConfigCallWaitingDelay, MIB 113 ppCfgMtaCallpFeatureSwitch, MIB 74, 92, 190, 283, 296
pktcNcsEndPntConfigCallWaitingMaxRep, MIB 113 ppCfgMtaCountryTemplate, MIB 68, 111, 283, 464, 680
pktcNcsEndPntConfigCriticalDialTO, MIB 192 ppcfgMtaCountryTemplate, MIB 191
pktcNcsEndPntConfigMaxHookFlash, MIB 123 ppCfgMtaFeatureSwitch, MIB 24, 84, 283
pktcNcsEndPntConfigMinHookFlash, MIB 123 ppCfgPortLocUserIndication, MIB 283
pktcNcsEndPntConfigMWD, MIB 177 ppCfgPortLoopCurrent, MIB 69, 283
pktcNcsEndPntConfigPartialDialTO, MIB 192 ppCfgPortT38MaxDatagram, MIB 103, 283
pktcNcsEndPntConfigTable, MIB 125 ppCfgRfc2833DigitPayloadType, MIB 75, 84, 92, 283
pktcNcsEndPntStatusError, MIB 39 ppSurvMtaMaintState, MIB 219
pktcSigDevCallerIdSigProtocol, MIB 108 ppSurvPortLcDiagLastResult, MIB 283
pktcSigDevCIDDTASAfterLR, MIB 109 ppSurvPortMaintState, MIB 219, 283
pktcSigDevCIDFskAfterDTAS, MIB 109 preset frequencies, provisioning 118
pktcSigDevCIDFskAfterRing, MIB 109 printAll, DOCSIS Fw commands 571
pktcSigDevCIDFskAfterRPAS, MIB 109 printcmstatusevents, DOCSIS Atp commands 566
pktcSigDevCIDMode, MIB 108 printds, RF commands 523
pktcSigDevCIDRingAfterFSK, MIB 109 printDsidDb, DOCSIS Dsid commands 589
pktcSigDevMultiFreqToneTable, MIB 111, 113 printLogFile, PACM Event commands 603
pktcSigDevR0Cadence, MIB 124, 466 printNvramDsUsFreqDb, DOCSIS Debug commands 584
pktcSigDevR7Cadence, MIB 124, 466 printscan, RF commands 519
pktcSigDevRgCadence, MIB 124, 466 printus, RF commands 529
pktcSigDevRsCadence, MIB 124, 466–467 printVendorRegisteredEvents, PACM Vendor commands 599
pktcSigDevToneDbLevel, MIB 112 privacy header feature switch, RFC3323 85
pktcSigDevToneFirstFrequency, MIB 111 process, firmware upgrade 47
pktcSigDevToneFourthFrequency, MIB 111 processing
pktcSigDevToneFreqAmpModePrtg, MIB 111 extended offhook 146
pktcSigDevToneFreqMode, MIB 111 hook flash 188, 196
pktcSigDevToneFreqRepeatCount, MIB 112 offhook 141, 172
pktcSigDevToneNumber, MIB 111 procwatch, Voice CallP commands 692
pktcSigDevToneOffDuration, MIB 112 prodSet, PACM Production commands 601
pktcSigDevToneOnDuration, MIB 112 Product Details screen 447

Firmware Guide Release 7.5 Standard 1.2 August 2012

732 Chapter 12

Production commands Psm, Main DOCSIS commands 591

PACM_CONFIG_EURO_set, PACM 601 psm, System PP commands 556
PACM_CONFIG_HW_ADDR_set, PACM 601 pulse
PACM_CONFIG_IP_ADDR_set, PACM 601 phantom 122
PACM_CONFIG_MTA_BBU_set, PACM 602 support, dial 122
PACM_CONFIG_MTA_NUM_LINES_set, PACM 601 PWoD tool, generating passwords 432
PACM_CONFIG_MTA_TELE_ID_set, PACM 601
prodSet, PACM 601
save, PACM 602
Q
setDefaultMacAddress, PACM 602 QoS, DSx 57
show, PACM 602 Qos, Main DOCSIS commands 575
production, Main PACM commands 601 QoS Statistics screen 449
prohibited, post-provisioning, per-line proxy/registrar 187 qos, System PP commands 557
protection state, line card over-current 207 Quality
provDBcontents, PACM Provisioning sub-commands 594 Dynamic 57
provDebug, PACM Provisioning sub-commands 595 provisioning 57
provFlow, PACM Provisioning sub-commands 595 quarantine
provision, Voice Linecard commands commands 654 endpoint, lockstep 75
provisional response feature switch 75 mode feature switch, lockstep 75
provisioning QueueLimitConfig, Logger commands 609
considerations for European loads 28 queueLimitShow, Logger commands 613
firmware upgrading, through 45 quit, Voice common commands 619
gain control 114
hook flash timing 123
jitter buffer 105
R
L2VPN 54 ranges, OUI 20
Main PACM commands 593 rates, packetization 60
modes 33 rc, Gateway sub-mode commands 532
modes, DHCP parameters 39 read
modes, IPv6 42 DOCSIS Debug commands 580
IPv6 42 RF commands 521
PacketCable 33 Voice Linecard commands commands 653
preset frequencies 118 reason log, last reset 503
Quality of Service 57 RebootSimulate, DOCSIS Debug commands 586
ring cadences 465 reconfig, DSP commands 636
SIP, refresh eDVA 146 recovery, network failure 233
Provisioning sub-commands redirect feature switch, NCS 75
configFile, PACM 594 reflection page 628
dhcpServersConfig, PACM 593 refresh eDVA provisioning, SIP 146
hashBypassSet, PACM 594 REG-ACK support 268
provDBcontents, PACM 594 regdump, Voice Linecard commands commands 653
provDebug, PACM 595 regevent_timer, Voice CallP commands 690
provFlow, PACM 595 Registration
provStatus, PACM 595 screen 444
sendCMFullScanNoQam, PACM 593 alarm, SIP 225
sendCMLinkDownEvent, PACM 593 rejection handling, SIP call 85
sendCMLinkUpEvent, PACM 593 related feature switch, RFC2833 82, 98
sendCMQamRegained, PACM 593 relay
sendCMResetEvent, PACM 593 DNS 128
sendDHCPLeaseFailEvent, PACM 593 DTMF 60, 92
sendDHCPNewIPEvent, PACM 593 SuperG3 FAX 689
sendMSMStartEvent, PACM 593 rem, DOCSIS General commands 564
sendMTAResetEvent, PACM 594 remote
sendSecRstDoneEvent, PACM 594 loopback test 460
sendSecRstFailEvent, PACM 594 metrics 379
sendVoiceRstDoneEvent, PACM 594 ringtone 85
sendVoiceRstFailEvent, PACM 594 remove authorization headers 85
setVoiceLoopVoltage, PACM 594 repeat dialing, SIP 200
tftpAlwaysOn, PACM 594 reporting
provisioning events 215
T.38 101, 188 per-call Syslog 369
TR-069 133 reqCoding, DSP commands 634
TR-069 TLV-43 based 133 reqNullCoding, DSP commands 634
XML-based router 131 requery_dns, Voice CallP commands, dnsTools sub-mode 692
provmethod, Voice MTA commands 695 request, DHCP lease time 30
provStatus, PACM Provisioning sub-commands 595 required, DHCP options 39
proxy see P-CSCF. reseqDsids, DOCSIS Dsid commands 589
Proxy Loss of Communications, alarm, SIP 226 !reset, DSP commands 644
proxy penalty box feature switch, SIP 85 reset, Gateway sub-mode commands 532
proxy/registrar prohibited, post-provisioning, per-line 187 !reset, General Console Commands 500
psm, DOCSIS Psm commands 592 reset reason log, last 503

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 733

!reset, Technician commands 512 frequency, configuring 108

reset to factory defaults 429 Voice CallP commands 683
!reset, Voice common commands 619 Voice Linecard commands commands 657
reset_tdm, DSP commands, dim 629 waveform, sinusoidal 67
resetaccesstime, DOCSIS Certification commands 563 waveform, trapezoidal 67
resetChrgr, Telemetry commands 514 ringfreq, Voice Linecard commands commands 663
resetDefaults, Technician commands 512 ringing
ResetLog, Event Manager commands 614 configuring distinctive 202
resetLogFile, PACM Event commands 603 waveform 67
resetMTA, Voice MTA commands 696 ringtone, remote 85
resetStats, System PP commands 555 rip2, MIB 362
resetTables, PACM Event commands 604 rip2IfConfTable, MIB 362
resetTickets, PACM Security commands 595 rip2IfStatTable, MIB 362
resetTimeout, System PP commands 555 rng_cad, Voice CallP commands 688
response tones, configuring SIP failure 167 rootpublickey, DOCSIS Certification commands 563
restart, DSP commands 641 router provisioning, XML-based 131
restore, PACM rread, Voice Linecard commands commands 654
PACM Debug commands 605 RTCP ToS byte 66
PACM Dynamic Config commands 603 rtcp_info
PACM Manager commands 607 DSP commands 637
PACM Vendor commands 600 Voice CallP commands 679
restored to factory defaults, alarm, Unit has been 231 rtcpdbg, DSP commands 631
resume, LED commands 506 RTCP-XR 379
RF commands rtosStats, DOCSIS Fw commands 570
!appmode 530 RTP session, modify 687
cache 521 RTP/RTCP feature switch, AES encryption for 75
cert 522 running
channelset 523 line card diagnostics 419
clearcw 522 loop diagnostics 420
clearfreq 518 rxtx_stat, DSP commands 637
dfreq 517
dlock 519
dsavg 522
S
dstatus 516 save, PACM
dtune 519 PACM Debug commands 605
dump 520 PACM Dynamic Config commands 603
!ecache 530 PACM Manager commands 607
freqband 517 PACM Production commands 602
macread 521 PACM Vendor commands 601
macwrite 521 scan, Main DOCSIS commands 560
nbdfreq 518 scanmode, RF commands 519
printds 523 Scanning Override screen 118, 446
printscan 519 screen
printus 529 Call Signalling Log 450
read 521 Configuration Parameters 451
scanmode 519 DHCP Parameters 448
sweep 518 Event Log 442
trr 519 Hardware/Firmware Versions 441
trw 519 Product Details 447
tune 517 QoS Statistics 449
tunerset 523 Registration Status 444
ufreq 518 Scanning Override 118, 446
ustatus 517 Technical Support 452
wbdfreq 518 Wireless 446
write 521 scwidTest, Voice CallP commands 685
rf_diag, System sub-mode commands 505 SDP
RFC2833 60, 75, 92, 102 AES encryption parameters 75
DTMF interactions with 83, 99 capability descriptor, T.38-only 75
feature switch, send DTMF via 75, 92 feature switch affecting 79, 94
payload type 94 feature switch 75, 92 MPTIME parameter 75
related feature switch 82, 98 parameter list considerations 100
RFC3315 44 sdqm, Voice CallP commands 691
RFC3323 privacy header feature switch 85 search, Gateway sub-mode commands 531
RFC3611 377 sec, Voice CallP commands 681
RFC3842 handshake feature switch 85 Security commands
RFC3903 365 certificates, PACM 596
RFC4028 85 displayDB, PACM 596
RFC5031 143, 174 mtaDisplay, PACM 596
ring overrideCmsTtl, PACM 595
cadence 685 resetTickets, PACM 595
cadences, displaying 688 smDataDisplay, PACM 595
cadences, provisioning 465 timersDisplay, PACM 595

Firmware Guide Release 7.5 Standard 1.2 August 2012

734 Chapter 12

security setTimeout, System PP commands 555

IP 25, 67 setting
Main PACM commands 595 DST policy 21
seed, changing the password 433 loop voltage management 73
send DTMF via RFC2833 feature switch 75, 92 settings, DSP jitsim commands 645
sendCMFullScanNoQam, PACM Provisioning sub-commands 593 setVoiceLoopVoltage, PACM Provisioning sub-commands 594
sendCMLinkDownEvent, PACM Provisioning sub-commands 593 setvp, DSP
sendCMLinkUpEvent, PACM Provisioning sub-commands 593 DSP commands 634
sendCMQamRegained, PACM Provisioning sub-commands 593 DSP jitsim commands 651
sendCMResetEvent, PACM Provisioning sub-commands 593 setWanDns, Technician commands 509
sendDHCPLeaseFailEvent, PACM Provisioning sub-commands setWanGateway, Technician commands 508
593 setWanIp, Technician commands 508
sendDHCPNewIPEvent, PACM Provisioning sub-commands 593 severitiesList, Logger commands 611
SendEvent, Event Manager commands 613 SeverityConfig, Logger commands 608
sendEvent, PACM Event commands 603 sfStats, DOCSIS Fw commands 568
sendMSMStartEvent, PACM Provisioning sub-commands 593 SG3FaxRelay, Voice CallP commands 689
sendMTAResetEvent, PACM Provisioning sub-commands 594 shift feature switch, enable ifIndex 84
sendSecRstDoneEvent, PACM Provisioning sub-commands 594 ShortDisplay, Logger commands 610
sendSecRstFailEvent, PACM Provisioning sub-commands 594 Show, Main DOCSIS commands 561
SendStdTrap, Event Manager commands 614 show
sendVoiceRstDoneEvent, PACM Provisioning sub-commands 594 OOS instead of IDLE for unprovisioned lines 75
sendVoiceRstFailEvent, PACM Provisioning sub-commands 594 PACM Debug commands 606
sent, signaling message, last 367 PACM Dynamic Config commands 603
servers, configuring trap 258 PACM Manager commands 607
service PACM Production commands 602
limitations 20 PACM Vendor commands 601
partial 267 showconfig, Voice MTA commands 693
Teen Line 164 showDebugOptions, DOCSIS Debug commands 585
serviceRoutes, Voice CallP commands 690 showEthernet, Technician commands 511
session showHttpAccess, Technician commands 511
modify RTP 687 showRip, Technician commands 510
System PP commands 556 showRipLog, Technician commands 510
set showStatus, Technician commands 511
Gateway sub-mode commands 531 showTACACS, Technician commands 510
PACM Dynamic Config commands 602 showWan, Technician commands 509
template, linecard 661 sig_trace, Voice CallP commands 687
set_cadence, Voice CallP commands 685 signal, constant power 642
set_status_req, DSP commands, dim 629 signaling
SetAllDebugOptions, DOCSIS Debug commands 584 buffer 686
SetDebugOption, DOCSIS Debug commands 584 message, last sent 367
setDefaultMacAddress, PACM Production commands 602 PacketCable 1.5 extended 100
setDefaults, Logger commands 613 ports 26
setDhcpEnable, Technician commands 509 trace 240, 687
setDhcpPool, Technician commands 509 signalling
setequthresh, DOCSIS Debug commands 579 configuration parameters, display 694
setEthernet, Technician commands 511 log, displaying 668
SetEventLevel, Event Manager commands 614 log, enabling 668
SetEventMask, Event Manager commands 615 log, erasing 669
SetEventText, Event Manager commands 615 single password, generating 432
setgain, Voice CallP commands 671 sinusoidal ring waveform 67
setHttpLanAccess, Technician commands 511 SIP
setHttpWanAccess, Technician commands 511 Authentication Failure, alarm 225
setLanIp, Technician commands 509 busy indication dialing 200
SetMdCfgIpProvMode, DOCSIS Debug commands 587 call rejection handling 85
SetMimo, DOCSIS Debug commands 586 CODECs, supported by 63, 192
SetModule, System SME commands 558 dialing features supported 197
SetPriorityMask, Event Manager commands 615 digit map objects 191
setRipAuth, Technician commands 510 domain override 195
setRipDhcpEnable, Technician commands 510 failure response tones, configuring 167
setRipEnable, Technician commands 510 feature switch 85
setRipIp, Technician commands 510 firmware upgrade, from NCS loads to 45
setRipKeyId, Technician commands 510 alarm 224
setRipLogMask, Technician commands 510 hybrid features 199
setRouteMode, Technician commands 508 lines, post-provisioning 146
SetSeverity, System SME commands 558 NCS, firmware upgrade, from 45
setTACACSSecret, Technician commands 509 loads, upgrading 45
setTACACSServer, Technician commands 509 local busy tone 85
setThreshold, System PP commands 557 loopback test 460
SetThrotAdmin, Event Manager commands 616 maximum UDP packet size 192
SetThrotInterval, Event Manager commands 616 netwloop 460
SetThrotThresh, Event Manager commands 616 alarm 225
netwtest 460

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 735

Proxy Loss of Communications, alarm 226 sipCfgPacketizationRate, MIB 192

proxy penalty box feature switch 85 sipCfgPacketLoopbackNumber, MIB 141, 171, 460
refresh eDVA provisioning 146 sipCfgPenaltyBoxTimeout, MIB 85
Registration Timeout, alarm 225 sipCfgPortDisplayName, MIB 191
repeat dialing 200 sipCfgPortFaxOnlyTimeout, MIB 101–103, 201
T1 timer 193 sipCfgPortFeatureSettings, MIB 181, 188, 192, 196
T.38 configuration 103, 201 sipCfgPortLogin, MIB 191
sip_callleg, Voice CallP commands 689 sipCfgPortMaxT38HSRedLevel, MIB 101, 188
sip_digitmap, Voice CallP commands 690 sipCfgPortMWIClear, MIB 169
sip_display_agpwd, Voice CallP commands 690 sipCfgPortPassword, MIB 191
sip_dns, Voice CallP commands 690 sipCfgPortProxyAdr, MIB 187, 194
sip_error, Voice CallP commands 689 sipCfgPortProxyPort, MIB 187, 194
sip_ftr, Voice CallP commands 690 sipCfgPortProxyType, MIB 187, 194
sip_ftr2, Voice CallP commands 690 sipCfgPortRegistrarAdr, MIB 187, 194
sip_impu, Voice CallP commands 690 sipCfgPortRegistrarPort, MIB 187, 194
sip_pub, Voice CallP commands 689 sipCfgPortRegistrarType, MIB 187, 194
sip_reg, Voice CallP commands 689 sipCfgPortT38Mode, MIB 101, 103, 188, 201
sip_rv, Voice CallP commands 689 sipCfgPortUserName, MIB 191
sip_stack_ver, Voice CallP commands 690 sipCfgPortWarmLineTimeout, MIB 150, 199–200
sip_subs, Voice CallP commands 689 sipCfgPortWarmOrHotlineEnable, MIB 150
sip_trans, Voice CallP commands 689 sipCfgPortWarmOrHotlineNumber, MIB 150, 199–200
sipCfgAlertInfoR0, MIB 143, 174, 182, 202 sipCfgProvisionedCodecArray, MIB 62, 151, 192
sipCfgAlertInfoR1, MIB 202 sipCfgProxyAdr, MIB 187
sipCfgAlertInfoR2, MIB 202 sipCfgProxyType, MIB 187
sipCfgAlertInfoR3, MIB 202 sipCfgRegExpires, MIB 177, 194
sipCfgAlertInfoR4, MIB 202 sipCfgRegistrarAdr, MIB 187
sipCfgAlertInfoR5, MIB 202 sipCfgRegistrarType, MIB 187
sipCfgAlertInfoR6, MIB 202 sipCfgRegTimerMax, MIB 177, 193
sipCfgAlertInfoR7, MIB 143, 174, 182, 202 sipCfgRegTimerMin, MIB 177, 193
sipCfgAnonCallRejectionCapability, MIB 184, 189 sipCfgRepeatDialingInterval, MIB 179, 201
sipCfgBusyDigitMap, MIB 192, 201 sipCfgRepeatDialingSessionProgressTimer, MIB 179, 201
sipCfgCallerIdDisplayCapability, MIB 184, 189 sipCfgRepeatDialingTimeout, MIB 179, 201
sipCfgCallerIdSendCapability, MIB 184, 189 sipCfgResetCallWaitingStarCode, MIB 180, 189
sipCfgCallForwardCapability, MIB 184, 189 sipCfgSessionExpires, MIB 193
sipCfgCallForwardForbiddenNumbers, MIB 179 sipCfgSipFeatureSwitch, MIB 85, 142–143, 153–154, 167,
sipCfgCallHoldCapability, MIB 184, 189 173–174, 192
sipCfgCallRedialCapability, MIB 184, 189 sipCfgSipFeatureSwitch2, MIB 89
sipCfgCallReturnCapability, MIB 184, 189 sipCfgT1, MIB 177, 184, 193
sipCfgCallTransferCapability, MIB 184, 189 sipCfgThreeWayCallCapability, MIB 184, 189
sipCfgCallWaitingCapability, MIB 184, 189 sipCfgTimerB, MIB 184
sipCfgCallWaitingStarCodeSurvivesReset, MIB 180, 189 sipCfgTimerF, MIB 147, 177, 184
sipCfgDefaultG711, MIB 60, 180 sipCfgWarmLineTimeout, MIB 150
sipCfgDialFeatActive, MIB 199–200 sipCfgWarmOrHotlineNumber, MIB 150
sipCfgDialFeatCode, MIB 198 size, SIP, maximum UDP packet 192
sipCfgDialFeatMap, MIB 198 skip USM user name comparison feature switch 84
sipCfgDialFeatMode, MIB 199 smDataDisplay, PACM Security commands 595
sipCfgDialFeatName, MIB 198 sme, Main System commands 557
sipCfgDialFeatTable, MIB 182, 199–200 SNMP
sipCfgDialFeatTone, MIB 198 access, enabling 245
sipCfgDialProxyActive, MIB 197 access mode 246
sipCfgDialProxyCode, MIB 197 coexistence 245
sipCfgDialProxyMap, MIB 197 coexistence, configuring 245
sipCfgDialProxyMessageType, MIB 197 coexistence, IPv6 212
sipCfgDialProxyMethod, MIB 197 configuration for coexistence 246
sipCfgDialProxyNumber, MIB 197 Entity, overriding 32
sipCfgDialProxyTable, MIB 182 firmware upgrading, through 46
sipCfgDialProxyTone, MIB 197 INFORM checks feature switch, bypass 84
sipCfgDigitMap, MIB 191 trap transmission 246
sipCfgDistinctiveRingingForCallHold, MIB 202 vacmAccessTable 248
sipCfgDomainOverride, MIB 180, 195 view logs 236
sipCfgEmergencyNumber, MIB 180 snmpCommunityContextEngineID, MIB 247
sipCfgEmergencyServiceURN, MIB 143, 154, 174 snmpCommunityContextName, MIB 247
sipCfgFeatureSettings, MIB 183 snmpCommunityName, MIB 247, 250
sipCfgGenLinger, MIB 146, 185 snmpCommunitySecurityName, MIB 247, 250
sipCfgInviteLinger, MIB 185 snmpCommunityStatus, MIB 247, 250
sipCfgMaxRetrans, MIB 184, 193 snmpCommunityStorageType, MIB 247
sipCfgMaxUDPSize, MIB 192 snmpCommunityTable
sipCfgMediaLoopbackNumber, MIB 141, 171, 460 adding 249
sipCfgMWITargetAddr, MIB 169 MIB 245, 247, 249
sipCfgMWITargetAddrType, MIB 169 snmpCommunityTransportTag, MIB 247
sipCfgMWITargetPort, MIB 169 SocketConfig, Logger commands 608

Firmware Guide Release 7.5 Standard 1.2 August 2012

736 Chapter 12

socketShow, Logger commands 612 sub-TLVs, TR-069 134

Speedtest Results, alarm 231 SuperG3 FAX 104
spls, Voice CallP commands 690 relay 689
spy, DSP commands 632 support
SRV lookup feature switch 85 Caller ID 22
SSH CM-STATUS 268
accessing the CLI through 438 configuring MWI 169
log 226 DHCP option 43 30
log 226 DHCP option 51 30
st_cleanup, DSP commands 642 DHCP option 60 30–31
st_setup, DSP commands 642 DHCP option 67 32
StartSNMP, Event Manager commands 617 dial pulse 122
StartSyslog, Event Manager commands 616 European flash 85
State fax/modem 90
Voice Line 223 IPv6 multicast 208
Voice Line Protection 223 PacketCable 1.5 84
state REG-ACK 268
DSP commands 634 TLV-39 27
Voice Linecard commands commands 662 TLV-41 27
states VMWI 85
CM 444 supported
eDVA 219 SIP, CODECs 63, 192
statistics CODECs 60
clearing counters, end of call connection 365 SIP dialing features 197
device level, end of call connection 366 suspendcmstatus, DOCSIS Atp commands 566
end of call 686 sweep, RF commands 518
end of call connection 364 synchronous upstreams, considerations 269
line level, end of call connection 367 sysDescr, MIB 29, 360–361
stats sysinfo, System sub-mode commands 502
DOCSIS Pp commands 590 Syslog reporting, per-call 369
System PP commands 556 sysObjectID, MIB 361
status sysORDescr, MIB 362
battery charger, display 512 sysORID, MIB 362
display downstream 516 sysORTable, MIB 362
display linecard 664 system descriptor 360
Display upstream 517 MIB 360
DOCSIS Certification commands 563 objects 360
General Console Commands 499 System
monitoring 439 commands, brief 556
persistent line 690 commands, dbg 555
persistent, line 65 commands, deinit 555
cable modem 440 commands, devs 556
Technician commands 512 commands, disable 555
statustuner, Main DOCSIS commands 560 commands, enable 555
StopSNMP, Event Manager commands 617 commands, global 556
StopSyslog, Event Manager commands 617 commands, nodbg 556
sub-commands commands, nopsm 556
configFile, PACM Provisioning 594 commands, noqos 557
dhcpServersConfig, PACM Provisioning 593 commands, pids 556
hashBypassSet, PACM Provisioning 594 commands, psm 556
provDBcontents, PACM Provisioning 594 commands, qos 557
provDebug, PACM Provisioning 595 commands, resetStats 555
provFlow, PACM Provisioning 595 commands, resetTimeout 555
provStatus, PACM Provisioning 595 commands, session 556
sendCMFullScanNoQam, PACM Provisioning 593 commands, setThreshold 557
sendCMLinkDownEvent, PACM Provisioning 593 commands, setTimeout 555
sendCMLinkUpEvent, PACM Provisioning 593 commands, stats 556
sendCMQamRegained, PACM Provisioning 593 commands, thresholdDisable 557
sendCMResetEvent, PACM Provisioning 593 commands, vpids 556
sendDHCPLeaseFailEvent, PACM Provisioning 593 commands, list 557
sendDHCPNewIPEvent, PACM Provisioning 593 commands, llong 558
sendMSMStartEvent, PACM Provisioning 593 commands, lshort 557
sendMTAResetEvent, PACM Provisioning 594 commands, SetModule 558
sendSecRstDoneEvent, PACM Provisioning 594 commands, SetSeverity 558
sendSecRstFailEvent, PACM Provisioning 594 commands, buffer 504
sendVoiceRstDoneEvent, PACM Provisioning 594 commands, dhcp 502
sendVoiceRstFailEvent, PACM Provisioning 594 commands, dpacm 504
setVoiceLoopVoltage, PACM Provisioning 594 commands, exception 504
tftpAlwaysOn, PACM Provisioning 594 commands, gw_diag 504
Sub-Mode, Voice CallP commands, dnsTools 692 commands, lastreset 503
sub-option 3, overriding, DHCP option 122 32 commands, rf_diag 505
commands, sysinfo 502

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 737

commands, telnet_timer 503 templates, country code 464

sysUpTime, MIB 307 temptuner, DOCSIS Debug commands 580
test
caller ID 685
T remote, loopback 460
T1 timer, SIP 193 SIP loopback 460
T.38 testDsLoss, Main DOCSIS commands 561
capability descriptor feature switch 75 tftpAlwaysOn, PACM Provisioning sub-commands 594
configuration 102 thresholdDisable, System PP commands 557
configuration, SIP 103, 201 through
fax relay 93 provisioning, firmware upgrading 45
provisioning 101, 188 SNMP, firmware upgrading 46
T.38-only, SDP capability descriptor 75 time
TACACS+ 399 delay 687
WebGUI 440 offset, adjusting 20
tapi TimeDisplay, Logger commands 609
Telemetry commands 513 timeoverversion, DOCSIS Show commands 562
Voice CallP commands 696 timer
TargetConfig, Logger commands 610 CLI inactivity 503
targetsList, Logger commands 612 loop voltage management, plant maintenance 71
taskwatch, Voice CallP commands 691 SIP T1 193
tcid_rec, Voice CallP commands 678 timers, Main System commands 555
tdox, DOCSIS Pp commands 590 timersDisplay, PACM Security commands 595
tdoxStats, DOCSIS Fw commands 575 timings, default hook flash 464
Technical Support screen 452 tlmStatus, Telemetry commands 512
Technician commands TLV-39 support 27
commit 512 TLV-41 support 27
!reset 512 TLV-43 based provisioning, TR-069 133
resetDefaults 512 ToD see Time of day.
setDhcpEnable 509 ToD feature switch, halt on no 84
setDhcpPool 509 tone
setEthernet 511 detection 642
setHttpLanAccess 511 DSP commands 634
setHttpWanAccess 511 generation, gain compensated 114
setLanIp 509 SIP local busy 85
setRipAuth 510 Voice Linecard commands commands 659
setRipDhcpEnable 510 tones
setRipEnable 510 adjusting CW-CID 114
setRipIp 510 configuring SIP failure response 167
setRipKeyId 510 Voice CallP commands 687
setRipLogMask 510 tool
setRouteMode 508 Password of the Day 431
setTACACSSecret 509 using the Password of the Day 431
setTACACSServer 509 ToS byte, RTCP 66
setWanDns 509 Touchstone
setWanGateway 508 log 227
setWanIp 508 log 228
showEthernet 511 log 228
showHttpAccess 511 log 229
showRip 510 log 229
showRipLog 510 log 229
showStatus 511 tpPorts, DOCSIS Pp commands 590
showTACACS 510 TR-069
showWan 509 provisioning 133
status 512 sub-TLVs 134
Teen Line service 164 TLV-43 based provisioning 133
telemetry, battery 206 TR69AcsInfo 134
Telemetry tr69Start, Database commands 532
commands 512 tr69Stop, Database commands 533
commands, chgrStatus 512 tr69Update, Database commands 533
commands, eprom 514 trace
commands, resetChrgr 514 customer-originated 150
commands, tapi 513 logs, DHCP message 234
commands, tlmStatus 512 logs, DSx message 234
log, Power Supply 224 logs, MGCP message 234
Telnet, accessing the CLI through 437 signaling 240, 687
telnet_timer, System sub-mode commands 503 Voice CallP commands 669
template tracing, enable message 235
country code 687 traffic
linecard, set 661 DSP commands 641
Voice Linecard commands commands 661 filtering, IPv6 211

Firmware Guide Release 7.5 Standard 1.2 August 2012

738 Chapter 12

transmission vacmAccessStatus, MIB 248, 255

inband DTMF 121 vacmAccessTable 255
SNMP, trap 246 Adding 255
trap MIB 245, 248, 255
servers, configuring 258 parameters 248
transmission, SNMP 246 SNMP 248
trapezoidal ring waveform 67 vacmAccessWriteViewName, MIB 248, 255
triggercmstatus, DOCSIS Atp commands 565 vacmGroupName, MIB 248, 252
troubleshooting 439 vacmSecurityModel, MIB 247–248
interface, controlling access 439 vacmSecurityName, MIB 247–248
trr, RF commands 519 vacmSecurityToGroupStatus, MIB 248, 252
true, MIB 191 vacmSecurityToGroupStorageType, MIB 248, 252
trw, RF commands 519 vacmSecurityToGroupTable 252
tune Adding 252
DOCSIS General commands 564 MIB 245, 247–248, 252
RF commands 517 vbat, Voice Linecard commands commands 663
tuner, Main DOCSIS commands 560 vbdbitmap, DSP commands 643
tunerset, RF commands 523 vbdmax, DSP commands 643
tunerstatus, DOCSIS Debug commands 580 vbdmin, DSP commands 643
TurboDOX 66 vbdnom, DSP commands 643
TurboDox VbdOverwriteJitterBuffer, MIB 294
counters 575 Vendor Class Identifier 30–31
database 590 commands, printVendorRegisteredEvents, PACM 599
disable 590 commands, restore, PACM 600
enable 590 commands, save, PACM 601
commands, show, PACM 601
commands, VENDOR_ADD_SNMP_TARGET_set, PACM
U 600
ucd, DOCSIS General commands 564 commands, VENDOR_AFTER_DHCP_ACK_set, PACM
ucdCollectStatus, DOCSIS Debug commands 584 599
UDP packet size, SIP, maximum 192 commands, VENDOR_AFTER_MSM_INIT_set, PACM
ufreq, RF commands 518 599
unconfig, DSP commands 633 commands, VENDOR_BEFORE_MTA_RESET_set, PACM
Unit has been restored to factory defaults, alarm 231 600
unlisted payloads feature switch, ignore 75 commands, VENDOR_DISABLE_CFM_SPEC_TREE_set,
unprovisioned lines, show OOS instead of IDLE for 75 PACM 600
upgrade commands, VENDOR_ENABLE_CFM_PLUG_IN_set,
from NCS loads to SIP, firmware 45 PACM 600
from SIP loads to NCS, firmware 45 commands, VENDOR_ENABLE_DHCP_PLUG_IN_set,
MIB, firmware 50 PACM 600
options, firmware 49 commands, VENDOR_ENABLE_EVENTS_set, PACM 600
process, firmware 47 commands, VENDOR_SET_DHCP_SERVER_ADDR_set,
upgrading PACM 599
firmware 47 commands, VENDOR_SET_TFTP_DATA_set, PACM 599
NCS loads 45 commands, VENDOR_STATUS_VENDOR_APP_set,
SIP loads 45 PACM 599
through provisioning, firmware 45 commands, vendorAddSnmpTarget, PACM 598
through SNMP, firmware 46 commands, vendorModifyDhcpAckParam, PACM 598
upstream commands, vendorSetDhcpServerAddr, PACM 598
DOCSIS Psm commands 591 commands, vendorSetTftpData, PACM 598
status, Display 517 Vendor Specific Information 30
UpstreamPacketClassification, MIB 190 VENDOR_ADD_SNMP_TARGET_set, PACM Vendor commands
upstreams, considerations, synchronous 269 600
USB not supported, WBM750 24 VENDOR_AFTER_DHCP_ACK_set, PACM Vendor commands
user name comparison feature switch, skip USM 84 599
UserDisplay, Logger commands 610 VENDOR_AFTER_MSM_INIT_set, PACM Vendor commands
using the Password of the Day tool 431 599
USM user name comparison feature switch, skip 84 VENDOR_BEFORE_MTA_RESET_set, PACM Vendor commands
usstatus, DOCSIS Debug commands 581 600
ustatus, RF commands 517 VENDOR_DISABLE_CFM_SPEC_TREE_set, PACM Vendor
commands 600
VENDOR_ENABLE_CFM_PLUG_IN_set, PACM Vendor
V commands 600
V.8 104 VENDOR_ENABLE_DHCP_PLUG_IN_set, PACM Vendor
vacmAccessContentPrefix, MIB 248 commands 600
vacmAccessContextMatch, MIB 248, 255 VENDOR_ENABLE_EVENTS_set, PACM Vendor commands
vacmAccessNotifyViewName, MIB 248, 255 600
vacmAccessReadViewName, MIB 248, 255 VENDOR_SET_DHCP_SERVER_ADDR_set, PACM Vendor
vacmAccessSecurityLevel, MIB 248 commands 599
vacmAccessSecurityModel, MIB 248 VENDOR_SET_TFTP_DATA_set, PACM Vendor commands 599
vacmAccesssStorageType, MIB 248, 255 VENDOR_STATUS_VENDOR_APP_set, PACM Vendor
commands 599

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Index 739

vendorAddSnmpTarget, PACM Vendor commands 598 CallP commands, serviceRoutes 690

vendorModifyDhcpAckParam, PACM Vendor commands 598 CallP commands, set_cadence 685
vendorSetDhcpServerAddr, PACM Vendor commands 598 CallP commands, setgain 671
vendorSetTftpData, PACM Vendor commands 598 CallP commands, SG3FaxRelay 689
vendorSubMenu, Main PACM commands 597 CallP commands, sig_trace 687
verify EPROM checksums, battery 514 CallP commands, sip_callleg 689
version CallP commands, sip_digitmap 690
BootROM image 360 CallP commands, sip_display_agpwd 690
DOCSIS Fw commands 566 CallP commands, sip_dns 690
firmware 360 CallP commands, sip_error 689
Main DOCSIS commands 559 CallP commands, sip_ftr 690
Main PACM commands 592 CallP commands, sip_ftr2 690
view logs, SNMP 236 CallP commands, sip_impu 690
VMWI 75 CallP commands, sip_pub 689
support 85 CallP commands, sip_reg 689
vmwi, Voice CallP commands 686 CallP commands, sip_rv 689
Voice Band Data 105, 643 CallP commands, sip_stack_ver 690
CallP commands, auto_osi 689 CallP commands, sip_subs 689
CallP commands, buf_store 686 CallP commands, sip_trans 689
CallP commands, callpClrLog 669 CallP commands, spls 690
CallP commands, callpDispLog 668 CallP commands, tapi 696
CallP commands, callpEnblLog 668 CallP commands, taskwatch 691
CallP commands, change_ne 671 CallP commands, tcid_rec 678
CallP commands, checkStackRes 690 CallP commands, tones 687
CallP commands, chg_alink 684 CallP commands, trace 669
CallP commands, chg_dialing 680 CallP commands, vmwi 686
CallP commands, chg_polarity 684 CallP commands, vqClear 696
CallP commands, chg_power 684 CallP commands, vqLocEnable 696
CallP commands, chg_state 683 CallP commands, vqMetrics 696
CallP commands, chg_template 680 CallP commands, vqRemEnable 696
CallP commands, chst 667 common commands, help 619
CallP commands, cid 685 common commands, quit 619
CallP commands, conn_rec 676 common commands, !reset 619
CallP commands, cotdump 690 log 222
CallP commands, cpq 681 log 223
CallP commands, ddly 687 voice line ports 26
CallP commands, dds 666 Voice
CallP commands, dlr 666 State Change log 223
CallP commands, dmon 673 State Change log 223
CallP commands, dmp_stack 692 Linecard commands, batcal 666
CallP commands, dnsTools Sub-Mode 692 Linecard commands commands, cal_dump 665
CallP commands, dnsTools sub-mode, force_lkup 692 Linecard commands commands, deprovision 654
CallP commands, dnsTools sub-mode, pne_print 692 Linecard commands commands, diag 654
CallP commands, dnsTools sub-mode, requery_dns 692 Linecard commands commands, diagForce 655
CallP commands, dsp_reset 686 Linecard commands commands, dresults 655
CallP commands, dst 667 Linecard commands commands, enableidle 665
CallP commands, dsxClrLog 669 Linecard commands commands, errors 660
CallP commands, dsxDispLog 669 Linecard commands commands, hook 659
CallP commands, dsxEnblLog 669 Linecard commands commands, idle 660
CallP commands, dsxtrace 671 Linecard commands commands, lcstatus 664
CallP commands, dtmf 673 Linecard commands commands, loopc 658
CallP commands, dumpdm 690 Linecard commands commands, lpdiag 656
CallP commands, eoc_stats 686 Linecard commands commands, lpdiagForce 656
CallP commands, etsi 685 Linecard commands commands, lpresults 657
CallP commands, ftrsw 672 Linecard commands commands, objdump 654
CallP commands, gettimers 690 Linecard commands commands, polarity 658
CallP commands, is 688 Linecard commands commands, provision 654
CallP commands, lcquery 683 Linecard commands commands, read 653
CallP commands, lineInfo 682 Linecard commands commands, regdump 653
CallP commands, mdfy_rtp 687 Linecard commands commands, ring 657
CallP commands, mgcp 671 Linecard commands commands, ringfreq 663
CallP commands, oos 688 Linecard commands commands, rread 654
CallP commands, parser 682 Linecard commands commands, state 662
CallP commands, penalty_box 690 Linecard commands commands, template 661
CallP commands, procwatch 692 Linecard commands commands, tone 659
CallP commands, regevent_timer 690 Linecard commands commands, vbat 663
CallP commands, ring 683 Linecard commands commands, write 653
CallP commands, rng_cad 688 Linecard commands commands, xconnect 660
CallP commands, rtcp_info 679 Linecard commands, polling 666
CallP commands, scwidTest 685 MTA commands 693
CallP commands, sdqm 691 MTA commands, codecs 695
CallP commands, sec 681 MTA commands, config 693

Firmware Guide Release 7.5 Standard 1.2 August 2012

740 Chapter 12

MTA commands, getSig 694

MTA commands, mtaftrsw 695
MTA commands, provmethod 695
MTA commands, resetMTA 696
MTA commands, showconfig 693
Monitoring, managing 371
Monitoring MIBs 378
voltage management, setting, loop 73
vp_stat, DSP
DSP commands 640
DSP jitsim commands 652
vpids, System PP commands 556
vqClear, Voice CallP commands 696
vqLocEnable, Voice CallP commands 696
vqMetrics, Voice CallP commands 696
vqRemEnable, Voice CallP commands 696

W
Waiting Indicator, Message 85
warmline 199
waveform
ringing 67
sinusoidal ring 67
trapezoidal ring 67
wb-adc, DOCSIS Psm commands 592
wbdfreq, RF commands 518
WBM750 USB not supported 24
WebGUI
access levels 398
default passwords 398
TACACS+ 440
Wireless screen 446
with, RFC2833, DTMF interactions 83, 99
write
DOCSIS Debug commands 582
RF commands 521
Voice Linecard commands commands 653
wrmStatus, Gateway sub-mode commands 533

X
xconnect, Voice Linecard commands commands 660
XML configuration file 495
XML-based router provisioning 131
xmlLog, Database commands 534
xmlRestart, Database commands 534
xmlStatus, Database commands 533

Touchstone® Telephony Release 7.5 Standard 1.2 August 2012

Touchstone® Telephony Firmware Guide

Corporate Headquarters
ARRIS • Suwanee • Georgia • 30024 • USA
T: 1−678−473−2000 F: 1−678−473−8470

www.arrisi.com