Dеvice automatic update algorithm based on DHCP

Device automatic update algorithm is defined by the 'Parameters Priority from' value.

If the 'Static settings' value is selected, then the full path (including access protocol and server address) to configuration file and firmware file will be defined by 'Configuration File' and 'Firmware File' parameters. Full path should be specified in URL format:

<protocol>://<server address>/<path to file>, where

• <protocol> — protocol used for downloading corresponding files from the server;
• <server address> — address of the server with a file to be downloaded (domain name or IPv4);
• <path to file> — path to file on the server, the file must be in tar.gz extension.

You may use the following macro in URL (reserved words substituted with the specific values):

• $MA – MAC address — this macro in file URL is substituted by the native device MAC address;
• $SN – Serial number — this macro in file URL is substituted by the native device serial number;
• $PN – Product name — this macro in file URL is substituted by the model name (e.g, VP-12P);
• $SWVER — Software version — this macro in file URL is substituted by the firmware version number;
• $HWVER — Hardware version — this macro in file URL is substituted by the device hardware version number.

For MAC address, serial number and model name, see 'Device' section on the 'Monitoring' tab. 

URL examples:

tftp://download.server.loc/firmware.tar.gz,

http://192.168.25.34/configs/vp-17(p)/mycfg.tar.gz,

tftp://server.tftp/$PN/config/$SN.tar.gz,

http://server.http/$PN/firmware/$MA.tar.gz etc.

If the system is unable to extract the necessary file downloading parameters (protocol, server address or path to file on server) from configuration file or firmware file URL, it will attempt to extract an unknown parameter from DHCP Option 43 (Vendor specific info) or 66 (TFTP server) and 67 (Boot file name), when address obtaining via DHCP is enabled for the Internet service (DHCP option format and analysis will be provided below). If the system is unable to extract missing parameter from DHCP options, default value will be used:

• protocol: tftp;

• server address: update.local;

• configuration file name: $MAC.cfg;

• firmware file name: vp17.fw;

• Manifest file name: vp17.manifest.

Thus, if you leave 'Configuration File' and 'Firmware File' fields empty, and Options 43 or 66, 67 with file locations are not obtained via DHCP, configuration file URL will be as follows:

tftp://update.local/A8.F9.4B.00.11.22.cfg,

firmware file URL:

tftp://update.local/ vp17.fw;

Manifest file URL:

tftp://update.local/ vp17.manifest.

If 'DHCP options' value is selected, configuration file and firmware file URLs will be extracted from DHCP Option 43 (Vendor specific info) or 66 (TFTP server) and 67 (Boot file name), wherefore address obtaining via DHCP should be enabled for the Internet service (DHCP option format and analysis will be provided below). If DHCP options fail to provide some of the URL parameters, default parameter value will be used:

• protocol: tftp;

• server address: update.local;

• configuration file name: $MAC.cfg;

• firmware file name: vp17.fw;

• Manifest file name: vp17.manifest.

Option 43 format  (Vendor specific info)

1|<acs_url>|2|<pcode>|3|<username>|4|<password>|5|<server_url>|6|<config.file>|7|<firmware.file>|9|<manifest>

1 — TR-069 autoconfiguration server address code;

2 — 'Provisioning code' parameter specification code;

3 — code of the username for TR-069 server authorization;

4 — code of the password for TR-069 server authorization;

5 — server address code; server address URL should be specified in the following format: tftp://address or 
http://address. The first version represents TFTP server address, the second version – HTTP server address;

6 — configuration file name code;

7 — firmware file name code;

9 — Manifest file name code;

'|' — mandatory separator used between codes and suboption values.

Algorithm of identification for configuration file and firmware file URL parameters from DHCP Options 43 and 66

1. DHCP exchange initialization.
   Device initializes DHCP exchange after the startup.
   
   
2. Option 43 analysis.
   When Option 43 is received, codes 5, 6, 7 and 9 suboptions are analyzed in order to identify the server address and the configuration, firmware file, and Minifest file names.
   
   
3. Option 66 analysis.
   If Option 43 is not received from DHCP server or it is received but the system fails to extract the server address, Option 66 will be discovered. If the system fails to obtain the firmware file name, Option 67 will be discovered. They are used for TFTP server address and the firmware file path extraction respectively. Next, configuration and firmware files will be downloaded from Option 66 address via TFTP.

Special aspects of configuration updates

Configuration file should be in .tar.gz format (this format is used when configuration is saved from the web interface in the 'System' → 'Configuration Management' tab). Configuration downloaded from the server will be applied automatically and does not require device reboot.

Special aspects of firmware updates

Firmware file should be in .tar.gz format. When the firmware file is loaded, the device unpacks it and checks its version (using 'version' file in tar.gz archive).

If the current firmware version matches the version of the file obtained via DHCP, firmware will not be updated. Update is performed only when firmware versions are mismatched. The process of writing a firmware image to the device’s flash memory is indicated by the appearance of the 'Firmware update in progress...' screen on the phone display.