Reference:Configuration/General/Update: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The '''update''' server is used for efficient administration of various VoIP devices. The update server reads a file at intervals from a configurable URL (Uniform Resource Locator).
On this page the device can be configured to poll an update server (a normal web server). A file pointed to by an URL is read from the update server and executed. This is an efficient mechanism to keep a large number of devices up to date. See [[Reference:Update Server]] for a detailed description of the available commands.


* '''Command File URL:'''
{|
<blockquote>
|valign=top nowrap=true|'''URL'''
An URL, for example http://192.168.0.1/update/script-ip800.txt, pointing to a file whose commands are executed.<br>
|An URL, for example <nowiki>http://192.168.0.1/update/script-ip800.txt</nowiki>, pointing to a file whose commands are executed.
If the URL ends with a slash (/), for example http://192.168.0.1/update/, the device is adding the file name update-ipxxx.htm automatically, deduced from the device short name (for example update-ip800.htm).<br>
Furthermore the placeholder #h and #m can be used in the URL-String:
* #h - will be replaced by the device short name (for example IP800).
* #m - will be replaced by the device mac-adress (for example 00-90-33-01-02-03).
These placeholders may be used e.g. to address a device-specific directory (http://192.168.1.2/update/#h/script.txt) or to generate HTTP-GET parameters (http://192.168.0.1/update/script.php?mac=#m).<br>
If the directory of the file is password-protected, the access credentials must be specified in the chapter "[[General_HTTP-Client|Configuration/General/HTTP Client]]".
</blockquote>


* '''Interval [min]:''' An interval (in minutes) at which the file is re-read and executed.
If the URL ends with a slash '/', for example <nowiki>http://192.168.0.1/update/</nowiki>, the device is adding the file name update-ipxxx.htm automatically, deduced from the device short name (for example update-ip800.htm). Furthermore some placeholders may be used in the URL-String as described in [[Reference:Update Server#SCFG_command | the update servers scfg command description]].


These placeholders may be used e.g. to address a device-specific directory (<nowiki>http://192.168.1.2/update/#h/script.txt</nowiki>) or to generate HTTP-GET parameters (<nowiki>http://192.168.0.1/update/script.php?mac=#m</nowiki>).


Detailed information on the update server and the update script is contained in "[[Update-Server|Configuration of the update server]]".
Some standard parameters are always appended to the query part of the URL:
{|
|+
| name || value || example
|-
| ver || human readable version information (as shown in the ''Version''' line of the [[Reference:Configuration/General/Info | general page ]] (display, for programmatic use rather apply [[Reference:Update Server#SCFG_command | '''#F''']] etc.) || 6.00 dvl-sr1 IP6000[07-60600.03], Bootcode[145], HW[104] 16384/131072
|-
| BOOT || last serial for [[Reference:Update Server#Boot_command | '''boot''']] command || 336
|-
| PROT || last serial for [[Reference:Update Server#Prot_command | '''prot''']] command || 07-6060003
|-
| CHECK || last serial for [[Reference:Update Server#Check_command | '''check''']] command || 20070511-01
|-
| BMC || last serial for [[Reference:Update Server#Bmc_command | '''bmc''']] command ||
|-
| CFG || last serial for [[Reference:Update Server#Cfg_command | '''cfg''']] command ||
|-
| CFG-BACKUP-NUM || last backup number for [[Reference:Update Server#Scfg_command | '''scfg''']] command ||
|}


If access to the command file requires authentication it must be configured within the HTTP-Client of the device. See [[Reference:Configuration/General/HTTP-Client|Configuration/General/HTTP-Client]].
|-
|valign=top nowrap=true|'''Interval'''
|An interval (in minutes) at which the file is re-read and executed. To restrict the update to certain hours (e.g. only during the night), there are mechanisms within the available commands to restrict the execution of the commands. The polling of the command file cannot be restrcited.
|}


<small>[[General|...go back]]</small>
== Current Update Serials ==
The '''Current Update Serials''' section shows the values of the variables set after last successful execution of the associated command. These values are provided as standard parameters in the query part of the URL.
 
{|
|+
| name || command
|-
| BOOT || [[Reference:Update Server#Boot_command | '''boot''']] ||
|-
| PROT || [[Reference:Update Server#Prot_command | '''prot''']] ||
|-
| CHECK || [[Reference:Update Server#Check_command | '''check''']] ||
|-
| BMC || [[Reference:Update Server#Bmc_command | '''bmc''']] ||
|-
| CFG || [[Reference:Update Server#Bmc_command | '''cfg''']] ||
|-
| CFG-BACKUP-NUM || [[Reference:Update Server#Scfg_command | '''scfg''']] ||
|}

Latest revision as of 12:26, 2 May 2008

On this page the device can be configured to poll an update server (a normal web server). A file pointed to by an URL is read from the update server and executed. This is an efficient mechanism to keep a large number of devices up to date. See Reference:Update Server for a detailed description of the available commands.

URL An URL, for example http://192.168.0.1/update/script-ip800.txt, pointing to a file whose commands are executed.

If the URL ends with a slash '/', for example http://192.168.0.1/update/, the device is adding the file name update-ipxxx.htm automatically, deduced from the device short name (for example update-ip800.htm). Furthermore some placeholders may be used in the URL-String as described in the update servers scfg command description.

These placeholders may be used e.g. to address a device-specific directory (http://192.168.1.2/update/#h/script.txt) or to generate HTTP-GET parameters (http://192.168.0.1/update/script.php?mac=#m).

Some standard parameters are always appended to the query part of the URL:

name value example
ver human readable version information (as shown in the Version' line of the general page (display, for programmatic use rather apply #F etc.) 6.00 dvl-sr1 IP6000[07-60600.03], Bootcode[145], HW[104] 16384/131072
BOOT last serial for boot command 336
PROT last serial for prot command 07-6060003
CHECK last serial for check command 20070511-01
BMC last serial for bmc command
CFG last serial for cfg command
CFG-BACKUP-NUM last backup number for scfg command

If access to the command file requires authentication it must be configured within the HTTP-Client of the device. See Configuration/General/HTTP-Client.

Interval An interval (in minutes) at which the file is re-read and executed. To restrict the update to certain hours (e.g. only during the night), there are mechanisms within the available commands to restrict the execution of the commands. The polling of the command file cannot be restrcited.

Current Update Serials

The Current Update Serials section shows the values of the variables set after last successful execution of the associated command. These values are provided as standard parameters in the query part of the URL.

name command
BOOT boot
PROT prot
CHECK check
BMC bmc
CFG cfg
CFG-BACKUP-NUM scfg