Touchstone Telephony
Provisioning Guide
Document release: Release 4.5 Standard 2.0
Date: December 2005
About This Document
This document describes installation and provisioning of Touchstone™ Telephony
modems using TS4.5 software.
1 Installing and Upgrading Touchstone Software
This chapter provides procedures used to install and upgrade Touchstone software
on local DHCP and TFTP servers.
2 Provisioning Modes
You can provision Touchstone Telephony products using a variety of PacketCable-compliant and non-compliant tools.
3 Provisioning
You can provision Touchstone Telephony products using the procedures outlined
in this section.
4 MIB Reference
This chapter lists the MIBs referenced by the TS4.5 software. See the Touchstone
Software Troubleshooting Guide for a partial list of MIB variables used for troubleshooting.
5 Appendix A: Example Files
The following is a list of example data and telephony provisioning file templates
included with TS4.5. See the PacketACE Configuration Tools User’s Guide for
more information about using the templates.
6 Appendix B: Configuring the Service Provider Root
PacketCable requires a Service Provider certificate hierarchy, which allows other
network elements to authenticate the service provider's servers. The following figure shows the hierarchy.
ii
7 Appendix C: Line Parameters by Country
The following tables show the default tones and ring definitions for each supported
country template.
 2004, 2005 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
proprietary to ARRIS.
ARRIS, ARRIS Interactive, C3, C4, and Touchstone™ are trademarks of ARRIS International, Inc. Cadant is a registered trademark
of ARRIS International, Inc. All other trademarks and registered trademarks are the property of their respective holders.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Publication history
December 2005
Release 4.5 Standard 2.0 version of this document for TS4.5 MSUP 2.
November 2005
Release 4.5 Standard 1.0 version of this document for TS4.5 MSUP 1.
April 2005
Release 4.4 Standard 2.0 version of this document for TS4.4 MSUP 3.
March 2005
Release 4.4 Standard 1.0 version of this document.
February 2005
Release 4.3 Standard 1.0 version of this document.
August 2004
Release 4.2 Standard 1.0 version of this document.
Release 4.1 Standard 2.0 version of this document.
April 2004
Release 4.1 Standard 1.0 version of this document.
September 2003
Release 3.2 Standard 1.0 version of this document.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
iv
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Contents
About This Document
ix
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
In this Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Installing and Upgrading Touchstone Software
1
Load Name Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
About ARRIS Enhanced Software Loading . . . . . . . . . . . . . . . . . . . . . . . 2
Upgrade Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Enhanced Software Loading Options . . . . . . . . . . . . . . . . . . . . . . . . 3
ArrisCmDevSwAdminStatus MIB feature switch . . . . . . . . . . . . . . . . 3
ArrisCmDevSwTable MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Example Software Lineup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Example Configuration File Excerpt . . . . . . . . . . . . . . . . . . . . . . . . . 5
Rejecting Software Download Requests . . . . . . . . . . . . . . . . . . . . . . . . . 6
Procedure: Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Adding the CVC 8
Installing the Software on a File Server 9
Configuring the NIU to Download its Software 9
Setting Up ARRIS Enhanced Software Loading 9
Procedure: Upgrading Touchstone Software . . . . . . . . . . . . . . . . . . . . 11
Upgrading the Software through Provisioning 12
Upgrading the Software through SNMP 13
Changing Configuration Files for Upgrades from TS4.2 13
Provisioning Modes
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Provisioning Method Indicator. . . . . . . . . . . . . . . . . . . . .
Provisioning Event Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PacketCable Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PacketCable (no KDC) Sequence. . . . . . . . . . . . . . . . . . . . . . . . . .
GUPI (including variants)/Basic 1 Sequence . . . . . . . . . . . . . . . . .
Basic 2 Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Single MAC/Config File Sequence . . . . . . . . . . . . . . . . . . . . . . . . .
Setting Up the Provisioning Server Data. . . . . . . . . . . . . . . . . . . . .
Verifying MTA Provisioning and Endpoint Status . . . . . . . . . . . . . .
DHCP Support by Provisioning Mode . . . . . . . . . . . . . . . . . . . . . . . . . .
Options Required in All Provisioning Modes . . . . . . . . . . . . . . . . . .
15
15
15
17
18
19
19
20
22
22
23
23
23
23
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
vi
PacketCable Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GUPI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARRIS modified version of Simplified PacketCable Provisioning
(Basic 1 and Basic 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Single MAC/Config File Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DOCSIS Only Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DHCP Option 43 Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DHCP Option 60 Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning Considerations for European Loads . . . . . . . . . . . . . . . . .
Flow MTA15: SNMP Enrollment INFORM . . . . . . . . . . . . . . . . . . .
Flow MTA19: SNMPv3 SET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flow MTA23: TFTP Configuration File Request . . . . . . . . . . . . . . .
Flow MTA25: SNMP INFORM . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning Considerations for SIP Loads . . . . . . . . . . . . . . . . . . . . . .
SIP Feature Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Information Required for SIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning Management Features . . . . . . . . . . . . . . . . . . . . . . . . . . .
BackOff and Retry Mechanism Support . . . . . . . . . . . . . . . . . . . . .
About IPSec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service Interruptions during Software Upgrades . . . . . . . . . . . . . .
Call Management Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning CM and MTA Features . . . . . . . . . . . . . . . . . . . . . . . . . . .
Full DQoS Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DSX QoS Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Voice and Signalling Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CODECs and Packetization Rates Supported . . . . . . . . . . . . . . . .
CallP Feature Switch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MTA Feature Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CM Feature Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SIP Feature Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Country Code Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dial Pulse Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SIP Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
European Productization Support . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration File Provisioning Notes . . . . . . . . . . . . . . . . . . . . . . . . . .
Support for TLV-41 (Downstream Channel Lists) . . . . . . . . . . . . . .
Embedding ARRIS-Proprietary MIBs within TLV-43 . . . . . . . . . . . .
Monitoring MTA Provisioning Status . . . . . . . . . . . . . . . . . . . . . . . . . . .
Software Upgrade Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Procedure: Configuring Alarm and Log Reporting . . . . . . . . . . . . . . . .
Action 52
Procedure: Updating the KDC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the KDC to use the CableLabs Test root 53
Using the Test Root Download feature 54
Procedure: Controlling General NIU Functionality . . . . . . . . . . . . . . . .
Controlling Access to Troubleshooting Pages 56
Controlling Data Shutdown Functionality 57
Reading Software Load Information 57
Changing the ifInOctets Counter Operation 57
Setting the Telephony Port CATV Relay 58
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
24
25
25
26
26
26
27
27
27
28
28
28
28
28
28
31
31
31
31
31
32
32
33
33
33
33
34
34
38
40
41
41
43
43
44
44
44
46
46
48
49
53
56
vii
Setting the Loop Voltage Management Policy 58
Procedure: Controlling Cable Modem Functionality . . . . . . . . . . . . . . .
Setting Allowed CPE Counts 60
Toggling the DOCSIS Mode 60
Controlling the WAN Isolation State 61
Setting IPv6 Forwarding 62
Setting DOCSIS 1.0 Fragmentation Support 63
Procedure: Controlling MTA Functionality . . . . . . . . . . . . . . . . . . . . . .
Configuring Loop Current 64
Configuring Gain Control 65
Adjusting Delta Rx/Tx Gain 66
Configuring Dial Pulse Support 66
Configuring the Echo Cancellation Tail Length 67
Configuring the Ringing Waveform 67
Configuring the Dynamic RTP Port Range 68
Configuring Non-Phase Reversed Modem Tone Handling 68
Setting Jitter Buffer Parameters 69
Setting the Upstream Buffer Depth 69
Procedure: Provisioning SIP Support. . . . . . . . . . . . . . . . . . . . . . . . . .
CM Configuration File Changes 70
MTA Configuration File Changes 71
Setting up Dialing Features 73
Configuring Warmline or Hotline 74
Procedure: Provisioning European Productization Support . . . . . . . . .
Configuring Power Ring Frequency 76
Configuring On-Hook Caller ID 77
Configuring Visual Message Waiting Indicator 77
Configuring Tone Operations 78
Configuring Hook Flash Timing 80
Procedure: Provisioning Voice and Signalling Packet Priority . . . . . . .
Action 81
MIB Reference
60
64
70
76
81
83
Supported MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ARRIS Proprietary MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DOCSIS MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PacketCable MIBs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network-related MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Imports and Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Duplicate and Obsolete MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Duplicate MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Obsolete MIBs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Deprecated MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Order of Compilation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A: Example Files
Listing of Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Location of Template FIles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MTA Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cable Modem Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . .
Text Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SNMP Co-existence Example Configuration File . . . . . . . . . . . . . . . . .
83
83
84
84
85
85
86
86
87
89
89
93
93
93
93
94
96
97
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
viii
Software Upgrade Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Gateway Dial Pulse Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
SIP CM Configuration File Example . . . . . . . . . . . . . . . . . . . . . . . . . . 101
SIP MTA Configuration File Example . . . . . . . . . . . . . . . . . . . . . . . . . 103
Appendix B: Configuring the Service Provider Root
105
Service Provider Root Provisioning for Touchstone Telephony Modems .
106
MIBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Appendix C: Line Parameters by Country
Provisioning Ring Cadence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
North American Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . .
Provisioning European Ring Cadences . . . . . . . . . . . . . . . . . . . .
Austria Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Belgium Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
France Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Germany Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hungary Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Japan Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mexico Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MexicoC Ring Cadences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Netherlands/Netherlands09 Ring Cadences. . . . . . . . . . . . . . . . .
Norway Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Panama Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Poland Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Switzerland Ring Cadences . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customizing Default Ring Cadences . . . . . . . . . . . . . . . . . . . . . .
Default Tone Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
111
111
111
112
113
113
114
115
115
116
116
117
117
118
118
119
120
120
121
About This Document
This document describes installation and provisioning of Touchstone™
Telephony modems using TS4.5 software.
Audience
This manual assumes that you have a basic understanding of SNMP
management systems, DOCSIS® and PacketCable™ standards, and a
working knowledge of cable data and telephony networks.
In this Document
This document contains the following information:
•
Chapter 1, “Installing and Upgrading Touchstone Software,”
describes how to install and upgrade Touchstone software.
•
Chapter 2, “Provisioning Modes,” describes provisioning
modes, the communication sequence associated with each
mode, and how provisioning modes affect DHCP.
•
Chapter 3, “Provisioning,” provides provisioning notes and procedures.
•
Chapter 4, “MIB Reference,” provides a brief overview of standard and proprietary MIBs used in system management.
•
“Appendix A: Example Files,” provides complete and partial
examples of provisioning files.
•
“Appendix B: Configuring the Service Provider Root,”
describes how to change the Service Provider certificate for use
with KDC servers.
Terminology
The following is a list of terms and abbreviations used in this manual.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
x
About This Document
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 ToIP network to the
PSTN. A CMS includes both a Call Agent (CA) and the PSTN
gateway, and controls audio call connections.
CallP
Call Processing. Software controlling the current state of a call.
CBR
Constant Bit Rate. A data service that provides a guaranteed,
fixed amount of bandwidth. Technically, it is not possible to
provide actual CBR services over an IP network due to factors
such as contention and latency. UGS service flows and lowlatency hardware such as the ARRIS™ Cadant® C4 CMTS,
however, can provide an approximation suitable for carriergrade telephone service.
Classifier
Rules used to classify packets into a Service Flow. The device
compares incoming packets to an ordered list of rules at several
protocol levels. Each rule is a row in the docsQosPktClassTable.
A matching rule provides a Service Flow ID (SFID) to which
the packet is classified. All rules need to match for a packet to
match a classifier. Packets that do not match any classifiers are
assigned to the default (or primary) Service Flow.
CM
Cable Modem. Typically a device installed at the subscriber
premises that provides a high-speed data (Internet) connection
through the HFC network.
CMTS
Cable Modem Termination System. A device at a cable headend
that connects to cable modems over an HFC network to an IP
network.
Codec
Coder-decoder. In ToIP 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.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
About This Document
xi
CPE
Customer Premises Equipment. Subscriber-owned equipment
connected to the network. Technically, a cable modem, MTA, or
NIU falls into this category, although many operators do not
designate them as such.
CVC
Code Verification Certificate, an encryption key that allows
secure downloading of encrypted software over the HFC network.
DHCP
Dynamic Host Configuration Protocol. An IP protocol used to
provide an IP address and location of services (such as DNS
and TFTP) needed by a device connecting to the network.
DNS
Domain Name Service (Server). An IP service that associates a
domain name (such as www.example.com) with an IP address.
Downstream
In an HFC network, the direction from the headend to the subscriber. Some older cable documentation may refer to this as the
forward path.
DOCSIS
Data Over Cable Service Interface Specification. The interoperability standards used for data communications equipment on
an HFC network.
E-MTA
Embedded MTA. A device, such as the ARRIS Touchstone
Telephony Modem, that contains both an MTA and a cable
modem.
Euro-DOCSIS
The European version of DOCSIS. Euro-DOCSIS specifies an
8 MHz downstream bandwidth (vs. 6 MHz for DOCSIS); other
minor differences exist as well.
FQDN
Fully Qualified Domain Name. The name used to identify a single device on the Internet. See RFC2821 for details.
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.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
xii
About This Document
IPSec and media encryption are disabled.
Headend
The “central office” in an HFC network. The headend houses
both video and data equipment. In larger MSO networks, a
“master” headend often feeds several “remote” headends to
provide distributed services.
HFC
Hybrid Fiber-Coaxial. A broadband, bi-directional shared
media transmission system using fiber trunks between the headend and fiber nodes, and coaxial distribution cable between the
fiber nodes and subscriber premises.
Jitter
Variance in packet arrival time. Jitter is a factor in applications
such as telephony, where the originating device sends packets at
a constant rate.
Latency
The time required for a signal element (e.g. packet) to pass
through a device or network.
KDC
Kerberos Key Distribution Center.
LCO
Local Connection Options. A structure that describes the characteristics of the media data connection from the point of view
of the CMS creating the connection.
MAC
Acronym for Media Access Control. A general term for the
link-level networking layer and associated protocols. MAC protocols used in HFC data networks include Ethernet, the DOCSIS RF interface, and HomePNA.
Maintenance window
The usual period of time for performing maintenance and repair
operations. Since these activities often affect service to one or
more subscribers, the maintenance window is usually an overnight period (often 1 a.m. to 5 a.m. local time).
MD5
Message Digest 5. A one-way hashing algorithm that maps variable length plaintext into fixed-length (16-byte) ciphertext.
MD5 files, built by a provisioning server, contain provisioning
data for each NIU on the network.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
About This Document
xiii
MIB
Management Information Base. The data representing the state
of a managed object in an SNMP-based network management
system. Often used colloquially to refer to a single object or
variable in the base; e.g. “the lcCmtsUpMaxCbrFlows MIB.”
MSO
Multi-System Operator. A cable company that operates multiple
headend locations, usually in several cities.
MPI
Micro-Processor Interface. An internal Touchstone Telephony
Modem component.
MTA
Multimedia Terminal Adapter. A subscriber premises device
that contains the network interface, codecs, and all signalling
and encapsulation functions required for telephony transport,
CLASS features signalling, and QoS signalling. The MTA is an
integral part of Touchstone Telephony embedded MTA (EMTA) products.
NCS
Network Call Signaling. The PacketCable protocol used to control calls.
NIU
Network Interface Unit. A generic term for a device providing
data and telephony connections at a subscriber site. Also
referred to as embedded MTA (E-MTA).
NMS
Network Management System. Software, usually SNMP-based,
that allows you to monitor and control devices on the network.
In a ToIP 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.
Off-net
A call between a ToIP phone line and a line on the PSTN.
On-net
A call between two ToIP phone lines. Depending on the CMS
used, the connection may be established directly between the
MTAs or be routed through a gateway.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
xiv
About This Document
PacketCable
A CableLabs-led initiative aimed at developing interoperable
interface specifications for delivering advanced, real-time multimedia services over two-way cable plant.
PSTN
Public Switched Telephone Network.
PCM
Pulse Code Modulation. A commonly employed algorithm to
digitize an analog signal (e.g. voice) into a digital bit stream
using simple analog to digital conversion techniques. PCM is
employed in the popular G.711 codec.
QAM
Quadrature Amplitude Modulation. A method of modulating
digital signals onto an RF carrier, involving both amplitude and
phase coding. QAM16 modulation encodes four digital bits per
state and is used on upstream carriers; QAM64 and QAM256
encode six or eight bits (respectively) for use on downstream
carriers.
QoS
Quality of Service. An attribute of a Service Flow, defining limitations or guarantees for data rate, latency, and jitter.
QPSK
Quadrature Phase Shift Keying. A method of modulating digital
signals onto an RF carrier, using four phase states to encode two
digital bits.
Quarantine
A state where an endpoint (phone line) may potentially buffer
events. Events not quarantined are processed normally. Processing of quarantined events may be delayed, potentially indefinitely.
RF
Radio Frequency.
SDP
Session Description Protocol. SDP describes multimedia sessions for the purposes of session announcement, session invitation, and other forms of multimedia session initiation.
SLAC
Subscriber Line Audio Circuit. An internal Touchstone Telephony Modem component.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
About This Document
xv
SIP
Session Initiation Protocol. A signaling protocol for Internet
conferencing, telephony, presence, events notification and
instant messaging.
SNMP
Simple Network Management Protocol.
TFTP
Trivial File Transfer Protocol. Used in DOCSIS networks to
transfer software and provisioning files to network devices.
ToIP
Telephony over IP. The ARRIS implementation of PacketCablecompliant telephony services over an HFC network.
Uniform Resource Identifier (URI)
A way to identify a specific phone line for an MTA. 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.
VF
Voice Frequency.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
xvi
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
About This Document
1
Installing and
Upgrading
Touchstone Software
1
This chapter provides procedures used to install and upgrade Touchstone software on local DHCP and TFTP servers.
Load Name Extensions
A variety of TS4.5 loads are available to support specific Touchstone
hardware, applications, protocols, or regions. Each load has a unique
extension to identify its function.
Load names begin with TS0405xx_date_, where xx is the revision
number and date indicates the date (in YYMMDD format) that the load
was built. The following table shows extensions used to further identify
the loads. Some loads may have multiple extensions.
Extension
Description
NA
North American signed software image.
EU
European signed software image.
TELNET_ON Telnet access permanently enabled.
D11PLUS
Features to transition from DOCSIS 1.0+ to DOCSIS 1.1.
OPT177
Supports DHCP Option 177 only PacketCable provisioning.
MODEL_4_5 Supports Model 4 and Model 5 Telephony Modems, and
Model 4 Telephony Ports.
SIP
Supports SIP signalling (non-SIP loads use NCS signalling).
EURO
Supports Euro-PacketCable provisioning changes and IETF
MIBs.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
2
Examples
Installing and Upgrading Touchstone Software
The following examples show how load names describe the functionality of the load.
TS0405xx_date_NA.MODEL_4_5.img
TS0405xx_date_EU.MODEL_4_5.img
North American and European signed software images for
Model 4 and Model 5 Telephony Modems, and TP402/404.
TS0405xx_date_NA.MODEL_4_5.TELNET_ON.img
TS0405xx_date_EU.MODEL_4_5.TELNET_ON.img
North American and European signed software image for
Model 4 and Model 5 Telephony Modems, and TP402/404,
with telnet access permanently enabled.
TS0405xx_date_EU.MODEL_4_5.EURO.img
European signed software image for Model 4 and Model 5 Telephony Modems, and TP402/404, with support for Euro-PacketCable provisioning changes and IETF MIB support.
TS0405xx_date_EU.MODEL_4_5.EURO.TELNET_ON.img
European signed software image for Model 4 and Model 5 Telephony Modems, and TP402/404, with support for Euro-PacketCable provisioning changes and IETF MIB support with telnet
access permanently enabled.
About ARRIS Enhanced Software Loading
The ARRIS Enhanced Software Loading feature (patent pending) is
part of TS4.1 and newer versions of Touchstone software. For DOCSIS
1.1 and 2.0 loads, it provides the ability to embed a common software
load lineup table in configuration files that matches software loads to
Touchstone NIUs. It supports a multiple-vendor common configuration
file that works with multiple Touchstone NIUs, while still being backward compatible with non-ARRIS equipment.
By eliminating the need for customized configuration files by product
type, Enhanced Software Loading simplifies software upgrades and
improves the general quality of the process.
Upgrade Process
When a Touchstone NIU ranges and registers with the headend and
receives the ArrisCmDevSwTable MIB (see “Enhanced Software
Loading Options” on page 3 for a listing of relevant MIBs) in its configuration file, it proceeds as follows:
1
The NIU checks the arrisCmDevSwAdminStatus MIB.
• If its value is allowArrisProvisioningUpgrade, proceed to
step 2.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Installing and Upgrading Touchstone Software
•
3
If its value is ignoreArrisProvisioningUpgrade, the
device uses the standard docsDevSoftware MIBs for its
upgrade decision-making.
Note: A setting of upgradeFromArrisMgt is not allowed in the
configuration file and returns an error condition (see the Touchstone Software Troubleshooting Guide for details).
2
The NIU scans the arrisCmDevSwTable, looking for matches
between arrisCmDevSwHwModel and its known model type.
• If it finds a match, it checks the optional arrisCmDevSwHwRev for a match to its known hardware revision. A blank
entry for arrisCmDevSwHwRev is a match only if there is
no entry with an explicit match to the NIU’s hardware revision. Upon finding a match, proceed to step 3.
• If it cannot match the model type or find a qualifying revision, then the system logs an error (see the Touchstone Software Troubleshooting Guide for details) and abort to the
standard DOCSIS upgrade process.
3
The NIU reads the values of arrisCmDevSwServer and
ArrisCmDevSwFilename from the matching entry for the
TFTP server and software file name to download, then downloads its software.
Enhanced Software Loading
Options
The Enhanced Software Loading system is controlled by several
SNMP MIB variables, described below. These variables are all ARRISspecific and do not interfere with non-ARRIS NIUs. All of these variables can be added to the vendor-specific section of configuration files.
The ARRIS PacketACE software (version 3.2 and higher) also supports
these MIBs for easy addition to configuration files. Each MIB can also
be controlled remotely via standard SNMP MIB browser software.
ArrisCmDevSwAdminStatus MIB
feature switch
The Enhanced Software Loading system has a MIB feature switch
named arrisCmDevSwAdminStatus that parallels the standard DOCSIS MIB docsDevSwAdminStatus. This MIB has three different settings:
upgradeFromArrisMgt (1)
Immediately upgrade the device using Enhanced Software
Loading. If a valid entry can't be found then an error condition
is returned. This is not a valid setting for this MIB in configuration files.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
4
Installing and Upgrading Touchstone Software
allowArrisProvisioningUpgrade (2)
Allow provisioning file upgrade using Enhanced Software
Loading. This setting overrides the DOCSIS upgrade mechanism unless a valid entry can't be found in the software load
lineup table for the device. If a valid entry can't be found then
an error is returned and the standard DOCSIS upgrade mechanism takes over.
ignoreArrisProvisioningUpgrade (3)
Disable Enhanced Software Loading and use the standard
DOCSIS upgrade mechanism. This is the power up default setting for all ARRIS products.
ArrisCmDevSwTable MIB
The arrisCmDevSwTable drives the main decision-making algorithm
of the Enhanced Software Loading system. The table can handle up to
32 load lineups. If you try to add more than 32 entries to this table, the
NIU generates an illegal SNMP SET during the ranging and registering
process. Per DOCSIS specification, the NIU does not range and register until this problem is corrected. Each row of the table contains the
following MIB variables:
MIB column variable
Description
Valid Setting
ArrisCmDevSwCustomerLoadId
A customer-defined string that can be
added to identify load lineups. This
string is unused by the software
upgrade mechanism.
1 - 64 byte
Optional
ASCII string*
ArrisCmDevSwHwModel
Defines which Touchstone hardware
model type this row applies to.
1 - 16 byte
Required
ASCII string*
ArrisCmDevSwHwRev
Defines the Touchstone hardware revi- Integer, 0 to
sion of the currently defined model.
255
Optional
arrisCmDevSwServer
Defines an IP address of the TFTP
server to use for software upgrades.
Any valid IP
Required
ArrisCmDevSwFilename
Defines what filename the device
should request from TFTP server.
1 - 64 byte
Required
ASCII string*
* - 1 byte reserved for null terminator
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Req/Opt
Installing and Upgrading Touchstone Software
5
The following list shows common arrisCmDevSwHwModel ASCII
strings for software loads supporting Enhanced Software Loading:
Example Software
Lineup
•
TM102A
•
TM402B
•
TP204A
•
TM102B
•
TM402G
•
TP302A
•
TM102D
•
TM402P
•
TP304A
•
TM102E
•
TM402Q
•
TP402A
•
TM202A
•
TM501A
•
TP404A
•
TM202B
•
TM501B
•
TM202P
•
TM502B
•
TM401B
•
TM502G
Below is an example software lineup table for various ARRIS Touchstone products. This table is mirrored in the following configuration
file excerpt.
The Enhanced Software Loading system in this example is assumed
enabled by setting arrisCmDevSwAdminStatus to allowArrisProvisioningUpgrade (2).
Customer Load Id
HW Model
Lab NA TTM502
TM502B
Node 3 NA TTM402 Rev. 3
TM402P
Euro TTM402 Rev. 3
HW Rev.
TFTP IP
Address
Upgrade Filename
10.1.50.21
TS0405_09292005_EU_
MODEL_4_5.EURO.bin
3
10.1.50.21
TS0405_09292005.bin
TM402Q
3
10.1.51.21
TS0405_09292005.bin
Euro TTM402 Non-Rev. 3
TM402Q
blank
(see note 1)
10.1.51.21
TS0405_09292005.bin
Node 1 TTM202 Non-Rev. 2
TTM202P
blank
(see note 1)
10.1.52.21
TS030203_090503A.bin
Node 2 TTM202 Rev. 2
TTM202P
2
10.1.52.21
TS030203_090503A.bin
Note 1: Not specifying a hardware revision makes that entry a wildcard for any unspecified hardware
revisions.
Example Configuration File Excerpt
The following configuration file excerpt implements the software load
lineup shown above. This excerpt would typically be placed in a vendor-specific section of a configuration file.
SnmpMib = arrisCmDevSwAdminStatus.0 2
SnmpMib = arrisCmDevSwCustomerLoadId.1 "Lab NA TTM402 Rev. 2"
SnmpMib = arrisCmDevSwHwModel.1 "TM402P"
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
6
Installing and Upgrading Touchstone Software
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
SnmpMib
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
arrisCmDevSwHwRev.1 2
arrisCmDevSwServer.1 10.1.50.21
arrisCmDevSwFilename.1 "TS0401_09222003.bin"
arrisCmDevSwCustomerLoadId.2 "Node 3 NA TTM402 Rev. 3"
arrisCmDevSwHwModel.2 "TM402P"
arrisCmDevSwHwRev.2 3
arrisCmDevSwServer.2 10.1.50.21
arrisCmDevSwFilename.2 "TS0401_09302003.bin"
arrisCmDevSwCustomerLoadId.3 "Euro TTM402 Rev. 3"
arrisCmDevSwHwModel.3 "TM402Q"
arrisCmDevSwHwRev.3 3
arrisCmDevSwServer.3 10.1.51.21
arrisCmDevSwFilename.3 "TS0401_09302003.bin"
arrisCmDevSwCustomerLoadId.4 "Euro TTM402 Non-Rev. 3"
arrisCmDevSwHwModel.4 "TM402Q"
arrisCmDevSwServer.4 10.1.51.21
arrisCmDevSwFilename.4 "TS0401_09222003.bin"
arrisCmDevSwCustomerLoadId.5 "Node 1 TTM202 Non-Rev. 2"
arrisCmDevSwHwModel.5 "TTM202P"
arrisCmDevSwServer.5 10.1.52.21
arrisCmDevSwFilename.5 "TS030203_090503A.bin"
arrisCmDevSwCustomerLoadId.6 "Node 2 TTM202 Rev. 2"
arrisCmDevSwHwModel.6 "TTM202P"
arrisCmDevSwHwRev.6 2
arrisCmDevSwServer.6 10.1.52.21
arrisCmDevSwFilename.6 "TS030203_090503A.bin"
Rejecting Software Download Requests during Calls
Software downloads or upgrades require the NIU to be rebooted. Thus,
any call in progress at the end of an upgrade is dropped as a result of
the reboot.
To minimize service impacts, Touchstone software can reject SNMPinitiated downloads while a call is in progress. When a download is
rejected for this reason, the NIU generates the “No system resources
available to perform SW upgrade” event:
Nov 17 19:43:35 2005 AALN/1:mta161.dev35 <7> <4115> <37> <00:00:CA:CB:22:FB> <No
system resources available to perform SW upgrade. Current Load:
TS040542_103105_NA.MODEL_4_5.img Requested Load
TS040544_111105_NA.MODEL_4_5.img>
If the rejection event is provisioned as an alarm, clear the alarm by
rebooting the MTA.
TS4.5 MSUP2 and newer versions support the arrisMtaDevSwDnldNoSvcImpact MIB to enable or disable rejection of downloads while a
call is in progress:
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Installing and Upgrading Touchstone Software
7
•
To enable rejection of downloads while a call is in progress, set
the arrisMtaDevSwDnldNoSvcImpact MIB to enable.
•
To disable rejection of downloads while a call is in progress, set
the arrisMtaDevSwDnldNoSvcImpact MIB to disable
(default).
When the arrisMtaDevSwDnldNoSvcImpact MIB is set to enable,
the MTA rejects software downloads when any line is in the active
state. A line is considered to be in the active state when the esafeDevServiceIntImpact MIB (defined by eDOCSIS specifications) returns a
value of “significant”. The MIB is set to “significant” when any line of
an eMTA is in the “offHook” or “onHookPlusNCSActivity” states.
Note 1: Touchstone software does not automatically retry a rejected
software download request. Manually retry the upgrade as
described in “Upgrading Touchstone Software” on page 11, preferably during a scheduled maintenance window. An operator may
force the upgrade by disabling the arrisMtaDevSwDnldNoSvcImpact MIB before initiating the upgrade.
Note 2: If the subscriber begins or takes a call after software downloading begins, the NIU reboots and drops the call when the download is complete.
Note 3: A software download initiated during eMTA initialization,
when the CM configuration file specifies a new load, are unaffected
since there is no service available during initialization.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
8
Installing and Upgrading Touchstone Software
Installing the Software
Use this procedure to install TS4.5 software on primary and backup
DHCP and TFTP servers.
Requirements
Action
You need the following to install TS4.5 software:
•
Touchstone software load
•
Access to the TFTP file servers
•
Location of the software directory on the file servers
•
Access to the provisioning server (to change NIU provisioning
files)
Perform the following tasks as needed.
Task
Page
Adding the CVC ........................................................... 8
Installing the Software on a File Server ....................... 9
Configuring the NIU to Download its Software............. 9
Setting Up ARRIS Enhanced Software Loading .......... 9
Adding the CVC
Follow these steps to use the ARRIS manufacturer CVC for cryptographic verification of the Touchstone software load.
1
Use your configuration file editor to set the Manufacturer CVC
TLV to include the contents of the ARRIS CVC certificate file
(import the file from the software CD). Use the appropriate CVC
for your NIU:
•
TM402P, TM502A, TM502H, TP402A, TP404A: use
ARRIS-NA-CVC
•
TM402B, TM402Q, TM501B, TM502B, TM502G: use
ARRIS-EURO-CVC
Note: If you are using PacketACE, it prompts you to specify a CVC
when entering the Manufacturer CVC TLV value.
2
Use your provisioning server to specify the Touchstone software
load. The load is cryptographically signed, so the NIU can validate
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Installing and Upgrading Touchstone Software
9
the load against the manufacturer’s CVC using the DOCSIS 1.1
secure software download feature. Use the appropriate software
load for your NIU.
3
Installing the Software on a
File Server
Proceed to “Installing the Software on a File Server” on page 9.
Follow these steps to install the TS4.5 software on a file server.
1
Log into the file server, using an account with administrative privileges.
Use an FTP client (make sure to use the binary transfer mode) or a
network file sharing service to access the file server.
Configuring the
NIU to Download
its Software
Setting Up ARRIS
Enhanced Software Loading
2
Change to the appropriate server directory for software storage.
3
Download the TS4.5 software file to the server.
4
Make sure that the software file has read access for all NIUs.
Follow these steps to configure the Touchstone Telephony NIU provisioning data to download its software during registration. Use your provisioning server to perform this task.
1
Set the docsDevSwServer MIB to the address of the file server
containing the TS4.5 software.
2
Set the docsDevSwFilename MIB to the name of the TS4.5 software file.
Follow these steps to set up Enhanced Software Loading in a configuration file. See “About ARRIS Enhanced Software Loading” on page 2
for details about the feature.
1
Use a provisioning server, or PacketACE version 5.8 or newer, to
create an entry in the ArrisCmDevSwTable with the following
MIB settings:
•
ArrisCmDevSwCustomerLoadId (optional): name of the load
lineup.
•
ArrisCmDevSwHwModel: the Touchstone NIU model (see the
Touchstone Software Feature Guide for a list of valid model
names).
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
10
Installing and Upgrading Touchstone Software
•
ArrisCmDevSwHwRev (optional): the hardware revision of the
NIU. Leave blank for this entry to apply to all revisions of the
same model.
•
arrisCmDevSwServer: the IP address of the TFTP server con-
taining the software load for NIUs matching the model and
revision.
•
ArrisCmDevSwFilename: the file name of the software load
for NIUs matching the model and revision.
2
In the configuration file, set the arrisCmDevSwAdminStatus MIB
to allowArrisProvisioningUpgrade.
Note: The NIU uses Enhanced Software Loading to download its
software during the next reboot, unless the NIU is running on battery power.
3
Do one of the following to force the NIU to immediately download
its software file, if desired:
a
Reboot the NIU, either directly or by setting the docsDevResetNow MIB to true from the network manager.
b
In the network manager, set the NIU’s arrisCmDevSwAdminStatus MIB to upgradeFromArrisMgt.
Note: If the NIU is running on battery power, it disables software
upgrades until AC power is restored.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Installing and Upgrading Touchstone Software
11
Upgrading Touchstone Software
Use this procedure to upgrade from previous versions of Touchstone
software.
Upgrading from
TS4.2 or Earlier
Versions
Several ARRIS-proprietary MIBs were changed in the TS4.3 release.
The update requires changes to configuration files to complete the
upgrade process.
The following table shows the MIB changes:
Old MIB
New MIB
arrisCmDevProvMethodIndicator
arrisMtaDevProvMethodIndicator
(will be deprecated in future release)
ppCfgPortDialingMethod
arrisMtaDevEndPntDialingMethod
(will be deprecated in future release)
The old MIBs are still available, but deprecated. The new MIBs override the original MIBs if the configuration file contains both. See
“Changing Configuration Files for Upgrades from TS4.2” on page 13
for instructions.
Upgrading from
Earlier NCS Loads
to TS4.5 SIP Loads
Customers upgrading from TS4.4.20 or earlier NCS-based versions of
Touchstone software to a TS4.5 SIP-based release must first upgrade to
TS4.4.20 or a newer release (either NCS- or SIP-based) as an intermediate step before upgrading to TS4.5 SIP. The upgrade proceeds as follows:
1
The operator initiates an upgrade to the intermediate release.
2
The NIU upgrades the boot loader firmware, then reboots both
the CM and MTA.
3
The NIU automatically upgrades the software image then
reboots (normal MTA upgrade sequence).
4
The operator initiates the upgrade to the TS4.5 SIP release.
Note: ARRIS recommends using either TS4.428B or TS4.4.41 as
the intermediate load (both loads are NCS-based), especially if you
plan for any delays between the intermediate release and the final
TS4.5 SIP release.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
12
Action
Installing and Upgrading Touchstone Software
Perform any of the following tasks as necessary.
Task
Page
Upgrading the Software through Provisioning ...................12
Upgrading the Software through SNMP.............................13
Changing Configuration Files for Upgrades from TS4.2 ....13
Upgrading the
Software through
Provisioning
Follow these steps to upgrade the Touchstone software load using a
provisioning server.
1
Install the new software, using the steps in “Installing the Software
on a File Server” on page 9.
2
Use the provisioning server to add or verify the following items in
the cable modem configuration file:
•
ManufacturerCVC (the CVC, needed only for secure down-
loading)
•
UpgradeFileName (file name of the software load)
•
UpgradeServer (IP address of the server containing the load)
•
SnmpMib = docsDevSwAdminStatus.0 2 (allow
ProvisioningUpgrade)
3
During the maintenance window, use your provisioning server or
element manager to reset each Touchstone NIU.
The NIUs download the new software, then reset.
Note 1: Upgrading from TS3.1 to TS4.5 requires that you first
upgrade to TS3.2 then to TS4.5. Configuration file changes,
described in “Upgrading the Software through Provisioning”
above, are also necessary.
Note 2: See “Upgrading from Earlier NCS Loads to TS4.5 SIP
Loads” on page 11 for information about upgrading from NCS to
SIP.
4
Verify that the NIU has the new load by checking the value of the
docsDevSwOperStatus MIB (using an SNMP server).
The value of the MIB should read completeFromProvisioning(3).
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Installing and Upgrading Touchstone Software
Upgrading the
Software through
SNMP
13
Follow these steps to upgrade the Touchstone software load using an
SNMP manager. See the Touchstone Software Feature Guide for information about the Touchstone Software Upgrade System.
1
Using the provisioning server, add the ManufacturerCVC to the
configuration file.
2
Using the SNMP manager, set the following docsDevSoftware
MIBs:
•
docsDevSwServer—IP address of the server containing the
load)
•
docsDevSwFilename—file name of the software load
•
docsDevSwAdminStatus—set to 1 (upgradeFromMgt)
The NIU downloads the new software, then resets.
Note 1: Upgrading from TS3.1 to TS4.5 requires that you first
upgrade to TS3.2 then to TS4.5. Configuration file changes,
described in “Upgrading the Software through Provisioning” on
page 12, are also necessary.
Note 2: See “Upgrading from Earlier NCS Loads to TS4.5 SIP
Loads” on page 11 for information about upgrading from NCS to
SIP.
3
Verify that the NIU has the new load by checking the value of the
docsDevSwOperStatus MIB.
The value of the MIB should read completeFromMgt(3).
Changing Configuration Files for
Upgrades from
TS4.2
Follow these steps to update configuration files from TS4.2 or earlier
versions.
1
For the following provisioning methods, replace the old arrisCmDevProvMethodIndicator MIB with the arrisMtaDevProvMethodIndicator MIB and set it to the appropriate value.
•
docsisOnly(0)
•
fullPacketCable(1)
•
packetCableMinusKDC(2)
•
cps(3)
Note: Support for this mode is no longer supported in TS4.1
and later releases.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
14
Installing and Upgrading Touchstone Software
2
•
gupi(4)
•
singleMAC(5)
For the following provisioning methods, set the old arrisCmDevProvMethodIndicator MIB to docsisOnly and set the
arrisMtaDevProvMethodIndicator MIB to the appropriate value.
•
basic1(6)
•
basic2(7)
•
gupiEncryptedMtaConfig(8)
Setting the arrisCmDevProvMethodIndicator MIB to docsisOnly ensures that any devices containing loads prior to TS4.3 can
upgrade.
Once the MTA has upgraded its software, it uses the provisioning
method set by the arrisMtaDevProvMethodIndicator MIB.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
2
2
Provisioning Modes
You can provision Touchstone Telephony products using a variety of
PacketCable-compliant and non-compliant tools.
Overview
Typically, you provision a ToIP network using a PacketCable-compliant provisioning server. The server provides both provisioning tools to
create data files, and servers (DHCP, DNS, TFTP) to store and transfer
software loads and provisioning data to both the CMTS and all attached
cable modems and MTAs.
In some cases, the provisioning server may not be PacketCable-compliant but supports one or two MAC addresses per NIU.
Provisioning Modes
To improve compatibility with non-compliant equipment, ARRIS supports eight provisioning modes for Touchstone NIUs and software;
each has multiple options to enable and disable PacketCable features.
Use the arrisMtaDevProvMethodIndicator MIB to select the desired
provisioning mode. Earlier versions of Touchstone software provided a
CM MIB, arrisCmDevProvMethodIndicator, for setting the provisioning mode. TS4.5 recognizes both MIBs, but the MTA MIB takes
priority. The CM MIB is deprecated and will be obsoleted in future versions.
Full PacketCable compliant (default)
The data and telephony components have unique IP addresses,
MAC addresses, and configuration files (i.e. two of each per
NIU). When the NIU registers, it makes two separate DHCP
and TFTP requests.
SNMP communication uses SNMPv3, sending an SNMPv3
INFORM.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
16
Provisioning Modes
IPSec is supported, and may be enabled or disabled using the
pktcMtaDevCmsIpsecCtrl MIB variable (the default is
enabled). Media encryption (voice security) can be enabled on a
per-call basis using NCS signalling (the LCO/SDP options) or
disabled per MTA using a feature switch. The feature switch is
stored in NVRAM.
Note: EURO (NCS-based) loads support only Full PacketCable
provisioning.
PacketCable without KDC
A PacketCable subset, using SNMPv1 or SNMPv2 (sending an
SNMPv2 INFORM).
IPSec is disabled. Media encryption can be controlled on a perMTA basis using a feature switch.
Global Universal Provisioning Interface (GUPI)
A PacketCable subset, intended to accommodate a wide range
of partially-compliant equipment. SNMP communication uses
SNMPv1 or SNMPv2, with INFORM disabled.
IPSec and media encryption are disabled.
CAUTION
Service-affecting
The following three provisioning methods (GUPI with MTA Configuration File Encryption, GUPI MAC MTA, GUPI Encrypted MAC
MTA) are to be used only with SIP loads. Using them with other
Touchstone loads may prevent the MTA from registering.
Global Universal Provisioning Interface (GUPI) with MTA
Configuration File Encryption
Similar to GUPI with support for decrypting the encrypted
MTA configuration file (patent pending).
IPSec and media encryption are disabled.
GUPI MAC MTA
Similar to GUPI, intended for use with SIP loads. The MTA
ignores the MTA configuration file name in the DHCP ACK
message and requests a file name using the MTA MAC address
with a .bin extension. An example of the requested filename
would be 0000CA123456.bin
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
17
GUPI Encrypted MAC MTA
Identical to GUPI MAC MTA provisioning, with support for
decrypting the encrypted provisioning file.
ARRIS Simplified PacketCable Provisioning (Basic 1)
Similar to GUPI. SNMP communication uses SNMPv1 or
SNMPv2, with enrollment and status INFORMs disabled.
Basic 1 advertises itself to the provisioning server using DHCP
Option 60.
ARRIS Simplified PacketCable Provisioning (Basic 2)
Similar to Basic 1, but sends the SNMP status INFORM to the
provisioning server.
Single MAC/Single Configuration File
Designed for use with certain provisioning servers that support
only one IP address, MAC address, and configuration file per
NIU. The NIU makes one DHCP and TFTP request. SNMP
communication uses SNMPv1 or SNMPv2, with INFORM disabled.
The configuration file includes MTA provisioning parameters.
IPSec and media encryption are disabled.
DOCSIS Only
A data-only mode (no telephony support). Uses a single IP
address for the cable modem component, making a DHCP and
TFTP request during registration.
Using the Provisioning Method
Indicator
Use the arrisMtaDevProvMethodIndicator MIB object to select a particular provisioning mode. The default method is Full PacketCable; you
can include this MIB in the configuration file to select other provisioning methods.
Note 1: The arrisCmDevProvMethodIndicator MIB, used in earlier releases to select the provisioning method, will be deprecated in
future releases. In addition, the older MIB does not support Basic 1,
Basic 2, or GUPI with MTA configuration file encryption modes.
Note 2: If you include the provisioning indicator MIB in the configuration file, it must be included in the CM configuration file.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
18
Provisioning Modes
The following table shows the supported values in the ArrisMtaDevProvMethodIndicator MIB as of TS4.5.
Value
Description
0
DOCSIS-only provisioning
1
Full PacketCable (default)
2
PacketCable minus KDC
4
GUPI
5
Single MAC/Single Configuration File
6
Basic 1
7
Basic 2
8
GUPI with MTA configuration file encryption
9
GUPI MAC MTA
10
GUPI Encrypted MAC MTA
Provisioning Event Sequences
The following diagrams show the normal sequence of events required
when a PacketCable compliant NIU registers on the cable data net-
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
19
work. The dark shaded areas are the events omitted when using each
provisioning scheme.
PacketCable
Sequence
The following diagram shows the full PacketCable event sequence. All
events are included.
PacketCable (no
KDC) Sequence
The following diagram shows the PacketCable (no KDC) event
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
20
Provisioning Modes
sequence. This sequence skips several events in the MTA provisioning.
GUPI (including
variants)/Basic 1
Sequence
The following diagram shows the sequence for:
•
GUPI
•
GUPI with MTA configuration file encryption
•
GUPI MAC MTA
•
GUPI Encrypted MAC MTA
•
Basic 1
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
21
This sequence skips several steps in the MTA provisoning.
DOCSIS
DOCSIS
DOCSIS ToD Prov Server
Flow
CM / MTA
CMTS
DHCP
TFTP
Start with DOCSIS 1.1 Initialization/Registration
DHCP Broadcast Discover (Option Code 177)
CM-1
PKT DHCP
PKT DNS
PKT
TFTP
CM-2
DHCP Offer (Option Code 177 w/ telephony service provider's DHCP server address = [255.255.255.255])
CM-3
DHCP Request
CM-4
DHCP Ack
CM-5
DOCSIS 1.1 CM config file request
CM-6
DOCSIS 1.1 config file
CM-7
ToD Request
CM-8
ToD Response
CM-9
CM registration with CMTS
CM-10
CMTS Registration ACK
MSO KDC
SYSLOG
Complete DOCSIS 1.1 Initialization/Registration
MTA-1
MTA2
DHCP Broadcast Discover (option code 60 w/ MTA device identifier)
DHCP Offer (Telephony TFTP config filename, NO OPCODE 177 options)
MTA-3
DHCP Request
MTA-4
DHCP Ack
MTA-5
DNS Request
MTA-6
DNS Srv (KDC host name associated with the provisioning REALM)
MTA-7
DNS Request
MTA-8
DNS Response (KDC IP Address)
MTA-9
AS Request
MTA-10
AS Reply
MTA-11
TGS Request
MTA-12
MTA-13
TGS Reply
AP Request
MTA-14
AP Reply
MTA-15
SNMP Inform
MTA-16
SNMP Get Request(s) for MTA device capabilities (optional/iterative)
MTA-17
SNMP Get Response(s) containing MTA device capabilities (optional/iterative)
(Key Mgmt Prot Vers. , Protocol ID, KRB_AP_REQ,, Ciphersuites, SHA-1 HMAC )
( KeyMgmtProtVers, Protocol ID, KRB_AP_REP, ciphersuite selected, key lifetime, Ack req , HMAC)
MTA-18
MTA config file
MTA-19
SNMP Set with URL encoded file download access method (TFTP or HTTP), filename, hash, and encryption key( if required)
MTA-20
Resolve TFTP server FQDN
MTA-21
TFTP server IP address
MTA-22
Telephony config file request
MTA-23
Telephony config file
MTA-25
Notify completion of telephony provisioning (MTA MAC address, ESN, pass/fail)
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
22
Basic 2 Sequence
Provisioning Modes
The following diagram shows the Basic 2 event sequence. This
sequence is identical to GUPI and Basic 1, but does not skip the last
step in the MTA provisoning.
DOCSIS
DOCSIS
DOCSIS ToD Prov Server PKT DHCP
Flow
CM / MTA
CMTS
DHCP
TFTP
Start with DOCSIS 1.1
lization/Registratio
Initia
n
DHCP
Broadcast
Discover
on
(Opti
Code
177)
CM-1
PKT
DNS
PKT
TFTP
CM-2
DHCP Offer (Option Codetelephony
177 w/
service provider's DHCP server255.255.255]
address )= [255.
CM-3
DHCP Request
CM-4
DHCP Ack
CM-5
DOCSIS 1.1 CM config file request
CM-6
DOCSIS 1.1 config file
CM-7
ToD Request
CM-8
ToD Response
CM-9
CM registration with CMTS
CM-10
CMTS Registration ACK
MSO KDC
SYSLOG
Complete DOCSIS 1.1 zation/Registratio
Initiali
n
MTA-1
MTA2
DHCP Broadcast Discover
ion (opt
code 60 w/ MTA device
identifier)
DHCP Offer (Telephony TFTPlename,
config fi
NO OPCODE 177 options
)
MTA-3
DHCP Request
MTA-4
DHCP Ack
MTA-5
DNS Request
MTA-6
DNS Srv (KDC host name associated with
sioning
the REALM)
provi
MTA-7
DNS Request
MTA-8
DNS Response (KDC IP Address)
MTA-9
AS Request
MTA-10
AS Repl
y
MTA-11
TGS Request
MTA-12
MTA-13
TGS Repl
y
AP Request (Key Mgmt Prot Vers. , Protocol ID, KRB_AP_REQ,,
A-1 Ciphersuites,
HMAC
)
SH
MTA-14
AP Reply
MTA-15
SNMP Inform
MTA-16
SNMP Get Request(s) for MTA
capabilities
device
(optional/i
terative)
MTA-17
SNMP Get Response(s) containi
ng MTA device capabilities (optional/iterative)
( KeyMgmtProtVers,
rotocol ID,
P
KRB_AP_REP,
ciphersuite selected, key
Acklifetime,
req , HMAC)
MTA-18
Single MAC/Config File Sequence
MTA config file
MTA-19
SNMP Set with URL encoded
le download
fi
access method
(TFTP or HTTP), filename, hash, and encryption key( if required)
MTA-20
Resolve TFTP server FQDN
MTA-21
TFTP server IP address
MTA-22
Telephony config file request
MTA-23
Telephony config file
MTA-25
Notify completion of telephony
provisioning (MTA MAC address, il)
ESN,
pass/fa
The following diagram shows the event sequence for single MAC/config file provisioning.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
Setting Up the Provisioning Server
Data
23
Set up the provisioning data as follows to use a non-PacketCable compliant provisioning server:
•
The MTA DHCP offer may not use DNS (option 6), SNMP, or
security (Kerberos or Ticket Granting).
•
The FQDN must be in IPv4 format (i.e. an IP address such as
10.1.2.3 rather than a domain name such as tt4.example.net).
Note 1: DNS is not supported for FQDN when using GUPI or single-MAC/config file provisioning.
Note 2: Basic 1 and Basic 2 provisioning modes require a PacketCable-compliant provisioning server.
Verifying MTA Provisioning and Endpoint Status
The MIB object pktcMtaDevProvisioningState indicates the status of
the MTA initialization process. The MIB object pktcNcsEndPntStatusError indicates whether the endpoint has successfully registered
with the call server.
DHCP Support by Provisioning Mode
The following sections list DHCP parameters used by each provisioning mode.
Options Required
in All Provisioning
Modes
The following DHCP options are required in all CM and MTA offers.
The NIU cannot function without a subnet mask and at least one router,
DNS 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 recommends including option 4 (IP address of the ToD
server) in all CM and MTA offers.
CAUTION
Load choices are potentially service-affecting
For load names with an OPT177 extension, the MTA only advertises
and requests DHCP Option Code 177 provisioning information. Option
Code 122 provisioning is not supported in an OPT177 load.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
24
PacketCable
Modes
Provisioning Modes
These options are valid for full PacketCable and PacketCable minus
KDC provisioning modes. Note that options 122 and 177 are mutually
exclusive (specify one or the other, not both).
CM DHCP Option 4: ToD Server IP Address
CM DHCP Option 122 (DOCSIS 1.1/2.0 loads only):
•
SubOption 1: Service Provider’s Primary DHCP (required)
•
SubOption 2: Service Provider’s Secondary DHCP (optional)
MTA DHCP Option 122 (DOCSIS 1.1/2.0 loads only):
•
SubOption 3: Service Provider’s SNMP Entity (required)
•
SubOption 4: AS REQ/REP Exchange Backoff and Retry for
SNMPv3 Key Management (optional)
•
SubOption 5: AP REQ/REP Exchange Backoff and Retry for
SNMPv3 Key Management (optional)
•
SubOption 6: Kerberos Realm (FQDN) (Full PacketCable,
Basic 1, Basic 2: required; GUPI, PacketCable Minus KDC:
optional)
•
SubOption 7: Authorization method (TGT for MTA) (optional)
•
SubOption 8: Provisioning Timer (minutes) (optional)
•
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)
MTA DHCP Option 177:
•
SubOption 3: Service Provider’s SNMP Entity (required)
•
SubOption 4: Service Provider Network Primary DNS
•
SubOption 5: Service Provider Network Secondary DNS
•
SubOption 6: Kerberos Realm (FQDN)
•
SubOption 7: Authorization method (TGT for MTA)
•
SubOption 8: Provisioning Timer (minutes)
Note: An ARRIS MTA provisioned using PacketCable minus KDC
ignores any security parameters which are included in the DHCP
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
25
OFFER/ACK (option 122 sub-options 4, 5, 6, 7 or option 177 suboptions 6, 7, 8 ) as well as security parameters included in the configuration file.
GUPI Mode
GUPI mode uses separate CM and MTA offers.
CM DHCP Option 122 (DOCSIS 1.1/2.0 loads only) or 177:
•
SubOption 1: Service Provider’s Primary DHCP (required)
•
SubOption 2: Service Provider’s Secondary DHCP (optional)
•
SubOption 6: Kerberos Realm (FQDN) (ignored)
MTA DHCP Option 122 or 177: ignored
MTA offer: MTA FQDN is configured in the MTA DHCP offer
(Options 12 and 15). SubOption 3 must contain the Service Provider’s
SNMP Entity.
DNS is optional.
Note: An ARRIS MTA provisioned using GUPI ignores any security parameters which are included in the DHCP OFFER/ACK
(option 122 sub-options 4, 5, 6, 7 or option 177 sub-options 6, 7, 8 )
as well as security parameters included in the configuration file.
ARRIS modified
version of Simplified PacketCable
Provisioning
(Basic 1 and
Basic 2)
Basic 1 and Basic 2 use separate CM and MTA offers.
CM DHCP Option 122 or 177:
•
SubOption 1: Service Provider’s Primary DHCP (required)
•
SubOption 2: Service Provider’s Secondary DHCP (optional)
MTA DHCP Option 122 or 177:
•
SubOption 3: Service Provider’s SNMP Entity (required)
•
SubOption 6: Kerberos Realm (FQDN) (required; realm name
is either BASIC.1 or BASIC.2)
MTA offer: MTA FQDN is configured in the MTA DHCP offer
(Options 12 and 15).
DNS is required.
Note: Security parameters are required in the configuration file.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
26
Single MAC/Config File Mode
Provisioning Modes
One offer requested and made.
MTA FQDN is configured in the DHCP Offer (options 12 or 15).
DNS is optional. The address is supplied in the standard DHCP option
(option 6).
Note: An ARRIS MTA provisioned using Single MAC/Config file
ignores any security parameters which are included in the DHCP
OFFER/ACK (option 122 sub-options 4, 5, 6, 7 or option 177 suboptions 6, 7, 8 ) as well as security parameters included in the configuration file.
DOCSIS Only
Mode
One offer requested and made.
DHCP Option 43
Support
TS4.5 sends DHCP option 43 (Vendor-Specific Information) in CM
DHCP Discover messages (except for Basic1 and Basic 2, which send
this option in MTA Request and Discover messages), with the following sub-options:
The DHCP options should not contain MTA option 122 or option 177
sub-options 1 and 2 (MTA primary and secondary DHCP server
addresses).
Sub-option
Name
Value
2
Device type
“ECM”
3
eSAFE type
“ECM:EMTA”
4
Serial number
Varies (e.g. “20034512K203RP”)
5
HW Version
Hardware version of modem (e.g. “04”)
6
SW Version
Software version (e.g. “4.1.5”)
7
Boot ROM
Boot ROM version (e.g. “4.02”)
8
Vendor ID
“0000CA”
9
Model Number NIU model number (e.g. “TM402P”)
10
Vendor Name
“ARRIS Interactive, L.L.C.”
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
27
In addition, Euro-DOCSIS modems (TM402B, TM402H) send the following sub-options:
Sub-option Name
DHCP Option 60
Support
Value
200
Vendor Name
“ARRIS Interactive, L.L.C.”
201
Modem Type
NIU model number (e.g. “TM402P”)
202
SW Version
Software version and build (e.g.
“TS.04.01.5.031504”)
203
HW Version
Hardware version of modem
TS4.5 uses DHCP option 60 (Vendor Class Identifier) in DHCP Discover messages to specify the DOCSIS support required. The option
contains one of the following strings:
•
“DOCSIS 1.0” (DOCSIS 1.0+ loads only)
•
“DOCSIS 1.1” (DOCSIS 1.1/2.0 loads only)
•
“DOCSIS 2.0” (DOCSIS 1.1/2.0 loads only)
Provisioning Considerations for European Loads
Provisioning changes are necessary to transition from a Touchstone
North American load to the EURO load. The basic flow sequence
remains the same; however, some OIDs change from the North American PacketCable MIBs to the IETF PacketCable MIBs. The objects that
require OID changes are highlighted below.
Note: EURO (NCS-based) loads support only Full PacketCable
provisioning.
Flow MTA15:
SNMP Enrollment
INFORM
pktcMtaDevProvisioningEnrollment and its contents:
•
sysDescr (remains the same)
•
pktcMtaDevSwCurrentVers
•
pktcMtaDevTypeIdentifier
•
ifPhysAddress (previously pktcMtaDevMacAddress)
•
pktcMtaDevCorrelationId
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
28
Flow MTA19:
SNMPv3 SET
Provisioning Modes
•
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
Provisioning Considerations for SIP Loads
The information in this section is needed for provisioning Touchstone
NIUs with SIP loads.
SIP Feature Switch
The SIP feature switch MIB sipCfgSipFeatureSwitch enables features that may be required for operation with certain call servers and
proxies. See “SIP Feature Switch” on page 41 for details about the SIP
feature switch.
Information
Required for SIP
The SIP load requires three pieces of information to function properly:
Outbound Proxy
The destination device for all outbound messages. The setting is
used as the domain in the Request-URI for all outgoing INVITE
messages.
Registrar
Registration messages are sent to the outbound proxy’s IP
address, but the Request-URI address is provisioned as the registrar address. This setting may or may not be the same as the
outbound proxy setting.
Domain Settings
The domain is set as part of the DHCP process of the TTM
using DHCP Option 15. This domain is used in all to and from
URIs that the Telephony Modem generates.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning Modes
29
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
sipCfgProxyAdr
sipCfgRegistrarAdr
User-id (phone #)
Called Number
arris-i.org
ser.arris-i.org;5060
registrar.arris-i.org;5060
7705552001
7705552002
REGISTER sip:registrar.arris-i.org:5060 SIP/2.0
From: "SIP1 Line1"<sip:7705552001@arris-i.org>;tag=94b73228-a013d16-13c4-2021829ddd-20
To: "SIP1 Line1"<sip:7705552001@arris-i.org>
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:7705552001@10.1.61.22:5060>
Content-Length: 0
INVITE sip:7705552002@ser.arris-i.org:5060 SIP/2.0
From: "SIP1 Line1"<sip:7705552001@arris-i.org>;tag=94b73808-a013d16-13c4-624e4a1883-62
To: <sip:7705552002@arris-i.org>
Call-ID: 94b6f7d8-a013d16-13c4-62-5370cb92-62@arris-i.org
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:7705552001@10.1.61.22:5060>
Content-Type: application/SDP
Content-Length: 168
<SDP REMOVED>
Here are examples of REGISTER and INVITE with IP address based provisioning 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:7705552001@10.1.63.10:5060>;tag=94b73228-a013d16-13c420-21829ddd-20
To: "SIP1 Line1"<sip:7705552001@10.1.63.10:5060>
Call-ID: 94b6e3b0-a013d16-13c4-20-22ce4f5-20
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
30
Provisioning Modes
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:7705552001@10.1.61.22:5060>
Content-Length: 0
INVITE sip:7705552002@10.1.63.10:5060 SIP/2.0
From: "SIP1 Line1"<sip:7705552001@10.1.63.10:5060>;tag=94b73808-a013d16-13c462-4e4a1883-62
To: <sip:7705552002@10.1.63.10:5060>
Call-ID: 94b6f7d8-a013d16-13c4-62-5370cb92-62@10.1.63.10
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:7705552001@10.1.61.22:5060>
Content-Type: application/SDP
Content-Length: 168
<SDP REMOVED>
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
3
Provisioning
3
You can provision Touchstone Telephony products using the procedures outlined in this section.
Overview
Typically, you provision a ToIP network using a PacketCable-compliant provisioning server. The server provides both provisioning tools to
create data files, and servers (DHCP, DNS, TFTP) to store and transfer
software loads and provisioning data to both the CMTS and all attached
cable modems and MTAs.
In some cases, the provisioning server may not be PacketCable-compliant but supports one or two MAC addresses per NIU.
Provisioning Management Features
This section discusses management features that are generally configured by provisioning. See the Touchstone Software Management Guide
for features designed to be controlled while the NIU is in service.
BackOff and Retry
Mechanism Support
ARRIS employs the registration and back-off mechanisms as specified
by the PacketCable™ MTA Device Provisioning Specification, PKTSP-PROV-I08-040113. This specification is available through the
CableLabs® PacketCable website (http://www.packetcable.com).
See this specification for details on specified registration throttling and
associated back-off mechanisms.
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 MIB
variable for each CMS that the MTA can communicate with; you can
include this variable in the MTA configuration file. Set the variable to
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
32
Provisioning
true(1) to enable IPSec between the MTA and a particular CMS, and
false(2) to disable it.
Note: Touchstone NIUs use only the IPSec ESP transport mode.
Service Interruptions during Software Upgrades
ARRIS EMTA devices are compliant with the relevant DOCSIS and
PacketCable specifications related to software downloading. However,
there are two major parts to a software upgrade process. The first part is
the server communication and software image download; the second
part is the actual firmware upgrade.
During the server communication and software image file download,
there is no interruption to eMTA operation. During this phase of the
procedure, all operation continues normally. However, per the DOCSIS
and PacketCable specifications, once the image is downloaded into the
eMTA, the device must automatically execute a reset operation to copy
the new image into the active flash memory and apply the functionality
of the new image.
By completing the non-service affecting image download process
before invoking the mandatory reset, the Touchstone eMTA minimizes
service interruptions as a result of a software upgrade.
To further minimize service interruptions, TS4.5 MSUP2 and newer
versions of Touchstone software can reject software download requests
when a line is in the active state. See “Rejecting Software Download
Requests during Calls” on page 6 for details.
Call Management
Servers
Touchstone software accepts up to 64 call management server IP
addresses identified in the MTA configuration file. Each call server
DNS entry can have up to six IP addresses associated with it, so assigning multiple IP addresses to a CMS reduces the total number of unique
servers that can be listed. Support for multiple CMSs allows for load
balancing, where an MTA can be redirected to use a CMS with a lighter
load.
When IPsec is activated, Touchstone NIUs store up to 10 security associations, limiting the number of CMSs that it can communicate with at
any given time. However, by setting the “CMS Redirect” bit
(0x00400000) in the CallP Feature Switch (see “CallP Feature Switch”
on page 34), 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.
See the Touchstone Software Feature Guide for more details.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
33
Provisioning CM and MTA Features
You can provision the following cable modem and MTA features using
a configuration file or SNMP management tool.
Full DQoS Mode
TS4.5 and later software defaults to Dynamic Quality of Service
(DQoS) provisioning. Full DQoS simplifies provisioning tasks by
requiring only that the primary Best Effort (BE) and MGCP (signalling) flows be provisioned. The TS4.5 software dynamically sets up
and tears down UGS service flows, using a standard set of parameters
designed for efficient use in ToIP networks, as needed. The CMS controls the bandwidth authorization as specified in the PacketCable DQoS
specifications.
Full DQoS provides an added layer of security by authenticating NIUs
that contact it during call setup. Each session is authorized; the session
authorization uses a handle (the Gate ID) assigned by the CMTS,
passed to the CMS, and sent to the MTA using an NCS message, to
match requests with authorizations. Upon receiving call-signalling
information, the MTA passes the Gate-ID to the CMTS in a DSA/DSC
message.
DSX QoS Mode
TS4.5 software supports an ARRIS-proprietary feature that implements
QoS using UGS flows for voice transmission using DOCSIS 1.1 DSx
messaging. This functionality provides a level of QoS in a network
where the CMS and CMTS do not support the PacketCable Full DQoS
model.
DSx QoS functionality can be activated using a feature switch. When
activated, the TS4.5 software sends the appropriate DSx messages
needed to Add/Modify/Delete the UGS service flows. DSx messages
flow only between the CMTS and the NIU, and do not involve the
CMS in any validation 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.
Voice and Signalling Ports
TS4.5 software uses a random selection of ports in the range 49152
through 65535 for RTCP-based voice communications. The port numbers cannot be modified or used for other purposes.
By default, the MTA uses port 2727 on the upstream, and port 2427 on
the downstream, to send and receive signalling information. You can
change the default port number in the MTA configuration file. You can
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
34
Provisioning
also change the transmit port by sending an NCS message from the call
server once the MTA is operating. See the Touchstone Software Troubleshooting Guide for details.
CODECs and
Packetization
Rates Supported
In addition to continued support for the G.711 CODEC, TS4.1 and later
software supports the following PacketCable™ optional and recommended CODECs:
•
G.728 (recommended)
•
G.729, G729E
•
G.726-16, G.726-24, G.726-32, G.726-40
Touchstone software uses the G.711 CODEC as a default, unless the
CMS directs the Touchstone NIU to negotiate a different CODEC with
other MTAs.
Implementation of CODECs is defined by the PacketCable Audio/
Video Codes Specification, PKT-SP-CODEC-I05-040113.
Note: If the Touchstone MTA detects a fax or modem call, the MTA
automatically uses the G.711 CODEC, overriding any negotiated
CODECs from the CMS.
The supported packetization rates in TS4.5 are 10, 20, and 30 ms.
CallP Feature
Switch
The TS4.5 software provides an ARRIS-specific MIB, ppCfgMtaCallpFeatureSwitch, used to configure the Telephony Modem for the
specific sub-set of PacketCable features supported by the selected network configuration. This allows the flexibility to interoperate with
other vendors by providing the ability to enable or disable the proper
functionality. The default is full PacketCable compatibility.
The feature switch is a 32-bit value, where each bit enables or disables
a certain feature. Most of these values should only be changed with the
guidance of ARRIS technical support, but some flags may be changed
as necessary:
The following is a list of CallP Feature Switches that can be adjusted at
your discretion.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
35
Note: For SIP loads, only the DSX/Access-only DQoS bit (0x4000)
is supported. SIP loads ignore other bit values in the feature switch.
Bit
Description
0x00000001 Enable NCS Piggyback Messages
Set this bit to allow transmission of NCS piggybacked messages (that is, sending more than one NCS message in a UDP
packet).
0x00000002 Enable Lockstep Quarantine Mode
Set this bit to allow endpoints to enter the lockstep quarantine mode. When this bit is set, the gateway must receive a
new Notification Request command after sending a Notify
command. Until this happens, the endpoint is in a lockstep
state, and events that occur and are to be detected are simply
stored in the quarantine buffer. until receiving the Notification Request command.
0x00000004 MGCP Error Codes
Set this bit to allow the MTA to send error code response
messages that are specified in MGCP, but not yet specified in
NCS. The following error messages are enabled.
Note: The CMS must be able to support these error messages.
Attempt to create a 3rd connection on a line when only
two are supported:
NCS = 502 The transaction could not be executed, because
the endpoint does not have sufficient resources.
MGCP = 540 Per Endpoint Connection Limit Exceeded.
0x00000004 Can’t get a DSP resource to support a given connection
(continued) since they are all in use by other lines:
NCS = 502 The transaction could not be executed, because
the endpoint does not have sufficient resources.
MGCP = 403 The transaction could not be executed, because
the endpoint does not have sufficient resources at this time.
Can’t support the currently requested combination of
connections due to DSP (or other) limitation.
NCS = 502 The transaction could not be executed, because
the endpoint does not have sufficient resources
MGCP = 502 The transaction could not be executed, because
the endpoint does not have sufficient resources (permanent
condition).
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
36
Provisioning
Bit
Description
0x00000010 Enable SDP Compliance
Set this bit to enable the transmission of SDP parameters
(default). Clearing this bit reduces the length of the SDP
parameter list, by suppressing transmission of non-essential
Telephony Modem parameters. The suppressed parameters
are origin (o), bandwidth (b), session name (s), time start/
stop (t), and T.38 capabilities.
Reducing the length of the SDP parameter list may be
required to communicate with a CMS that does not support
SDP lists longer than 512 bytes, or when the CMS (for whatever reason) cannot interpret the SDP.
Note 1: Some commercially available gateways are not
able to support emergency communications, such as
E911 calls, with this setting. In this situations, use the
“Suppress SDP Capability Attribute Parameters” switch
setting instead of this switch setting.
Note 2: Clearing this bit disables T.38 strict mode functionality (T.38 loose mode is still available).
0x00000080 Omit MPTIME parameter in returned SDP
Set this bit to omit the MPTIME parameter in the MTA’s
SDP message for DOCSIS 1.1 operation. (DOCSIS 1.0+
operation automatically omits this information.)
0x00000100 Suppress SDP Capability Attribute Parameters
Set this bit to suppress T.38 capabilities only from being
transmitted in the SDP parameter list. in the SDP. The origin
(o), bandwidth (b), session name (s), and time start/stop (t)
bits are included in the transmitted SDP parameter list.
Clear this bit (default) to enable transmission of T.38 capabilities in the SDP parameter list. Reducing the length of the
SDP parameter list may be required to communicate with a
CMS that does not support SDP lists longer than 512 bytes,
or when the CMS (for whatever reason) cannot interpret the
SDP. However, some network gateways may require the o, b,
s, and t parameters in the SDP parameter list in order to process emergency communications.
Note: Setting this bit disables T.38 strict mode functionality
(T.38 loose mode is still available).
0x00000200 RSIP Wildcarding
For NCS loads, set this bit to allow transmission of wildcarded RSIP data.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
37
Bit
Description
0x00000800 No Gate-ID No Service
Set this bit to disable Best Effort calls. When this feature is
enabled, the Telephony Modem rejects all Create Connection
(CRCX) commands that do not contain a DQoS Gate-ID.
Since the Gate-ID is considered to be persistent, the Telephony Modem also rejects Modify Connection (MDCX)
commands, unless a previous MDCX or CRCX command for
that connection contained a DQoS Gate-ID. The rejection
message uses NCS error code 526 (no bandwidth).
0x00004000 DSX/Access only DQoS
(Applies to both SIP and NCS loads) Set this bit to use DSX/
Access DQoS only between the CM and CMTS.
0x00010000 Payload Header Suppression
Set this bit to allow Payload Header Suppression of voice
packets between the CM and CMTS.
0x00400000 CMS Redirect
Set this bit to allow a CMS to redirect the MTA to another
CMS that is not provisioned in the MTA CMS table, allowing the MTA to communicate with the CMS without attempting to establish an IPsec association first. Setting this bit is
for redirect cases only, the MTA does not respond to call
servers not provisioned in the MTA’s CMS table.
0x02000000 Provisionable Ring Cadences
Set this bit to enable provisionable ring cadences using the
NCS Signaling MIB. This feature is applicable only to nonNorth American countries since North America already uses
provisioned ring cadences. When this feature is disabled, the
hard-coded country template based ring cadences are used
which are not limited to 6 second durations as the provisioned values currently are.
Note: The setting of this bit does not affect European loads.
0x04000000 Flash timing values of 90 ms (Flash Time Min) and 800 ms
(Flash Time Max).
Set this bit to use these defined flash timing values.
For non-PacketCable configuration settings, contact your ARRIS Technical Support representative.
For more information, see the PacketCable Network-Based Call Signaling Protocol Specification, PKT-SP-EC-MGCP-I09-040113.
Example
If your configuration requires DSx-QoS and PHS, set the feature switch
to include the 0x4000 and 0x10000 flags using PacketACE or a provi-
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
38
Provisioning
sioning server. If no other flags are required, the setting would be as
follows:
SnmpMib = ppCfgMtaCallpFeatureSwitch.0 hexstr: 01.40.00
Switch Settings Removed in TS4.3
The following feature switch settings were removed in TS4.3:
Bit
Description
0x00000008 MGCP version 1.0 if set
0x00000040 Include comments in response messages
0x00000080 Allow any FQDN if set
0x00000100 Do not put line card in standby mode
0x00000800 Use hard-coded digit map
0x00002000 DQoS mode
0x00400000 Allow CMS to control loop rev. and caller ID
Note: No settings were removed in TS4.4.
Switch Settings Removed in TS4.4
The following feature switch settings were removed in TS4.4:
Bit
Description
0x00800000 Use the RxGainControl and TxGain Control MIB values
Switch Settings Removed in TS4.5
The following feature switch settings were removed in TS4.5:
Bit
Description
0x00000400 NCS Flexibility (standard behavior for release TS 4.5 and
newer).
MTA Feature
Switch
TS4.1 and later versions of Touchstone software support an MTA feature switch that allows you to enable several features, described below.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
39
The ppCfgMtaFeatureSwitch MIB 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
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.
0x00000002
MTA MAC addresses are not counted against the MaxCpeAllowed MIB. This is required to enable telephony if
policy requires this MIB to have a value of 1. Without this
switch setting, you must set the MaxCpeAllowed MIB to 2
or higher to enable telephony.
0x00000004
MTA packets bypass the CM CPE filters (interface 0). This
switch has no effect on filters applied against interface 16
(MTA).
0x00000008
Enables ARRIS-proprietary MTA coexistence and notification features. See the Touchstone Software Management
Guide for details.
0x00000010
The MTA bypasses IP checks for KDC responses if the
KDC load balancer replaces the original KDC IP address.
0x00000020
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 server such as Cisco BACC.
The default MTA feature switch value is 0, except for D11PLUS loads
which have a default value of 0x06.
Note: If you include MTA feature switch settings in the configuration, use the CM configuration file, not the MTA configuration file.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
40
CM Feature Switch
Provisioning
The arrisCmDevModemFeatureSwitch MIB is a group of flags that
enable or disable extended features of ARRIS cable modems. The supported bits are (starting with the most significant bit):
Bit Value
0x80
Description
badMapDiscard—set this bit to discard invalid MAP mes-
sages.
0x40
wanIsolationOverride—set this bit to disable the WAN Isola-
tion switch on Touchstone cable and telephony modems. Internet access remains enabled regardless of the position of the
WAN isolation switch (Standby button).
Note: This feature switch setting is specific to specific hardware used in Japan deployments. Use the arrisCmDevWanIsolationState MIB to override this functionality in other markets.
0x20
usbDisable—set this bit to disable the USB interface on
Touchstone cable and telephony modems.
0x10
concatDisable—clear this bit to enable fragmentation support
for use with DOCSIS 1.0 CMTS products that support this feature.
0x08
octetCounterChange—set this bit to set the ifInOctets counter
to exclude SYNC and MAP packets from being counted on
interface 3 (the downstream RF interface).
0x04
(DOCSIS 1.0+ loads only) bypassMAX_CPE — set this bit to
ignore the MTA when counting attached CPE devices; MaxCPE can use its default of 1 while allowing both data and telephony traffic. DOCSIS filters are still applied to the MTA
packet stream unless the MTAfilterDisable bit is also set.
0x02
(DOCSIS 1.0+ loads only) MTAfilterDisable — set this bit to
disable application of DOCSIS filters to the MTA packet
stream. The MTA is still counted as a CPE unless the
bypassMAX_CPE bit is also set.
0x01
enableIpv6Multicast—set this bit to enable forwarding of IPv6
multicast packets.
The default value is 0 for DOCSIS 1.1/2.0 loads, or 0x06 for
DOCSIS 1.0+ loads.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
SIP Feature Switch
41
The SIP feature switch MIB sipCfgSipFeatureSwitch is a group of
flags that enable or disable extended features in the SIP load. The supported flags are:
Bit Value
Description
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 proxy address (instead of
the domain) in outgoing URI fields. The default behavior is
to use the domain setting from MTA DHCP Option 15.
0x08000000
RFC3323 Privacy Header Usage
Set this bit to enable the RFC3323 privacy header instead
of setting the From header to an anonymous value (as
defined in RFC3261).
0x10000000
Advanced flash handing
Set this bit to enable European advanced flash feature support (where the flash is followed by a DTMF digit). The
normal mode of operation handles flash using North American standards.
0x20000000
RFC3842 handshake
Set this bit to enable an RFC3842-compliant SubscribeNotify handshake for message waiting indicator (VMWI)
support. The normal VMWI scheme uses unsolicited Notify
messages.
0x40000000
MTA FQDN
Set this bit to use the MTA FQDN instead of the IP address
in the contact header field of SIP messages.
The default value is 0 for all SIP loads.
Country Code
Templates
Use the ppCfgMtaCountryTemplate MIB to set the country code template.
TS4.5 software supports the following country code templates:
Name
Gain settings (dB)
Flash time (ms)
(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
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
42
Provisioning
Name
Gain settings (dB)
Flash time (ms)
(NA load only)
Tx
Rx
Min
Max
Australia (4)
-3
-9.5
250
1200
Austria (5)
-3
-9.5
250
1200
France (6)
-3
-9.5
250
1200
Germany (7)
-3
-9.5
250
1200
Ireland (8)
-3
-9.5
250
1200
Netherlands (9)
(Euro-DOCSIS default)
-3
-9.5
300
500
Portugal (10)
-3
-9.5
250
1200
Spain (11)
-3
-9.5
250
1200
Belgium (12)
-3
-9.5
50
600
Poland (13)
-3
-9.5
250
520
Israel (14)
-3
-9.5
250
1200
Czech Republic (15)
-3
-9.5
250
1200
Brazil (16)
-3
-9.5
220
320
North America 3/3 (17)
(DOCSIS default)
-3
-3
250
1200
North America 0/9 (18)
0
-9
250
1200
Netherlands 0/9 (19)
0
-9
300
500
Japan 600L412(20)
-4
-8
200
1200
Hungary (21)
-3
-9.5
60
200
Sweden (22)
-3
-9.5
250
1200
Norway (23)
-3
-9.5
250
1200
Slovakia (24)
-3
-9.5
250
1200
Japan 600L412 (25)
(see note)
-4
-12
200
1200
Mexico (26)
0
-7
100
800
Panama (27)
-3
-9.5
220
320
MexicoC (28)
0
-7
100
800
Switzerland (29)
-3
-9.5
88
600
Note: Code 25 (Japan 600L412) is provided for lab environment
tests only. ARRIS does not support field deployment using this template as it does not meet certain NTT specifications.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
43
See Appendix C for default ring cadences and tones set for each country template.
Dial Pulse Support
Dial pulse support may be required to support subscriber equipment
such as older rotary phones or alarm systems. Touchstone software provides two methods of dial pulse support:
•
Gateway (IPDT) dial pulse—Touchstone MTAs detect dial
pulses and relay the information to the network as DTMF tones.
•
Softswitch (CMS) dial pulse—Touchstone MTAs relay dial
pulses to the CMS.
The support method used depends on the network configuration, and is
selected by setting the ARRIS-proprietary arrisMtaDevEndPntDialingMethod MIB as follows:
Value
Method
Description
1
Tone
(default) Enables DTMF detection only.
2
Pulse
Enables pulse dialing detection (CMS dial
pulse).
3
Tone & Pulse
Enables both DTMF and pulse dialing detection (CMS dial pulse).
4
Pulse with DTMF Enables pulse dialing detection with DTMF inRelay
band relay (patent pending) enabled (gateway
dial pulse).
5
Tone & Pulse with Enables both DTMF and pulse dialing detecDTMF Relay
tion with DTMF in-band relay enabled (gateway dial pulse).
Note: The arrisMtaDevEndPntDialingMethod MIB replaces the
ppCfgPortDialingMethod MIB, which has been deprecated. In
TS4.2 and earlier software versions, a value of 2 enabled both
DTMF and pulse dialing. When upgrading, check configuration
files and change this MIB as needed.
See “Configuring Dial Pulse Support” on page 66 for more information.
SIP Support
The load provides support for SIP by making modifications to the CM
configuration file and requiring a new MTA configuration file.
The following parameters are changed in the CM configuration file:
•
QoS Parameter
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
44
Provisioning
•
SIP communication port
The MTA configuration file is outlined in Appendix A.
European Productization Support
The .EURO load provides support for Euro-PacketCable compliance.
The EURO load adds the following functionality:
•
Configurable power ring frequency using the pktcSigPowerRingFrequency MIB.
•
Supports different methods of on-hook caller ID using the pktcSigDevCIDMode MIB.
•
Configurable visual message waiting indicator using the pktcSigDevVmwiMode MIB.
•
Configurable tone operations using the pktcSigDevToneTable
MIB.
•
Configurable hook flash timing using the pktcNcsEndPntConfigMinHookFlash and the pktcNcsEndPntConfigMaxHookFlash MIBs.
Configuration File Provisioning Notes
CM and MTA provisioning files, as described in DOCSIS and PacketCable specifications, use TLV (Type/Length/Value) objects to specify
configuration parameters. This section provides information useful in
provisioning Touchstone products through configuration files.
Support for TLV-41
(Downstream
Channel Lists)
A new DOCSIS feature (TLV-41) introduces the concept of Downstream Channel Lists to the RFI specification. When provisioned in the
CM config file, downstream channel lists provide the ability to specify
an allowed range of downstream frequencies to use during downstream
scanning operations.
When Downstream Channel Lists are specified in the configuration
file, the CM does not use any frequencies outside of the provisioned
range without specifically being directed to so by the CMTS. Also, this
list overrides the last operational channel value stored in NVRAM. If
the CM (portion of the MTA) loses sync with the CMTS, the CM
retains the provisioned list of downstream channels provided in the
config file, and uses them to search for a new downstream during subsequent MAC re-initialization and downstream scanning.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
45
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-I09-050812).
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
46
Embedding
ARRIS-Proprietary
MIBs within TLV-43
Provisioning
In TS4.4 and newer versions, all ARRIS MIBs (TLV-11) may be
embedded within the Vendor Specific Information TLV (TLV-43). The
TLV-43 Vendor ID field must contain the ARRIS Organization Unique
Identifier (OUI); the OUI is a three-byte representation of the ARRIS
MAC Address (0000CA). Multiple ARRIS TLV-11s may be embedded
within a single TLV-43.
Note: Always use the 0000CA OUI value, even if the Telephony
Modem OUI is 001311.
The following is an example (encoded by PacketACE) of an ARRIS
TLV-11 embedded within a TLV-43.
VendorSpecific = ARRISVendorId SnmpMib = arrisMtaDevLoopVoltageKey.0
"F1DA57E514D58B23"
VendorSpecific = ARRISVendorId SnmpMib = arrisMtaDevLoopVoltagePolicy.0
always_voltage_present
VendorSpecific = ARRISVendorId SnmpMib = arrisMtaDevLoopVoltageResetTimeout.0
800
See the PacketACE User’s Guide for details about encoding TLV-11
objects within a TLV-43.
Monitoring MTA Provisioning Status
The arrisMtaDevProvState MIB reports the current provisioning state
of the MTA. The possible values of this MIB object represent the following steps of the provisioning sequence, and depend on the provisioning method used:
•
dhcpBound(1)
•
dnsReqProvSvrIP(2)
•
kdcHostNameDnsReq(3)
•
kdcHostNameDnsRply(4)
•
kdcIpDnsReq(5)
•
kdcIpDnsRply(6)
•
asReqSent(7)
•
asRplyRcvd(8)
•
tgsReqSent(9)
•
tgsRplyRcvd(10)
•
apReqSent(11)
•
apRplyRcvd(12)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
47
•
enrollmentInform(13)
•
cfgUrlSet(14)
•
dnsReqTftpSvrIp(15)
•
cfgFileReq(16)
•
rcvCfgFile(17)
•
syslogMsgProvComplete(18)
•
statusInform(19)
•
provcomplete(20)
The following table shows the provisioning states that can be reported
for each provisioning method.
Provisioning Method
States Reported
docsisOnly
None
fullPacketCable
enrollmentInform(13)
cfgUrlSet(14)
dnsReqTftpSvrIp(15)
cfgFileReq(16)
rcvCfgFile(17)
syslogMsgProvComplete(18)
statusInform(19)
provcomplete(20)
PacketCableMinusKDC
dhcpBound(1)
dnsReqProvSvrIP(2)
enrollmentInform(13)
cfgUrlSet(14)
dnsReqTftpSvrIp(15)
cfgFileReq(16)
rcvCfgFile(17)
syslogMsgProvComplete(18)
statusInform(19)
provcomplete(20)
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
48
Provisioning
Provisioning Method
States Reported
Gupi,
gupiEncryptedMtaConfig,
gupiMacMta,
gupiEncryptedMacMta
dhcpBound(1)
dnsReqProvSvrIP(2)
dnsReqTftpSvrIp(15)
cfgFileReq(16)
rcvCfgFile(17)
syslogMsgProvComplete(18)
provcomplete(20)
singleMAC
None
basic1
dhcpBound(1)
dnsReqProvSvrIP(2)
dnsReqTftpSvrIp(15)
cfgFileReq(16)
rcvCfgFile(17)
syslogMsgProvComplete(18)
provcomplete(20)
basic2
dhcpBound(1)
dnsReqProvSvrIP(2)
dnsReqTftpSvrIp(15)
cfgFileReq(16)
rcvCfgFile(17)
syslogMsgProvComplete(18)
statusInform(19)
provcomplete(20)
Software Upgrade
Status
The arrisMtaDevSWUpgradeStatus MIB reports the current software
upgrade status of the device. Its value is a direct copy of docsDevSwOperStatus. The possible values for this MIB are:
•
inProgress(1)
•
completeFromProvisioning(2)
•
completeFromMgt(3)
•
failed(4)
•
other(5)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
49
Configuring Alarm and Log Reporting
Use this procedure to configure how the Touchstone NIUs generate and
send events (alarms and logs). The Touchstone Software Troubleshooting Guide provides detailed descriptions of alarms and logs.
Touchstone MTA events function within the context of the PKTCEVENT-MIB. Touchstone CM events function within the context of the
DOCS-CABLE-DEVICE-MIB.
Overview
TS4.5 software provides the capability to provision logs and alarms utilizing two different methods.
•
The standard mode provides the ability to provision:
— separate Syslog server and trap receiver addresses for
alarms and logs.
— multiple trap receivers allowing multiple monitoring stations if desired.
— different reporting schemes for each event if desired.
•
A compatibility mode, that allows the TS4.5 software to use
provisioning from previous software releases (see “TS4.1 and
Older Compatible Provisioning Method” on page 50).
You can use both provisioning methods as desired. However, if you use
the same servers for both methods, the Telephony Modem sends duplicate reports to that server.
Standard Mode
When the NIU generates an event, each event can be sent to any combination of:
•
local event log
CM events are stored locally in the docsDevEventTable. The
Data-Over-Cable Service Interface Specifications, SPOSSIv2.0-I09-050812, describes the reporting of DOCSIS and
vendor-specific events.
MTA events are stored locally in the pktcDevEventTable.
The default configuration sends CM and MTA events only to
the local event log.
•
SNMP trap server
To report CM events, you can configure the CM in either
NmAccess mode or SNMP co-existence mode. To report MTA
events, you must configure the CM in SNMP co-existence
mode.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
50
Provisioning
SNMP co-existence mode supports multiple trap destinations.
See the Touchstone Software Management Guide for detailed
information.
•
Syslog server (MTA logs)
The NIU sends MTA logs to the Syslog server whose IP address
is specified in the pktcDevEvSyslogAddress MIB. The NIU
receives its MTA Telephony Syslog Server IP Address in the
MTA DHCP OFFER, option 7. The value of the option must be
one of the following:
— 0.0.0.0—Disable Syslog logging for the MTA.
— FF.FF.FF.FF—Use the CM log server as the Syslog server.
— Valid IP address of the Telephony syslog server.
The pktcDevEvSyslogAddress MIB value can also be configured from the MTA configuration file.
•
TS4.1 and Older
Compatible Provisioning Method
Syslog server (CM logs)
The NIU sends CM logs to the Syslog IP address specified in
docsDevEvSyslog. The CM receives its Syslog IP Address in
the CM DHCP options. To disable Syslog transmission for the
CM, set the IP address to 0.0.0.0.
For backwards compatibility with previous releases, Touchstone software provides a proprietary method of configuring the trap/Syslog destination IP address. By setting the ppCfgMtaTeleSyslogServIpAddr
MIB variable in the MTA configuration file, the MTA reports ARRIS
proprietary alarms as traps/Syslog events to the specified IP address. If
this IP address is set, each ARRIS alarm event reports to the local event
database, an SNMP trap and a Syslog message.
Each log report can also be modified by setting the new value to the
pktcDevEvFixedReporting MIB.
About the Event
Tables
The PKTC-EVENT-MIB provides two tables to describe events and
control their reporting: the pktcDevEvProgrammableTable and the
pktcDevEvFixedTable. The primary difference between the two tables
is that entries in the programmable table allow for changes to the message text. Currently, the programmable table contains alarms, and the
fixed table contains logs, although this is not a requirement.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
51
The following tables provide an overview of the alarms and logs.
pktcDevEvProgrammableTable
Event ID
Origin
Severity
Text
65529
ARRIS Major(2)
Power Supply Telemetry
65530
ARRIS Major(2)
Call Agent Loss of Communications
65533
ARRIS Major(2)
Voice Line Failure
65534
ARRIS Major(2)
Voice Line Total Failure
In addition, the pktcDevEvProgrammableTable defines several PacketCable alarms for battery telemetry. The ARRIS Power Supply Telemetry Alarm (and Log) supports these status events.
pktcDevEvFixedTable
Instance
Origin
Text
1
ARRIS Voice Line Diag Failed
2
ARRIS Voice Line Diag Passed
3
ARRIS Voice Line State Change
6
ARRIS Voice Line Protection State Change
7
ARRIS Voice Line Loop Current Change to High
8
ARRIS Voice Line Loop Current Change to Normal
10
ARRIS State Change
11
ARRIS CATV changed
14
ARRIS Power Supply Telemetry
15
ARRIS MTA TFTP: No Channel
16
ARRIS MTA TFTP: Successful
17
ARRIS MTA TFTP: File Not Found
18
ARRIS MTA TFTP: Protocol Error: TFTP Init
19
ARRIS MTA TFTP: Protocol Error: TFTP Open
20
ARRIS MTA TFTP: Protocol Error: TFTP Read
21
ARRIS MTA TFTP: Protocol Error: TFTP Close
22
ARRIS MTA TFTP: Protocol Error: TFTP DB Access
23
ARRIS MTA TFTP: Config File Error
24
ARRIS MTA TFTP: Failed
25
ARRIS MTA PROV: Failed
26
ARRIS MTA PROV: Successful!
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
52
Provisioning
The pktcDevEvSyslogAddress MIB specifies the address of the Syslog server to receive event notifications.
Action
Follow these steps to configure alarm and log reporting. You can configure individual NIUs through an SNMP manager, or all NIUs by
using a provisioning server to add the MIBs to the MTA configuration
file.
1
Set the pktcDevEvSyslogAddress MIB to the IP address of a Syslog server.
2
For each event in the pktcDevEvProgrammableTable, set the
pktcDevEvProgrammableReporting MIB to one of the following
values:
Value
Events Reported to
0x00
none
0x80
Local event log only
0xA0
Local event log and Syslog server
0xC0
Local event log and Trap server
0xE0
Local event log, Syslog server, and Trap server
For example, to configure “AC Fail” events to go to a Syslog server
(and the local log), set the following MIB:
pktcDevEvProgrammableReporting.65535.4491 = 0xA0
Note: If you want to report events to Syslog or trap servers, you
must report those events to the local event log as well.
3
For each event in the pktcDevEvFixedTable, set the pktcDevEvFixedReporting MIB to one of the values shown in step 2.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
53
Updating the KDC
Use this procedure if you require secure MTA provisioning and secure
NCS.
TS4.5 software commonly uses one of the following embedded certificates:
•
CableLabs Real Service Provider Root certificate (default). The
Real Root certificate is only issued to authorized MSOs and
Service Providers.
•
CableLabs Test Service Provider Root certificate. The Test Root
certificate is an alternative to the Real Root certificate for the
purpose of lab testing.
If you prefer to use the test certificate, you must configure the
Kerberos Key Distribution Center (KDC) with the Test Root
certificate.
•
IPfonix Test Service Provider Root certificate (used primarily
with earlier versions of Touchstone NIU software).
If you continue to use the IPfonix certificate, you must reconfigure the CM provisioning files.
Note: Due to limitations in the DNS UDP packet size (512 bytes)
there is a limit of ten “A” records that can be supported by the
Touchstone software. The “A” provides a mapping of the FQDN of
the Kerberos server to its IP address. Without an “A” record, it is
not possible to acquire the IP address of the Kerberos server.
For more information, see “Appendix B: Configuring the Service Provider Root.”
Action
Perform either of the following tasks as needed.
Task
Page
Configuring the KDC to use the CableLabs Test root .. 53
Using the Test Root Download feature......................... 54
Configuring the
KDC to use the
CableLabs Test
root
To use the CableLabs Real Service Provider Root certificate, do nothing. Follow these steps to use the test root certificate:
1
Generate a KDC certificate chained to your KDC certificate hierarchy (Real/Test Root CA, Service Provider CA, Local System Operator CA).
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
54
Provisioning
2
•
the realm name that you are using
•
the KDC's FQDN
Proceed as follows, depending on your KDC:
If you are using…
Then…
Alopa KDC
Modify the kdcConfig.org file as follows:
•
modify the KDC realm name to contain
the realm name that you are using; for
example, <kdcRealm name=”DEV49”>
•
Modify the principal name to contain the
KDC’s FQDN; for example,
<kdcPrincipalDataBase
name=”mmtaprovsrvr/hyde.dev49”>
IPfonix KDC
Generate the KDC private key and include it in
the KDC_private_key file.
If you are using a different KDC server, or need more help, contact
your next level of support.
3
4
Using the Test
Root Download
feature
Place the certificates on your KDC. The directory path to place the
certificates is:
•
IPfonix - KDCDir/windows/PacketCable/certificates/
•
Alopa - /opt/Alopa/MetaServ/KDC/config/certs/
Install the configuration file:
•
IPfonix - Place the KDC_private_key file in KDCDir/windows/
•
Alopa - Place the kdcConfig.org file in /opt/Alopa/MetaServ/
KDC/config/
5
Change the realm org name in the MTA configuration file from
"Really Amazing Telephone Company" to CableLabs.
6
Restart your KDC.
This option allows you to continue using the KDC with the IPfonix test
root configuration (supported in older versions of Touchstone NIU software). The NIU’s CM configuration file must contain three MIBs,
which instruct the NIU to download a test root. The test root is stored
only in the NIU’s RAM memory and therefore the download is
required after each reboot. Follow these steps to use this option.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
55
1
Place your IPfonix Test Root certificate on your TFTP server. This
server is normally the same server as the configuration file TFTP
server.
Note: The certificate must use the X.509 DER-encoded format.
2
Edit your CM configuration file to contain the following MIBs with
the following values:
•
•
PpCfgMtaDevSPTestRootCertAdminStatus: Set to downloadTestRootCert.
PpCfgMtaDevSPTestRootCertFilename: Set to the file name
containing the IPfonix Test Root.
•
PpCfgMtaDevSPTestRootCertServer: Set to the IP address of
the TFTP server.
3
Reboot the MTA.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
56
Provisioning
Controlling General NIU Functionality
Use this procedure to enable and disable general functionality on
Touchstone NIUs as desired.
Action
Perform the following tasks as needed.
Task
Page
Controlling Access to Troubleshooting Pages.............. 56
Controlling Data Shutdown Functionality ..................... 57
Reading Software Load Information ............................ 57
Changing the ifInOctets Counter Operation ................. 57
Setting the Telephony Port CATV Relay ...................... 58
Setting the Loop Voltage Management Policy ............. 58
Controlling
Access to Troubleshooting Pages
The TS4.5 software provides troubleshooting information using an
HTTP (web) interface. Follow these steps to control access to troubleshooting information after the cable modem registers (access is always
available before registration completes). These MIBs are read-only, so
they must be set in the configuration file.
1
2
In the configuration file, set the arrisCmDevHttpLanAccess MIB
to control access to the troubleshooting pages from the cable
modem LAN (Ethernet and USB) interfaces:
•
off (1)
•
basic (2) (default)
•
advanced (3)
•
until-registered (4)
Use the arrisCmDevHttpWanAccess MIB to control access to the
troubleshooting pages from the cable modem WAN (RF) interface:
•
off (1) (default)
•
basic (2)
•
advanced (3)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
Controlling Data
Shutdown Functionality
57
When the Telephony Modem loses AC power, one of the default
actions it takes to conserve battery power is to shut down the data services running over the Ethernet (all models) and USB (Model 5 and
newer) ports after 15 minutes of power loss. Follow these steps to configure the shutdown time or disable data shutdown altogether.
1
Enable or disable data shutdown by setting the value of the
arrisMtaDevPwrSupplyEnableDataShutdown MIB. The allowed
values are:
•
Enabled (1)—The Telephony Modem discontinues data services after the period of time defined in the arrisMtaDevPwrSupplyDataShutdownTime MIB. This is the default value.
•
Disabled (2)—The Telephony Modem allows the subscriber to
continue using data services while the modem is running on
battery power.
Note: Disabling data shutdown can reduce the battery holdup
time.
2
Reading Software
Load Information
Changing the
ifInOctets Counter
Operation
Set the time between initial loss of AC power and data shutdown by
changing the value of the arrisMtaDevPwrSupplyDataShutdownTime MIB. Specify the timeout period in seconds. The default is
900 seconds (15 minutes).
Follow these steps to see information about an NIU’s software load.
1
To see the name of the software image in use on the NIU, read
(GET) the value of the arrisCmDevSwImageName MIB.
2
To see the build date and time of the software image in use on the
NIU, read (GET) the value of the arrisCmDevSwImageBuildTime
MIB.
In TS4.1 and later versions of Touchstone software, you can change the
ifInOctets counter to exclude SYNC and MAP packets from being
counted on interface 3 (the downstream RF interface). You may want to
use this feature to match the way that Broadcom-based cable modems
use the ifInOctets counter to maintain compatibility with existing commercial monitoring products in the field. Follow these steps to configure the counter.
1
To exclude counting octets from SYNC and MAP packets on interface 3, set the bit in the 0x08 position of the arrisCmDevModemFeatureSwitch MIB.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
58
Provisioning
2
Setting the Telephony Port CATV
Relay
Setting the Loop
Voltage Management Policy
To include counting octets from SYNC and MAP packets on interface 3, clear the bit in the 0x08 position of the arrisCmDevModemFeatureSwitch MIB.
Touchstone Telephony Ports have a CATV relay that allows you to
enable or disable CATV service to a subscriber. Follow these steps to
set the relay:
1
To allow CATV service, set the ppCfgMtaCableTvEnable MIB to
on (1).
2
To disable CATV service, set the ppCfgMtaCableTvEnable MIB
to off (2).
In TS4.4 and later versions, you can set the loop voltage policy option.
This allows the MSO to determine which policy is best for their operations and set the value accordingly. A signed indemnification agreement must also be on record with ARRIS before this feature may be
enabled. Two items are necessary to enable this feature; a feature key
and a policy setting. If either are absent or invalid, the MTA uses the
default Policy 4. Otherwise, the setting that is entered into the configuration file will be enabled. See the Touchstone Software Feature Guide
for details about each policy.
1
Contact ARRIS for the appropriate software optionality key. The
optionality key is a 16 bit alpha-numeric string and is unique per
MSO. An example of the software optionality key is
0D3BC4267A2C438F.
2
Add the software optionality key to the MTA configuration file in
the arrisMTADevLoopVoltageKey MIB as a TLV-43 or a TLV-11
parameter to enable the feature.
Note: All MIBs referenced by this task must be placed in the MTA
configuration file; the MTA reads them only after ranging and registering. To make changes after the MTA ranges and registers, you
must change the MTA configuration file and reset the MTA.
3
Set the arrisMTADevLoopVoltagePolicy MIB to the appropriate
value:
•
Always-Voltage-Present (1)
•
RF-Carrier-Voltage-Present (2)
•
In-Service-Voltage-Present (3)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
59
•
4
Normal-Operation (4) (default)
For MTAs using policy 3, modify the reset timer (if necessary) by
setting the arrisMtaDevLoopVoltageResetTimeout MIB. Valid
range: 8 to 1000 seconds. Default: 300 seconds.
The reset timer drops loop voltage after an MTA reset, if the MTA
has not successfully ranged and registered before the time expires.
Note: This MIB is only used with policy option 3 and is ignored if a
policy setting of other than 3 is used.
5
For MTAs using policy 3, modify the plant maintenance timer (if
necessary) by setting the arrisMtaDevLoopVoltageMaintTimeout
MIB. Valid range: 0 to 1440 minutes (24 hours).
6
Reset the MTA to enable the new loop voltage policy on the MTA.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
60
Provisioning
Controlling Cable Modem Functionality
Use this procedure to enable and disable cable modem functionality on
Touchstone NIUs as desired.
Action
Perform the following tasks as needed.
Task
Page
Setting Allowed CPE Counts........................................ 60
Toggling the DOCSIS Mode ......................................... 60
Controlling the WAN Isolation State............................. 61
Setting IPv6 Forwarding............................................... 62
Setting DOCSIS 1.0 Fragmentation Support ............... 63
Setting Allowed
CPE Counts
The eDOCSIS specifications (http://www.cablemodem.com/downloads/specs/CM-SP-eDOCSIS-I06-050812.pdf) require that the default
value for the MaxCpeAllowed TLV be 1, and that an MTA interface be
treated as a CPE—thus, data service on a Telephony Modem that is
provisioned with voice capabilities is effectively disabled by default.
Follow these steps to enable data functionality.
1
Open the CM configuration file with PacketACE or another configuration editor.
2
Do one of the following to enable MTA service:
3
Toggling the DOCSIS Mode
•
Change the MaxCpeAllowed TLV to 2 or higher.
•
Set the 0x02 bit of the ppCfgMtaFeatureSwitch MIB to
exclude the MTA interface from the CPE count (automatically
enabled in D11PLUS loads).
Save the configuration file, then reset any affected Telephony
Modems to force the change to take effect.
In TS4.1 and later software, the NIU can automatically configure itself
for DOCSIS 2.0 operation based on the presence of DOCSIS 2.0
upstreams (disabled in DOCSIS1.0+ loads). Follow these steps to manually set the desired operating mode.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
61
1
Use the arrisCmDevEnableDocsis20 MIB to control the operating mode:
•
true (1) — enables DOCSIS 2.0 operating mode
•
false (2) — enables DOCSIS 1.1 operating mode (default)
If you change the value using SNMP, the cable modem reboots.
You may prefer to add this MIB to the configuration file and reset
the NIU during the next maintenance window. If the MIB is in the
configuration file, the NIU only resets the first time the value
changes.
Note: Model 4 and Model 5 Telephony Modems automatically
update DOCSIS settings from DOCSIS 1.1 to DOCSIS 2.0 when
communicating with a DOCSIS 2.0 CMTS using either an
A-TDMA or S-CDMA carrier. When the NIU detects the DOCSIS
2.0 UCD, it switches to DOCSIS 2.0 mode, caches the downstream
frequency in NVRAM, and reboots so the new settings can take
effect.
Controlling the
WAN Isolation
State
You can use the arrisCmDevWanIsolationState MIB variable to read
the state of a subscriber’s Standby button (located on the front panel of
Model 4 NIUs), or to control the subscriber’s access to the Internet.
Additionally, TS4.1 and newer software releases can override the subscriber’s Standby button setting. Possible uses of this feature might be
in response to a customer service call when the subscriber has inadvertently pressed the Standby button on the NIU, or to disable a subscriber’s access to the Internet.
1
To read the state of the Standby button, read (GET) the value of the
arrisCmDevWanIsolationState MIB object value and evaluate it
as follows:
•
off-InactiveMode (value = 1) — Data traffic is allowed to pass
freely between the subscriber’s network and the outside network (i.e. the Internet). The Standby button is enabled.
•
on-ActiveMode (value = 2) – The subscriber network is isolated from the Internet. Data traffic does not pass between the
subscriber’s network and the Internet. The Standby button is
enabled.
•
off-InActiveMode-ButtonDisabled (value = 3) — Data traffic
passes freely between the subscriber’s network and the outside
network (i.e. the Internet). The subscriber’s setting of the
Standby Button is disabled.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
62
Provisioning
•
2
on-ActiveMode-ButtonDisabled (value = 4) — The subscriber’s network is isolated from the Internet. The subscriber’s
setting of the Standby button is disabled.
To override the Standby button setting and disable the subscriber’s
ability to change this setting, set the arrisCmDevWanIsolationState MIB object as follows:
•
off-InActiveMode-ButtonDisabled (value = 3) — The
Standby button functionality is disabled, and data traffic is
allowed to pass freely between the subscriber’s network and the
outside network (i.e. the Internet).
•
on-ActiveMode-ButtonDisabled (value = 4) — The Standby
button functionality is disabled, and data traffic is not allowed
to pass freely between the subscriber’s network and the outside
network (i.e. the Internet).
Note 1: Subscribers may accidentally push the Standby button on
their cable modems and then call in a trouble report stating that they
no longer have the ability to access the WAN. Otherwise, the
EMTA is operating correctly. Verifying the WAN Isolation state
should be one of the first things that your support staff should check
when responding to this type of trouble call.
Note 2: Activating Standby mode on TM402C and TM402J Telephony Modems (Japan market) turns off all front panel LEDs other
than the Power LED without disabling WAN access, regardless of
the arrisCmDevWanIsolationState MIB value.
Note 3: Model 5 Telephony Modems do not have a Standby button.
However, the arrisCmDevWanIsolationState MIB is still valid
and works as described otherwise on Model 4 and Model 5 hardware.
Setting IPv6 Forwarding
Follow these steps to enable or disable IPv6 forwarding on the NIU.
The default setting disables forwarding.
1
Set the least significant bit (0x01) of the arrisCmDevModemFeatureSwitch MIB to enable IPv6 forwarding.
Note: TS4.5 does not support filtering of IPv6 packets at the NIU.
2
Clear the least significant bit (0x01) of the arrisCmDevModemFeatureSwitch MIB to disable IPv6 forwarding.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
Setting DOCSIS
1.0 Fragmentation
Support
63
While DOCSIS 1.0 does not require fragmentation support, some
CMTS vendors support it. Follow these steps to enable or disable
DOCSIS 1.0 fragmentation support on an NIU. The default setting
enables the support.
1
Clear the 0x10 bit of the arrisCmDevModemFeatureSwitch MIB
to enable DOCSIS 1.0 fragmentation support.
2
Set the 0x10 bit of the arrisCmDevModemFeatureSwitch MIB to
disable DOCSIS 1.0 fragmentation support.
Note: Disabling fragmentation support may be required to allow
the cable modem to register on certain older DOCSIS 1.0 CMTS
units.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
64
Provisioning
Controlling MTA Functionality
Use this procedure to enable and disable MTA functionality on Touchstone NIUs as desired.
About Monitoring
Functionality
The features described in this procedure are generally controlled
through the MTA configuration file. See the Touchstone Software Management Guide for monitoring features, such as statistics and message
reporting through Syslog, which may be controlled while the MTA is in
service.
Action
Perform the following tasks as needed.
Task
Page
Configuring Loop Current. . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Configuring Gain Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Adjusting Delta Rx/Tx Gain . . . . . . . . . . . . . . . . . . . . . . . . . 66
Configuring Dial Pulse Support . . . . . . . . . . . . . . . . . . . . . . 66
Configuring the Echo Cancellation Tail Length . . . . . . . . . . 67
Configuring the Ringing Waveform . . . . . . . . . . . . . . . . . . . 67
Configuring the Dynamic RTP Port Range . . . . . . . . . . . . . 68
Configuring Non-Phase Reversed Modem Tone Handling . 68
Setting Jitter Buffer Parameters . . . . . . . . . . . . . . . . . . . . . . 69
Setting the Upstream Buffer Depth . . . . . . . . . . . . . . . . . . . 69
Configuring Loop
Current
Touchstone Telephony Modems support a “boost,” or high loop current
mode (40 mA vs. 23 mA) to compensate for faulty CPE or wiring. Use
this setting, for example, to alleviate issues related to off-hook not
being detected or fax machines failing to operate properly due to
increased current draw by the equipment.
1
To specify normal loop current (the default), set the ppCfgPortLoopCurrent MIB to 1.
2
To specify high loop current, set the ppCfgPortLoopCurrent MIB
to 2.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
65
Note 1: High loop current reduces battery hold-up times.
Note 2: The TM401 and TM501 Telephony Modems do not support
high loop current.
Configuring Gain
Control
Follow these steps as necessary to configure gain control settings.
1
Adjust MTA-generated FSK tones (CID and VMWI) by setting the
arrisMtaDevGainControlFSK MIB. Valid range: -10 to 2 (dBm).
Default: 0.
2
Adjust the transmit digital gain adjustment for MTA-generated
CAS tone by setting the arrisMtaDevGainControlCAS MIB. Valid
range: -2 to 2 (dBm). Default: 0.
3
Adjust the transmit digital gain adjustment for MTA-generated Call
Progress tones (dial tone, busy tone, ringback, etc.) to the CPE by
setting the arrisMtaDevGainControlLocalTone MIB. Valid range:
-2 to 2 (dBm). Default: 0.
4
Adjust the transmit digital gain adjustment for MTA-generated Call
Progress tones (ringback) to the network by setting the arrisMtaDevGainControlNetworkTone MIB. Valid range: -2 to 2 (dBm).
Default: 0.
5
Adjust the transmit digital gain adjustment for MTA-generated
DTMF tones to the CPE by setting the arrisMtaDevGainControlLocalDTMF MIB. Valid range: -15 to 9 (dBm). Default: 0.
6
Adjust the transmit digital gain adjustment for MTA-generated
DTMF tones to the network by setting the arrisMtaDevGainControlNetworkDTMF MIB. Valid range: -9 to 9 (dBm). Default: 0.
7
Adjust the transmit digital gain adjustment for voice by setting the
arrisMtaDevGainControlTxVoice MIB. Valid range: -2 to 2
(dBm). Default: 0.
Note: This setting does not affect local tone or FSK levels.
8
Adjust the receive digital gain adjustment for voice by setting the
arrisMtaDevGainControlRxVoice MIB. Valid range: -2 to 2
(dBm). Default: 0.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
66
Adjusting Delta
Rx/Tx Gain
Provisioning
You can adjust both delta Receive gain (Rx—from the MTA to the
CPE) and delta Transmit (Tx—from the CPE to the MTA) gain as necessary. Follow these steps to provision delta Rx/Tx gain.
CAUTION
Service affecting
Changing the delta Rx/Tx Gain from the default value based on the
country template used may affect overall voice transmission quality,
local tone levels, digit detection, and modem/fax tone detection. PESQ
scores may also be affected when additional loss is introduced.
1
Add the following Rx/Tx Gain MIB objects to the CM configuration file, using any valid line index for the NIU:
•
ppCfgPortTxGainControl
•
ppCfgPortRxGainControl
Note: Even though the deltaRx/Tx Gain MIB objects are defined to
be line-based, setting the MIB for any valid line sets the delta gain
for all lines. Also, if the same delta Rx/Tx Gain MIB object appears
multiple times in the CM configuration file using different indexes,
only the last one is used to set the gain settings.
The valid range for the Rx/Tx Gain MIB objects is -2 dB to 2 dB, in
1 dB increments. The default value for each MIB object is 0 dB.
Configuring Dial
Pulse Support
Follow these steps to configure dial pulse support on Touchstone
MTAs. See “Dial Pulse Support” on page 43 for more information.
CAUTION
Change to functionality
The arrisMtaDevEndPntDialingMethod MIB values have changed as
of TS4.3. If MTA configuration files use this MIB to enable pulse
detection, upgrade the software first and then the configuration file during a scheduled maintenance window.
1
To enable Gateway (IPDT) dial pulse support, set the arrisMtaDevEndPntDialingMethod MIB to 5 (pulse and DTMF detection).
2
To enable softswitch (CMS) dial pulse support, set the arrisMtaDevEndPntDialingMethod MIB to 3 (pulse and DTMF detection).
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
67
3
Configuring the
Echo Cancellation
Tail Length
To disable dial pulse detection, set the arrisMtaDevEndPntDialingMethod MIB to 1.
TS4.3 increased the default echo cancellation tail length for TM402
and later MTAs from 8 ms to 32 ms. Follow these steps to configure the
desired echo cancellation tail length.
1
In the MTA configuration file, add the arrisMtaDevEchoCancellerTailLength MIB and set it to eightMs or thirtyTwoMs as
desired.
Note: The MIB setting has no effect on Model 1 or Model 2 Telephony Modems, as well as Model 2 and Model 3 Telephony Ports.
The echo cancellation tail for these MTAs is fixed at 8 ms.
2
Reset the MTA.
The MTA sets the echo cancellation tail as configured, then marks
the MIB read-only.
Configuring the
Ringing Waveform
TM402 and newer Telephony Modems support both trapezoidal and
sinusoidal ringing waveforms when used with North American country
templates. Other models and templates currently support only trapezoidal waveforms. You may need to change the waveform if certain nonEIA compliant subscriber equipment does not recognize the trapezoidal
waveform (in short, the phone does not ring). Configure the ringing
waveform as follows:
CAUTION
Potentially service-affecting
Sinusoidal ringing is supported only for North American templates on
Model 4 and Model 5 hardware. Use of this feature with other templates, or with other hardware, may result in loss of service.
1
Set the arrisMtaDevEndPntRingingWaveform MIB using one of
the following methods:
a
In the MTA configuration file, add the arrisMtaDevEndPntRingingWaveform MIB and set it to sinusoidal or normal as
desired. Then reset the MTA to have the change take effect.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
68
Provisioning
b
Use an SNMP manager to access the MTA and set the arrisMtaDevEndPntRingingWaveform MIB to sinusoidal or normal
as desired.
Note: Setting this MIB in the configuration file does not write the
setting to NVRAM; therefore, if you remove the MIB from the configuration file and reset the MTA, it reverts to using the trapezoidal
waveform. Setting the MIB through SNMP does write the setting to
NVRAM.
Configuring the
Dynamic RTP Port
Range
Follow these steps to configure the dynamic RTP port range.
1
2
Configuring NonPhase Reversed
Modem Tone Handling
Set the arrisMtaCfgRTPDynPortStart MIB to the starting UDP
port number in the desired range. Valid range: 1024 to 65535.
Default: 49152. Note that the IANA defines the following ranges:
•
0–1023: Well-known ports
•
1024–49151: Registered ports
•
49152–65535: Dynamic and private ports
Set the arrisMtaCfgRTPDynPortEnd MIB to the ending UDP port
number in the desired range. Valid range: 1024 to 65535. Default:
65535.
TS4.4 and newer versions of Touchstone software support handling of
non-phase reversed CED fax/modem tones. You may need to enable
this feature to support low-speed analog modems which do not support
non-phase reversed CED tones.
1
Set the arrisMtaDevDspHandleNonPhaseReversedTone MIB to
one of the following values as appropriate:
•
off(1)—do not handle non-phase reversed tones. This behavior
is identical to TS4.1 and earlier versions of Touchstone software.
•
onECANEnable(2) (default)—handle non-phase reversed
tones with the echo canceller enabled.
•
onECANDisabled(3)—handle non-phase reversed tones with
the echo canceller disabled.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
Setting Jitter
Buffer Parameters
69
TS4.4 and newer versions of Touchstone software allow adjustments to
the MTA jitter buffer parameters. If you change these parameters with
an SNMP manager, the new settings take effect starting with the next
phone call.
1
Configure the jitter buffer mode by setting the arrisMtaDevVPJitterBufferMode MIB to either 1 (adaptive, the default) or 2
(fixed).
Setting the
Upstream Buffer
Depth
2
Configure the nominal jitter buffer size by setting the arrisMtaDevVPNomJitterBuffer MIB. The value represents a multiple of
the packetization rate. Valid range: 1 to 4. Default: 1.
3
(TS4.5 MSUP2 and newer only) Configure the maximum jitter
buffer size by setting the arrisMtaDevVPMaxJitterBuffer MIB.
The value represents a multiple of the packetization rate. Valid
range: 1 to 4. Default: 3.
TS4.5 MSUP2 and newer versions of Touchstone software allow for
provisioning the RTP transmit buffer depth by specifying a MIB in the
configuration file. This MIB can be written only in the configuration
file at initialization. Once MTA registration is complete, the MTA sets
the RTP buffer depth and marks the MIB read-only.
1
In the MTA configuration file, add the arrisMtaDevRTPTxQueueSize MIB and set its value. Valid range: 2 to 4 (packets) Default: 2.
Note: The MIB setting is enforced only for RTP voice packets. The
total buffer depth can increase to a maximum of 7 packets for
RFC2833 events, or for fax and analog modem call RTP packets.
2
Reset the MTA.
The MTA sets the RTP transmit buffer depth as configured, then
marks the MIB read-only.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
70
Provisioning
Provisioning SIP Support
TS4.5 provides SIP support for MTAs. This feature requires modifications be made to the CM configuration file and a new MTA configuration file. This feature requires a specialized software load.
See the Touchstone Software Feature Guide for details about SIP support.
Action
Perform the following tasks as necessary:
Task
Page
CM Configuration File Changes ................................... 70
MTA Configuration File Changes ................................. 71
Setting up Dialing Features.......................................... 73
Configuring Warmline or Hotline .................................. 74
CM Configuration
File Changes
Follow these steps to modify the cable modem configuration file for
SIP support.
1
Modify the ppCfgMtaCallpFeatureSwitch MIB. To use QoS for a
SIP EMTA load the value of the feature switch must be set to
0x4000 or decimal 16384. If this bit is not set in the feature switch,
the RTP packets are transmitted using Best Effort. Other QoS specific settings may be needed depending on the CMTS (and its software load) used.
2
Modify the PcIpClassification MIB. The Classification for
Upstream and Downstream packets should be set up with a different port number to indicate the correct SIP source port(s). PcIpSourcePortStart and PcIpSourcePortEnd should be set to 5060
in both UpstreamPacketClassification and DownstreamPacketClassification. Please refer to Appendix A for a sample configuration
file lookup.
3
(optional) Set the arrisMtaCfgRTPDynPortStart and arrisMtaCfgRTPDynPortEnd MIBs to the desired port range used for
sending SIP RTP voice packets. The valid range for the start and
end ports is 1024–65535. The default range is 49152–65535.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
MTA Configuration File Changes
71
Follow these steps to enable SIP support in the MTA configuration file.
1
Enable the MTA device by modifying the pktcMtaDevEnabled
MIB. The MIB is used to control the MTA device; it is not line specific. The value has to be set to true to provide dial tone on individual lines. To enable individual lines, set the ifAdminStatus.9
(line1) or .10 (line2) to 1 and also set the user name field for the
corresponding line.
2
Add a ppcfgMtaCountryTemplate MIB setting to change tones,
linecard configuration, and certain Euro-PacketCable defaults (such
as CallerID and VMWI) to match local requirements.
3
Enter the SIP user name by modifying the sipCfgPortUserName
MIB. This is the user name and it is recommended that it be the
phone number for that line of the MTA. This will be used in the
caller ID number at a later date. For line specific provisioning,
sipCfgPortUserName.1 and .2 represent the different line numbers. The user name must be less than 255 characters. If a string
contains any special characters, the entire string must be enclosed
within double quotes. To enable service this must be set along with
the pktcMtaDevEnabled set to true as well as the ifAdminStatus
set to true for the line.
4
Enter the display name by modifying the sipCfgPortDisplayName
MIB. This is the display name in the SIP messages that will be used
for the caller name delivery at a later date. The name must be less
than 255 characters. If a string contains any special characters the
entire string must be enclosed within double quotes "".
5
Enter the login name by modifying the sipCfgPortLogin MIB. The
login name is to be specified for each device to meet the requirements for HTTP digest authentication. The login is provisioned in
the SIP configuration file for the EMTA. To provide login name privacy, this setting when read will only display as "XXXXXXX"
(255 Max).
6
Enter the password by modifying the sipCfgPortPassword MIB.
The password is the paired requirement for the HTTP authentication on SIP messages. The string can be set only when downloading
the configuration file. In order to provide password privacy, this
setting when read will only display as "XXXXXXX" (255 Max).
7
Enter the interface admin status by modifying the ifAdminStatus
MIB. For SIP EMTAs, the ifAdminStatus.9 is for line 1 and ifAdminStatus.10 is for line 2. Both values need to be set to 1 to enable
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
72
Provisioning
the interfaces, same as the existing NCS settings. To bring the MTA
lines into service, the pktcMtaDevEnabled flag has to be set to
true and a value must be set for the sipCfgPortUserName for the
corresponding line.
8
Enter the SIP proxy server address and type by modifying the
sipCfgProxyAdr and the sipCfgProxyType MIBs. The SIP proxy
server address can be specified using the DNS or IPv4 format. If the
proxy type is set to DNS, then the domain name can be used. If the
IPv4 address format is used, a regular IP address needs to be specified. The port number is optional with a default value set to 5060.
The correct pair of information (proxy address and type) is required
for successful provisioning. No default value is assumed.
9
Enter the SIP registrar address and type by modifying the sipCfgRegistrarAdr and sipCfgRegistrarType MIBs. The SIP registration server (registrar) can be specified using either the DNS or Ipv4
format. The registrar can be the same address as the proxy server
but it will have to be specified again. If the registrar type is set to
DNS, then the domain name can be used. If the IPv4 address format
is used, a regular IP address needs to be specified. The port number
is optional with a default value set to 5060. The correct pair of
information (registrar address and type) is required for successful
provisioning. No default value is assumed.
10 Enter the digit map specification by modifying the sipCfgDigitMap
MIB. The digit map support on ARRIS SIP MTA is specified in the
config file via TLV43 and sub TLV69. It is applied to all the lines
on the Touchstone Telephony Modem. The format of the string is
the same as a digit map used in MGCP. It can be set only in the configuration file. The maximum length for the digit map is 2048 characters.
11 Enter the SIP call feature switch by modifying the sipCfgSipFeatureSwitch MIB. This call feature switch is intended to be used
later in the release. Each bit corresponds to a supported SIP call feature. There are 32 bits reserved for the feature switch. Default value
is 0.
12 Enter the SIP provisioned codec by modifying the sipCfgProvisionedCodecArray MIB. 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.These are entered as a string separated by
semi-colon ';' for example 'PCMU;PCMA;G726-32'. The supported
codecs are PCMU, PCMA, G728, G729, G729E, G726-16,G72624, G726-32, and G726-40. The default string is “PCMU;PCMA.”
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
73
13 Enter the packetization rate by modifying the sipCfgPacketizationRate MIB. The supported packetization rates are 10, 20 and 30
milliseconds. The default value is 20ms.
14 (optional) Set the arrisMtaCfgRTPDynPortStart and arrisMtaCfgRTPDynPortEnd MIBs to the desired port range used for
sending SIP RTP voice packets. The valid range for the start and
end ports is 1024–65535. The default range is 49152–65535.
Setting up Dialing
Features
Add to the MIBs described below to the MTA configuration file to set
up dialing features. The sipCfgDialFeatMap MIB, provided in earlier
TS4.4 loads, is supported for backwards compatibility but no longer
documented. The MIBs for each feature are distinguished by the
numeric suffix; for example, sipCfgDialFeatName.1 and sipCfgDialFeatName.2 are two different features.
1
2
Add the sipCfgDialFeatName MIB to enable particular dialing
features. Supported dialing features are:
•
Anonymous Call Reject
•
Anonymous Call Reject Disable
•
Call Forward Busy
•
Call Forward Busy Disable
•
Call Forward Fixed/Variable (Unconditional)
•
Call Forward Fixed/Variable Disable
•
Call Forward No Answer
•
Call Forward No Answer Disable
•
Call Return
•
Call Waiting Temp Disable
•
Call Waiting Perm Disable Toggle
•
Caller ID Perm Block Toggle
•
Caller ID Temp Enable
•
Caller ID Temp Block
Add the sipCfgDialFeatCode MIB to define a dialing code for a
particular feature. You can specify up to three codes, separated by a
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
74
Provisioning
comma, for each feature. For example, use “*70,1170” to allow
either *70 or 1170 to activate a feature.
3
Add the sipCfgDialFeatTone MIB to specify the confirmation tone
used when activating a feature. The choices are stutterTone
(default) and dialTone.
4
Add the sipCfgDialFeatActive MIB to assign a feature to one or
more lines on the MTA. The value for this MIB 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
Add the sipCfgDialProxyMap MIB to specify hybrid features—
those features where the MTA handles the tones, but the proxy handles the actual messaging. Each feature definition consists of three
parts, separated by commas and ended by a vertical bar. The parts
are:
•
Dial code (such as *50)
•
Confirmation tone (1 for stutter tone, 2 for dial tone)
•
Supported lines (a bitmap with a format similar to that of the
sipCfgDialFeatActive MIB).
For example, the value *50,1,1|*51,2,3| defines two features. The
first feature is activated by *50, uses a stutter confirmation tone,
and is active only on line 1. The second feature is activated by *51,
uses a dial tone for confirmation, and is active on lines 1 and 2.
Configuring Warmline or Hotline
The SIP load includes support for specifying a hotline or warmline
number in the configuration file. A hotline automatically dials the specified number as soon as the specified line goes off-hook; a warmline
automatically dials the specified number after providing dial tone for a
specified amount of time. Add the MIBs described below to the MTA
configuration file to set up a hotline or warmline for a specific line.
1
In the configuration file, set the sipCfgPortWarmOrHotlineNumber MIB to the phone number to dial. This MIB 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
MIB to the timeout value (in seconds) for a warmline, or to 0 for a
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
75
hotline. This MIB is specific to a line, so it must be specified with
the line number; for example, sipCfgPortWarmLlineTimeout.1
for line 1.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
76
Provisioning
Provisioning European Productization
Support
The TS4.5 .EURO load only provides support for full Euro-PacketCable provisioning. This requires that new features be configured and
existing MIBs be modified. This feature requires a specialized software
load.
See the Touchstone Software Feature Guide for details about European
Productization support.
Action
Perform the following tasks as necessary:
Task
Page
Configuring Power Ring Frequency ............................. 76
Configuring On-Hook Caller ID .................................... 77
Configuring Visual Message Waiting Indicator............. 77
Configuring Tone Operations ....................................... 78
Configuring Hook Flash Timing .................................... 80
Configuring Power
Ring Frequency
Follow these steps to configure the power ring frequency.
1
Select the pktcSigPowerRingFrequency MIB and input the
appropriate frequency for your network . The following frequencies are valid:
•
20 Hz (1)
•
25 Hz (2) (default for Belgium, Germany, Netherlands,
Netherlands09, and Poland)
•
33.33 Hz (3)
•
50 Hz (4) (default for France and Hungary)
•
15 Hz (5)
•
16 Hz (6)
•
22 Hz (7)
•
23 Hz (8)
•
45 Hz (9)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
Configuring OnHook Caller ID
77
Follow these steps to configure the on-hook Caller ID functionality.
1
Set the protocol by modifying the pktcSigDevCallerIdSigProtocol MIB. Supported protocols are fsk(1) (default) and dtmf(2).
2
Select the pktcSigDevCIDMode MIB and select from one of the
following modes:
•
duringRingingETS—The FSK containing the Caller ID infor-
mation is sent between the first and second ringing pattern. The
delay between the end of the first ringing pattern and the start of
the transmission for of the FSK containing the Caller ID information is configurable using the pktcSigDevCIDFskAfterRing
MIB.
•
dtAsETS (default for Belgium, France, Germany, Netherlands,
Netherlands09, and Poland)—The FSK is sent after the Dual
Tone Alert Signal but before the first ring pattern.
•
rpAsETS (default for Hungary)—The FSK is sent after 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 MIB object.
•
lrAsETS—The Line Reversal occurs first, then the Dual Tone
Alert Signal, and finally the FSK is sent but before the first ring
pattern. The delay between the end of the Line Reversal and the
start of the Dual Tone Alert Signal is configurable via the pktcSigDevCIDDTASAfterLR MIB 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 MIB.
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
MIB object.
Configuring Visual
Message Waiting
Indicator
Follow these steps to configure visual message waiting indicator.
1
Select the pktcSigDevVmwiMode MIB and select from one of the
following modes:
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
78
Provisioning
•
dtAsETS (default for Belgium, France, Germany, Netherlands,
and Netherlands09)—The FSK is sent after the Dual Tone Alert
Signal but before the first ring pattern.
•
rpAsETS (default for Hungary)—The FSK is sent after the
Ring Pulse. The delay between the end of the Ring Pulse Alert
Signal and the start of the transmission of the FSK containing
the VMWI information is configurable via the pktcSigDevVmwiFskAfterRPAS MIB 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 pktcSigDevVmwiDTASAfterLR MIB 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
MIB object.
Configuring Tone
Operations
Follow these steps to configure the tone operations.
1
Modify the pktcSigDevToneType MIB. The pktcSigDevToneTable table contains any modifications. The supported tone types
are listed below:
•
busy (16)
•
confirmation (17)
•
dial (18)
•
messageWaiting(19)
•
offHookWarning (20)
•
ringBack (21)
•
reOrder (22)
•
stutterdial (23)
•
loopback (24)
•
callWaiting1 (25)
•
callWaiting2 (26)
•
callWaiting3 (27)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
79
•
2
3
callWaiting4 (28)
The following tones are only supported by the MIB, but are not signaled through the supported line package:
•
alertingSignal (29)
•
testTone (30)
•
specialDial(31)
•
specialInfo (32)
•
release (33)
•
congestion (34)
•
userDefined1 (35)
•
userDefined2 (36)
•
userDefined3 (37)
•
userDefined4 (38)
To modify the decibel level of each of the tones listed above, modifications to the pktcSigDevToneDbLevel MIB can be made but,
are not necessary.
Note: This MIB object is supported by the Belgium, France, Germany, Hungary, Netherlands, Netherlands09, NorthAmerica33high,
and Poland country code templates.
4
To modify how the frequencies are applied for each of the given
tones, modifications to the pktcSigDevToneFreqType MIB can be
made, but are not necessary. Possible methods are:
•
allFrequencies—All frequencies specified by the MIB object
pktcSigDevToneNumFrequencies are mixed to form a single
tone. The tone is then applied in sequence using the number of
on/off times specified in pktcSigDevToneNumOnOffTimest
•
singleFrequencySequence—All frequencies specified by the
MIB object pktcSigDevToneNumFrequencies are applied in
sequence using the corresponding frequency number on/off
times.
•
dualFrequencySequence—Two pairs of frequencies are
mixed to form two sequenced tones. The first and second frequencies are mixed to form one and applied using pktcSigDevToneFirstToneOn and pktcSigDevToneFirstToneOff. The
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
80
Provisioning
third and fourth frequencies are mixed to form tone two and are
applied using pktcSigDevToneSecondToneOn and pktcSigDevToneSecondToneOff. For this tone type pktcSigDevToneNumFrequencies MUST equal 4 and
pktcSigDevToneNumOnOffTimes MUST equal 2
•
allFrequenciesModulated—All frequencies specified by
pktcSigDevToneNumFrequencies are modulated to form a
single tone. The tone is then applied in sequence using the number of on/off times specified in pktcSigDevToneNumOnOffTimes. The pktcSigDevToneNumFrequencies MUST equal
2, and the frequency in pktcSigDevToneFirstFrequency modulates the frequency in pktcSigDevToneSecondFrequency
Configuring Hook
Flash Timing
Follow these steps to configure hook flash timing in .EURO loads.
1
Modify the following MIBs as needed:
•
pktcNcsEndPntConfigMinHookFlash—represents the minimum time a line needs to be on hook for a valid hook flash. The
range is 20 to 1000 milliseconds. The defaults are as follows:
— Belgium: 50 ms
— France: 300 ms
— Germany: 300 ms
— Hungary: 60 ms
— Netherlands/Netherlands09: 300 ms
— Poland: 50 ms
•
pktcNcsEndPntConfigMaxHookFlash—represents the maxi-
mum time the line needs to be on hook for a valid hook flash.
The range is 20 to 1000 milliseconds. The defaults are as follows:
— Belgium: 600 ms
— France: 500 ms
— Germany: 500 ms
— Hungary: 200 ms
— Netherlands/Netherlands09: 500 ms
— Poland: 520 ms
Note: These MIBs are available only in .EURO loads.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Provisioning
81
Provisioning Voice and Signalling Packet
Priority
Use this procedure to set the priority of voice and signalling packets.
This may be necessary to give ToIP traffic priority in non-PacketCable
portions of the network, especially when the CMTS and call server or
CMS are located at different sites.
ToS-related MIBs
IP packets contain a ToS (Type of Service) field in the header, which
allows devices to specify the priority and traffic type of packets. Routers can use this information to process and prioritize traffic.
Two PacketCable MIBs allow setting the ToS field:
•
pktcSigDefCallSigTos—sets the ToS field for signalling
packets
•
pktcSigDefMediaStreamTos—sets the ToS field for voice
(ToIP) packets
These MIBs no longer exist in the European loads. The following
DSCP MIBs are used: pktcSigDefCallSigDscp and pktcSigDefMediaStreamDscp.
The following diagram shows the structure of the ToS field for both
voice and signalling packets:
Precedence bits:
Priority of traffic
7
6
5
Unused
4
3
2
1
0
Traffic type; not
used by Touchstone
Software
Touchstone software does not use (or recognize the existence of) the
lower two bits of the ToS field. In addition, you should always set the
“traffic type” bits (2 through 4) to zero. These restrictions result in a
valid range of 0 to 56 for the ToS MIBs, in multiples of 8. Touchstone
software automatically left-shifts the value given by two bits to insert
the correct values into the ToS field.
Action
Follow these steps to provision voice and signalling packet priority.
1
Create an MTA provisioning file, or open an existing file, using
PacketACE or another provisioning file editor.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
82
Provisioning
2
Create a setting for the pktcSigDefCallSigTos MIB with the
desired signalling priority. For example, if you want the priority for
signalling packets to be 3, set the value to 24 (3*8).
3
Create a setting for the pktcSigDefMediaStreamTos MIB with the
desired voice priority. For example, if you want the priority for
voice packets to be 5, set the value to 40 (5*8).
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
4
4
MIB Reference
This chapter lists the MIBs referenced by the TS4.5 software. See the
Touchstone Software Troubleshooting Guide for a partial list of MIB
variables used for troubleshooting.
The MIB files required are shipped on the CD with the TS4.5 software.
Supported MIBs
The TS4.5 software supports all standard MIBs required by DOCSIS.
Note: To comply with PacketCable specifications, Touchstone software restricts CM-related MIB access to the CM IP address, and
MTA-related MIB access to the MTA IP address.
ARRIS Proprietary
MIBs
The following ARRIS-specific MIBs are required for full SNMP support of Touchstone cable modems and are included on the software CD.
ARRIS-MIB
A header for the ARRIS enterprise MIB.
ARRIS-CM-DEVICE-MIB
The portion of the ARRIS enterprise MIB that applies to Touchstone Cable Modems.
PACKETPORT-MIB
The portion of the ARRIS enterprise MIB that applies to Touchstone NIUs.
ARRIS-MTA-DEVICE-MIB
The portion of the ARRIS enterprise MIB that applies to status
monitoring for Touchstone TM402 Li-Ion batteries and Loop Voltage Management settings.
ARRIS-SIP-MIB
The portion of the ARRIS enterprise MIB that applies to SIP support.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
84
DOCSIS MIBs
MIB Reference
DOCS-CABLE-DEVICE-MIB (RFC-2669)
Provides controls and status information in the CMTS and cable
modems.
DOCS-IF-MIB (RFC-2670)
Describes MCNS compliant Radio Frequency (RF) interfaces in
CMTS and cable modems.
DOCS-BPI-MIB (RFC-2083)
Describes the Baseline Privacy Interface (BPI) implementation in
the CMTS and cable modems.
DOCS-BPI2-MIB
Describes the Baseline Privacy Plus Interface (BPI+) implementation in the CMTS and cable modems.
DOCS-QOS-MIB
Describes the management information for Quality Of Service
(QOS) in DOCSIS 1.1.
DOCS-SUBMGT-MIB
Describes the subscriber management interface for cable modems.
DOCS-IF-EXT-MIB
Extensions to the DOCS-IF-MIB.
DOCS-CABLE-DEVICE-TRAP-MIB
An extension of the CABLE DEVICE MIB defined in RFC2669. It
defines various trap objects for both cable modems and the CMTS.
ESAFE-MIB
Describes the objects necessary to configure functionality of
eSAFE components of a device containing an eDOCSIS compliant
cable modem and one or more eSAFE elements.
PacketCable MIBs
CLAB-DEF-MIB
A header for the PacketCable MIB.
PKTC-MTA-MIB
Supplies basic management objects for MTA devices.
PKTC-IETF-MTA-MIB
Euro-PacketCable equivalent of PKTC-MTA-MIB.
PKTC-SIG-MIB
Contains all objects and provisioning data for each endpoint (or
telephone line).
PKTC-IETF-SIG-MIB
Euro-PacketCable equivalent of PKTC-SIG-MIB.
PKTC-EVENT-MIB
Supplies the basic objects required for reporting events (for example, logs and alarms).
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
MIB Reference
Network-related
MIBs
85
IF-MIB (RFC-2233)
Describes generic objects for network interface sub-layers.
BRIDGE-MIB (RFC-1493)
An interface to IEEE 802.1D-style bridges.
EtherLike-MIB (RFC-2665)
Status objects and counters associated with an Ethernet interface.
IP-MIB (RFC-2011)
The MIB module for managing IP and ICMP implementations, but
excluding their management of IP routes.
UDP-MIB (RFC-2013)
The MIB module for managing UDP implementations.
IGMP-STD-MIB (RFC-2933)
IGMP protocol support.
USB-MIB
Describes the cable modem USB interface.
SNMP-NOTIFICATION-MIB
SNMP-TARGET-MIB (RFC-2573)
Defines MIB objects that provide mechanisms to remotely configure the parameters used by an SNMP entity for the generation of
notifications.
SNMP-USER-BASED-SM-MIB (RFC-2574)
The management information definitions for the SNMP User-based
Security Model (USM).
SNMP-USER-BASED-ACM-MIB
SNMP-VIEW-BASED-ACM-MIB (RFC-2575)
The management information definitions for the SNMP Viewbased Access Control Model (ACM).
SNMP-COMMUNITY-MIB (RFC-2576)
This MIB module defines objects to help support coexistence
between SNMPv1, SNMPv2, and SNMPv3.
SNMP-USM-DH-OBJECTS-MIB (RFC-2786)
The management information definitions for providing forward
secrecy for key changes for the usmUserTable, and for providing a
method for kick-starting access to the agent via a Diffie-Helman
key agreement.
Imports and
Definitions
RFC1155-SMI
Common definitions for the structure and identification of management information for TCP/IP-based internets.
RFC1157-SNMP
Defines the SNMP protocol.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
86
MIB Reference
SNMPv2-PDU
Describes SNMP Protocol Data Units.
SNMPv2-TM
Defines textual conventions and objects for transporting SNMP
over various network protocols.
SNMPv2-MIB (RFC-1907)
Defines SNMPv2 entities.
SNMP-FRAMEWORK-MIB (RFC-2571)
Defines the SNMP management architecture.
SNMP-MPD-MIB (RFC-2572)
SNMP Message Processing and Dispatching.
SNMPv2-SMI (RFC-2578)
Object identifiers for SNMPv2, including SNMP MIB II (RFC
1907).
SNMPv2-TC (RFC-2579)
Common textual conventions, used throughout the MIBs.
SNMPv2-CONF (RFC-2580)
Definitions for conformance groups.
INET-ADDRESS-MIB (RFC-2851)
Defines textual conventions for representing Internet addresses. An
Internet address can be an IPv4 address, an IPv6 address or a DNS
domain name.
DIFFSERV-DSCP-TC (RFC-3289)
Defines textual conventions used in the PKTC-IETF-SIG-MIB.
INTEGRATED-SERVICES-MIB (RFC-2713)
Defines textual conventions used in the PKTC-IETF-SIG-MIB.
Duplicate and Obsolete MIBs
Duplicate MIBs
The following PacketPort MIBs are deprecated in favor of equivalent
PacketCable MIBs. ARRIS continues to make them available as readonly variables for customers using them in their network management
and monitoring.
Old PacketPort MIB
Description and Replacement MIB
ppCfgPortAdminState
Administrative status of the line.
Use ifAdminStatus
ppCfgPortCallAgentName
The call agent name.
Use pktcNcsEndPntConfigCallAgentId
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
MIB Reference
Obsolete MIBs
87
Old PacketPort MIB
Description and Replacement MIB
ppCfgPortCallAgentUdpPort
The call agent UDP port. Use
pktcNcsEndPntConfigCallAgentUdpPort
ppCfgPortMtaAdminState
MTA administrative status. Use
ifAdminStatus or pktcMtaDevEnableID
The following MIBs are no longer used or available as of TS4.1.
MIB
Reason for deletion
ppCfgPortCallAgentIpAddress
No longer used. Redundant information.
ppCfgPortProvSignalingProt
NCS is only supported signaling protocol.
ppCfgPortTpar
Duplicate of PacketCable NCS timer
ppCfgPortTcrit
Duplicate of PacketCable NCS timer
ppCfgPortBusyToneTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortDialToneTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortMsgWaitTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortOffHookWarnTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortRingingTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortRingBackTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortReorderTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortStutterDialToneTimeOut
Duplicate of PacketCable NCS timer
ppCfgPortMaxWaitDelay
Duplicate of PacketCable NCS timer
ppCfgPortPacketizationPeriod
Does nothing, packetization rate is
controlled by codec negotiation.
ppCfgPortCodec
Does nothing, codec is controlled by
codec negotiation.
ppCfgMtaFullyQualName
Duplicate of PacketCable MIB
object for FQDN
ppCfgMtaTeleServProvServIpAddr
Duplicate of PacketCable MIB
object for SNMP Entity
ppCfgMtaTeleServProvServName
Duplicate of PacketCable MIB
object for SNMP Entity
ppCfgMtaTeleServProvDhcpIpAddr Duplicate of PacketCable MIB
object for DHCP 1
ppCfgMtaTeleServProvDhcpName
Duplicate of PacketCable MIB
object for DHCP 1
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
88
MIB Reference
MIB
Reason for deletion
ppCfgMtaPrimTeleNetDnsAddr
Duplicate of PacketCable MIB
object for DNS 1
ppCfgMtaSecTeleNetDnsAddr
Duplicate of PacketCable MIB
object for DNS 2
ppCfgMtaConfigFileAccName
Duplicate of PacketCable MIB
object for config file location
ppCfgMtaProvMethodIndicator
Duplicates arrisCmDevProvMethodIndicator
ppCfgMtaTeleConfigServerIpAddr
Duplicate of PacketCable MIB
object for config file location
ppCfgMtaTeleConfigServerName
Duplicate of PacketCable MIB
object for config file location
ppCfgMtaNcsCallSigTos
Duplicate of PacketCable MIB
object for NCS ToS setting
ppCfgMtaCallServerType
No longer supported. Too many call
servers with different versions of
software for this to work
ppCfgMtaClientSeed
Duplicate of PacketCable MIB
object for config file location
ppCfgMtaHttpAdvLink
Duplicate of PacketCable MIB
object for config file location
ppSurvPortDigitMap
Not supported, should be audited
through NCS
ppSurvMtaCodecCapTable
Duplicate of PacketCable MIB and
values don’t match CableLabs definitions
ppSurvMtaSigCapTable
Only supporting NCS.
ppSurvMtaPeccode
No longer using this hardware code
style.
ppSurvMtaInitialProvAck
Old proprietary provisioning method
before the PacketCable inform was
used.
ppSurvMtaProvStatusAck
Old proprietary provisioning method
before the PacketCable inform was
used.
ppSurvMtaProvState
Duplicate of PacketCable MIB
(PacketCable MIB is more granular).
ppSurvMtaDevCorrelationId
Old proprietary provisioning method
before the PacketCable inform was
used.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
MIB Reference
Deprecated MIBs
89
MIB
Reason for deletion
ppCfgMtaInternetIsolationState
Duplicate of arrisCmDevWanIsolationState MIB.
ppSurvMtaActiveSwBank
Dual bank MTA loads no longer supported.
ppSurvMtaSoftwareLoadBankA
Dual bank MTA loads no longer supported.
ppSurvMtaSoftwareLoadBankB
Dual bank MTA loads no longer supported.
ppCfgPortDialingMethod
Replaced by
arrisMtaDevEndPntDialingMethod
The following MIBs are scheduled to be deprecated in TS5.x.
MIB
Reason for deletion
arrisCmDevprovMethodIndicator
Replaced by
arrisMtaDevProvMethodIndicator
ppCfgMtaLanHttpAccess
Replaced by
arrisCmDevHttpLanAccess
ppCfgMtaWanHttpAccess
Replaced by
arrisCmDevHttpWanAccess
Order of Compilation
Some SNMP managers, notably SNMPc, are sensitive to the order in
which MIB files are to be compiled. The following list is the recommended order for compilation.
•
standard.mib
•
snmp_tc.mib
•
snmpv2.mib
•
snmpv3.mib
•
SNMP-COMMUNITY-MIB.mib
•
rfc1213.mib
•
rfc1215.mib
•
rfc1493.mib
•
rfc1643.mib
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
90
MIB Reference
•
rfc1907.mib
•
rfc2011.mib
•
rfc2013.mib
•
ianaif.mib
•
rfc2233.mib
•
rfc2786.mib
•
rfc2933.mib
•
rfc2670_50.mib
•
qos_50.mib
•
bpi.mib
•
bpiplus.mib
•
dhkeychg.mib
•
rfc2665_50.mib
•
rfc2669_50.mib
•
DOCS-IF-EXT-MIB.mib
•
DOCS-CABLE-DEVICE-TRAP-MIB_50.mib
•
lcheader.mib
•
lancity_50.mib
•
clabs.mib
•
mtai02rv_50.mi2
•
sigi02rs_50.mi2
•
pkevt_50.mib
•
almtraps.mib
•
arrishdr.mib
•
arris_capability.mib
•
pp.mib
•
usb_50.mib
Note: Files whose names contain the string “_50” are modified for
use with SNMPc V5.0. If you are using a different NMS, substitute
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
MIB Reference
91
the files without the string (for example, use rfc2670.mib instead of
rfc2670_50.mib).
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
92
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
MIB Reference
5
Appendix A:
Example Files
5
The following is a list of example data and telephony provisioning file
templates included with TS4.5. See the PacketACE Configuration
Tools User’s Guide for more information about using the templates.
Listing of Templates
ARRIS may update these templates when updating PacketACE or
Touchstone software, so you should keep your own templates in a separate directory.
The following templates are provided (additional templates may be
added in later releases).
Location of
Template FIles
C:\Program Files\ARRIS\PacketACE\ACE_Templates
MTA Configuration
Files
The following is a list of example MTA configuration files included
with PacketACE.
The PacketACE installer places template files in the directory
ARRIS_proprietary_mibs.mta
Provides default values for all ARRIS proprietary MIBs.
PCABLE_mandatory_params.mta
Mandatory PacketCable parameters.
PCABLE_mandatory_params_2line.mta
Mandatory PacketCable parameters for a Touchstone Telephony Modem.
PCABLE_mandatory_params_4line.mta
Mandatory PacketCable parameters for a Touchstone Telephony Port.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
94
Appendix A: Example Files
MTA_PacketCable.mta
Basic PacketCable configuration for a Touchstone Telephony
Modem using TS4.2.
MTA_DOCSIS10_PLUS.mta
Basic DOCSIS 1.0+ configuration for a Touchstone Telephony
Modem using TS4.2.
Cable Modem
Configuration
Files
The following is a list of example MTA configuration files included
with PacketACE.
DOCSIS10_mandatory_params.cm
Mandatory parameters for a DOCSIS 1.0 compatible cable
modem.
DOCSIS11_mandatory_params.cm
Mandatory parameters for a DOCSIS 1.1 compatible cable
modem.
DOCSIS20_mandatory_params.cm
Mandatory parameters for a DOCSIS 2.0 compatible cable
modem.
DOCSIS11_NACVC.cm
Cable modem configuration with embedded ARRIS North
American Manufacturer’s CVC.
DOCSIS11_EUROCVC.cm
Cable modem configuration with embedded ARRIS European
Manufacturer’s CVC.
DOCSIS11_NACVC_SwUpgrade.cm
Cable modem configuration with ARRIS CVC that initiates a
secure software upgrade through the config file (North American load).
DOCSIS11_EUROCVC_SwUpgrade.cm
Cable modem configuration with ARRIS CVC that initiates a
secure software upgrade through the config file (European
load).
DOCSIS11_BASIC.cm
Basic configuration for a Touchstone NIU, configured as a
DOCSIS 1.0 cable modem, using TS4.0.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix A: Example Files
95
DOCSIS11_BASIC.cm
Basic configuration for a Touchstone NIU, configured as a
DOCSIS 1.1 cable modem, using TS4.0.
DOCSIS11_http_basic.cm
Basic configuration for a Touchstone NIU, configured as a
DOCSIS 1.1 cable modem, with the basic cable modem webbased troubleshooting interface enabled.
DOCSIS11_http_off.cm
Basic configuration for a Touchstone NIU, configured as a
DOCSIS 1.1 cable modem, with the basic cable modem webbased troubleshooting interface disabled.
DOCSIS11_to_DOCSIS20.com
Cable modem configuration file that toggles the NIU from
DOCSIS 1.1 to DOCSIS 2.0 mode, using TS4.0.
DOCSIS20_to_DOCSIS11.com
Cable modem configuration file that toggles the NIU from
DOCSIS 2.0 to DOCSIS 1.1 mode., using TS4.0.
DOCSIS11_CPS.cm
Touchstone NIU CM configuration using the CPS provisioning
mode.
DOCSIS11_DocsisOnly.cm
Touchstone NIU CM configuration using the DOCSIS provisioning mode.
DOCSIS11_PacketCable.cm
Touchstone NIU CM configuration using the Full PacketCable
provisioning mode.
DOCSIS11_GUPI.cm
Touchstone NIU CM configuration using the GUPI provisioning mode.
DOCSIS11_PCMINUSKDC.cm
Touchstone NIU CM configuration using the PacketCable (no
KDC) provisioning mode.
SingleConfig.sng
Touchstone Telephony Modem CM/MTA configuration using
the single MAC/single configuration file provisioning mode.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
96
Text Files
Appendix A: Example Files
In addition to binary CM and MTA configuration files, ARRIS provides a plain-text equivalent of each file (using a .txt extension). Using
PacketACE, you can cut and paste all or part of appropriate text files
into your own configuration files to modify them as needed.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix A: Example Files
97
SNMP Co-existence Example Configuration File
The following listing shows the MIBs and TLVs necessary to implement SNMP co-existence. The configuration is based on a minimal
DOCSIS 1.1 cable modem configuration file.
NetworkAccess = 1
UpstreamServiceFlow =
SfReference = 1
SfQosSetType = 7
SfSchedulingType = 2
DownstreamServiceFlow =
SfReference = 2
SfQosSetType = 7
PrivacyEnable = 0
SnmpMib = snmpCommunityName.comm1 "my_password"
SnmpMib = snmpCommunitySecurityName.comm1 "rwAccess"
SnmpMib = snmpCommunityStorageType.comm1 volatile
SnmpMib = snmpCommunityStatus.comm1 createAndGo
SnmpMib = vacmGroupName.1 rwAccess "rwAccess"
SnmpMib = vacmSecurityToGroupStorageType.1 rwAccess volatile
SnmpMib = vacmSecurityToGroupStatus.1 rwAccess createAndGo
SnmpMib = vacmGroupName.2 rwAccess "rwAccess"
SnmpMib = vacmSecurityToGroupStorageType.2 rwAccess volatile
SnmpMib = vacmSecurityToGroupStatus.2 rwAccess createAndGo
SnmpMib = vacmAccessContextMatch.rwAccess 1 1 exact
SnmpMib = vacmAccessReadViewName.rwAccess 1 1
"docsisManagerView"
SnmpMib = vacmAccessWriteViewName.rwAccess 1 1
"docsisManagerView"
SnmpMib = vacmAccessNotifyViewName.rwAccess 1 1
"docsisManagerView"
SnmpMib = vacmAccessStorageType.rwAccess 1 1 volatile
SnmpMib = vacmAccessStatus.rwAccess 1 1 createAndGo
SnmpMib = vacmAccessContextMatch.rwAccess 2 1 exact
SnmpMib = vacmAccessReadViewName.rwAccess 2 1
"docsisManagerView"
SnmpMib = vacmAccessWriteViewName.rwAccess 2 1
"docsisManagerView"
SnmpMib = vacmAccessNotifyViewName.rwAccess 2 1
"docsisManagerView"
SnmpMib = vacmAccessStorageType.rwAccess 2 1 volatile
SnmpMib = vacmAccessStatus.rwAccess 2 1 createAndGo
SNMPv3NotificationReceiver =
SNMPv3NrIpAddress = 10.1.50.100
SNMPv3NrTrapType = 1
SNMPv3NotificationReceiver =
SNMPv3NrIpAddress = 10.1.50.80
SNMPv3NrTrapType = 2
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
98
Appendix A: Example Files
Software Upgrade Example
The following configuration file provides an example of how to configure the Touchstone Software Upgrade system.
NetworkAccess = 1
UpgradeServer = 10.1.50.31
UpgradeFileName = "Non-ARRIS-product.bin"
SnmpMib = docsDevSwAdminStatus.0 2
MaxCpeAllowed = 16
BaselinePrivacy =
AuthorizeWaitTimeout = 10
ReauthorizeWaitTimeout = 10
KekGraceTime = 600
OpWaitTimeout = 10
RekeyWaitTimeout = 10
TekGraceTime = 600
AuthorizeRejectWaitTimeout = 60
SAMapWaitTimeout = 1
SAMapMaxRetries = 4
UpstreamServiceFlow =
SfReference = 1
SfClassName = "USPrimaryBE"
SfQosSetType = 7
SfTrafficPriority = 1
SfMaxTrafficRate = 0
SfMaxTrafficBurst = 3044
SfMinReservedRate = 0
SfMinReservedRatePktsize = 64
SfActiveQosTimeout = 0
SfAdmittedQosTimeout = 200
SfMaxConcatBurst = 3044
SfSchedulingType = 2
SfRqTxPolicy = 128
SfIpTosOverwrite = 64512
UpstreamServiceFlow =
SfReference = 2
SfClassName = "USMTAMGCP"
SfQosSetType = 7
SfTrafficPriority = 7
SfMaxTrafficRate = 0
SfMaxTrafficBurst = 1522
SfMinReservedRate = 0
SfMinReservedRatePktsize = 64
SfActiveQosTimeout = 0
SfAdmittedQosTimeout = 200
SfMaxConcatBurst = 3000
SfSchedulingType = 2
SfRqTxPolicy = 136
SfIpTosOverwrite = 64512
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix A: Example Files
99
DownstreamServiceFlow =
SfReference = 101
SfClassName = "DSPrimaryBE"
SfQosSetType = 7
SfTrafficPriority = 1
SfMaxTrafficRate = 100000000
SfMaxTrafficBurst = 1522
SfMinReservedRate = 0
SfMinReservedRatePktsize = 64
SfActiveQosTimeout = 0
SfAdmittedQosTimeout = 200
SfMaxDownstreamLatency = 0
DownstreamServiceFlow =
SfReference = 102
SfClassName = "DSMTAMGCP"
SfQosSetType = 7
SfTrafficPriority = 7
SfMaxTrafficRate = 10000000
SfMaxTrafficBurst = 1522
SfMinReservedRate = 12000
SfMinReservedRatePktsize = 64
SfActiveQosTimeout = 0
SfAdmittedQosTimeout = 200
SfMaxDownstreamLatency = 5000
UpstreamPacketClassification =
PcServiceFlowReference = 2
PcReference = 2
PcRulePriority = 1
PcActivationState = 1
PcIpClassification =
PcIpProtocol = 17
PcIpSourceAddress = 0.0.0.0
PcIpSourceMask = 0.0.0.0
PcIpDestAddress = 0.0.0.0
PcIpDestMask = 0.0.0.0
PcIpSourcePortStart = 2427
PcIpSourcePortEnd = 2427
DownstreamPacketClassification =
PcServiceFlowReference = 102
PcReference = 102
PcRulePriority = 1
PcActivationState = 1
PcIpClassification =
PcIpProtocol = 17
PcIpSourceAddress = 0.0.0.0
PcIpSourceMask = 0.0.0.0
PcIpDestAddress = 0.0.0.0
PcIpDestMask = 0.0.0.0
PcIpDestPortStart = 2427
PcIpDestPortEnd = 2427
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
100
Appendix A: Example Files
PrivacyEnable = 0
SnmpMib = arrisCmDevSwAdminStatus.0 2
SnmpMib = arrisCmDevSwCustomerLoadId.1 "ARRIS Philly Lab NA TTM402 Rev. 2"
SnmpMib = arrisCmDevSwHwModel.1 "TM402P"
SnmpMib = arrisCmDevSwHwRev.1 2
SnmpMib = arrisCmDevSwServer.1 10.1.50.21
SnmpMib = arrisCmDevSwFilename.1 "TS0401_09222003.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.2 "ARRIS Philly Node 3 NA TTM402 Rev. 3"
SnmpMib = arrisCmDevSwHwModel.2 "TM402P"
SnmpMib = arrisCmDevSwHwRev.2 3
SnmpMib = arrisCmDevSwServer.2 10.1.50.21
SnmpMib = arrisCmDevSwFilename.2 "TS0401_09302003.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.3 "Euro TTM402 Rev. 3"
SnmpMib = arrisCmDevSwHwModel.3 "TM402Q"
SnmpMib = arrisCmDevSwHwRev.3 3
SnmpMib = arrisCmDevSwServer.3 10.1.51.21
SnmpMib = arrisCmDevSwFilename.3 "TS0401_09302003.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.4 "Euro TTM402 Non-Rev. 3"
SnmpMib = arrisCmDevSwHwModel.4 "TM402Q"
SnmpMib = arrisCmDevSwServer.4 10.1.51.21
SnmpMib = arrisCmDevSwFilename.4 "TS0401_09222003.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.5 "ARRIS Detroit Node 1 TTM202 Non-Rev. 2"
SnmpMib = arrisCmDevSwHwModel.5 "TTM202P"
SnmpMib = arrisCmDevSwServer.5 10.1.52.21
SnmpMib = arrisCmDevSwFilename.5 "TS030203_090503A.bin"
SnmpMib = arrisCmDevSwCustomerLoadId.6 "ARRIS Detroit Node 2 TTM202 Rev. 2"
SnmpMib = arrisCmDevSwHwModel.6 "TTM202P"
SnmpMib = arrisCmDevSwHwRev.6 2
SnmpMib = arrisCmDevSwServer.6 10.1.52.21
SnmpMib = arrisCmDevSwFilename.6 "TS030203_090503A.bin"
Gateway Dial Pulse Example
The following configuration file provides an example of how to configure Gateway dial pulse support.
TelephonyConfigFileBeginEnd = 1
SnmpMib = pktcMtaDevEnabled.0 true
SnmpMib = arrisMtaDevEndPntDialingMethod.1 toneAndPulseWithDTMFRelay
SnmpMib = arrisMtaDevEndPntDialingMethod.2 toneAndPulseWithDTMFRelay
SnmpMib = pktcSigDefCallSigTos.0 0
SnmpMib = pktcSigDefMediaStreamTos.0 0
SnmpMib = pktcSigTosFormatSelector.0 ipv4TOSOctet
SnmpMib = pktcMtaDevRealmOrgName.DEV50 "Really Amazing Telephone Company"
SnmpMib = pktcNcsEndPntConfigCallAgentId.9 "ca@sn05.dev2"
SnmpMib = pktcNcsEndPntConfigCallAgentId.10 "ca@sn05.dev2"
SnmpMib = pktcNcsEndPntConfigCallAgentUdpPort.9 2727
SnmpMib = pktcNcsEndPntConfigCallAgentUdpPort.10 2727
SnmpMib = pktcMtaDevCmsKerbRealmName.SN05.DEV2 "SWLAB.ATL.ARRIS"
SnmpMib = pktcMtaDevCmsIpsecCtrl.SN05.DEV2 true
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix A: Example Files
101
SnmpMib = pktcNcsEndPntConfigMWD.9 10
SnmpMib = pktcNcsEndPntConfigMWD.10 10
SnmpMib = pktcMtaDevCmsUnsolicitedKeyNomTimeout.SN05.DEV2 20000
SnmpMib = pktcMtaDevRealmOrgName.SWLAB.ATL.ARRIS "Really Amazing Telephone
Company"
TelephonyConfigFileBeginEnd = 255
SIP CM Configuration File Example
The following is an example of a CM configuration file for SIP support.
{NetworkAccess Yes}
{MaxCpeAllowed 4}
{MaxClassifiers 20}
{PrivacyEnable 1}
{SnmpMib ppCfgMtaCallpFeatureSwitch.0 16384}
{SnmpMib arrisMtaProvMethodIndicator.0 4}
{UpstreamServiceFlow
{SfReference 1}
{SfQosSetType 7}
{SfTrafficPriority 1}
{SfMaxTrafficRate 0}
{SfMaxTrafficBurst 8192}
{SfMinReservedRate 0}
{SfMinReservedRatePktsize 64}
{SfActiveQosTimeout 0}
{SfAdmittedQosTimeout 0}
{SfMaxConcatBurst 0}
{SfSchedulingType 2}
{SfRqTxPolicy 0}
{SfIpTosOverwrite 64512}
}
{UpstreamServiceFlow
{SfReference 2}
{SfQosSetType 7}
{SfTrafficPriority 7}
{SfMaxTrafficRate 0}
{SfMaxTrafficBurst 8192}
{SfMinReservedRate 0}
{SfMinReservedRatePktsize 64}
{SfActiveQosTimeout 0}
{SfAdmittedQosTimeout 0}
{SfMaxConcatBurst 0}
{SfSchedulingType 2}
{SfRqTxPolicy 0}
{SfIpTosOverwrite 64512}
}
{DownstreamServiceFlow
{SfReference 101}
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
102
Appendix A: Example Files
{SfQosSetType 7}
{SfTrafficPriority 1}
{SfMaxTrafficRate 100000000}
{SfMaxTrafficBurst 96000}
{SfMinReservedRate 0}
{SfMinReservedRatePktsize 64}
{SfActiveQosTimeout 0}
{SfAdmittedQosTimeout 0}
{SfMaxDownstreamLatency 20000}
}
{DownstreamServiceFlow
{SfReference 102}
{SfQosSetType 7}
{SfTrafficPriority 7}
{SfMaxTrafficRate 100000000}
{SfMaxTrafficBurst 96000}
{SfMinReservedRate 12000}
{SfMinReservedRatePktsize 64}
{SfActiveQosTimeout 0}
{SfAdmittedQosTimeout 0}
{SfMaxDownstreamLatency 5000}
}
{UpstreamPacketClassification
{PcServiceFlowReference 2}
{PcReference 2}
{PcRulePriority 64}
{PcActivationState 1}
{PcIpClassification
{PcIpProtocol 17}
{PcIpSourcePortStart 5060}
{PcIpSourcePortEnd 5060}
}
{PcIeee8021Classification
{PcIeee8021VlanId 0}
}
}
{DownstreamPacketClassification
{PcServiceFlowReference 102}
{PcReference 102}
{PcRulePriority 1}
{PcActivationState 1}
{PcIpClassification
{PcIpProtocol 17}
{PcIpDestPortStart 5060}
{PcIpDestPortEnd 5060}
}
}
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix A: Example Files
103
SIP MTA Configuration File Example
The following is an example of an MTA configuration file for SIP support.
TelephonyConfigFileBeginEnd = 1
SnmpMib = pktcMtaDevEnabled.0 true
SnmpMib = sipCfgPortUserName.1 "7705553001"
SnmpMib = sipCfgPortDisplayName.1 ""Caller-ID Line 1""
SnmpMib = sipCfgPortLogin.1 "arris1"
SnmpMib = sipCfgPortPassword.1 "password1"
SnmpMib = ifAdminStatus.9 up
SnmpMib = sipCfgPortUserName.2 "7705553002"
SnmpMib = sipCfgPortDisplayName.2 ""Caller-ID Line 2""
SnmpMib = sipCfgPortLogin.2 "arris1"
SnmpMib = sipCfgPortPassword.2 "password1"
SnmpMib = ifAdminStatus.10 up
SnmpMib = sipCfgProxyAdr.0 "10.1.63.11;5060"
SnmpMib = sipCfgProxyType.0 ipv4
SnmpMib = sipCfgRegistrarAdr.0 "10.1.63.11;5060"
SnmpMib = sipCfgRegistrarType.0 ipv4
SnmpMib = sipCfgSipFeatureSwitch.0 hexstr: 0.0.0.0
SnmpMib = sipCfgProvisionedCodecArray.0 "PCMA;PCMU"
SnmpMib = sipCfgPacketizationRate.0 twentyMilliSeconds
VendorSpecific = ARRISVendorID SIPDigitMap = "8888|0[t#]|00|101xxxx0[t#]|01[29]XXXXXXX.[t#]|101xxxx01[29]XXXXXXX.[T#]|011xxxxxxx.[t#]|101xxxx011xxxxxxx.[t#]|[2-9]11|[01][29]11|101xxxx[2-9]11|101xxxx[01][2-9]11|*xx|11xx|[2-9]xxxxxx[t#]|[01][29]xxxxxx[t#]|101xxxx[2-9]xxxxxx[t#]|101xxxx[01][2-9]xxxxxx[t#]|[2-9]xx[29]xxxxxx|[01][2-9]xx[2-9]xxxxxx|101xxxx[2-9]xx[2-9]xxxxxx|101xxxx[01][2-9]xx[29]xxxxxxx|[2-9]x#|#[2-9]xxx[2-9]xxxxxx|101xxxx[01][2-9]xx[2-9]xxxxxxx|[29]x#|#[2-9]x"
VendorSpecific = ARRISVendorID SIPDialProxyMap = "*50,1,1|*51,2,3|"
SnmpMib = arrisMtaCfgRTPDynPortStart.0 49152
SnmpMib = arrisMtaCfgRTPDynPortEnd.0 65535
SnmpMib = sipCfgDialFeatName.1 anonCallReject
SnmpMib = sipCfgDialFeatCode.1 "*77,1177"
SnmpMib = sipCfgDialFeatTone.1 stutterTone
SnmpMib = sipCfgDialFeatActive.1 hexstr: 0.0.0.1
SnmpMib = sipCfgDialFeatName.2 anonCallRejectDisable
SnmpMib = sipCfgDialFeatCode.2 "*87,1187"
SnmpMib = sipCfgDialFeatTone.2 dialTone
SnmpMib = sipCfgDialFeatActive.2 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.3 callForwardBusy
SnmpMib = sipCfgDialFeatCode.3 "*90,1190"
SnmpMib = sipCfgDialFeatTone.3 stutterTone
SnmpMib = sipCfgDialFeatActive.3 hexstr: 0.0.0.0
SnmpMib = sipCfgDialFeatName.4 callForwardBusyDisable
SnmpMib = sipCfgDialFeatCode.4 "*91,1191"
SnmpMib = sipCfgDialFeatTone.4 stutterTone
SnmpMib = sipCfgDialFeatActive.4 hexstr: 0.0.0.3
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
104
Appendix A: Example Files
SnmpMib = sipCfgDialFeatName.5 callForwardUncond
SnmpMib = sipCfgDialFeatCode.5 "*72,1172"
SnmpMib = sipCfgDialFeatTone.5 stutterTone
SnmpMib = sipCfgDialFeatActive.5 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.6 callForwardUncondDisable
SnmpMib = sipCfgDialFeatCode.6 "*79,1179"
SnmpMib = sipCfgDialFeatTone.6 stutterTone
SnmpMib = sipCfgDialFeatActive.6 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.7 callForwardNoAnswer
SnmpMib = sipCfgDialFeatCode.7 "*92,1192"
SnmpMib = sipCfgDialFeatTone.7 stutterTone
SnmpMib = sipCfgDialFeatActive.7 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.8 callForwardNoAnswerDisable
SnmpMib = sipCfgDialFeatCode.8 "*93,1193"
SnmpMib = sipCfgDialFeatTone.8 stutterTone
SnmpMib = sipCfgDialFeatActive.8 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.9 callReturn
SnmpMib = sipCfgDialFeatCode.9 "*69,1169"
SnmpMib = sipCfgDialFeatTone.9 stutterTone
SnmpMib = sipCfgDialFeatActive.9 hexstr: 0.0.0.0
SnmpMib = sipCfgDialFeatName.10 callWaitTempDisable
SnmpMib = sipCfgDialFeatCode.10 "*70,1170"
SnmpMib = sipCfgDialFeatTone.10 stutterTone
SnmpMib = sipCfgDialFeatActive.10 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.11 callWaitPermDisableToggle
SnmpMib = sipCfgDialFeatCode.11 "*78,1178"
SnmpMib = sipCfgDialFeatTone.11 stutterTone
SnmpMib = sipCfgDialFeatActive.11 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.12 callerIDPermBlockToggle
SnmpMib = sipCfgDialFeatCode.12 "*65,1165"
SnmpMib = sipCfgDialFeatTone.12 stutterTone
SnmpMib = sipCfgDialFeatActive.12 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.13 callerIDTempEnable
SnmpMib = sipCfgDialFeatCode.13 "*82,1182"
SnmpMib = sipCfgDialFeatTone.13 stutterTone
SnmpMib = sipCfgDialFeatActive.13 hexstr: 0.0.0.3
SnmpMib = sipCfgDialFeatName.14 callerIDTempBlock
SnmpMib = sipCfgDialFeatCode.14 "*67,1167"
SnmpMib = sipCfgDialFeatTone.14 stutterTone
SnmpMib = sipCfgDialFeatActive.14 hexstr: 0.0.0.3
TelephonyConfigFileBeginEnd = 255
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
6
Appendix B:
Configuring the Service
Provider Root
6
PacketCable requires a Service Provider certificate hierarchy, which
allows other network elements to authenticate the service provider's
servers. The following figure shows the hierarchy.
CableLabs
Service Provider
Root CA
Service
Provider CA
Local System
Operator CA
DF
Certificate
KDC
Certificate
Other
Certificate
The CableLabs Service Provider Root CA issues certificates only to
authorized MSOs or Service Providers. This creates a problem for vendors or manufacturers who need to interoperate with the KDC and cannot obtain a Service Provider CA certificate under this root. One
solution is to create a test root hierarchy and use it instead of the real
root hierarchy for the purpose of lab testing. The MTA is manufactured
with the CableLabs Service Provider Root certificate in order to verify
and validate the certificates obtained in the AS_Reply message from
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
106
Appendix B: Configuring the Service Provider Root
the KDC. In the case where the KDC is configured with a test root, the
MTA must also be configured with the same test root.
Service Provider Root Provisioning for Touchstone Telephony Modems
Touchstone Software versions prior to TS3.2 (June 2003) embedded
the IPFonix test root digital certificate. TS3.2 software released after
June 2003, and all subsequent versions, embeds the official PacketCable test root digital certificate from CableLabs, Inc.
TS4.5 can support networks using the IPFonix test root digital certificate or MSO-generated test root digital certificates by allowing any
valid test root certificate to be downloaded from a specified TFTP location. Three MIBs (described in “MIBs” below) control this support.
The capability to download the certificates includes a retry mechanism
to allow automatic recovery in the event of failure to download the certificate from the server. This mechanism retries the download 16 times,
then waits for a period of time before retrying the download. The cycle
repeats three times, and then the Telephony Modem resyncs and starts
the configuration process over again. During this process, the Telephony Modem generates download retry/failure logs, described in the
Touchstone Software Troubleshooting Guide.
CAUTION
Service affecting
If the Telephony Modem is configured to use secure downloading, the
Telephony Modem does not restart the provisioning cycle and thus does
not provide service.
MIBs
The CM configuration file transports the Service Provider Root MIBs
to the Telephony Modem. Once the device has rebooted and downloaded the CM configuration file, then the Telephony Modem uses its
private MIBs to determine how to proceed.
There are three ARRIS private MIBs that can be set in the CM configuration file:
•
ppCfgMtaDevSPTestRootCertAdminStatus—instructs the
Telephony Modem to either use the embedded test root or
download and use a test root certificate from a TFTP server
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix B: Configuring the Service Provider Root
107
•
ppCfgMtaDevSPTestRootCertServer—for the download
option, this MIB specifies the IP address of the TFTP server
containing the root certificate file
•
ppCfgMtaDevSPTestRootCertFilename—for the download
option, this MIB specifies the file name on the TFTP server that
contains the test root certificate
The ppCfgMtaDevSPTestRootDownloadState MIB displays the status of the download, if the download option is chosen.
Following is the definition of the MIBs:
ppCfgMtaDevServiceProviderTestRootCert OBJECT IDENTIFIER ::= {
ppCfgMtaDevSecurity 1 }
ppCfgMtaDevSPTestRootCertServer OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The IP address of the TFTP server used for downloading Service
Provider Test Root Certificates to this device. Returns 0.0.0.0
if the TFTP server address is unknown or unassigned. This object
can only be changed by the configuration file."
::= { ppCfgMtaDevServiceProviderTestRootCert 1 }
ppCfgMtaDevSPTestRootCertFilename OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The file name of the Service Provider Test Root Certificate to be
downloaded to this device from the TFTP server. Returns an empty
string if the certificate filename is unknown or unassigned. This
object can only be changed by the configuration file."
::= { ppCfgMtaDevServiceProviderTestRootCert 2 }
ppCfgMtaDevSPTestRootCertAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
ignoreCertSettings(0),
useEmbeddedTestRootCert(1),
downloadTestRootCert(2)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
108
Appendix B: Configuring the Service Provider Root
"Controls the usage of Root Certificates by the MTA device.
If set to downloadTestRootCert(2), the MTA will download the
Service Provider Test Root Certificate specified by
'ppCfgMtaDevSPTestRootCertFilename' from the TFTP server
specified by 'ppCfgMtaDevSPTestRootCertServer'. If set to
useEmbeddedTestRootCert(1), the MTA will use the factory-installed
Test Root Certificate embedded in the device. If the value of this
object is ignoreCertSettings(0), all of the Test Root Certificate
settings (i.e. TestRootCertServer, TestRootCertFilename) are ignored
and the MTA will, by default, use the factory-installed Real Root
Certificate embedded in the device. This object can only be changed
by the configuration file. At initial startup, this object has a
default value of ignoreCertSettings(0)."
DEFVAL { ignoreCertSettings }
::= { ppCfgMtaDevServiceProviderTestRootCert 3 }
ppCfgMtaDevSPTestRootDownloadState OBJECT-TYPE
SYNTAX INTEGER {
noDownload(0),
downloadRequested(1),
inProgress(2),
completed(3),
failed(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates the current state of the Service Provider Test
Root Certificate download process. noDownload(0) indicates that no
certificate download has been requested. downloadRequested(1) indicates
a Test Root Certificate download is desired, most likely as a result of
a downloadTestRootCert request. inProgress(2) indicates that a TFTP
download is underway. completed(3) indicates that the last Test Root
Certificate download was completed successfully. failed(4) indicates
that the last attempted download failed.
At initial startup, this object has a default value of noDownload(0)."
DEFVAL { noDownload }
::= { ppCfgMtaDevServiceProviderTestRootCert 4 }
Using the default embedded root
To use the embedded real root, which is the default factory setting,
either remove the ppCfgMtaDevSPTestRootCertAdminStatus from
the CM configuration file, or set it to ignoreCertSettings.
Using the embedded test root
Select the embedded test root by setting the ppCfgMtaDevSPTestRootCertAdminStatus to useEmbeddedTestRootCert.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix B: Configuring the Service Provider Root
109
The ppCfgMtaDevSPTestRootCertFilename and ppCfgMtaDevSPTestRootCertServer MIBs are ignored.
Using the downloadable test root feature
Download a test root to the MTA by setting the ppCfgMtaDevSPTestRootCertAdminStatus to downloadTestRootCert. Set
ppCfgMtaDevSPTestRootCertServer to the IP address of the TFTP
server and ppCfgMtaDevSPTestRootCertFilename to the file name.
If the file name or the IP address of the TFTP server are missing or
invalid, the download fails.
The certificate must use the X.509 DER-encoded format.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
110
Appendix B: Configuring the Service Provider Root
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
7
Appendix C: Line
Parameters by Country
7
The following tables show the default tones and ring definitions for
each supported country template.
Provisioning Ring Cadence
North American
Ring Cadences
The following Ring Cadences may be provisioned using the PacketCable NCS Signaling MIB (see PKT-SP-MIB-SIG-I08-040113). 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 software uses the default ring cadences shown above when
the country template is provisioned to be one of the following:
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
112
Appendix C: Line Parameters by Country
•
northAmerica57
•
northAmerica33
•
northAmerica09
Template (i.e. hard-coded country-specific) based ring cadences are
used by default when the country template is provisioned. This default
behavior may be overridden by setting the “Provisioned Ring
Cadences” Callp Feature Switch setting, and updating the MTA configuration file with the provisioning for the appropriate MIBs to define
ring cadences (for example, pktcSigDevRgCadence). To make this
setting, add 0x02000000 to the current feature switch setting in the CM
configuration file.
Provisioning
European Ring
Cadences
European standard ring cadence and ring splash may be provisioned
through the PKTC-IETF-MTA-MIB objects pktcSigDevStandardRingCadence and pktcSigDevRingSplashCadence. These
MIBs are represented as an octet string where the first octet represents
the length in bits of the duration of the cadence. Each bit after the first
octet represents 50 ms; 1 represents ring and 0 represents silent.
For example, the default standard ring cadence for Belgium is
50.FF.FF.F0.00.00.00.00.00.00.00, which corresponds to:
•
50: 80 bits (4 seconds total)
•
FF.FF.F0: 1 second on
•
00.00.00.00.00.00.00: 3 seconds off
The R0–R7 Ring Cadence MIB objects have country-specific defaults
as shown below. Each MIB is a 64 bit octet string. The ring cadence
representation begins with the first 1 in the pattern. Each bit represents
100 ms of tone; 1 is tone, 0 is no tone. 64 bits must be used for cadence
representation. Leading 0s in the MSB are padding and are ignored.
The last 4 bits in the string represent repeatable characteristics; 0000
means repeatable, 1000 means non-repeatable.
Template (i.e. hard-coded country-specific) based ring cadences are
used by default when the country template is provisioned. This default
behavior may be overridden by setting the “Provisioned Ring
Cadences” Callp Feature Switch setting, and updating the MTA configuration file with the provisioning for the appropriate MIBs to define
ring cadences (for example, pktcSigDevRgCadence). To make this
setting, add 0x02000000 to the current feature switch setting in the CM
configuration file.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix C: Line Parameters by Country
Austria Ring
Cadences
The following table shows the default ring cadences for Austria. The
defaults have been updated from TS4.4.
Name
Belgium Ring
Cadences
113
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
500 ms on
RT
Ringback Tone
1000 ms on, 5000 ms off
The following table shows the default ring cadences for Belgium.
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 (see note)
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
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
114
Appendix C: Line Parameters by Country
Name
Description
Default
RS
Ring Splash
300 ms on (not repeated)
RT
Ringback Tone
1 second on, 3 seconds off
Note: The default R0 Ring Cadence definition for the Belgian
country template requires a granularity of 50 ms. Since this MIB
definition only allows for a granularity of 100 ms, the R0 value
contains the closest representation of the actual cadence definition.
This cadence is not writable for the Belgian template.
France Ring
Cadences
The following table shows the default ring cadences for France.
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 second 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
Note: The default R0 and R1 Ring Cadence definitions for the
French country template require a granularity of 50 ms. Since these
MIB definitions only allow for a granularity of 100 ms, the R0 and
R1 values contain the closest representation of the actual cadence
definitions. These cadences are not writable for the French template.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix C: Line Parameters by Country
Germany Ring
Cadences
Hungary Ring
Cadences
115
The following table shows the default ring cadences for Germany.
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
650 ms on (not repeated)
RT
Ringback Tone
1 second on, 4 seconds off
The following table shows the default ring cadences for Hungary.
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 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
650 ms on (not repeated)
RT
Ringback Tone
1.25 seconds on, 3.75 seconds off
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
116
Japan Ring
Cadences
Mexico Ring
Cadences
Appendix C: Line Parameters by Country
The following table shows the default ring cadences for Japan.
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
400 ms on, 200 ms off, 400 ms on,
200 ms off, 800 ms on, 4 seconds 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
The following table shows the default ring cadences for Mexico.
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
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Appendix C: Line Parameters by Country
Name
RT
MexicoC Ring
Cadences
Description
Ringback Tone
Default
1000 ms on, 4000 ms off
The following table shows the default ring cadences for MexicoC.
Name
Netherlands/
Netherlands09
Ring Cadences
117
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
400ms on, 200ms off, 400ms on,
200ms off, 800ms on, 4000ms 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
The following table shows the default ring cadences for all Netherlands
templates.
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 seconds 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
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
118
Norway Ring
Cadences
Appendix C: Line Parameters by Country
Name
Description
Default
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
650 ms on (not repeated)
RT
Ringback Tone
1 second on, 4 seconds off
The following table shows the default ring cadences for Norway. The
defaults have been updated from TS4.4.
Name
Panama Ring
Cadences
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
The following table shows the default ring cadences for Panama.
Name
RG
Description
Standard Ringing
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Default
1000 ms on, 4000 ms off
Appendix C: Line Parameters by Country
Name
Poland Ring
Cadences
119
Description
Default
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
The following table shows the default ring cadences for Poland.
Name
Description
Default
RG
Standard Ringing
1000 ms on, 1000 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
2 seconds 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
650 ms on (not repeated)
RT
Ringback Tone
1 second on, 4 seconds off
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
120
Switzerland Ring
Cadences
Customizing
Default Ring
Cadences
Appendix C: Line Parameters by Country
The following table shows the default ring cadences for Switzerland.
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
500 ms on, 5.5 seconds off (not
repeated)
Any of the above ring cadences may be customized in the MTA configuration file. All MIB objects are MTA based; therefore, the first
cadence is index 0. To enable customization, set the Provisioned Ring
Cadences CallP Feature Switch (0x02000000) bit in the MTA configuration file. See “Provisioning European Ring Cadences” on page 112
for more information.
The ring cadence is internally represented as a 64-bit string and provisioned in hex format. The ring cadence representation starts with the
first 1 in the bit string pattern. Leading zeros are ignored, thus shortening the overall ring cadence duration. Each bit represents 100 ms of
ringing (or tone in the case of L/RT); 1 is ring on, 0 is ring off.
All 64 bits must be provisioned. The least significant 4 bits are used for
representing repeatable characteristics: 0000 indicates that the ring
cadence repeats, and 1000 indicates a non-repeatable ring cadence.
Therefore, only the first 60 bits are used to represent the actual ring
cadence for a maximum duration of 6 seconds.
As mentioned earlier, shorter ring cadences may be provisioned by
padding the ring cadence with leading zeros. For example, a ring
cadence of 0.5 seconds on, 4 seconds off, repeatable, has a value of
0x0001F00000000000 and would be provisioned in the MTA configuration file as 00.01.F0.00.00.00.00.00.
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
121
Default Tone Settings
The following tables show default tones for each country template.
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
-6
-19
-24
-13
-13
-13
-17
Offhook Warning (20)
Ringback(21)
Reorder(22)
Stutterdial(23)
Message Waiting(24)
Call Waiting 1 (25)
Special Information
Tone(30)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
-17
-17
-17
-17
-17
-18
Dial(18)
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
-17
Busy(16)
Confirmation(17)
level
type
Austria
-13
-13
Dial(18)
-24
Busy(16)
Confirmation(17)
level
type
North America
1
1
1
1
1
1
1
Freq.
Type
1
1
1
1
1
1
1
1
1
1
Freq.
Type
1
2
1
1
1
2
1
# Freq.
3
1
2
2
2
2
4
2
2
2
# Freq.
425
400
425
425
425
400
425
1st
Freq
950
440
350
350
480
440
1400
350
350
480
1st
Freq
0
425
0
0
0
425
0
2nd
Freq
1400
0
440
440
620
480
2060
440
440
620
2nd
Freq
0
0
0
0
0
0
0
3rd
Freq
1800
0
0
0
0
0
2450
0
0
0
3rd
Freq
0
0
0
0
0
0
0
4th
Freq
0
0
0
0
0
0
2600
0
0
0
4th
Freq
1
1
1
1
1
1
1
#on/off
1
1
2
4
1
1
1
1
3
1
#on/off
40
5000
200
1000
5000
1000
400
1st tone
on
330
300
100
100
250
2000
100
5000
1000
500
1st tone
on
1950
0
200
5000
0
5000
400
1st tone
off
1000
0
100
100
250
4000
100
0
1000
500
1st tone
off
0
5000
0
0
0
1000
0
2nd
tone on
0
0
5000
100
0
0
0
0
1000
0
2nd
tone on
0
0
0
0
0
5000
0
2nd
tone off
0
0
0
100
0
0
0
0
1000
0
2nd
tone off
0
0
0
0
0
0
0
3rd
tone on
0
0
0
100
0
0
0
0
1000
0
3rd
tone on
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
1000
0
3rd
tone off
0
0
0
0
0
0
0
4th
tone on
0
0
0
5000
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
4th
tone off
0
0
0
0
0
0
0
0
0
0
4th
tone off
0
0
5000
5000
0
2
5000
rep.
count
2
1
10
0
5000
5000
5000
0
0
5000
rep.
count
2
1
2
2
1
2
2
tone
steady
3
2
2
4
2
2
2
1
4
2
tone
steady
122
-14
-14
-14
-14
-14
-14
-14
-15
-13
-13
Confirmation(17)*
Dial(18)
Message Waiting(19)*
Offhook Warning(20)
Ringback(21)
Reorder(22)
Stutterdial(23)*
Call Waiting 1 (25)
Call Waiting 2 (26)
Call Waiting 3 (27)
1
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
1
1
1
1
1
1
1
1
1
1
1
1
# Freq.
440
440
440
1400
425
425
425
425
425
425
425
425
1st
Freq
0
0
0
0
0
0
0
0
0
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
3
1
1
1
1
1
1
1
1
1
1
1
#on/off
100
100
100
175
40
167
1000
167
40
5000
40
500
1st tone
on
100
100
100
175
40
167
3000
167
40
0
40
500
1st tone
off
300
0
0
0
0
0
0
0
0
0
0
0
2nd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
2nd
tone off
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone off
0
2
1
1
112
5000
5000
5000
112
0
23
5000
rep.
count
2
2
2
2
1
2
2
2
1
1
2
2
tone
steady
Confirmation Tone: 425 Hz, -14 dbm, 3*((160 ms on, 40 ms off), 7*(40 ms on, 40 ms off))
Message Waiting and Stutterdial Tones: 425 Hz, -14 dbm, 1 second on, 9*(40 ms off, 40 ms on), 40 ms off, continuously on
until timeout
•
•
Note: The default Confirmation, Message Waiting, and Stutter dial tone definitions for the Belgian country template are more complex than what is currently definable per the pktcSigDevToneTable. The values above are the closest representation of the tone
definition played for these tones. These three tones are not writable for the Belgian template. The actual played tone definitions for
each are as follows:
-13
-14
Busy(16)
Call Waiting 4 (28)
level
type
Belgium
123
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
-11
-11
-11
-11
-13
-13
-13
Stutterdial(23)
Call Waiting 1 (25)
Call Waiting 2 (26)
Call Waiting 3 (27)
Call Waiting 4 (28)
-11
Offhook Warning(20)
Reorder(22)
-11
Message Waiting(19)
Ringback(21)
-10
-10
Dial(18)
-11
Busy(16)
Confirmation(17)
level
type
France
1
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
1
1
1
1
1
1
1
2
1
1
1
1
# Freq.
440
440
440
440
440
440
440
330
440
440
425
440
1st
Freq
0
0
0
0
0
0
0
440
0
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
3
1
1
1
1
1
1
1
1
1
1
1
#on/off
100
100
100
300
5000
500
1500
500
5000
5000
200
500
1st tone
on
100
100
100
0
0
500
3500
500
0
0
100
500
1st tone
off
300
0
0
0
0
0
0
0
0
0
0
0
2nd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
2nd
tone off
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone off
0
2
1
0
0
5000
5000
5000
0
0
2
5000
rep.
count
2
2
2
2
1
2
2
2
1
1
2
2
tone
steady
124
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
-13
-16
-13
-13
-13
-16
-18
-13
-13
Dial(18)
Message Waiting(19)
Offhook Warning(20)
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
Call Waiting 2 (26)
Call Waiting 3 (27)
-13
-10
Call Waiting 4 (28)
1
-13
Busy(16)
Confirmation(17)
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
level
type
Germany
1
1
1
1
2
1
1
1
2
1
1
1
# Freq.
440
440
440
425
400
425
425
425
400
425
425
425
1st
Freq
0
0
0
0
425
0
0
0
425
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
3
1
1
1
1
1
1
1
1
1
1
1
#on/off
100
100
100
200
5000
240
1000
240
5000
5000
200
480
1st tone
on
100
100
100
200
0
240
4000
240
0
0
100
480
1st tone
off
300
0
0
0
0
0
0
0
0
0
0
0
2nd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
2nd
tone off
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone off
0
2
1
1
0
5000
5000
5000
0
0
2
5000
rep.
count
2
2
2
2
1
2
2
2
1
1
2
2
tone
steady
125
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
-8
-8
-10
-10
-14
-8
-8
-10
-8
-13
-13
-13
Busy(16)
Confirmation(17)
Dial(18)
Message Waiting(19)
Offhook Warning(20)*
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
Call Waiting 2 (26)
Call Waiting 3 (27)
Call Waiting 4 (28)
1
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
1
1
1
1
1
1
1
1
1
1
1
1
# Freq.
440
440
440
425
425
425
425
425
425
425
425
425
1st
Freq
0
0
0
0
0
0
0
0
0
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
3
1
1
1
4
1
1
1
1
1
1
1
#on/off
100
100
100
400
0
300
1250
375
100
5000
40
300
1st tone
on
100
100
100
0
125
300
3750
375
100
0
40
300
1st tone
off
300
0
0
0
100
0
0
0
0
0
0
0
2nd
tone on
100
0
0
0
100
0
0
0
0
0
0
0
2nd
tone off
100
0
0
0
100
0
0
0
0
0
0
0
3rd
tone on
100
0
0
0
100
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
100
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
100
0
0
0
0
0
0
0
4th
tone off
0
2
1
0
0
5000
5000
5000
0
0
2
5000
rep.
count
2
2
2
2
1
2
2
2
1
1
2
2
tone
steady
Note: The default Offhook Warning tone definition for the Hungarian country template is more complex than what is currently
definable per the pktcSigDevToneTable. The values above are the closest representation of the tone definition. This tone is not writable for the Hungarian template. The actual played tone definition is as follows: (425 Hz, -14 dbm, (375 ms on, 375 ms off)), (425
Hz, -24 dbm, (375 ms on, 375 ms off)), entire sequence repeated continuously until timeout.
level
type
Hungary
126
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
1
-8
-8
-8
-8
-13
-15
-13
Dial(18)
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
Special Information
Tone
Intrusion Tone
-10
-10
-10
-10
Call Waiting 1 (25)
Special Information
Tone(30)
-10
Reorder(22)
Message Waiting(24)
-10
Ringback(21)
Stutterdial(23)
-10
-10
Confirmation(17)
-10
Busy(16)
Dial(18)
level
type
MexicoC
1
-8
Confirmation(17)
1
1
1
1
1
1
1
1
1
Freq.
Type
1
1
1
1
1
1
1
-8
Busy(16)
Freq.
Type
level
type
Mexico
3
1
1
1
1
1
1
1
1
# Freq.
1
3
1
1
1
1
1
1
1
# Freq.
950
425
425
425
425
425
425
425
425
1st
Freq
425
950
425
425
425
425
425
425
425
1st
Freq
1400
0
0
0
0
0
0
0
0
2nd
Freq
0
1400
0
0
0
0
0
0
2nd
Freq
1800
0
0
0
0
0
0
0
0
3rd
Freq
0
1800
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
4th
Freq
0
0
0
0
0
0
0
0
0
4th
Freq
1
2
3
1
1
1
1
2
1
#on/off
1
2
2
1
1
1
1
1
1
#on/off
330
130
1000
400
250
1000
5000
500
500
1st tone
on
150
330
200
5000
250
1000
5000
5000
500
1st tone
on
1000
160
0
40
250
4000
0
500
500
1st tone
off
1500
330
200
0
250
4000
0
0
500
1st tone
off
0
320
40
0
0
0
0
5000
0
2nd
tone on
0
330
200
0
0
0
0
0
0
2nd
tone on
0
650
40
0
0
0
0
0
0
2nd
tone off
0
1000
4400
0
0
0
0
0
0
2nd
tone off
0
0
5000
0
0
0
0
0
0
3rd
tone on
0
0
0
0
0
0
0
0
0
3rd
tone on
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
4th
tone off
0
0
0
0
0
0
0
0
0
4th
tone off
2
1
50
5000
5000
5000
0
0
5000
rep.
count
0
2
2
0
5000
5000
0
0
5000
rep.
count
3
3
3
2
2
2
1
2
2
tone
steady
2
3
3
1
2
2
1
1
2
tone
steady
127
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
-14
-15
-13
-13
-13
Stutterdial(23)
Call Waiting 1 (25)
Call Waiting 2 (26)
Call Waiting 3 (27)
Call Waiting 4 (28)
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
1
-11
-11
-6
-6
-25
-11
-11
-6
-25
Busy(16)
Confirmation(17)
Dial(18)
Message Waiting(19)
OffHook Warning(20)
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
1
1
1
1
1
1
1
2
Freq.
Type
1
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
level
type
Norway
-14
-14
-14
Offhook Warning(20)
Reorder(22)
-14
Message Waiting(19)
Ringback(21)
-14
-14
Dial(18)
-14
Busy(16)
Confirmation(17)
level
Type
1
1
1
1
1
1
1
2
1
# Freq.
1
1
1
1
1
1
1
1
1
1
1
1
# Freq.
Netherlands/Netherlands09
425
425
425
425
1400
425
425
425
425
1st
Freq
440
440
440
1400
425
425
425
425
425
425
425
425
1st
Freq
0
0
0
0
0
0
0
470
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
4th
Freq
0
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
1
1
1
1
3
1
1
2
1
#on/off
3
1
1
1
1
1
1
1
1
1
1
1
#on/off
200
700
200
1000
400
700
5000
400
500
1st tone
on
100
100
100
175
1000
250
1000
250
1000
5000
1000
500
1st tone
on
600
60
200
4000
5000
60
0
0
500
1st tone
off
100
100
100
175
250
250
4000
250
250
0
0
500
1st tone
off
0
0
0
0
0
0
0
400
0
2nd
tone on
300
0
0
0
0
0
0
0
0
0
0
0
2nd
tone on
0
0
0
0
5000
0
0
0
0
2nd
tone off
100
0
0
0
0
0
0
0
0
0
0
0
2nd
tone off
0
0
0
0
0
0
0
0
0
3rd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone on
0
0
0
0
5000
0
0
0
0
3rd
tone off
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
4th
tone off
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone off
1
5000
5000
5000
5000
5000
0
5000
5000
rep.
count
0
2
1
1
5000
5000
5000
5000
5000
0
0
5000
rep.
count
2
2
2
2
2
2
1
2
2
tone
steady
2
2
2
2
2
2
2
2
2
1
2
2
tone
steady
128
-10
-10
-10
-10
-10
-10
-10
-10
-10
Confirmation(17)
Dial(18)
Message Waiting(19)
Offhook Warning(20)
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
Special Information
Tone
-10
-10
Busy(16)
Payphone Recognition
level
type
Panama
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
2
1
1
1
1
1
1
1
1
2
1
# Freq.
1000
440
425
425
425
425
1400
425
425
400
425
1st
Freq
1400
0
0
0
0
0
0
0
0
425
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
1
1
1
3
1
1
1
1
1
2
1
#on/off
200
400
300
300
250
1200
500
300
5000
100
500
1st tone
on
200
40
0
100
250
4650
0
500
0
100
500
1st tone
off
0
0
0
300
0
0
0
0
0
300
0
2nd
tone on
0
0
0
1300
0
0
0
0
0
100
0
2nd
tone off
0
0
0
5000
0
0
0
0
0
0
0
3rd
tone on
0
0
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
0
0
4th
tone off
1
1
2
0
5000
5000
0
0
0
2
5000
rep.
count
2
2
2
3
2
2
2
2
1
3
2
tone
steady
129
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
-10
-6
-6
-10
-10
-13
-13
-13
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
Call Waiting 2 (26)
Call Waiting 3 (27)
Call Waiting 4 (28)
-10
Dial(18)
-36
-10
Confirmation(17)
Offhook Warning(20)
-6
Busy(16)
Message Waiting(19)
level
type
Poland
1
1
1
1
1
1
1
1
1
1
1
1
Freq.
Type
1
1
1
1
2
1
1
1
2
1
1
1
# Freq.
440
440
440
425
350
425
425
1440
350
425
425
425
1st
Freq
0
0
0
0
425
0
0
0
425
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
0
0
0
4th
Freq
3
1
1
1
1
1
1
1
1
1
1
1
#on/off
100
100
100
150
5000
500
1000
5000
5000
5000
200
500
1st tone
on
100
100
100
150
0
500
4000
0
0
0
100
500
1st tone
off
300
0
0
0
0
0
0
0
0
0
0
0
2nd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
2nd
tone off
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone on
100
0
0
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
0
0
0
4th
tone off
0
2
1
2
0
5000
5000
0
0
0
2
5000
rep.
count
2
2
2
2
1
2
2
1
1
1
2
2
tone
steady
130
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
-12
-12
-12
-12
-12
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
-12
Dial(18)
-12
-12
Confirmation(17)
OffHook Warning (20)
-12
Busy(16)
Message Waiting(19)
level
type
Spain
1
1
1
1
1
1
1
1
1
Freq.
Type
1
2
1
1
1
2
1
2
1
# Freq.
425
400
425
425
425
160
425
1st
Freq
0
425
0
0
0
425
0
2nd
Freq
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
4th
Freq
2
2
3
1
1
2
1
2
1
#on/off
40
5000
200
1000
250
100
5000
160
170
1st tone
on
1950
0
200
5000
250
100
0
160
170
1st tone
off
0
5000
0
0
0
330
0
2nd
tone on
0
0
0
0
0
1750
0
2nd
tone off
0
0
0
0
0
0
0
3rd
tone on
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
4th
tone off
0
0
5000
5000
0
2
5000
rep.
count
2
1
2
2
1
2
2
tone
steady
131
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
-16
-20
-20
-17
-29
Ringback(21)
Reorder(22)
Stutterdial(23)
Call Waiting 1 (25)
-15
Dial(18)
-13
-10
Confirmation(17)
OffHook Warning (20)
-20
Busy(16)
Message Waiting(19)
level
type
Switzerland
1
1
1
1
1
1
1
1
1
Freq.
Type
1
2
1
1
1
2
1
1
1
# Freq.
425
425
425
425
425
400
425
425
425
1st
Freq
0
340
0
0
0
425
0
0
0
2nd
Freq
0
0
0
0
0
0
0
0
0
3rd
Freq
0
0
0
0
0
0
0
0
0
4th
Freq
1
1
1
1
1
1
1
1
1
#on/off
200
1100
200
1000
240
5000
5000
200
500
1st tone
on
200
1100
200
4000
240
0
0
100
500
1st tone
off
200
0
0
0
0
0
0
0
0
2nd
tone on
4000
0
0
0
0
0
0
0
0
2nd
tone off
0
0
0
0
0
0
0
0
0
3rd
tone on
0
0
0
0
0
0
0
0
0
3rd
tone off
0
0
0
0
0
0
0
0
0
4th
tone on
0
0
0
0
0
0
0
0
0
4th
tone off
1
0
5000
5000
5000
0
0
2
5000
rep.
count
2
1
2
2
2
1
1
2
2
tone
steady
132
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Signal
Code
l/dl
l/rt
l/bz
l/ro
l/sl
l/cf
l/ot
l/mwi
l/wt1
l/wt2
ID
17
18
19
20
21
22
23
24
25
26
Japan
BR
BR
TO
TO
BR
TO
TO
TO
TO
TO
Signal
Type
call waiting tone 2
call waiting tone 1
message waiting
receiver off hook
confirmation / positive indication
special dial tone
reorder tone / congestion tone
busy tone
audible ringback
dial tone
Description
Repeated tone; 392 Hz at -20 dBm0 + 408 Hz at
-20 dBm; 100 ms ON, 100 ms OFF, 100 ms ON,
(as MIB defined*) OFF
Initial tone; 392 Hz @ -20 dBm0 + 408 Hz @
-20 dBm0; 500 ms ON, 3500 ms OFF (this is
equivalent to a 400 Hz tone modulated at 16 Hz)
Repeated tone; 400 Hz @ -20 dBm0
500 ms ON, 450 ms OFF, 500 ms ON, (as MIB
defined*) OFF
Initial tone; 392 Hz @ -20 dBm0 + 408 Hz @
-20 dBm0
500ms ON, 3500ms OFF (this is equivalent to a
400 Hz tone modulated at 16 Hz)
Use Japan l/sl
use NA l/ot
400 Hz @ -24 dBm0 (.125 s ON, .125 s OFF, .125
ON) repeated 3 times
400 Hz @ -24 dBm0
repeated pattern: 0.125 s ON, 0.125 s OFF
400 Hz @ -13 dBm0
repeated pattern: 0.25 s ON, 0.25 s OFF
400 Hz @ -13 dBm0
repeated pattern: 0.5 s ON, 0.5 s OFF
392 Hz @ -13 dBm0 + 408 Hz @-13 dBm0
repeated pattern: 1 s ON, 2 s OFF
400 Hz @ -24 dBm0 continuous
Tone Definition
MIBs control repeat count
and delay between repeats.
MIBs control repeat count
and delay between repeats.
Infinite unless CMS signals
otherwise
Infinite unless CMS signals
otherwise
german l/sl
german l/ro
-
[14]
[14]
[14]
[14]
[14]
Timeout Source
60 s
135 s
1s
16 s
30 s
30 s
180 s
16 s
Timeout
133
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
Signal
Code
l/wt3
l/wt4
cg/cr
cg/sit
cg/wt
xcg/cmft
xcg/nack
xcg/vac
srvtn/rdt
srvtn/ht
xsrvtn/xferdt
xsrvtn/cft
xsrvtn/ccst
ID
27
28
29
30
31
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
32
33
34
35
36
37
38
39
BR
TO
TO
TO
TO
TO
BR
TO
BR
TO
TO
BR
BR
Signal
Type
Japan (Continued)
credit card service
call forward ringback
tone
transfer dial tone
held tone / call on
hold tone
recall / second dial
vacant number
negative indication
comfort / routing /
call in progress tone
warning tone
special information
tone
caller waiting tone
call waiting tone 4
call waiting tone 3
Description
generic xsrvtn/ccst
use Japan l/rt
use Japan l/dl
generic srvtn/ht
use Japan l/dl
use Japan l/ro
generic xcg/nack
(not used [1]) = silence
use generic cg/wt
950 Hz @-17dBm0, 0.33 s ON
1400 Hz @ -17dBm0, 0.33 s ON
1800 Hz @ -17dBm0, 0.33 s ON
1 s OFF repeated pattern
use Japan l/rt
Repeated tone; 392 Hz @ -20 dBm0 + 408 Hz @
-20 dBm0; 100 ms ON, 100 ms OFF, 300ms ON,
100 ms OFF, 100 ms ON, (as MIB defined*) OFF
Initial tone; 392 Hz @ -20 dBm0 + 408 Hz @
-20 dBm0; 500 ms ON, 3500ms OFF, (this is
equivalent to a 400 Hz tone modulated at 16 Hz)
Repeated tone; 392 Hz @ -20 dBm0 + 408 Hz @
-20 dBm0; 100 ms ON, 100 ms OFF, 100ms ON,
100 ms OFF, 100 ms ON, (as MIB defined*) OFF
Initial tone; 392 Hz @ -20 dBm0 + 408 Hz @
-20 dBm0; 500 ms ON, 3500ms OFF, (this is
equivalent to a 400 Hz tone modulated at 16 Hz)
Tone Definition
generic xsrvtn/ccst
180 s
16s
generic srvtn/ht
16 s
30 s
-
generic xcg/cmft
none
Japan l/rt
Japan l/dl
none
Japan l/ro
Japan l/ro
-
none
generic int/int
[14]
40 s
1s
Japan l/rt
MIBs control repeat count
and delay between repeats.
MIBs control repeat count
and delay between repeats.
Timeout Source
180 s
Timeout
134
int/pend
int/int
int/rem
int/tbi
biztn/ofque
biztn/erwt
test/low
test/high
test/loud
test/faint
test/slow
test/fast
scwid/cas
40
41
42
43
44
45
46
47
48
49
50
51
52
BR
OO
OO
OO
OO
OO
OO
BR
BR
BR
BR
BR
BR
Signal
Type
SCWID/CAS
fast interrupted
slow interrupted
faint tone
loud tone
high tone
low tone
expensive route
warning tone
off hook queueing
toll break in tone
intrusion reminder
intrusion tone
intrusion pending
Description
generic scwid/cas
generic test/fast
generic test/slow
generic test/faint
generic test/loud
generic test/high
generic test/low
generic biztn/erwt
generic biztn/ofque
use Japan int/int
use Japan int/int
425 Hz @ -18 dBm0
burst: 0.24s ON, 0.24s OFF, 0.24s ON, 1.28s OFF
(played once, infinite last off element)
use Japan int/int
Tone Definition
80 ms
-
-
-
-
-
-
generic biztn/erwt
generic biztn/ofque
1s
1s
1s
1s
Timeout
[29]
-
-
-
-
-
-
-
-
Japan int/int
Japan int/int
-
Japan int/int
Timeout Source
* The NcsEndPntConfigCallWaitingDelay MIB object is used to control the delay between repeated call waiting tones only; not the
repeat count.
Signal
Code
ID
Japan (Continued)
135
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
136
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
8
8
Index
A
Access-only DQos 37
Adding the CVC 8
Adjusting Rx/Tx gain 66
Advanced flash features 41
Alarms, configuring 49
arrisCmDevEnableDocsis20 61
arrisCmDevHttpLanAccess 56
arrisCmDevHttpWanAccess 56
arrisCmDevModem Feature Switch 62, 63
arrisCmDevSwImageBuildTime 57
arrisCmDevSwImageName 57
arrisMtaDevPwrSupplyDataShutdownTime 57
arrisMtaDevPwrSupplyEnableDataShutdown 57
B
Boost mode 64
C
Cadence, ring 111
Call management servers (CMS) 32
CallP feature switch 34
Certificates
private MIBs 106
Service Provider Root 106
using default 108
Changing ifInOctets counter operation 57
Channel lists, downstream 44
CMS 32
CMS redirect (switch) 37
CODECs supported 34
Configuring
alarms and log reporting 49
dynamic RTP port range 68
gain control 65
loop current 64
Payload Header Suppression 37
Controlling data shutdown 57
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
138
Controlling functionality 56, 60, 64
CVC, adding 8
D
Data shutdown, controlling 57
DHCP
option 43 support 26
option 60 support 27
options required 23
Vendor Class Identifier 27
Dial pulse support 66
DOCSIS 1.0 fragmentation support 63
Downstream channel lists 44
DQoS 33
DQoS switch 37
DSx DQoS 37
Duplicate MIBs 86
Dynamic Quality of Service 33
Dynamic RTP port range, configuring 68
E
Echo cancellation tail 67
Enable SDP compliance (switch) 36
Endpoint, lockstep quarantine 35
EURO loads, provisioning restrictions 16, 27
European flash feature 41
European load, provisioning considerations 27
Event tables 50
Event. See Alarms, Logs.
F
Feature switch 34, 40, 62
Flash feature support 41
Flash timing (switch) 37
Forwarding IPv6 packets 62
Fragmentation, DOCSIS 1.0 63
functionality, controlling 56, 60, 64
G
Gain control, provisioning 65
Gain, adjusting 66
Global Universal Provisioning Interface 16
GUPI 16
H
Hotline 74
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
139
I
ifInOctets 57
Installing the software 1
IP ports 33
IP security 31
IPFonix certificate 106
IPSEC 31
IPv6 forwarding 62
J
Jitter buffer, provisioning 69
K
KDC
load balancer, bypass checks 39
updating 53
Kerberos
Key Distribution Center, updating 53
through DHCP 24, 25
L
Lockstop quarantine mode (switch) 35
Logs, configuring 49
Loop current 64
M
Manufacturer CVC, adding 8
MaxCpeAllowed 60
Message Waiting Indicator 41
MGCP error codes (switch) 35
MIB reference 83
MIBs
duplicate 86
for root certificates 106
obsolete 87, 89
PacketCable OID changes 27
supported 83
Monitoring provisioning status 46
MTA feature switch 38
N
NCS piggyback (switch) 35
O
Obsolete MIBs 87, 89
Omit MPTIME parameter (switch) 36
Option 43 26
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
140
Option 60 27
Organization Unique Identifer (OUI) 46
P
PacketACE 3
PacketCable
event tables 50
provisioning 15
test root digital certificate 106
Packetization rates 34
Payload Header Suppression 37
PHS 37
Ports
signalling 33
voice line 33
ppCfgMtaCableTvEnable 58
ppCfgMtaFeatureSwitch 60
ppCfgPortLoopCurrent 64
ppCfgPortRxGainControl 66
ppCfgPortTxGainControl 66
Priority, voice and signalling packets 81
Provisionable ring cadences 37
Provisioning 15, 31
echo cancellation tail 67
for European loads 27
gain control 65
jitter buffer 69
methods, SIP 16
modes 15
DHCP parameters 23
selecting 17
monitoring status 46
notes 33
queue size 69
restriction for EURO loads 16, 27
ring cadence 111
secure MTA and NCS 53
upstream buffer depth 69
voice and signalling priority 81
Pulse dialing support 66
Q
Quality of Service 33
Queue size, provisioning 69
R
Required DHCP options 23
RFC3323 privacy header 41
RFC3842 handshake 41
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
141
Ring cadences
provisionable (switch) 37
provisioning 111
Ringing waveform 67
RSIP wildcarding (switch) 36
RTP port range, configuring 68
S
SDP
enable compliance 36
MPTIME parameter 36
suppress capability attributes 36
Service interruption during software upgrade 32
Service Provider Certificates, private MIBs 106
Service Provider Root certificate 106
Shutdown, data, controlling 57
Signalling port 33
Signalling priority 81
Sinusoidal ring waveform 67
SIP
feature switch 41
provisioning methods 16
Software
installation 1
upgrade, service interruption during 32
upgrading 2, 12, 13
Software upgrade
MIBs 4
options 3
process 2
rejection of 6
status 48
Suppress SDP capability attribute parameters (switch) 36
T
TLV-11, embedded in TLV-43 46
TLV-41 support 44
TLV-43, containing TLV-11s 46
ToS field 81
Trapezoial ring waveform 67
U
Updating the KDC 53
Upgrade
service interruption during 32
Upgrading the software
Enhanced Software Loading 2
from earlier NCS loads to TS4.5 SIP 11
from TS4.2 and earlier 13
Provisioning Guide Release 4.5 Standard 2.0 Dec 2005
142
through provisioning 12
through SNMP 13
Upstream buffer depth, provisioning 69
Using the default root certificate 108
V
Vendor Class Identifier 27
Vendor Specific Information 26, 46
VMWI support 41
Voice line ports 33
Voice priority 81
W
Warmline 74
Waveform, ring 67
Touchstone Telephony Release 4.5 Standard 2.0 Dec 2005
Touchstone Telephony
Provisioning Guide
 2002–2005 ARRIS
All rights reserved
All information contained in this document is subject to change
without notice. ARRIS reserves the right to make changes to
equipment design or program components, as progress in
engineering, manufacturing methods, or other circumstances
may warrant.
ARRIS, ARRIS Interactive, and Touchstone are trademarks of
ARRIS International, Inc. All other trademarks are the property of
their respective holders.
Release 4.5 Standard 2.0
December 2005