CONFIG AUTOBACKUP SET

Level

modify,maintenance

History

Appears in 1.0.0
backupid appears in 2.3.0
IgnoreProxy appears in 3.10.2
BindAddr appears in 4.5.0
StartTime, StartMDay and StartWDay appear in 4.8.0

Description

Set autobackup configuration.

Usage

[state=<0|1>] [distantbackup=<0|1|2>] [period=<period as string>] [starttime=*|HH[:MM] [startmday=1-31|startwday=1-7]]
[backuppassword=<backup password>] [backupid=<alphanum str>]
[server=<server obj>] [port=<server port obj>] [path=<path>] [protocol=(http|https)] [mode=(basic|digest|post)]
[authusername=<authentication username>] [authpassword=<authentication password>] [controlname=<http control name>]
[servercertificate=<ca:cert>] [clientcertificate=<ca:cert>] [IgnoreProxy=<0|1>] [BindAddr=<host>]
- period : time + unit (s,m,h,d,w);
- starttime : \"*\" (means start at boot) or hours[:minutes] optionally followed by date (startmday|startwday);
- startmday : month day (1-31). First autobackup startup day. starttime mandatory, startwday forbidden;
- startwday : week day (1-7). First autobackup startup day. starttime mandatory, startmday forbidden;
- distantbackup : localbackup only (0), cloud stormshield (1), custom server (2);
- backupid : used in backup filename (default is serial number);
- protocol : protocol used (http,https);
- mode : webdav mode with authentication (basic,digest) or post request;
- controlname : name also used with html form (only with post mode);
- authusername : authentication username (only with basic and digest webdav modes);
- authpassword : authentication password (only with basic and digest webdav modes);
- path : path on the server;
- servercertificate : server certificate reference;
- clientcertificate : client certificate;

Returns

Error code

Remark

Protocol http and mode post are incompatible

Example

CONFIG AUTOBACKUP SET state=1 server=backupserver port=http controlname=myfile path=/action.php period=10h password=mypassword