Command Line Interface Specification Windows

ManualsBrandsAcronis ManualsApplicationsBackupAgent

Online Backup Client version 4.3.x

1. Introduction

The CloudBackup Command Line Interface (CLI for short) makes it possible to access the

CloudBackup Client software from the command line. The following actions are implemented:

backup, delete, dir en restore. These actions are described in more detail in the following

paragraphs.

For all actions applies that a successful action is indicated by means of exit code 0. In all other

cases a status code of 1 will be used.

2. Configuration

The command line client needs a configuration file. This configuration file may have the same

layout as the configuration file for the full CloudBackup client. This configuration file is expected

to reside in one of the following folders: CLI installation location or the settings folder in the CLI

installation location. The name of the configuration file must be: Settings.xml.

Example: if the CLI is installed in C:\Windows\MyBackup\, the configuration file may be in one of

the two following locations:

C:\Windows\MyBackup\Settings.xml

C:\Windows\MyBackup\Settings\Settings.xml

If both are present, the first form has precedence.

Also the customer needs to edit the CloudBackup.Console.exe.config file which is located in the

program file directory and edit the following line:

Summary of content (14 pages)

PAGE 1
Command Line Interface Specification Windows Online Backup Client version 4.3.x 1. Introduction The CloudBackup Command Line Interface (CLI for short) makes it possible to access the CloudBackup Client software from the command line. The following actions are implemented: backup, delete, dir en restore. These actions are described in more detail in the following paragraphs. For all actions applies that a successful action is indicated by means of exit code 0.
PAGE 2
After making these changes the customer can use the CLI instruction to make backups and restore data. 2.1 Configuration Error Handling If an error is found in the configuration file, the command line client will issue an error message describing which value or setting or option is causing the error and terminate with an exit value of 1.
PAGE 3
These two commands can be used to register an account. The ‘Register’ command is an analog of passing the Registration Wizard by a new user who has not set an Encryption Key yet. The format is as follows (all parameters are required): CloudBackup.Console.exe register /server {url} /login {username} /pass {password} /key {encryption key} /keyreminder {encryption key reminder} The ‘Signin’ command is an analog of passing the Registration Wizard by a user who has already set an Encryption Key.
PAGE 4
the following document for additional information: "Characters Allowed in BA.doc" which describes the full username and password limitations. /pass The password for the specified login name. The password has a minimum length of 6 characters and a maximum length of 20 characters.
PAGE 5
The name of the task that needs to be executed. The actual task definition is read by the agent from the xml file containing the task definitions1, and this file is expected to reside in one of the following folders: application installation location, the config folder in the application installation location or the current directory. If the task definition file cannot be found, the client must issue a proper error message and terminate with an exit value of 1.
PAGE 6
User canceled 9 6. Delete This command makes it possible to delete files and directories of the CloudBackup Server. CloudBackup.Console.exe delete /login /pass /server [/version [all|last|]] /input | ... 6.1 Arguments explained /login The login name of the user. See the backup command for more information. /pass The password for the specified login name. See the backup command for more information.
PAGE 7
/input This option specifies that the list of files to be deleted must be read from the given file. This option may be useful if a large number of files needs to be removed. The input file must be structured as follows: … Where is one of all, last or a number (see the -version command line option for more information), and is the full path to a file or folder that must be deleted.
PAGE 8
5 Completed unsuccessfully 7 Completed unsuccessfully with not found resources 9 User canceled 7. Dir This command makes it possible to display one or multiple directories on the CloudBackup Server. It’s even possible to see if this file exists by using this command. CloudBackup.Console.exe dir /login /pass /server [/r[]] [/l|/s] 7.1 Arguments explained /login The user login name of the user.
PAGE 9
/l This option will display the long File version. This option is mutually exclusive with the -s command line option. This option is implied unless the -s option is provided. /s This option will display the short File version. This option is mutually exclusive with the -l command line option. file The name of the file or folder that needs to be displayed.
PAGE 10
||||| De type indicator indicates if a field has to be displayed as a file or directory. Possible values are:  F (File)  D (Directory) For a single-directory listing, the name will only contain the name of a file or directory and will not contain the path. For a recursive directory listing, the name will contain the full path. If the name contains a “|” . then the “|” will be replaced with a “\|”.
PAGE 11
d|D_Root|0|0|0|1 d|X_Root|0|0|0|1 C:\> Request of the backup tree under DMA_684-C_Root (which example the C-drive of a scan pc for the user of the DMA application with client number 684 displays): C:\> CloudBackup.Console.exe dir -login test -pass test -server 10.0.0.1 -l DMA_684-C_Root d|Program Files|0|0|0|1 d|Documents and Settings|0|0|0|1 f|msizap.exe|94720|02-17-2007 15:03:48|02-17-2007 15:03:48|1 f|pagefile.sys|603979776|10-01-2007 13:29:42|10-29-2007 01:14:07|1 f|pagefile.
PAGE 12
8. Restore This action makes it possible to perform a restore by using the command line. CloudBackup.Console.exe restore /login /pass /key /server [/version [all|last|]] [/dest ] /input | ... 8.1 Arguments explained /login The user login name of the user. See the backup command for more information. /pass The password of a user. See the backup command for more information.
PAGE 13
 version : specifies that the version that the defined version has to be restored. When a user uses -version all then all versions of a file will be stored. This will be done such as .1 2 etc. If this option is not used -version last is assumed. This parameter is ignored when the -input parameter is used. /dest This parameter defines the location on the file system where the requested files have to be restored.
PAGE 14
It is possible to perform a wildcard restore by using an asterisk in place of either a filename, a part of a filename or an extension. The action is the same as with a normal restore, only the filename can have the following variation:  *.extension (e.g. *.pdf – This will restore all files ending in .pdf)  *name.extension (e.g. *1.png – This will restore all .png files ending with a 1 in their name)  *name*.* (e.g. *flow*.* - This will restore any type of file with the word ‘flow’ in their name) 8.