TIPTEL IP 280 User manual

1
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
Auto Provision Manual

2
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
Contents
Contents .................................................................................................................................................................................2
1.1 Summary........................................................................................................................................................................3
2.1 Obtain the server address .......................................................................................................................................3
2.1.1 Pushed by PnP servers..................................................................................................................................3
2.1.2 Detect DHCP custom option. ......................................................................................................................4
2.1.3 Detect DHCP Option 66................................................................................................................................4
2.1.4 Detect DHCP Option 43................................................................................................................................4
2.1.5 Detect the phone flash. ................................................................................................................................5
2.2 Download configuration files ..................................................................................................................................6
2.3 Resolve and apply the configurations .................................................................................................................7
2.4 Do other updates ........................................................................................................................................................ 8
Appendix A .......................................................................................................................................................................... 11
1. Description of configuration parameters in CFG file............................................................................ 11
2.5 Configure the Expansion Module via Auto Provisioning .............................................................................30

3
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
1.1 Summary
The presented document will show you how auto provision works and how to make auto provision work.
The process of a successful auto provision is:
1. Obtain a server address in which store the configuration files.
2. Download the configuration files from the configured server.
3. Resolve and apply the configurations written in the configuration file.
4. Do other updates, for example the firmware updating.
2.1 Obtain the server address
When the phone boots up, it will go by the following process to try to obtain the server address:
PnP server DHCP custom option DHCP option 66 DHCP option 43 Phone Flash
The following are the details of each process:
2.1.1 Pushed by PnP servers
Note Plug „n Play (PnP) provides a proprietary method to enable "Auto Provisioning". When PnP
config is Enabled, the phone will send SIP SUBSCRIBE messages to a multicast address. Any SIP
server understanding that message may reply with a SIP NOTIFY message containing the Auto

4
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
Provisioning Server URL where the phones can request their configuration. Modern SIP PBXs/Proxies
can provide the PnP configuration data. Please refer to the manual of your PBX/Proxy. This kind of auto
provision is mainly used under some possible circumstance like your phones have no default
provisioning server set and are not able to detect DHCP options (when the they use static IP address).
Pay attention to the point that PnP config has the highest priority in obtaining the provisioning server
address and if it fails to get any information from PnP servers, it won‟t go to other processes.
2.1.2 Detect DHCP custom option.
It must be configured to the phone by web management:
Note: A valid Custom Option is from 128 to 254. The Custom Option Type must be in accordance
with the one defined in the DHCP server. If the phone fails to get any information from custom option,
it will go to detect DHCP Option 66.
2.1.3 Detect DHCP Option 66.
Tiptel phones will check this option by default. If the phone fails to get any information from DHCP
Option 66, it will go to detect DHCP Option 43.
2.1.4 Detect DHCP Option 43.
Tiptel phones will check this option by default. If the phone fails to get any information from DHCP
Option 43 and Check New Config is not Disabled, it will go to detect the phone flash.

5
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
2.1.5 Detect the phone flash.
The value is what you can read from the web management of the phone:
Note: This process depends on the setting of Check New Config and if it is set to be Disabled, the
phone won‟t detect the FLASH. The supported protocols of a URL are: HTTP/HTTPS/FTP/TFTP.
Account and Password will be used to access to the URL if required. FTP server always has this
requirement. For example, the following settings will make the phone access to FTP server
192.168.0.231, using account Vin and Passwords 123 (on the web it is hid by 3 black points). If the
phone fails to get any information from phone flash, the current round of obtaining server address will
stop here.

6
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
2.2 Download configuration files
There are 2 configuration files both of which are CFG formatted that the phone will try to download from
the server. We call them Common CFG file and Phone-specific CFG file. The Common CFG file will be
effectual for all the phones of the right model. However, a Phone-specific CFG file will only be effectual for
one specific phone which can be tell by its MAC address. A common CFG file has a fixed name for each
model while a Phone-specific CFG file is named after a MAC address of a specific phone. The names of the
Common CFG file for each model are:
tiptel IP 286: y000000000000.cfg
tiptel IP 284: y000000000004.cfg
tiptel IP 280: y000000000007.cfg
There are 11 zeros between the letter y and the last number. The last number is decided by the hardware
version of the relevant model, for it is the first number of the hardware version of the model. For instance,
for a tiptel IP 286 whose MAC address is 001565113af8, the 2 configuration files for it will be:
y000000000000.cfg and 001565113af8.cfg.
To have this name division on configuration files will help when doing same auto provision to mass phones.
For example, assumed that you have 1000 pieces of tiptel IP 286 and you want to update firmware for all
phones, you just need to prepare only one y000000000000.cfg in which defines the firmware update
request, then put it onto the provisioning server.
Note: In case that the phone is on a live call, it will keep on asking for the CFG files with an interval of 30
seconds for up to 2 hours.

7
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
2.3 Resolve and apply the configurations
If the downloaded configuration files have been AES encrypted, the specified keys will be needed. The
Specified AES Key is for decrypting the Common CFG file. The Per-phone AES Key is for decrypting the
Phone-specific CFG file. The keys must be 16 bytes and the supported characters are: 0 ~ 9, A ~ Z, a ~
z and the following special characters: # $ % * + , - . : = ? @ [ ] ^ _ { } ~
In a CFG file, there are texts defining configurations. Here‟s a brief description to the texts. Take the
AES_KEY section in the following picture for example.

8
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
The following texts are system-defined that cannot be changed manually; otherwise it will cause a failure
to auto provision:
1. The section header [AES_KEY]
2. The directory of the section path = /config/Setting/autop.cfg
3. The parameters aes_key_16 and aes_key_16_mac
You can only specify a valid value after the equal sign “=”. This is a section for specifying the AES keys. So
you can make it like follow to specify 1234567890123456 for both Specified AES Key and Per-phone
AES Key:
[ AES_KEY ]
path = /config/Setting/autop.cfg
aes_key_16 = 1234567890123456
aes_key_16_mac =1234567890123456
The lines start with # are instructions, they don‟t make any sense to the configuration, just for easy
understanding when read by a person. For the detailed instruction of the parameters written in the CFG
files, please refer to the Appendix A.
Note: If the phone finds that the downloaded CFG files are completely the same as it is applied the very
last time, the auto provision will stop here. The phone knows it by comparing the MD5 value of the
downloaded CFG files and the latest applied CFG files.
2.4 Do other updates
It depends on the texts written in the CFG files to decide whether to make other updates. There are mainly
the following other updates:
1. The section defining request for ringtone update in the CFG files:
###############################################################
########################
[ ringtone ]
path = /tmp/download.cfg

9
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
server_address =
###############################################################
########################
The server_address must link to a .wav file. The wav file should not be larger than 100kB.
For example: ftp://Vin:[email protected].0.231/Ring20.wav
2. The section defining request for language update in the CFG files:
###############################################################
########################
[ Lang ]
path = /tmp/download.cfg
server_address =
###############################################################
########################
The server_address must be like serverAddress/lang-*.txt. For example:
http://192.168.0.231/provision/lang-Dutch.txt
And note that it does not enable you to add new languages. It just enables you to modify the existed
languages. Currently in TIPTEL IP 286, there are lang-English.txt, lang-Chinese_S.txt, lang-Chinese_T.txt,
lang-Russian.txt, lang-Turkey.txt, lang-spanish.txt, lang-Dutch.txt, lang-Hebrew.txt, lang-Italian.txt
3. The section defining request for contacts update in the CFG files:
###############################################################
########################
[ ContactList ]
path = /tmp/download.cfg
server_address =
###############################################################
########################
An example of server_address: http://192.168.0.132:9/provision/contactData1.xml
Note that the name has to be contactData1.xml.
The format of the XML file is different from the file which you use in “remote phone book”. It‟s the same
as the “Local phone book”. You can export an existed local phone book to see what the format is exactly.
4. The section defining request for firmware update in the CFG files:
###############################################################
########################
[ firmware ]
path = /tmp/download.cfg
server_type =
server_ip =
server_port =
login_name =
login_pswd =
http_url =
firmware_name =
###############################################################
########################

10
www.tiptel.nl
Tiptel b.v.
Camerastraat 2
1336 BC Almere
Tel: [phone]
Fax: [phone]
An example:
[ firmware ]
path = /tmp/download.cfg
server_type = ftp
server_ip = 192.168.0.231
server_port = 21
login_name = Vin
login_pswd = 123
http_url = http://192.168.0.231/
firmware_name = 0.0.0.143.rom
The above section will make the phone access to ftp server 192.168.0.231, using port 21, user name “Vin”
and password “123” to download the 0.0.0.143.rom. And if the server_type = http, it will go to
http://192.168.0.231/ to download the 0.0.0.143.rom and then update.