Linksys ATA

Administrator Guide

Document Version 3.1

Chapter 3

Configuring Linksys ATAs

Provisioning

Reboot URL

The Reboot URL lets you reboot the Linksys ATA.

Note

The Linksys ATA reboots only when it is idle.

The Reboot URL is http://spa-ip-addr/admin/reboot.

Provisioning

This section describes the provisioning functionality of the Linksys ATA. This section includes the

following topics:

•

Provisioning Capabilities, page 3-4

•

Configuration Profile, page 3-4

For detailed information about provisioning the Linksys ATA, refer to the

Linksys SPA Provisioning

Guide.

Provisioning Capabilities

The Linksys ATA provides for secure provisioning and remote upgrade. Provisioning is achieved

through configuration profiles transferred to the device via TFTP, HTTP, or HTTPS.

The Linksys ATA can be configured to automatically resync its internal configuration state to a remote

profile periodically and on power up. The automatic resyncs are controlled by configuring the desired

profile URL into the device.

The Linksys ATA accepts profiles in XML format, or alternatively in a proprietary binary format, which

is generated by a profile compiler tool available from Linksys. The Linksys ATA supports up to 256-bit

symmetric key encryption of profiles. For the initial transfer of the profile encryption key (initial

provisioning stage), the Linksys ATA can receive a profile from an encrypted channel (HTTPS with

client authentication), or it can resync to a binary profile generated by the Linksys-supplied profile

compiler. In the latter case, the profile compiler can encrypt the profile specifically for the target Linksys

ATA, without requiring an explicit key exchange.

Remote firmware upgrade is achieved via TFTP or HTTP (firmware upgrades using HTTPS are not

supported). Remote upgrades are controlled by configuring the desired firmware image URL into the

Linksys ATA via a remote profile resync.

For further information about remote provisioning refer to the

Linksys SPA Provisioning Guide

.

Configuration Profile

The Linksys ATA configuration profile can be either an XML file or a binary file with a proprietary

format.

The XML file consists of a series of elements (one per configuration parameter), encapsulated within

the element tags <flat-profile> … </flat-profile>. The encapsulated elements specify values for

individual parameters. Here is an example of a valid XML profile:

<flat-profile>

<Admin_Passwd>some secret</Admin_Passwd>

Linksys ATA

Administrator Guide

Document Version 3.1

Chapter 3

Configuring Linksys ATAs

Configuring a Dial Plan

<Upgrade_Enable>Yes</Upgrade_Enable>

</flat-profile>

Binary format profiles contain Linksys ATA parameter values and user access permissions for the

parameters. By convention, the profile uses the extension .cfg (for example, spa2102.cfg). The Linksys

Profile Compiler (SPC) tool compiles a plain-text file containing parameter-value pairs into a properly

formatted and encrypted .cfg file. The SPC tool is available from Linksys for the Win32 environment

and Linux-i386-elf environment. Requests for SPC tools compiled on other platforms are evaluated on

a case-by-case basis. Please contact your Linksys sales representative for further information about

obtaining the SPC tool.

The syntax of the plain-text file accepted by the profile compiler is a series of parameter-value pairs,

with the value in double quotes. Each parameter-value pair is followed by a semicolon. Here is an

example of a valid text source profile for input to the SPC tool:

Admin_Passwd

“some secret”;

Upgrade_Enable “Yes”;

Refer to the

Linksys SPA Provisioning Guide

for further details.

The names of parameters in XML profiles can generally be inferred from the Linksys ATA configuration

Web pages, by substituting underscores (_) for spaces and other control characters. Further, to

distinguish between Lines 1, 2, 3, and 4, corresponding parameter names are augmented by the strings

_1_, _2_, _3_, and _4_. For example, Line 1 Proxy is named Proxy_1_ in XML profiles.

Parameters in the case of source text files for the SPC tool are similarly named, except that to

differentiate Line 1, 2, 3, and 4, the appended strings ([1], [2], [3], or [4]) are used. For example, the

Line 1 Proxy is named Proxy[1] in source text profiles for input to the SPC.

Configuring a Dial Plan

The Linksys ATA allows each line to be configured with a distinct dial plan. The dial plan specifies how

to interpret digit sequences dialed by the user, and how to convert those sequences into an outbound dial

string.

The Linksys ATA syntax for the dial plan closely resembles the corresponding syntax specified by

MGCP and MEGACO. Some extensions are added that are useful in an end-point.

Note

When using the SPA3102 or AG310 as a PSTN gateway, gateway calls can be restricted on a per-caller

basis using dial plans. Up to eight dial plans can be configured to restrict gateway calls in either

direction.

Dial Plan Digit Sequences

The plans contain a series of digit sequences, separated by a vertical bar ( | ). The collection of sequences

is enclosed in parentheses.

When a user dials a series of digits, each sequence in the dial plan is tested as a possible match. The

matching sequences form a set of candidate digit sequences. As more digits are entered by the user, the

set of candidates diminishes until only one or none are valid.

Any one of a set of terminating events triggers the Linksys ATA to either accept the user-dialed sequence

and transmit it to initiate a call, or else to reject it as invalid. The terminating events are as follows:

•

No candidate sequences remain—The number is rejected.

Linksys ATA

Administrator Guide

Document Version 3.1

Chapter 3

Configuring Linksys ATAs

Configuring a Dial Plan

•

Only one candidate sequence remains, and it has been matched completely—The number is

accepted and transmitted after any transformations indicated by the dial plan, unless the sequence

is barred by the dial plan, in which case the number is rejected.

•

A timeout occurs—The digit sequence is accepted and transmitted as dialed if incomplete, or

transformed as per the dial plan if complete.

•

An explicit “send” (user presses the # key)—The digit sequence is accepted and transmitted as

dialed if incomplete, or transformed as according to the dial plan if complete.

The time-out duration depends on the matching state. If no candidate sequences are as yet complete (as

dialed), the Interdigit_Long_Timeout applies. If a candidate sequence is complete, but there exists one

or more incomplete candidates, then the <Interdigit_Short_Timeout> applies.

The following table describes the entries to use when programming the dial plan.

Note

Early production versions of the SPA2102 supported dual-line telephones on a single FXS port. A

subsequent hardware change revised the FXS ports on the SPA2102 and this function is to be reserved

for future development.

Dial Plan Rules

This section describes the rules that apply to configuring and interpreting dial plans.

Note

White space is ignored, but may be used for readability.

Digit Sequence Syntax

Each digit sequence within the dial plan consists of a series of elements, which are individually matched

to the keys pressed by the user. Elements can be one of the following:

•

Individual keys 0, 1, 2 . . . 9, *, #.

•

The letter x matches any one numeric digit (0 .. 9)

•

A subset of keys within brackets (allows ranges): for example, [389] means 3 or 8 or 9)

Numeric ranges (

n

-

n

) are allowed within the brackets: for example, [2-9] means any digit from

2 through 9)

Table 1-26

Dial Plan Entries

Dial Plan Entry

Function

*xx

Allows arbitrary 2-digit star code

[3469]11

Allows x11 sequences (for example, 311, 411, 611, 911)

0

Dials operator

00

Dials international operator

[2-9]xxxxxx

Dials US local number

1xxx[2-9]xxxxxx

Dials US 1 + 10-digit long distance number

xxxxxxxxxx.

Dials all other numbers, including international long distance

Linksys ATA

Administrator Guide

Document Version 3.1

Chapter 3

Configuring Linksys ATAs

Configuring a Dial Plan

Ranges can be combined with other keys: e.g. [235-8*] means 2 or 3 or 5 or 6 or 7 or 8 or *.

Element Repetition

Any element can be repeated zero or more times by appending a period (.) to the element. Thus, “01.”

matches “0”, “01”, “011”, “0111”, … and so on.

Sub-sequence Substitution

A sub-sequence of keys (possibly empty) can be automatically replaced with a different sub-sequence

using an angle bracket notation: < dialed-subsequence : transmitted-subsequence >. So, for example,

“<8:1650>xxxxxxx” would match “85551212” and transmit “16505551212”.

Inter-sequence Tones

An “outside line” dial tone can be generated within a sequence by appending a comma (,) between digits.

Thus, the sequence “9, 1xxxxxxxxxx” sounds an “outside line” dial tone after the user presses 9, until

the 1 is pressed.

Number Barring

A sequence can be barred (rejected) by placing a ! character at the end of the sequence. Thus,

“1900xxxxxxx!” automatically rejects all 900 area code numbers from being dialed.

Interdigit Timer Master Override

The long and short interdigit timers can be changed in the dial plan (affecting a specific line) by

preceding the entire plan with the following syntax:

•

Long interdigit timer: L : delay-value ,

•

Short interdigit timer: S : delay-value ,

Thus, “L:8,( . . . )” would set the interdigit long timeout to 8 seconds for the line associated with this

dial plan. And, “L:8,S:4,( . . . )” would override both the long and the short time-out values.

Local Timer Overrides

The long and short time-out values can be changed for a particular sequence starting at a particular point

in the sequence. The syntax for long timer override is: L delay-value<space>. Note the terminating space

character. The specified delay-value is measured in seconds. Similarly, to change the short timer

override, use: S delay-value<space>.

Pause

A sequence may require an explicit pause of some duration before continuing to dial digits, in order for

the sequence to match. The syntax for this is similar to the timer override syntax: P delay-value <space>.

The delay-value is measured in seconds.

Linksys ATA

Administrator Guide

Document Version 3.1

Chapter 3

Configuring Linksys ATAs

Configuring a Dial Plan

This syntax allows for the implementation of Hot-Line and Warm-Line services. To achieve this, one

sequence in the plan must start with a pause, with a 0 delay for a Hot Line, and a non-zero delay for a

Warm Line.

Implicit Sequences

The Linksys ATA implicitly appends the vertical code sequences entered in the administration web

server Regional parameter settings to the end of the dial plan for both Line 1 and Line 2. Likewise, if

<Enable_IP_Dialing> is enabled, then IP dialing is also accepted on the associated line.

Dial Plan Examples

The following dial plan accepts only US-style 1 + area-code + local-number, with no restrictions on the

area code and number:

( 1 xxx xxxxxxx )

The following also allows 7-digit US-style dialing, and automatically inserts a 1 + 212 (local area code)

in the transmitted number.

( 1 xxx xxxxxxx | <:1212> xxxxxxx )

For an office environment, the following plan requires a user to dial 8 as a prefix for local calls and 9 as

a prefix for long distance. In either case, an “outside line” tone is played after the initial 8 or 9, and

neither prefix is transmitted when initiating the call.

( <9,:> 1 xxx xxxxxxx | <8,:1212> xxxxxxx )

The following allows only placing international calls (011 call), with an arbitrary number of digits past

a required 5 digit minimum, and also allows calling an international call operator (00). In addition, it

lengthens the default short interdigit timeout to 4 seconds.

S:4, ( 00 | 011 xxxxx x. )

The following allows only US-style 1 + area-code + local-number, but disallows area codes and local

numbers starting with 0 or 1. It also allows 411, 911, and operator calls (0).

( 0 | [49]11 | 1 [2-9]xx [2-9]xxxxxx )

The following allows US-style long distance, but blocks 9xx area codes:

( 1 [2-8]xx [2-9]xxxxxx )

The following allows arbitrary long distance dialing, but explicitly blocks the 947 area code.

( 1 947 xxxxxxx ! | 1 xxx xxxxxxx )

The following implements a hot line phone, which automatically calls 1 212 5551234.

( S0 <:12125551234> )

The following provides a warm line to a local office operator (1000) after five seconds, unless a

four-digit extension is dialed by the user.

( P5 <:1000> | xxxx )