Command Line Interface Specification Linux Mac

ManualsBrandsAcronis ManualsApplicationsBackupAgent

Online Backup Client version 4.1.x and higher

1. Introduction

These modifications make it possible to access the BackupAgent Client software from the

command line. The following actions will be implemented: backup, delete, dir en restore. These

actions will be 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 does not need any configuration for it to function properly. All necessary

information required to complete a given action is supplied via command line options. The

default values for options otherwise configurable via the full BackupAgent client should be such

that these are satisfactory in the majority of installations.

However, to allow the user to modify the values of options that cannot be set via a command line

option, the command line client is able to read default values from a configuration file. When

used, this configuration file is expected to reside in one of the following folders: application

installation location or the config folder in the application installation location.

If the command line client detects a configuration file in one of the aforementioned folders, it will

load and process the contents of this configuration file before processing the command line

options. If an error is found in the configuration file, the command line client will issue an error

message describing which value, setting or option is causing the error and terminate with an exit

value of 1. In addition, the error message will specify the line on which the error was detected

and the full path to the configuration file the error was found in.

Summary of content (12 pages)

PAGE 1
Command Line Interface Specification Linux Mac Online Backup Client version 4.1.x and higher 1. Introduction These modifications make it possible to access the BackupAgent Client software from the command line. The following actions will be implemented: backup, delete, dir en restore. These actions will be 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.
PAGE 2
3. Backup This action makes it possible to perform a command line backup. The following arguments will be used: java -jar cli.jar backup -login -pass -key -server [-uid ] [-r] –retention: file1 file2 … 3.1 Arguments explained -login This is the login name of the user. The user name has a minimum length of 6 characters and a maximum length of 150 characters.
PAGE 3
The network address or domain name of the BackupAgent Server specified as https://. -uid This is an optional unique identification number. When specified, this value will be used instead of the computer name to identify the files of the user. This allows the user to access the stored files from different locations. Only alpha-numerical characters, underscore (_) and hyphen (-) are allowed. -task This is the name of the task that needs to be executed.
PAGE 4
file1 file2 … This argument specifies a list of files and/or folders to be backed up. Multiple files and/or folders are separated with any amount of whitespace. It is the user’s responsibility to properly quote any file or folder name containing embedded whitespace or other special characters. If the optional -r option is specified, all specified folders will be backed up recursively.
PAGE 5
If neither the -task or a set of files and/or folders was provided on the command line, the client must inform the user that a required option is missing and that either the -task option must be used or a list of files and/or folders must be specified. 4. Delete This command makes it possible to delete files and directories of the BackupAgent Server. Java -jar cli.jar delete -login -pass -server [-version [all|last|]] -input | ... 4.
PAGE 6
An optional parameter specifying which version of a file has to be deleted. There are 3 possible values for this parameter:  Version all: specifies that all versions of the file have to be deleted.  Version last: specifies that the last version of a file has to be deleted.  Version : specifies that the defined version has to be deleted. When version is not specified -version all is assumed.
PAGE 7
during the delete, an appropriate error message will be printed to standard error and the client will exit with a status value of 1. 5. Dir This command makes it possible to display one or multiple directories on the BackupAgent Server. It is even possible to see if this file exists by using this command: Java -jar cli.jar dir -login -pass -server [-r[:]] [-l|-s] 5.1 Arguments explained -login This is the user login name of the user.
PAGE 8
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 This is the name of the file or folder that needs to be displayed.
PAGE 9
The version number will define the file version. Most of the files will have version 1. Directories will always have version 1. 5.2.1 Examples The request to display the top of the backup tree for the user test on backup server 10.0.0.1 is: C:\>OnlineBackupAgent dir -login test -pass test -server 10.0.0.1 -l d|DMA_684|0|0|0|1 d|MIJN_PC|0|0|0|1 C:\> The request to display the top of the backup tree with the unique identification DMA_684 is: C:\>OnlineBackupAgent dir -login test -pass test -server 10.0.0.
PAGE 10
f|pagefile.sys|515263981|10-01-2007 13:29:42|10-30-2007 14:56:37|2 C:\> 5.3 Format short File version The short version will display the result in the following format: | The 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.
PAGE 11
This is the password of a user. See the backup command for more information. -key This is the encryption key of the user. See the backup command for more information. -server This is the network address or domain name of the BackupAgent Server. As example: http:// or https:// -version [all | last| ] This optional parameter specifies which version of a file has to be restored.
PAGE 12
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 restored. Please note that when the -input command line option is mutually exclusive with a list of files specified on the command line. file file .... This is the list of files that must be restored. The specified names must contain the whole path.