Auto-provisioning via Configuration File
  • 21 Nov 2024
  • Dark
    Light
  • PDF

Auto-provisioning via Configuration File

  • Dark
    Light
  • PDF

Article summary

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:


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 door phone to perform provisioning for itself at a specific time according to your schedule.

Set it up on the web System > Auto Provisioning > Automatic Autop interface.

  • Mode:

    • Power On: Allow the device to perform Autop every time it boots up.

    • Repeatedly: Allow the device to perform Autop according to the schedule.

    • Power On + Repeatedly: Combine Power On and Repeatedly modes, allowing the device to perform Autop every time it boots up or according to the schedule.

    • Hourly Repeat: Allow the device to perform Autop every hour.

  • Schedule: When Power On + Repeatedly mode is selected, you can select the specific day and time for the Autop.

  • Clear MD5: Used to compare the existing autop file with the autop file in the server, if the files are the same, then the provisioning will be stopped, thus avoiding unnecessary auto-provisioning.

Static Provisioning

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.

Download the Autop template on the System > Auto Provisioning > Automatic Autop.

Set the Autop server on System > Auto Provisioning > Manual Autop interface.

  • URL: The TFTP, HTTP, HTTPS, or FTP server address for the provisioning.

  • User Name: Set up a username if the server needs a username to be accessed.

  • Password: Set up a password if the server needs a password to be accessed.

  • Common AES Key: Set up AES code for the intercom to decipher the general Auto Provisioning configuration file.

  • AES Key(MAC): Set up the 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 does not provide a user-specified server. Please prepare the TFTP/FTP/HTTP/HTTPS server by yourself.

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 Custom Option as defined by users with option codes ranging from 128-255), you are required to configure DHCP Custom Option on the web interface.

Note
The Custom Option type must be a string. The value is the URL of the TFTP server.

Set up DHCP Autop with Power On mode and export Autop Template to edit the configuration.

Download the Autop template on the System > Auto Provisioning > Automatic Autop.

Set it up on System > Auto Provisioning > DHCP Option interface.

  • 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 to get the upgrade 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 a 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.

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.

Enable/disable it on the web System > Auto Provisioning > PNP Option interface.


Was this article helpful?

What's Next