A-Series Provisioning

Overview

Sangoma A-Series phones may be provisioned one one of three ways:

Local phone user interface
Phone web user interface
Remote configuration retrieval

First Boot

At initial boot, the phone will:

Attempt to retrieve its IP address from a DHCP server
Attempt to set its VLAN ID based on learned VLAN from LLDP-MED
Present the User with a language selection screen
Attempt to retrieve its configuration as directed by DHCP Option 66.

Configuration Retrieval

Sangoma phones can be directed to an HTTP, HTTPs, FTP, or TFTP host via DHCP Option 66. FTPs is not supported.

Here is a typical DHCP daemon configuration specifying Option 66:

Example DHCP daemon configuration specifying Option 66

Notice in this example the option:

option boot-server "http://server.example.com/phoneprov/";

That directive, option boot-server, tells phones to contact the server http://server.example.com/proneprov/ for their configuration files.

The phone will, upon receipt of the Option 66 option boot-server parameter, attempt to use its cURL application to retrieve, from the specified path, its configuration file. The phone will attempt to retrieve two files, a common configuration file, that contains settings that can apply to more than one phone, and a device configuration file, that contains settings that apply to only one phone. If the phone fails to retrieve the files, it will make 4 more attempts, and then stop. The successful retrieval of files will stop the process, as the phone will load the files and startup using the specified settings.

The common configuration files that will be retrieved are, per model:

Model	Common File

Model	Common File
A20	f0A20hw1.100.cfg
A22	f0A22hw1.100.cfg
A25	f0A25hw1.100.cfg
A30	A0V0A3000000.cfg

Following its attempts to retrieve the common configuration file, the phone will attempt to retrieve a device configuration file that is defined as:

<mac.cfg>, the MAC address of the phone, in all lower-case characters, dot cfg.

HTTPd logs will resemble:

10.1.2.3 - - [20/Feb/2018:09:47:51 -0600] "GET /phoneprov/f0A25hw1.100.cfg HTTP/1.1" 200 196 "-" "Asterisk A25 2.3.2.4652 000fd3000000"
10.1.2.3 - - [20/Feb/2018:09:47:51 -0600] "GET /phoneprov/000fd3000000.cfg HTTP/1.1" 200 213 "-" "Asterisk A25 2.3.2.4652 000fd3000000"

If you see the phone making multiple GET requests for a file, it is because the phone was not able to successfully retrieve and/or parse the first file.

If the configuration file does not include a Version identifier in its first line, the phone will not parse it successfully.

Firmware Management

Sangoma A-Series phones may have their firmware managed via the phone web UI or by remote retrieval. Remote retrieval, as a part of the phone's configuration file, is controlled with the AUTOUPDATE CONFIG MODULE configuration section with the Auto Image Url configuration parameter , e.g.

<<VOIP CONFIG FILE>>Version:2.0000000000
   
<AUTOUPDATE CONFIG MODULE>
Auto Image Url     :http://server.example.com/phoneprov/myfirmware.z
<<END OF FILE>>

Remote Restart

Sangoma A-Series phones, by default, are configured not to remotely restart upon receipt of the check-sync Event in a SIP NOTIFY. This behavior must be enabled, and is controlled with the SIP CONFIG MODULE configuration section with the Notify Reboot configuration parameter, e.g.:

To test, the SIPp test tool can be used with the following scenario file:

SIPp Reconfigure checksync.xml

to programmatically restart Sangoma phones like:

where 10.1.2.3 represents the IP address of the phone to be restarted.

Option 60

Sangoma phones can present Option 60, Vendor class identifier, when communicating with a DHCP service. But, they do not do it by default. The option must be enabled in the phone's configuration, e.g.:

Phones