You can configure and upgrade the device through the web interface using one-time or scheduled auto-provisioning with configuration files. This eliminates the need to set up configurations manually, saving you time and effort.
Provisioning Principle
Auto-provisioning is a feature used to configure or upgrade devices in batch via third-party servers. DHCP, PNP, TFTP, FTP, and HTTPS are the protocols used by the Akuvox devices to access the URL of the address of the third-party server which stores configuration files and firmware, which will then be used to update the firmware and the corresponding parameters on the device.
Please see the flow chart below:
.png)
Introduction to the Configuration Files for Auto-Provisioning
Configuration files for auto-provisioning come in two formats: general configuration files and MAC-based configuration files.
Differences:
General Configuration Provisioning:
A general configuration file is stored on a server, allowing all related devices to download the same file to update parameters.
MAC-Based Configuration Provisioning:
MAC-based configuration files are specific to individual devices, identified by their unique MAC addresses. Files named with the device's MAC address will be matched automatically before downloading for provisioning.
Note
Configuration files must be in CFG format.
The name of the general configuration file for batch provisioning varies by model.
The MAC-based configuration file is named after its MAC address.
Devices will first access general configuration files before the MAC-based ones if both types are available.
You may click here to see the detailed format and steps.
Autop Schedule
Akuvox provides you with different AutoP methods that enable the device to perform provisioning for itself according to the schedule.
To set up the schedule on the device web Upgrade > Advanced > Automatic Autop interface.
Please see the picture below:
Parameter Set-up:
- Power On: select Power on, if you want the device to perform Autop every time it boots up.
- Repeatedly: select Repeatedly, if you want the device to perform Autop according to the schedule you set up.
- Power On + Repeatedly: select Power On + Repeatedly if you want to combine Power On Mode and Repeatedly mode that will enable the device to perform Autop every time it boots up or according to the schedule you set up.
- Hourly Repeat: select Hourly Repeat if you want the device to perform Autop every hour.
DHCP Provisioning Configuration
Auto-provisioning URL can also be obtained using the DHCP option which allows the device to send a request to a DHCP server for a specific DHCP option code. If you want to use CustomOptionas defined by users with option codes ranging from 128-255), you are required to configure DHCP Custom Option on the web interface.
.png)
Note
The Custom Option type must be a string. The value is the URL of the TFTP server.
Navigate to Upgrade > Advanced interface.
- The custom Option type must be a string. The value is the URL of TFTP server.
Parameter Set-up:
- Custom Option: enter the DHCP code that matches the corresponding URL so that the device will find the configuration file server for the configuration or upgrading.
- DHCP Option 66: if none of the above is set, the device will automatically use DHCP Option 66 for getting the upgraded server URL. This is done within the software and the user does not need to specify this. To make it work, you need to configure the DHCP server for option 66 with the updated server URL in it.
- DHCP Option 43: if the device does not get an URL from DHCP Option 66, it will automatically use DHCP Option 43. This is done within the software and the user does not need to specify this. To make it work, you need to configure the DHCP server for option 43 with the updated server URL in it.
- The general configuration file for the in-batch provisioning is with the format cfg taking R29 as an example r000000000029.cfg (10 zeros in total), while the MAC- based configuration file for the specific device provisioning is with the format MAC_Address of the device.cfg, for example, 0C110504AE5B.cfg.
Static Provisioning Configuration
You can manually set up a specific server URL for downloading the firmware or configuration file. If an auto-provision schedule is set up, the device will perform the auto-provisioning at a specific time according to the auto provision schedule you set up. In addition, TFTP, FTP, HTTP, and HTTPS are the protocols that can be used for upgrading the device firmware and configuration.
Parameter Set-up:
- URL: set up TFTP, HTTP, HTTPS, and FTP server address for the provisioning.
- User Name: set up a user name if the server needs a user name to be accessed otherwise leave it blank.
- Password: set up a password if the server needs a password to be accessed otherwise leave it blank.
- Common AES Key: set up AES code for the intercom to decipher the general Auto Provisioning configuration file.
- AES Key (MAC): set up AES code for the intercom to decipher the MAC-based auto provisioning configuration file.
-
AES as one type of encryption should be configured only when the config file is encrypted with AES.
Server Address format:TFTP: tftp://192.168.0.19/
FTP: ftp://192.168.0.19/ (allows anonymous login)
ftp://username:password@192.168.0.19/(requires a user name and password)
HTTP: http://192.168.0.19/ (use the default port 80)
http://192.168.0.19:8080/ (use other ports, such as 8080)
HTTPS: https://192.168.0.19/ (use the default port 443)
- Akuvox does not provide user specified server. Please prepare TFTP/FTP/HHTP/HTTPS sever by yourself.