Contents x
      Auto-provisioning via Configuration File
      • 21 Nov 2023
      • Print
      • Dark
        Light
      • PDF
      Contents

      Auto-provisioning via Configuration File

      • Updated on 21 Nov 2023
      • Print
      • Dark
        Light
      • PDF
      Article Summary

      You can configure and upgrade the door phone on the web interface via one-time auto- provisioning and scheduled auto-provisioning via configuration files, thus saving you from setting up configurations needed one by one manually on the door phone.

      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 have two formats for auto-provisioning. One is the general configuration files used for the general provisioning and the other one is the MAC-based configuration provisioning.

       The difference between the two types of configuration files is shown below:

      •  General configuration provisioning: a general file is stored in a server from which all the related devices will be able to download the same configuration file to update parameters on the devices, such as cfg.
      • MAC-based configuration provisioning: MAC-based configuration files are used for auto-provisioning on a specific device, as distinguished by its unique MAC number. The configuration files named with the device MAC number will be matched automatically with the device MAC number before being downloaded for provisioning on the specific device.
      Note
      • The configuration file should be in CFG format.
      • The general configuration file for the in-batch provisioning varies by model.
      • The MAC-based configuration file for the specific device provisioning is named by its MAC address.
      • If a server has these two types of configuration files, devices will first access the general configuration files before accessing the MAC-based configuration files.
      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.

      image.png

      Parameter 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 which 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.

      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 TFTP server.

      Navigate to Upgrade > Advanced Interface.

      image.png

      Parameter set-up:

      • Custom Option: enter the DHCP code that matched 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 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 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.
      Note:
      • The general configuration file for the in-batch provisioning is with the format "r0000000000xx.cfg". Take R29 as an example, its format is "r000000000029.cfg" (10 zeros in total). 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.

      To download the Autop template on Upgrade > Advanced > Automatic Autop, and set up Autop server on Upgrade > Advanced > Manual Autop interface.

      automatic auto1.png

      image.png

      Parameter 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 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.
      Was this article helpful?
      What's Next
      Akuvox is a global leading provider of Smart Intercom products and solutions. We are committed to unleashing the power of technologies to improve people's lives with better communication, greater security and more convenience.
      Products
      Support
      Company
      Follow Us
      © Copyright 2012-2020 Akuvox (Xiamen) Networks Co., Ltd. All rights Reserved