Auto-provisioning via Configuration File

  • Updated on Nov 21, 2023
Prev Next

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:


Please see the flow chart below:

图片.png

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.

To get the Autop configuration file template on Upgrade > Advanced > Automatic Autop interface.
图片.png

AutoP Schedule

Akuvox provides you with different AutoP methods that enable the device to perform provisioning for itself according to the schedule.

Path: Upgrade > Advanced > Automatic Autop interface.
图片.png

Parameters Set-up:

  • Mode: select “Power on”, if you want the device to perform Autop every time it boots up. Select “Repeatedly”, if you want the device to perform autop according to the schedule you set up. 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. Select “Hourly Repeat” if you want the device to perform Autop every hour.

  • Schedule: if “Repeatedly” is selected, you can set up the time schedule for the AutoP.

PNP Configuration

Plug and Play (PNP) is a combination of hardware and software support that enables a computer system to recognize and adapt to hardware configuration changes with little or no intervention by a user. 

Click here to watch the configuration video.

To do this configuration on web Upgrade > Advanced > PNP Option interface.
图片.png

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.

Navigate to Upgrade > Advanced > Manual Autop.
图片.png

Parameters Set-up:

  • URL: set up TFTP, HTTP, HTTPS, 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.

Note
  • 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)
Tip
  • Akuvox do not provide user specified server. Please prepare TFTP/FTP/HTTP/HTTPS server by yourself.

Integration via HTTP API

HTTP API is designed to achieve a network-based integration between the third-party device and the Akuvox device.

You can configure the HTTP API function on the web Security > HTTP API interface for the integration.
图片.png

Parameters Set-up:

  • Enabled: If the function is disabled any request to initiate the integration will be denied and be returned HTTP 403 forbidden status.

  • Authorization Mode: select among six options: “None”, “Normal”, “WhiteList” “Basic”, “Digest”, and “Token” for authorization type, which is explained in detail in the following chart.

  • User Name: enter the user name when “Basic” and “Digest” authorization mode is selected. The default user name is “admin”.

  • Password: enter the password when “Basic” and “Digest” authorization mode is selected.

  • 1st IP-5th IP: enter the IP address of the third party devices when the “White List” authorization is selected for the integration.

Please refer to the following description for the Authentication mode:

NO. Authorization Mode Description
1 None No authentication is required for HTTP API as it is only used for demo testing.
2 Normal This mode is used by Akuvox developers only.
3 Whitelist If this mode is selected, you are only required to fill in the IP address of the third-party device for the authentication. The whitelist is suitable for operation in the LAN.
4 Basic If this mode is selected, you are required to fill in the user name and the password for the authentication. In the Authorization field of the HTTP request header, use the Base64 encoding method to encode the username and password.
5 Digest The password encryption method only supports MD5. MD5( Message-Digest Algorithm) In the Authorization field of the HTTP request header: WWW-Authenticate: Digest realm="HTTP API",qop="auth,auth-int",nonce="xx", opaque="xx".
6 Token This mode is used by Akuvox developers only.