Administration Guide

Section 26

26

Within this directory, the Apache module mod_ssl verifies the client certificate, and verifies that the

MAC address in the certificate corresponds the configuration file it is requesting. Either this directory

must contain a configuration file, or a CGI application needs to generate the appropriate config file if

that MAC address is configured in your system. (The Apache web server is freely available at

http://www.apache.org ).

Once an initial XML configuration file is downloaded from the provider web server, subsequent

configuration can be downloaded from the same server. Alternatively, the individual configuration

files can be encrypted using AES 256-bit encryption as described previously, using a key that was

conveyed in the initial configuration file. These encrypted configuration files then can be downloaded

safely using HTTP or TFTP.

Linksys recommends using an encrypted configuration file. In the unlikely event that the private key of

a terminal adapter or the Linksys certificate authority is compromised, terminal adapters which have

already enrolled with a provider and use an encrypted configuration file would be unaffected by such

a compromise.

3.3.

Web Interface

The PHONE ADAPTER provides a built-in web server. Configuration and administration can be

performed through this convenient web interface.

3.3.1.

Web Interface Conventions

The PHONE ADAPTER line uses the following conventions with the web administration capabilities:

o The PHONE ADAPTER web administration supports two privilege levels: Administrator and

User. To use the User privilege, simply point a web browser at the IP address of the PHONE

ADAPTER; to use the administrator privilege, use this URL for the PAP2

http://IP_Address_Of_PHONE ADAPTER/admin/, and this URL for the RT31P2:

http://IP_Address_Of_PHONE ADAPTER/Voice_adminPage.htm . The default IP address for

the LAN interface of the RT31P2 is 192.168.15.1. See the next section for more information

about administration privileges.

o The PHONE ADAPTER supports Internet Explorer 5.5 and above and Netscape 7.0 and

above.

o The web configuration pages can be password protected. See 3.3.2 for more information

about password protect.

o The user name of web Administrator is : admin

o The user name of web User is : user

o Note: The user names for both administrator and User are fixed and cannot be changed.

o After making changes to PHONE ADAPTER configuration parameters, pressing “Submit All

Changes” button will apply all the changes and if necessary, automatically reboot the device.

Multiple changes may be made on multiple page tabs of the web interface at the same time.

Pressing “Submit All Changes” will apply all the modifications.

Important Note: switching between page tabs won’t apply the changes to PHONE

ADAPTER, The only way to apply the changes is to press the “Submit All Changes” button.

o If the “Undo All Changes” button is clicked, any modifications to profile parameters on any and

all pages will be reset back to their original values before modification.

27

NOTE: Pressing the “Undo All Changes” has no effect on the PHONE ADAPTER; it will only

reset the values on the web page.

3.3.2.

Administration Privileges

The PHONE ADAPTER supports two levels of administration privileges: Administrator and User, both

privileges can be password protected. Important note: by factory default, there are no passwords

assigned for both Administrator and User.

The Administrator has the privilege to modify all the web profile parameters and can also modify the

passwords of both Administrator and User. A User only has the privilege to access part of the web

profile parameters; the parameter group that User can access is specified by the Administrator, which

can only be done through provisioning.

To access the Administrator level privilege, use the URL for your model number as described in the

previous section. If the password has been set for Administrator, the browser will prompt for

authentication. The username for Administrator is “admin” and cannot be changed.

To access the User level privilege, use URL: http://IP_Address_Of_PHONE ADAPTER/. If the

password has been set for User, the browser will prompt for User authentication. The username for

User is “user” and cannot be changed.

When browsing Administrator pages, one can switch to User privileges by click the link “User Login”.

(Note: if User password was set, the browser will prompt for User authentication when you click “User

Login” link). On the other side, from the User pages you can switch to Administrator privilege by

clicking the link “Admin Login.” Authentication is needed if Administrator password has been set.

Warning: Switching between the User and Administrator will discard the uncommitted changes that

have already been made on the web pages.

3.3.3.

Basic and Advanced Views

The PAP2 web configuration interface provides a Basic and an advanced view from which the various

configuration parameters can be accessed. The PHONE ADAPTER Provisioning tab is only visible

from the Advanced Administrator view of the web interface.

Warning: Switching between the basic and advanced view will discard the uncommitted changes that

have already been made on the web pages.

3.4.

Functional Configuration URLs

The web interface of the PHONE ADAPTER supports several functions through special URLs:

Upgrade, Reboot, Profile Resync, and Factory Reset. Administrator privilege is needed for these

functions.

Note that on the RT31P2, these URLs are only accessible from the LAN interface, unless the

Admin_Passwd has been set and the Enable_Web_Admin_Access parameter is set.

3.4.1.

Upgrade URL

Through upgrade URL you can upgrade the PHONE ADAPTER to a firmware specified by the URL.

Note: If the value of “upgrade enable” parameter in Provisioning tab is no, you cannot upgrade the

PHONE ADAPTER even if the web page tells you that the upgrade will be done when it is not in use.

See 4.2.1 to get more information on firmware upgrade.

The syntax of Upgrade URL is:

http://<PAP2-ip-addr>/upgrade?[protocol://][server-name[:port]][/firmware-pathname] or

28

http://<PAP2-ip-addr>/admin/upgrade?[protocol://][server-name[:port]][/firmware-pathname]

If no protocol is specified, TFTP is assumed. Note: Only TFTP is supported in the current release.

If no server-name is specified, the host that requests the URL is used as server-name.

If no port specified, default port of the protocol is used. (69 for TFTP, 80 for http, 443 for HTTPS)

The “firmware-pathname” is typically the file name of the PHONE ADAPTER binary located in the root

directory of the TFTP server. If no firmware-pathname is specified, “/Phone Adapter.bin” is assumed.

For example: http://192.168.2.217/upgrade?tftp://192.168.2.251/PAP2.bin

3.4.2.

Resync URL

Through Resync URL you can force the PHONE ADAPTER to do a resync to a profile specified in the

URL.

Note: The PHONE ADAPTER will resync only when it is idle.

The syntax of Resync URL is:

http://<Phone Adapter-ip-addr>/resync?[[protocol://][server-name[:port]]/profile-pathname]

If no parameter follows “/resync?”, the profile rule setting in provisioning is used. See 4.2 for detailed

information about profile rule in provisioning

If no protocol is specified, TFTP protocol is assumed. Note: Only TFTP is supported in the current

release.

If no server-name is specified, the host that requests the URL is used as server-name.

If no port specified, default port of the protocol is used – 69 for TFTP, 80 for http, 443 for HTTPS.

The profile-path is the path to the new profile to resync with.

For example: http://192.168.2.217/upgrade?tftp://192.168.2.251/PAP2.scf

3.4.3.

Reboot URL

Through the Reboot URL, you can reboot the PHONE ADAPTER.

Note: Upon request, the PHONE ADAPTER will reboot only when it is idle.

The Reboot URL is: http://<Phone Adapter-ip-addr>/admin/reboot

3.4.4.

Factory Reset URL

Through the Reset URL, you can perform a factory reset of the PHONE ADAPTER.

Note: Upon request, the PHONE ADAPTER will reset and then reboot only when it is idle.

The Reset URL is: http://<Phone Adapter-ip-addr>/admin/reset

29

3.5.

Configuration via the IVR (PAP2 only)

Administrators and/or users can check (read) and set (write) basic network configuration settings via

a touchtone telephone connected to one of the RJ-11 phone ports of the PAP2 model PHONE

ADAPTER.

Please Note:

Service Providers offering service using the PHONE ADAPTER may restrict, protect or turn off certain

aspects of the unit’s IVR and web configuration capabilities.

The Interactive Voice Response (IVR) capabilities of the PHONE ADAPTER are designed to give the

administrator and/or user basic read/write capabilities such that the unit can attain basic IP network

connectivity and the more advanced browser-based configuration menu may be accessed.

1. The PHONE ADAPTER IVR uses the following conventions: By factory default there is no

password and no password authentication is prompted for all the IVR settings. If administrator

password is set, password authentication will be prompted for certain IVR settings. See 3.4.2 for

detailed information about administrator password.

To input the password using the phone keypad, the following translation convention applies:

o To input: A, B, C, a, b, c -- press ‘2’

o To input: D, E, F, d, e, f -- press ‘3’

o To input: G, H, I, g, h, i -- press ‘4’

o To input: J, K, L, j, k, l -- press ‘5’

o To input: M, N, O, m, n, o -- press ‘6’

o To input: P, Q, R, S, p, q, r, s -- press ‘7’

o To input: T, U, V, t, u, v -- press ‘8’

o To input: W, X, Y, Z, w, x, y, z -- press ‘9’

o To input all other characters in the administrator password, press ‘0’

Note: This translation convention only applies to the password input.

For example: to input password “test#@1234” by phone keypad, you need to press the following

sequence of digits: 8378001234.

2. After entering a value, press the # (pound) key to indicate end of input.

o To Save value, press ‘1’

o To Review the value, press ‘2’

o To Re-enter the value, press ‘3’

o To Cancel the value entry and return to the main configuration menu, press ‘

*

’ (star)

Notes:

o The final ‘#’ key won’t be counted into value.

o Saved settings will take effect when the telephone is hung-up and if necessary, the PHONE

ADAPTER will automatically reboot.

30

3. After one minute of inactivity, the unit times out. The user will need to re-enter the configuration

menu from the beginning by pressing * * * *.

4. If, while entering a value (like an IP address) and you decide to exit without entering any changes,

you may do so by pressing the * (star) key twice within a half second window of time. Otherwise,

the entry of the * (star) key will be treated as a dot (decimal point).

Example: To enter IP address, use numbers 0 – 9 on the telephone key pad and use the * (star) key

to enter a decimal point.

To enter the following IP address value: 192.168.2.215

A. Use the touchtone key pad to enter: 192*168*2*215#

B. When prompted, enter 1 to save setting to configuration.

C. Hang-up the phone to cause setting to take effect.

- or -

D. Enter the value of the next setting category to modify . . .

5. Hang-up the phone to cause all settings to take effect.

PHONE ADAPTER Interactive Voice Response (IVR) Menu:

IVR Action

IVR Menu Choice

Parameter(s)

Notes:

Enter IVR Menu

* * * *

None

Ignore SIT or other tones

until you hear, “Linksys

configuration menu.

Please enter option

followed by the pound key

or hang-up to exit.”

Exit IVR Menu

3948

None

Check DHCP

100

None

IVR will announce if DHCP

in enabled or disabled.

Enable/Disable DHCP

101

Enter 1 to enable

Enter 0 to disable

Requires Password

Check IP Address

110

None

IVR will announce the

current IP address of

PHONE ADAPTER.

Set Static IP Address

111

Enter IP address

using numbers on

the telephone key

pad. Use the *

(star) key when

entering a decimal

point.

DHCP must be “Disabled”

otherwise you will hear,

“Invalid Option,” if you try

to set this value.

Requires Password

Check Network Mask

120

None

IVR will announce the

current network mask of

31

PHONE ADAPTER.

Set Network Mask

121

Enter value using

numbers on the

telephone key pad.

Use the * (star) key

when entering a

decimal point.

DHCP must be “Disabled”

otherwise you will hear,

“Invalid Option,” if you try

to set this value.

Requires Password

Check Static Gateway IP

Address

130

None

IVR will announce the

current gateway IP

address of PHONE

ADAPTER.

Set Static Gateway IP

Address

131

Enter IP address

using numbers on

the telephone key

pad. Use the *

(star) key when

entering a decimal

point.

DHCP must be “Disabled”

otherwise you will hear,

“Invalid Option,” if you try

to set this value.

Requires Password

Check MAC Address

140

None

IVR will announce the

MAC address of PHONE

ADAPTER in hex string

format.

Check Firmware Version

150

None

IVR will announce the

version of the firmware

running on the PHONE

ADAPTER.

Check Primary DNS

Server Setting

160

None

IVR will announce the

current setting in the

Primary DNS field.

Set Primary DNS Server

161

Enter IP address

using numbers on

the telephone key

pad. Use the *

(star) key when

entering a decimal

point.

Requires Password

Check PHONE

ADAPTER’s Web Server

Port

170

None

IVR will announce the

port that the web server

is listening on. (Default is

80)

Enable/Disable Web

Server of PHONE

ADAPTER

7932

Enter 1 to enable

Enter 0 to disable

Requires Password

Manual Reboot of Unit

732668

None

After you hear “Option

Successful,” hang-up. Unit

will reboot automatically.

32

User Factory Reset of Unit

WARNING:

ALL “User-Changeable” NON-

DEFAULT SETTINGS WILL BE

LOST!

This might include network and

service provider data.

877778

Enter 1 to confirm

Enter *(star) to

cancel operation

PHONE ADAPTER will

prompt for confirmation.

After confirming, you will

hear “Option Successful.”

Hang-up. Unit will reboot

and all “User Changeable”

configuration parameters

will be reset to factory

default values.

Factory Reset of Unit

WARNING:

ALL NON-DEFAULT SETTINGS

WILL BE LOST!

This includes network and

service provider data.

73738

Enter 1 to confirm

Enter * (star) to

cancel operation

PHONE ADAPTER will

prompt for confirmation.

After confirming, you will

hear “Option Successful.”

Hang-up. Unit will reboot

and all configuration

parameters will be reset to

factory default values.

Note: If the Administrator password is not set or the user is allowed to change it, the items marked

with “Requires Password” will not require a password.

4. Configuration Parameters

4.1.

Data Types

The data types for the PHONE ADAPTER configuration parameters are described below.

•

Uns<n> – Unsigned n-bit value, where n = 8, 16, or 32. It can be specified in decimal or hex

format such as 12 or 0x18 as long as the value can fit into n bits.

•

Sig<n> – Signed n-bit value. It can be specified in decimal or hex format. Negative values must

be preceded by a “-“ sign. A ‘+’ sign before positive value is optional

•

Str<n> – A generic string with up to n non-reserved characters.

•

Float<n> – A floating point value with up to n decimal places.

•

Time<n> – Time duration in seconds, with up to n decimal places. Extra decimal places specified

are ignored.

•

PwrLevel – Power level expressed in dBm with 1 decimal place, such as –13.5 or 1.5 (dBm)

•

Bool: Boolean value of either “yes” or “no”

•

{a,b,c,…} – A choice among a, b, c, …

•

IP – IP Address in the form of x.x.x.x, where x between 0 and 255. For example 10.1.2.100

•

Port – TCP/UDP Port number (0-65535). It can be specified in decimal of hex format.

•

UserID – User ID as appeared in a URL; up to 63 characters

•

FQDN – Fully Qualified Domain Name, such as “sip.Linksys.com:5060”, or “109.12.14.12:12345”.

It can contain up to 63 characters

•

Phone – A phone number string, such as 14081234567, *69, *72, 345678, or a generic URL such

as 1234@10.10.10.100:5068, or jsmith@Linksys.com. It can contain up to 39 characters.

•

ActCode – Activation code for a supplementary service, such as *69. It can contain up to 7

characters.

•

PhTmplt – A phone number template. Each template may contain 1 or more patterns separated

by a “,”. White Phone Adapterce at the beginning of each pattern is ignored. “?” and “*” represent

33

wildcard characters. It can contain up to 39 characters. Examples: “1408*, 1510*”,

“1408123????, 555?1”.

•

RscTmplt – A template of SIP Response Status Code, such as “404, 5*”, “61?”, “407, 408, 487,

481”. It can contain up to 39 characters.

•

CadScript – A mini-script that specifies the cadence parameters of a signal. Up to 127

characters. Syntax: S

1

[;S

2

], where

S

i

=D

i

(on

i,1

/off

i,1

[,on

i,2

/off

i,2

[,on

i,3

/off

i,3

[,on

i,4

/off

i,4

[,on

i,5

/off

i,5

[,on

i,6

/off

i,6

]]]]]) and is known as a section,

on

i,j

and off

i,j

are the on/off duration in seconds of a segment and i = 1 or 2, and j = 1 to 6. D

i

is the

total duration of the section in seconds. All durations can have up to 3 decimal places to provide 1

ms resolution. The wildcard character “*” stands for infinite duration. The segments within a

section are played in order and repeated until the total duration is played. Examples:

Example 1: Normal Ring

60(2/4)

Number of Cadence Sections = 1

Cadence Section 1: Section Length = 60 s

Number of Segments = 1

Segment 1: On=2s, Off=4s

Total Ring Length = 60s

Example 2: Distinctive Ring (short,short,short,long)

60(.2/.2,.2/.2,.2/.2,1/4)

Number of Cadence Sections = 1

Cadence Section 1: Section Length = 60s

Number of Segments = 4

Segment 1: On=0.2s, Off=0.2s

Segment 2: On=0.2s, Off=0.2s

Segment 3: On=0.2s, Off=0.2s

Segment 4: On=1.0s, Off=4.0s

Total Ring Length = 60s

•

FreqScript – A mini-script that specifics the frequency and level parameters of a tone. Up to 127

characters. Syntax: F

1

@L

1

[,F

2

@

L2

[,F

3

@L

3

[,F

4

@L

4

[,F

5

@L

5

[,F

6

@L

6

]]]]], where F

1

–F

6

are frequency

in Hz (unsigned integers only) and L

1

–L

6

are corresponding levels in dBm (with up to 1 decimal

places). White spaces before and after the comma are allowed (but not recommended)

Example 1: Call Waiting Tone

440@-10

Number of Frequencies = 1

Frequency 2 = 440 Hz at –10 dBm

Example 2: Dial Tone

350@-19,440@-19

34

Number of Frequencies = 2

Frequency 1 = 350 Hz at –19 dBm

Frequency 2 = 440 Hz at –19 dBm

•

ToneScript – A mini-script that specifies the frequency, level and cadence parameters of a call

progress tone. May contain up to 127 characters. Syntax: FreqScript;Z

1

[;Z

2

]. The section Zi is

similar to the S

i

section in a CadScript except that each on/off segment is followed by a frequency

components parameter: Z

i

= D

i

(on

i,1

/off

i,1

/f

i,1

[,on

i,2

/off

i,2

/f

i,2

[,on

i,3

/off

i,3

/f

i,3

[,on

i,4

/off

i,4

/f

i,4

[,on

i,5

/off

i,5

/f

i,5

[,on

i,6

/off

i,6

/f

i,6

]]]]]), where fi,j = n

1

[+n

2

]+n

3

[+n

4

[+n

5

[+n

6

]]]]] and 1 < n

k

< 6 indicates which of the

frequency components given in the FreqScript shall be used in that segment; if more than one

frequency component is used in a segment, the components are summed together.

Example 1: Dial Tone

350@-19,440@-19;10(*/0/1+2)

Number of Frequencies = 2

Frequency 1 = 350 Hz at –19 dBm

Frequency 2 = 440 Hz at –19 dBm

Number of Cadence Sections = 1

Cadence Section 1: Section Length = 10 s

Number of Segments = 1

Segment 1: On=forever, with Frequencies 1 and 2

Total Tone Length = 10s

Example 2: Stutter Tone

350@-19,440@-19;2(.1/.1/1+2);10(*/0/1+2)

Number of Frequencies = 2

Frequency 1 = 350 Hz at –19 dBm

Frequency 2 = 440 Hz at –19 dBm

Number of Cadence Sections = 2

Cadence Section 1: Section Length = 2s

Number of Segments = 1

Segment 1: On=0.1s, Off=0.1s with Frequencies 1 and 2

Cadence Section 2: Section Length = 10s

Number of Segments = 1

Segment 1: On=forever, with Frequencies 1 and 2

Total Tone Length = 12s

Example 3: SIT Tone

985@-16,1428@-16,1777@-16;20(.380/0/1,.380/0/2,.380/0/3,0/4/0)

Number of Frequencies = 3

Frequency 1 = 985 Hz at –16 dBm

Frequency 2 = 1428 Hz at –16 dBm

Frequency 3 = 1777 Hz at –16 dBm

Number of Cadence Sections = 1

Cadence Section 1: Section Length = 20s

Number of Segments = 4

Segment 1: On=0.38s, Off=0s, with Frequency 1

35

Segment 2: On=0.38s, Off=0s, with Frequency 2

Segment 3: On=0.38s, Off=0s, with Frequency 3

Segment 4: On=0s, Off=4s, with no frequency components

Total Tone Length = 20s

•

ProvisioningRuleSyntax – Scripting syntax used to define configuration resync and firmware

upgrade rules. Refer to the provisioning discussion in the next section for a detailed explanation

of the syntax.

•

DialPlanScript – Scripting syntax used to specify line 1 and line 2 dial plans. Refer to the dial

plan section of this document for a detailed explanation of the syntax.

4.1.1.

Conventions

• <Par Name> represents a configuration parameter name. In a profile, the corresponding

tag is formed by replacing the space with an underscore “_”, such as Par_Name.

• An empty default value field implies an empty string < “” >.

• The PHONE ADAPTER shall continue to use the last configured values for tags that are

not present in a given profile.

• Templates are compared in the order given. The first, not the closest, match is selected.

The parameter name must match exactly.

• If more than one definition for a parameter is given in a configuration file, the last such

definition in the file is the one that will take effect in the PHONE ADAPTER.

• A parameter specification with an empty parameter value forces the parameter back to its

default value. To specify an empty string instead, use the empty string “” as the parameter

value.

4.2.

Provisioning Related Parameters

Provisioning is controlled by the following parameters (firmware upgrades are discussed later in this

section).

•

Provision_Enable

•

Resync_On_Reset

•

Resync_Random_Delay

•

Resync_Periodic

•

Resync_Error_Retry_Delay

•

Forced_Resync_Delay

•

Resync_From_SIP

•

Resync_After_Upgrade_Attempt

•

Resync_Trigger_1

•

Resync_Trigger_2

•

Resync_Fails_On_FNF

•

Profile_Rule

•

Profile_Rule_B

•

Profile_Rule_C

•

Profile_Rule_D

•

Log_Resync_Request_Msg

•

Log_Resync_Success_Msg

•

Log_Resync_Failure_Msg

36

•

GPP_A through GPP_P

•

GPP_SA through GPP_SD

Provision Enable:

ParName:

Provision_Enable

Default:

Enable

The CFG profile must be requested by the PHONE ADAPTER, and cannot be pushed from a

provisioning server (although a service provider can effectively push a profile by triggering the request

operation remotely via a SIP NOTIFY). The functionality is controlled by the Provision_Enable

parameter. The parameter enables the functionality encompassed by the remaining provisioning

parameters.

In addition, Provision_Enable also gates the ability to issue an explicit resync command from the web

interface (discussed earlier in the "Function URLs" section of this document).

Resync on Reset:

ParName:

Resync_On_Reset

Default:

Enable

Resync_On_Reset determines whether the PHONE ADAPTER will attempt to resync with the

provisioning server on power-up and following explicit reboot requests.

Resync Random Delay:

ParName:

Resync_Random_Delay

Default:

2

Resync_Random_Delay helps to scatter resync requests from multiple devices uniformly over a

period of time, whose duration (in seconds) is indicated by this parameter. Hence, if a number of

PHONE ADAPTER devices were to power-up at the same time, their resync requests would be

distributed over time, lessening the impact on the provisioning servers.

Resync Periodic:

ParName:

Resync_Periodic

Default:

3600

The PHONE ADAPTER attempts to resync with the provisioning server periodically, provided the

Resync_Periodic parameter is configured with a non-zero value. The value (in seconds) indicates the

interval between resync attempts. Normally, the PHONE ADAPTER will not start the resync while an

37

active call is in progress. The PHONE ADAPTER will wait up to Forced_Update_Delay seconds for

both lines to become idle. If the adapter still is not idle, the adapter will perform a resync anyway.

Resync Error Retry Delay:

ParName:

Resync_Error_Retry_Delay

Default:

3600

If a resync attempt fails, the PHONE ADAPTER will retry with a delay indicated by the

Resync_Error_Retry_Delay parameter, specified in seconds. If the value is zero, the PHONE

ADAPTER treats resync failures as though they were successful, and simply waits for the next

periodic event to resync.

Resync From SIP:

ParName:

Resync_From_SIP

Default:

Enable

Resync_From_SIP gates the ability of a service provider to trigger a profile resync via a SIP NOTIFY

message to the PHONE ADAPTER.

If the PHONE ADAPTER receives a SIP NOTIFY request with an Event header field value of

"resync", "reboot", or "restart"; the PHONE ADAPTER will attempt to Digest authenticate the notifier

using the authentication password used for registrations on that line if the Auth_Resync-Reboot

parameter is set. If this parameter is not set or if the NOTIFY request is authenticated, the PHONE

ADAPTER triggers a resync, cold-boot, or warm-boot respectively. The actual resync, reboot, or

restart will not take place until the PHONE ADAPTER is idle (i.e. no calls are in progress).

Profile Rule:

ParName:

Profile_Rule

Default:

/spa$PSN.cfg

ParName:

Profile_Rule_B through Profile_Rule_D

Default:

Empty

The Profile_Rule parameter is a script that identifies the provisioning server to contact when

performing a profile resync. The Profile_Rule_B, Profile_Rule_C, and Profile_Rule_D parameters are

also scripts used to contact other provisioning URLs. Each profile rule is executed only if the previous

profile rule was executed successfully(*).

38

These strings each supports one level of macro expansion, using a small set of variables. Following

macro substitution, the rule is evaluated to obtain the URL of the CFG file to be requested from the

provisioning server.

The URL can be partially specified, in which case default values are assumed for the unspecified

terms. The filepath portion of the URL must always be specified.

The Profile_Rule supports additional syntax that allows the URL to include conditions, for example

based on a function of the firmware release currently running in the PHONE ADAPTER. This

mechanism can aid the service provider’s firmware upgrade sequence, by allowing them to define

different configuration profiles for different stages of an upgrade sequence.

The conditional syntax consists of a sequence of condition-url pairs, separated by the ‘|’ character.

The condition component tests the current firmware version number against a specified value. If the

last url in the sequence does not have an associated condition, it will be attempted unconditionally.

The sequence of conditions is evaluated until one is satisfied. The URL associated with that

condition is then used to resync the PHONE ADAPTER. No additional URLs in the rule are

considered.

(*) A profile rule which attempts to fetch a URL succeeds if the profile is received and parsed

correctly. If the Resync_Fails_On_FNF parameter is set to No, a profile rule will also succeed if an

attempted fetch for a URL returns a File Not Found error message. A profile rule with only

assignments always succeeds.

Optional qualifiers can be specified in brackets, preceding each URL.

To ease testing and development, the script syntax also supports using ‘#’ as a comment delimiter

(until end-of-parameter). This allows a potentially long script to be temporarily “commented out”.

The syntax for the rule is as follows (with standard conventions for URLs):

rule = term *( "|" term )

term = [condition] [assignments] [options] url

condition = "(" conditionseq ")" "?"

conditionseq = condelem *( conjunction condelem )

condelem = numcond / vercond / strcond

numcond = number relop number

vercond = [ version ] relop version

relop = "<" / "<=" / ">" / ">=" / "==" / "!="

/ "!" / "gt" / "ge" / "lt" / "le" / "eq" / "ne"

version = major "." minor "." build [ "(" features ")" ]

strcond = cond *( conjunction cond )

strcond = qstr eqop qstr

conjunction = "and"

qstr = DQUOT val DQUOT

eqop = "==" / "!=" / "!" / "eq" / "ne"

assignments = "(" *assignment ")" "!"

assignment(*) = attribute "=" expr ";"

39

expr = DQUOT val DQUOT

options = "[" *option "]"

option = key-opt / alias-opt / post-opt

key-opt = "--key" key-string

key-string = password / quoted-pass-phrase / hex-string

alias-opt = "--alias" val

post-opt = "--post" val

url = [ method "://" [ server [":" port]]] "/" *(dir "/") file

method = "tftp" / "http" / "https"

server(**) = ip4quad / fqdn

( * ) Attribute can contain the name of any configuration parameter

( ** ) If the server and scheme are unspecified, the TFTP server name provided by the LAN’s DHCP

server is used instead. Also, an FQDN with multiple DNS entries is multiply resolved by the PHONE

ADAPTER.

The variables available for macro substitution (with example values) are as follows:

PN

PAP2

Product Name

PSN

PAP2

Product Series Number

MA

000f66aaa010

MAC Address

MAU

000F66AAA010

MAC Address (upper case)

MAC

00:0f:66:aa:a0:10

MAC Addr with Colon separators

SN

CH500D600862

Serial Number

SWVER

1.0.2

Firmware Version Number

HWVER

1.0.1

Hardware Version Number

UPGCOND

1.0.2<1.1

Upgrade(*) Condition

SCHEME

tftp

Access Scheme

SERV

http.example.com

Server Name

SERVIP

10.2.3.200

Server IP Address

PORT

69

TCP/IP Request Port

PATH

/guest/pap2.cfg

File path

IP

192.168.1.102

IP address of the PHONE ADAPTER

EXTIP

45.73.21.44

Configured or discovered external IP

address (for example using STUN)

PRVST

0

Error Code of Last Profile Rule(**)

UPGST

0

Error Code of Last Upgrade Rule(**)

ERR

corrupt file

Error/Info(***) message

A to P

some-value

Contents of GPP_A to GPP_P

SA to SD

some-value

Contents of GPP_SA to GPP_SD

( * ) Note that the UPGCOND term is particularly useful in the Upgrade_Rule (discussed later in this

document), but applies equally as a resync condition. It shows which term of the rule triggered the

operation.

( ** ) See section 6.5 for the values of these macro variables.

( *** ) Upon successful firmware upgrade, the ERR variable carries the version of the newly installed

load.

40

In addition, the contents of the general purpose parameters, GPP_A, through GPP_P, are available

as macro variables A through P, respectively.

A secondary set of general purpose parameters is also available for macro substitution, GPP_SA,

GPP_SB, GPP_SC, GPP_SD, using the respective expressions SA, SB, SC, and SD. These

parameters are not accessible through the web interface, and can only be set via a configuration

profile.

Strings identified above as "val" values are strings which can include variable substitution. The macro

variables are invoked by prefixing the name with a ‘$’ character (e.g. $MAC). The substitution works

even within a quoted string, without requiring additional escapes. If the variable name is immediately

followed by an alphanumeric character, enclose the variable name in parentheses (e.g.

"$(MAC)config.xml" ).

To include a dollar sign in the rule, escape it with another dollar sign. That is $$ maps to $.

Profile_Rule syntax examples (each line is a separate example):

/pap2.cfg

pserv.myvoice.com:42000/sip/$MA/pap2.cfg

[--key 6e4f2a8733ba7c90aa13250bde4f6927]ur.well.com/Gj2fLx3Nqbg/a.cfg

(<1.0)?/pre-rel.cfg | /curr.cfg

Profile Example Scenarios:

Enterprise LAN with DHCP Supplied TFTP Server Name:

The DHCP server automatically advertises a TFTP server name to service the local network. Each

PHONE ADAPTER in the network is supplied a unique CFG file based on its MAC address. The

TFTP server would also contain a generic Phone Adapter2000.cfg in its tftp-root directory that

contains the Profile_Rule indicated below. It would additionally carry individualized CFG files, one

per device, within a tree below the tftp-root node. Each of these files would then individualize the

devices.

/profiles/$MA/pap2.cfg

When first powered-on, unprovisioned devices would download the /pap2.cfg file from the TFTP

server indicated by DHCP, (following their manufacturing default setting for the Profile_Rule

parameter). The downloaded file would then direct the PHONE ADAPTER to resync to the server

and fetch the individualized CFG file, as per the rule above, which completes the provisioning

sequence.

VoIP Service Provider:

Conceptually, a service provider solution would follow the steps as in the above example. In addition,

it would then proceed to enable stronger encryption by implementing one more provisioning step, with

one more level of redirection, involving a random CFG file path and encryption key. Hence, each of

the “first-stage” CFG files above would point to a “second-stage” CFG file, with entries such as the

following:

41

Profile_Rule “[--key $B] ps.global.com/profiles/active/$A/pap2.cfg”;

GPP_A “Dz3P2q9sVgx7LmWbvu”;

GPP_B

“83c1e792bc6a824c0d18f429bea52d8483f2a24b32d75bc965d05e38c163d5ef”;

In practice, the first provisioning stage (which individualizes each PHONE ADAPTER into fetching a

unique CFG file) could be preconfigured during manufacturing.

For added security, the second stage, which introduces strong encryption, may be performed in-

house, prior to shipping an PHONE ADAPTER to each end-user.

Release 2.0 supports SSL-based key exchanges, alleviating the need for this in-house step, while

preserving strong security for the provisioning process.

A provisioning flow chart, from the point of view of the PHONE ADAPTER endpoint is presented in a

later section.

Log Resync Request Message:

ParName:

Log_Resync_Request_Msg

Default:

$PN $MAC –- Requesting resync $SCHEME://$SERVIP:$PORT$PATH

The Log_Resync_Request_Msg is a script that defines the message sent to the configured Syslog

server whenever the PHONE ADAPTER attempts to resync with the provisioning server. The string

supports one level of macro substitution, with the same variables as for the Profile_Rule above. An

empty string does not generate a syslog message.

Log Resync Success Message:

ParName:

Log_Resync_Success_Msg

Default:

$PN $MAC –- Successful resync $SCHEME://$SERVIP:$PORT$PATH

The Log_Resync_Success_Msg is a script that defines the message sent to the configured Syslog

server whenever the PHONE ADAPTER successfully completes a resync with the provisioning

server. The string supports one level of macro substitution, with the same variables as for the

Profile_Rule above. An empty string does not generate a syslog message.

Log Resync Failure Message:

ParName:

Log_Resync_Failure_Msg

Default:

$PN $MAC –- Resync failed: $ERR

The Log_Resync_Failure_Msg is a script that defines the message sent to the configured Syslog

server whenever the PHONE ADAPTER fails to complete a resync with the provisioning server. The

42

string supports one level of macro substitution, with the same variables as for the Profile_Rule above.

An empty string does not generate a syslog message.

General Purpose Parameters:

ParName:

GPP_A through GPP_P

Default:

empty

GPP_A through GPP_P are the 16 General Purpose Parameters, usable by both the provisioning and

the upgrade logic. Each general purpose parameter can be configured to hold any string value.

Such a value can then be incorporated in other scripted parameters.

General Purpose Secure Parameters:

ParName:

GPP_SA through GPP_SD

Default:

empty

GPP_SA through GPP_SD are the 4 Secure General Purpose Parameters, usable by both the

provisioning and the upgrade logic. Each secure parameter can be configured to hold any string

value. Such a value can then be incorporated in other scripted parameters. The secure parameters

are not accessible through the PHONE ADAPTER web interface, and can only be set via a

configuration profile. Also, the parameters cannot be incorporated as part of a syslog message.

Parameter Name

Description

Type

Default

Provision Enable

Master enable for configuration profile

resync operations

Bool

yes

Resync On Reset

Resyncs configuration profile from

configuration server whenever the PHONE

ADAPTER resets.

Bool

yes

Resync Random

Delay

Spread interval for resync requests

Time0

2

Resync Periodic

Resyncs configuration profile periodically

after reset.

Time0

3600

Resync Error Retry

Delay

Retry interval following resync failure

Time0

3600

Resync From SIP

Enables resync of configuration profile from

a SIP command.

Bool

Yes

Resync After Upgrade

Attempt

Bool

Yes

Resync Trigger 1

Resync Trigger 2

Profile Rule

Configuration profile URL script.

ProfileScript /Phone

Adapter.cfg

Profile Rule B

ProfileScript

Profile Rule C

ProfileScript

Profile Rule D

ProfileScript

43

Log Resync Request

Msg

Syslog message generated when attempting

a resync

ProfileMsg

See

provisioning

discussion

section

Log Resync Success

Msg

Syslog message generated after a

successful resync

ProfileMsg

See

provisioning

discussion

section

Log Resync Failure

Msg

Syslog message generated after a failed

resync

ProfileMsg

See

provisioning

discussion

section

GPP A thru GPP P

General purpose parameter

String

empty

GPP SA thru GPP SD

General purpose parameter

String

empty

Note: In a customized PHONE ADAPTER, the profile rule would point to a service provider’s server.

4.2.1.

Firmware Upgrade

The PHONE ADAPTER is firmware upgradeable via TFTP and HTTP. Firmware loads are released

as single binary files, which contain all the modules pertaining to any one release version. By

convention, the firmware loads are named with the extension “.bin” (e.g. pap2.bin)

The PHONE ADAPTER can be configured to upgrade to a specific version, possibly staging through

intermediate releases, if necessary. This process can be automated for a pool of devices through

configuration profile parameters.

Alternatively, an individual PHONE ADAPTER can be directed to perform an upgrade to a specific

firmware load via its built-in web server interface (this mechanism is discussed in section 3.4.1 of this

document).

Firmware upgrades are attempted only when the PHONE ADAPTER is idle, since they trigger a

software reboot.

Firmware upgrades are controlled by the following parameters (which operate in a manner similar to

but independent of the provisioning parameters).

•

Upgrade_Enable

•

Upgrade_Error_Retry_Delay

•

Upgrade_Rule

•

Downgrade_Rev_Limit

•

Log_Upgrade_Request_Msg

•

Log_Upgrade_Success_Msg

•

Log_Upgrade_Failure_Msg

Upgrade Enable:

ParName:

Upgrade_Enable

Default:

Enable

44

The firmware file must be requested by the PHONE ADAPTER and cannot be pushed from an

upgrade server (although a service provider can effectively push a new firmware load by triggering

the request operation remotely via the CFG file). The functionality is controlled by the

Upgrade_Enable parameter. The parameter enables the functionality encompassed by the remaining

upgrade parameters.

In addition, Upgrade_Enable also gates the ability to issue an explicit upgrade command from the

web interface (discussed in section 3.4.1 of this document).

Upgrade Error Retry Delay:

ParName:

Upgrade_Error_Retry_Delay

Default:

3600

If an upgrade attempt fails, the PHONE ADAPTER will retry with a delay indicated by the

Upgrade_Error_Retry_Delay parameter, specified in seconds. If the value is zero, the PHONE

ADAPTER treats upgrade failures as though they were successful, and will not retry to upgrade

unless some event triggers a reboot.

Upgrade Rule:

ParName:

Upgrade_Rule

and Upgrade_Rule_B

Default:

Empty

The Upgrade_Rule and Upgrade_Rule_B parameters are scripts that identifies the upgrade server to

contact during a firmware upgrade. Upgrade_Rule_B is only executed if Upgrade_Rule executed

successfully. These strings support one level of macro expansion, using a small set of variables.

Following macro substitution, the rule is evaluated to obtain a URL of the firmware file to request from

an upgrade server.

The URL can be partially specified, in which case default values are assumed for the unspecified

terms. The filepath portion of the URL must be specified.

The Upgrade_Rule supports additional syntax that allows the URL to be a function of the firmware

release currently running in the PHONE ADAPTER. This mechanism can aid service providers

sequence through a firmware upgrade, by allowing them to automatically stage the upgrade

sequence, if so required by the firmware. Also, the Downgrade_Rev_Limit parameter can contain a

version string below which the PHONE ADAPTER will not downgrade.

The conditional syntax consists of a sequence of condition-url pairs, separated by the ‘|’ character.

The condition component tests the current firmware version number against a specified value.

The sequence of conditions is evaluated until one is satisfied. The URL associated with that

condition is then used to upgrade the PHONE ADAPTER. No additional URLs in the rule are

considered.

45

The upgrade will fail if the new firmware load does not satisfy the upgrade rule condition that

suggested the URL. This alleviates the possibility of infinite upgrade loops, in case the device has

been misconfigured.

The rule syntax is the same as for the Profile_Rule described in a previous section, except that there

are no supported optional qualifiers for upgrades at this time. (That is, the bracketed options

preceding the URL are not supported in the Upgrade_Rule).

Upgrade Rule Syntax Examples (each line is a separate example):

(! 1.0.2)? /Phone Adapter2000/1-00-02/Phone Adapter.bin

(<1.0)? tftp://pserv.myvoice.com:42001/upg/Phone

Adapter2000/1.0.2/Phone Adapter.bin

(<0.99.52)?/Phone Adapter09952.bin | (<1.0.2)?/Phone Adapter10002.bin

Log Upgrade Request Message:

ParName:

Log_Upgrade_Request_Msg

Default:

$PN $MAC –- Requesting upgrade

$SCHEME://$SERVIP:$PORT$PATH

The Log_Upgrade_Request_Msg is a script that defines the message sent to the configured Syslog

server whenever the PHONE ADAPTER attempts an upgrade from the upgrade server. The string

supports one level of macro substitution, with the same variables as for the Upgrade_Rule above. An

empty string does not generate a syslog message.

Log Upgrade Success Message:

ParName:

Log_Upgrade_Success_Msg

Default:

$PN $MAC –- Successful upgrade

$SCHEME://$SERVIP:$PORT$PATH -- $ERR

The Log_Upgrade_Success_Msg is a script that defines the message sent to the configured Syslog

server whenever the PHONE ADAPTER successfully completes an upgrade from the upgrade server.

The string supports one level of macro substitution, with the same variables as for the Upgrade_Rule

above. An empty string does not generate a syslog message.

Log Upgrade Failure Message:

ParName:

Log_Upgrade_Failure_Msg

Default:

$PN $MAC –- Upgrade failed: $ERR

The Log_Upgrade_Failure_Msg is a script that defines the message sent to the configured Syslog

server whenever the PHONE ADAPTER fails to complete an upgrade from the upgrade server. The

46

string supports one level of macro substitution, with the same variables as for the Upgrade_Rule

above. An empty string does not generate a syslog message.

Parameter Name

Description

Type

Default

Upgrade Enable

Master enable for firmware upgrade

operations

Bool

Yes

Upgrade Error

Retry Delay

Retry interval following upgrade failure

Time0

3600

Upgrade Rule

Upgrade script.

UpgradeScript empty

Log Upgrade

Request Msg

Syslog message generated when

attempting an upgrade

UpgradeMsg

See

provisioning

discussion

section

Log Upgrade

Success Msg

Syslog message generated after a

successful upgrade

UpgradeMsg

See

provisioning

discussion

section

Log Upgrade

Failure Msg

Syslog message generated after a failed

upgrade

UpgradeMsg

See

provisioning

discussion

section

Note: In a customized PHONE ADAPTER, the upgrade rule would point to a service provider’s

server.

4.2.2.

Provisioning Server Redundancy

The Provisioning Server (PS) may be specified as an IP address or a FQDN. PS redundancy is not

available in the former case. For the latter, PHONE ADAPTER shall attempt to resolve the IP address

of the PS via DNS SRV, then DNS A Record. In either case, the DNS server may return a number of

IP addresses with priority (priority can be indicated in the case of SRV record; for A records, all IP

addresses have the same priority). The PHONE ADAPTER then contacts the IP address with the

highest priority. If that fails, the PHONE ADAPTER shall contact the next available IP address. The

PHONE ADAPTER shall continue the process until one of the PS responds. If all PS fail to respond,

the PHONE ADAPTER shall log an error to the Syslog server.

4.2.3.

Configuring the Web Server and IVR

System Configuration

Parameter Name

Description

Type

Default

Restricted Access

Domains

This feature is used when implementing software

customization.

Str127

Enable Web Server

Enable/disable web server of PHONE ADAPTER

This feature should only be used on firmware version 1.0.9 or later.

Bool

Yes

Web Server Port

TCP port through which the PHONE ADAPTER web

server will communicate

Uns8

80

Enable Web Admin

Access

Enable/disable Admin pages of web server of PHONE

ADAPTER

Bool

Yes

47

Protect IVR Factory

Reset

Bool

No

Admin Password

The password for administrator

Str63

User Password

The password for User

Str63

4.3.

Basic Networking Configuration

Configuration parameters in this list are used for setting up basic network connectivity. In general,

many of these parameters are set automatically (for example, using DHCP) or are configured by the

end user of the device.

Note that the RT31P2 ignores the following parameters: DHCP, Static_IP, NetMask, and Gateway.

Other than the DNS_Server_Order and DNS_Query_Mode, the rest these parameters also can be

configured from the RT31P2 User GUI.

Network Configuration

Parameter Name

Description

Type

Default

DHCP

Enable/Disable DHCP

Bool

Yes

Host Name

Host Name of PHONE ADAPTER

Str31

Domain

The network domain of PHONE ADAPTER

Str127

Static IP

Static IP address of PHONE ADAPTER, which will take

effect if DHCP is disabled

IP

0.0.0.0

NetMask

The NetMask used by PHONE ADAPTER when DHCP

is disabled

IP

255.255.255.

0

Gateway

The default gateway used by PHONE ADAPTER when

DHCP is disabled

IP

0.0.0.0

Primary DNS

DNS server used by PHONE ADAPTER in addition to

DHCP supplied DNS servers if DHCP is enabled; when

DHCP is disabled, this will be the primary DNS server.

IP

0.0.0.0

Secondary DNS

DNS server used by PHONE ADAPTER in addition to

DHCP supplied DNS servers if DHCP is enabled; when

DHCP is disabled, this will be the secondary DNS

server.

IP

0.0.0.0

DNS Query Mode

Do parallel or sequential DNS Query

Choice

Parallel

Syslog Server

Specify the Syslog server name and port. This feature

specifies the server for logging PHONE ADAPTER

system information and critical events.

FQDN

Debug Server

The debug server name and port. This feature

specifies the server for logging PHONE ADAPTER

debug information. The level of detailed output

depends on the debug level parameter setting.

FQDN

Debug Level

The higher the debug level, the more debug

information will be generated. Zero (0) means no

debug information will be generated.

Choice

0

Primary NTP

Server

IP address or name of primary NTP server.

Str127

or IP

Secondary NTP

Server

IP address or name of secondary NTP server

Str127

or IP

Notes:

48

-

Parallel DNS query mode: PHONE ADAPTER will send the same request to all the DNS servers

at the same time when doing a DNS lookup, the first incoming reply will be accepted by PHONE

ADAPTER.

-

To log SIP messages, Debug Level must be set to at least 2.

-

If both Debug Server and Syslog Server are specified, _Syslog messages are also logged to the

Debug Server.

4.4.

Basic Account Configuration

Basic SIP Account Configuration is typically straightforward, involving only a handful of key

parameters. All of these parameters are configured on a per-line basis.

The Line_Enable parameters control whether a line is enabled or not. The Proxy setting is the

address of the SIP Registrar (usually collocated with a SIP Proxy) for the account. The User_ID is

the username or phone number of the SIP account. The Proxy and User_ID together form the SIP

URI. For example: User_ID = alice ; Proxy = sip.provider.net:5060 ; the SIP URI used for registration

would be sip:alice@sip.provider.net:5060.

The Password is the password used for Digest authentication. With some providers, the username

used for authentication is different from the User_ID used in the SIP From header. For example,

Alice Smith could have a User_ID of 1234, and a Digest username of alice.smith. In this situation, set

the Auth_ID to alice.smith and set Use_Auth_ID to yes. The Display_Name is the string that will

appear in quotes in the From header. It can be an arbitrary string such as a name (for example "Alice

Smith") or a local phone number (for example "5551212").

Proxy and Registration

Proxy

SIP Proxy Server for all outbound requests

FQDN

Register

Enable periodic registration with the <Proxy>. This

parameter is ignored if <Proxy> is not specified.

Bool

Yes

Make Call Without

Reg

Allow making outbound calls without successful

(dynamic) registration by the unit. If “No”, dial tone

will not play unless registration is successful

Bool

No

Ans Call Without Reg

Allow answering inbound calls without successful

(dynamic) registration by the unit

Bool

No

Register Expires

1

Expires value in sec in a REGISTER request.

PHONE ADAPTER will periodically renew

registration shortly before the current registration

expired. This parameter is ignored if <Register> is

“no”. Range: 0 – (2

31

– 1) sec

Time0

3600

Use DNS SRV

Whether to use DNS SRV lookup for Proxy and

Outbound Proxy

Bool

No

DNS SRV Auto Prefix If enabled, the PHONE ADAPTER will

automatically prepend the Proxy or Outbound

Proxy name with _sip._udp when performing a

DNS SRV lookup on that name

Bool

No

Proxy Fallback Intvl

This parameter sets the delay (sec) after which the

PHONE ADAPTER will retry from the highest

priority proxy (or outbound proxy) servers after it

has failed over to a lower priority server. This

Time0

3600

49

parameter is useful only if the primary and backup

proxy server list is provided to the PHONE

ADAPTER via DNS SRV record lookup on the

server name. (Using multiple DNS A record per

server name does not allow the notion of priority

and so all hosts will be considered at the same

priority and the PHONE ADAPTER will not attempt

to fall back after a fail over)

Subscriber Information

Display Name

Subscriber’s display name to appear in caller-id

Str23

User ID

Subscriber’s user-id. Usually a E.164 number

Str47

Password

Subscriber’s a/c password

Str23

Auth ID

Subscriber’s authentication ID

Str39

Use Auth ID

If set to “yes”, the pair <Auth ID> and <Password>

are used for SIP authentication. Else the pair <User

ID> and <Password> are used.

Bool

No

4.5.

Configuration for NAT Traversal

In general, there are 3 general approaches to enable NAT traversal available on the PHONE

ADAPTER: STUN (Simple Traversal of UDP through NAT), Using an outbound rewriting "proxy", and

manual configuration. If the PHONE ADAPTER is not "behind" a NAT, the default settings should be

used.

Note: The Linksys model RT31P2 includes NAT (Network Address Translator) functionality. As long

as the IP address of the "WAN Port" is a public IP address, the RT31P2 can be configured with all

NAT Traversal features (NAT Traversal off), since the PHONE ADAPTER portion shares the same IP

address as the WAN Port. If the address obtained on the WAN Port is already a private address, then

the RT31P2 still needs to be configured for NAT traversal.

The Outbound Proxy approach works through more than 99% of NATs, but it requires the service

provider to relay RTP media packets for every call. To use this approach, set the following

parameters: Outbound_Proxy, Use_Outbound_Proxy, NAT_Keep_Alive_Dest,

NAT_Keep_Alive_Msg, NAT_Keep_Alive_Intvl, and NAT_Keep_Alive_Enable. If the

NAT_Keep_Alive_Msg parameter is set to blank, the PHONE ADAPTER will send a Carriage-

Return/Line-Feed as the Keep-Alive Message.

The STUN approach works through more than 95% of home NATs when there is only a single

PHONE ADAPTER in use behind the same NAT. The STUN approach requires a STUN server setup

by the provider, but uses very few resources. The actual media flows directly between the PHONE

ADAPTER and its peer. To configure STUN set the following parameters: STUN_Enable,

STUN_Test_Enable, STUN_Server, NAT_Mapping_Enable, Substitute_VIA_Addr,

NAT_Keep_Alive_Dest, NAT_Keep_Alive_Msg, NAT_Keep_Alive_Intvl, and

NAT_Keep_Alive_Enable.

The Manual Configuration approach requires coordinated administration of the NAT and the PHONE

ADAPTER. It is not practical for general retail use, but can be used behind symmetric NATs

occasionally found in larger businesses, for troubleshooting, and in circumstances where other

mechanisms have been exhausted. The configure the PHONE ADAPTER for manual NAT traversal,

set the EXT_IP parameter to the public/translated/outside/external IP address, the EXT_SIP_Port

parameters (per line) to the translated port number for this line and PHONE ADAPTER, and the

EXT_RTP_Port_Min parameter to the first translated port number reserved for this PHONE

50

ADAPTER. Also, set the Substitute_VIA_Addr and NAT_Mapping_Enable parameters. Follow the

instructions of the NAT software to configure static NAT mappings between the external address and

ports (EXT_SIP_Port, EXT_RTP_Port_Min) and the internal address and ports (SIP_Port,

RTP_Port_Min). Set the RTP_Port_Max parameter to a smaller number (for example, RTP_Port_Min

plus 8). There must be mappings for the every port number between RTP_Port_Min and

RTP_Port_Max when using the Manual Configuration approach. Reserving 8 ports is safe, since it

allows both lines to have two simultaneous calls with a port for RTP and RTCP.

Parameter Name

Description

Type

Default

Handle_VIA_received

If set to “yes”, the PHONE ADAPTER will process

the “received” parameter in the VIA header inserted

by the server in a response to any one of its

request. Else the parameter is ignored.

Bool

No

Handle_VIA_rport

If set to “yes”, the PHONE ADAPTER will process

the “rport” parameter in the VIA header inserted by

the server in a response to any one of its request.

Else the parameter is ignored.

Bool

No

Insert VIA received

Insert received parameter in VIA header in SIP

responses if received from IP and VIA sent-by IP

differ

Bool

No

Insert VIA rport

Insert rport parameter in VIA header in SIP

responses if received-from port and VIA sent-by

port differ

Bool

No

Substitute VIA addr

Use nat-mapped IP:port values in VIA header

Bool

No

Send Resp To Src Port

Send response to the request source port instead

of the VIA sent-by port

Bool

No

STUN Server

STUN server to contact for NAT mapping discovery

FQDN

STUN Enable

Enable the use of STUN to discover NAT mapping

Bool

No

STUN Test Enable

If enabled with <STUN Enable> = “yes” and a valid

<STUN Server>, the PHONE ADAPTER will

perform a NAT type discovery operation when first

power on by contacting the configured STUN

server. The result of the discovery will be reported

in a Warning header in all subsequent REGISTER

requests –

“Warning: 399 Phone Adapter <stun type>”, where

<stun type> is one of the following:

"Unknown NAT Type",

"STUN Server Not Reachable",

"STUN Server Not Responding",

"Open Internet Detected",

"Symmetric Firewall Detected",

"Full Cone NAT Detected",

"Restricted Cone NAT Detected",

"Symmetric NAT Detected";

If the PHONE ADAPTER detects Symmetric Nat or

Symmetric Firewall, Nat Mapping will be disabled

(that is, no substitution of IP address and port with

external IP address an nat-mapped port)

Bool

No

Ext IP

External IP address to substitute for the actual IP

address of the unit in all outgoing SIP messages. If

“0.0.0.0” is specified, no IP address substitution is

performed.

IP

0.0.0.0