Automatic Update Parameters

Assigns an IP Interface (in the IP Interfaces table - see Configuring IP Network Interfaces) for the Auto-Update mechanism.

By default, the device uses the IPv4 OAMP interface.

For more information, see Assigning IP Interface for Auto-Update Mechanism.

Enables the Automatic Update mechanism for the cmp file.

Note: For the parameter to take effect, a device restart is required.

Defines the periodic interval (in seconds) between each automatic update. The count starts from a trigger for auto-update with the provisioning server.

The valid value range is 0 to 604,800. The default is 0 (i.e., disabled).

Note:

Defines the time of day at which the device performs automatic updates.

The format syntax of the parameter is 'hh:mm', where hh denotes the hour and mm the minutes. The value must be enclosed by a single quotation mark (e.g., '20:18'). The default is undefined (i.e., disabled).

Note:

Defines the maximum randomization interval (in seconds) for the daily scheduled automatic update (configured by the [AutoUpdatePredefinedTime] parameter). For example, if you configure the [AutoUpdatePredefinedTime] parameter to ‘13:00’ (i.e., 1 pm) and [AutoUpdatePredefinedRandomTime] to ‘300’ (i.e., 5 min.), the actual update can start anywhere between the time 13:00 and 13:05.

The valid value range 60 to 86400. The default is 300.

Note: The parameter is applicable only to the [AutoUpdatePredefinedTime] parameter.

Defines the file transfer timeout (minutes) for downloading a file from the provisioning server for automatic updates. If the download is not complete when this timeout expires, the device moves on to the next file in the Auto-Update file download queue.

The valid value range is 1 to 1000. The default is 10.

Enables the device to gracefully lock for the Automatic Update feature when updating the ini configuration file. When the file is downloaded from the provisioning server, the device gracefully locks. During this graceful period (configured by the [AdminStateLockControl] ini file parameter), no new calls are accepted. If all existing calls end before the timeout expires, the device locks and applies the settings of the file. If there are still existing calls when the timeout expires, the device terminates them and applies the settings of the file. For more information, see Applying Downloaded ini File after Graceful Timeout.

Defines the information that is included in the HTTP User-Agent header in HTTP Get requests sent by the device to the provisioning server for the Automatic Update mechanism.

The valid value is a string of up to 511 characters. The information can include any user-defined string or the following case-sensitive, string variable tags (placeholders):

The device automatically populates these variables with actual values in the sent User-Agent header. If not configured (default), the device sends the following information in the User-Agent header:

User-Agent: Mozilla/4.0 (compatible; AudioCodes; <product name>;<software version>;<MAC address>;<configuration version>)

For example, if you configure the parameter to AupdHttpUserAgent = MyWorld-<NAME>;<VER>(<MAC>), the device sends the following User-Agent header:

User-Agent: MyWorld-Mediant;7.40A.500.966; 00:90:8f:5b:10:35;0

Note:

Defines the filename and path (URL) to the provisioning server from where the software file (.cmp) can be downloaded, based on timestamp for the Automatic Updated mechanism.

The valid value is an IP address in dotted-decimal notation or an FQDN.

Enables the Automatic Update mechanism to verify the TLS certificate received from the provisioning server when the connection is HTTPS.

Defines the username and password for digest (MD5 cryptographic hashing) and basic access authentication with the HTTP server on which the files to download are located for the Automatic Update feature.

The valid value is a string of up to 128 characters. The syntax is 'username:password' (e.g., 'joe:1234'). By default, no value is defined.

Note: The device only uses the username and password configured by this parameter if no username and password has been configured for the parameter used to configure the URL of the server with the name of the file, for example, [CmpFileURL].

Enables the device to perform cyclic redundancy checks (CRC) on downloaded configuration files during the Automatic Update process. The CRC checks whether the content (raw data) of the downloaded file is different to the content of the previously downloaded file from the previous Automatic Update process. The device compares the CRC check value (code) result with the check value of the previously downloaded file. If the check values are identical, it indicates that the file has no new configuration settings, and the device discards the file. If the check values are different, the device installs the downloaded file and applies the new configuration settings.

Defines the size of the TFTP data blocks (packets) when downloading a file from a TFTP server for the Automatic Update mechanism. This is in accordance to RFC 2348. TFTP block size is the physical packet size (in bytes) that a network can transmit. When configured to a value higher than the default (512 bytes), but lower than the client network’s Maximum Transmission Unit (MTU), the file download speed can be significantly increased.

The valid value is 512 to 8192. The default is 512.

Note:

Defines the password used to protect (encrypt) the Configuration Package file when it's uploaded to the device using the Automatic Update feature (see the configuration-pkg command below). If the file is not password-protected, then ignore this command.

Note: The password configured by this command is also used for protecting (encrypting) the Configuration Package file when downloading it from the device through SFTP.

Invokes an immediate device restart. This option can be used to activate offline (i.e., not on-the-fly) parameters that are loaded using the [IniFileUrl] parameter.

Note: If you use the parameter in an ini file for periodic automatic provisioning with non-HTTP (e.g., TFTP) and without CRC, the device restarts upon every file download.

Defines the name of the cmp file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password (username:password) for access authentication with the server can also be configured.

Example syntax:

'http://192.168.0.1/<filename>'
'https://<username>:<password>@<IP address>/<file name>'

Note:

Defines the name of the ini file (configuration) and the URL address (IP address or FQDN) of the server where the file is located. Parameters that are not included in the ini file are restored to default settings. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Example syntax:

'http://192.168.0.1/<filename>'
'http://192.8.77.13/config_<MAC>.ini'
'https://<username>:<password>@<IP address>/<filename>'

Note:

Defines the name of the incremental ini file (configuration) and the URL address (IP address or FQDN) of the server where the file is located. Parameters that are not included in the ini file remain at their current settings. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Example syntax:

'http://192.168.0.1/<filename>'

'http://192.8.77.13/config_<MAC>.ini'

'https://<username>:<password>@<IP address>/<filename>'

Note:

Defines the URL of the server where the CLI Script file containing the device's configuration is located. This file is used for automatic provisioning. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Note: The case-sensitive string, "<MAC>" can be used in the URL path and filename, which is automatically replaced with the device's MAC address. For more information, see MAC Address Placeholder in Configuration File Name.

Defines the URL address of the server where the CLI Startup Script file containing the device's configuration is located. This file is used for automatic provisioning. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Note:

Defines the name of the Configuration Package file (.7z) and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

For example:

ConfPackageURL = 'http://www.corp.com/ConfBackupPkg5967925.7z'

For more information on the Configuration Package file, see Downloading and Uploading the Configuration Package File.

Note:

Defines the name of the Prerecorded Tones (PRT) file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Example syntax:

'http://<server_name>/<filename>'
'https://<server_name>/<filename>'

Note:

Defines the name of the Call Progress Tone (CPT) file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Example syntax:

'http://<server_name>/<filename>'
'https://<server_name>/<filename>'

Note:

Defines the name of the Voice Prompts file and the URL address (IP address or FQDN) of the server on which the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Example syntax:

'http://<server_name>/<filename>'
'https://<server_name>/<filename>'

Note:

Defines the name of the CAS file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Example syntax:

'http://<server_name>/<filename>'
'https://<server_name>/<filename>'

Note:

Defines the name of the Dial Plan file (.csv) and the URL address of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<filename>') for access authentication with the server can also be configured.

Note:

Defines the name of the TLS trusted root certificate file and the URL address of the server where the file is located (e.g., tftp://172.17.116.216/Trust.pem). Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Note:

Defines the name of the TLS trusted root certificate file and the URL address of the server where the file is located (e.g., tftp://172.17.116.216/Trust.pem). Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured. The parameter adds the file to any existing trusted root certificate file (i.e., incremental file upload).

Note:

Defines the name of the TLS certificate file and the URL address of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Note:

Defines the URL address of the server on which the TLS private key file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

Note:

Defines the name of the Gateway User Information file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured. For example:

'https://www.company.com/GW-User_Info.csv'

Note: You can use the placeholder string "<MAC>" (case-sensitive) in the URL path and filename, which the device replaces with its MAC address. For more information, see MAC Address Placeholder in Configuration File Name.

Defines the name of the SBC User Information file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured. For example:

'https://www.company.com/SBC-User-Info.csv'

Note:

Defines the name of the User Information file and the URL address (IP address or FQDN) of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<file name>') for access authentication with the server can also be configured.

The maximum length of the URL address is 99 characters.

Example syntax:

'http://<server_name>/<filename>'
'https://<server_name>/filename>'

Note:

Defines the name of the License Key file and the URL address of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<filename>') for access authentication with the server can also be configured.

Note:

Defines the URL address in the File Template for automatic updates, of the provisioning server where the files to download are located. Optionally, the username and password ('https://username:password@10.1.1.1/<filename>') for access authentication with the server can also be configured.

For more information, see File Template for Automatic Provisioning.

Note:

Defines the list of file types in the File Template for automatic updates, to download from the provisioning server.

For more information, see File Template for Automatic Provisioning.

Defines the name of the favicon image file and the URL address of the server where the file is located. This is used for the Automatic Update feature.

For more information, see Customizing the Favicon.

Note:

Defines the name of the SBC Wizard configuration template file and the URL address of the server where the file is located. Optionally, the username and password ('https://username:password@10.1.1.1/<filename>') for access authentication with the server can also be configured.

Note:

Defines a configuration table as a Comma-Separated Values (CSV) file and the URL address of the server where the file is located.

The filename must include the name of the configuration table, for example:

MatrixCsvFileUrl = 'http://www.corp.com/device_IPGroup.cvs'

You can also include in the filename the string variable tag "MAC" (case-sensitive), which the device automatically replaces with its MAC address, for example:

MatrixCsvFileUrl = 'http://www.corp.com/device_<MAC>_IPGroup.cvs'

Note: