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. 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:
1
<add key="SettingsFolder" value="%settingsfilelocation%" />
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. In addition, the error message must specify the line on which the error was detected and
the full path to the configuration file the error was found in.
If no command line actions are used or one of the following command line options is used: -?, -
help, the client will issue a help message listing the available commands and their parameters,
along with a short description of each parameter, and exit with a status code of 1.
3. Silent mode installation
It is possible to install or uninstall in the silent mode. The format is as follows:
BackupAgent_Setup.exe /VerySilent [/Log={filepath}]
[/OverwriteClientSetting={Y|N}] [/OverwriteServiceSetting={Y|N}] [/InstallGUIMode={Y|N}
/AllUsers={Y|N}]
Default values are following:
/OverwriteClientSetting="N"
/OverwriteServiceSetting="N"
/InstallGUIMode="Y"
/AllUsers="N"
unins000.exe /VerySilent /KeepSettings="N" /Log="D:\Uninstall.txt"
This is only possible in client version 4.3.8 and higher.
4. Register and Sign-in command
2
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. The format is as follows (all parameters are required):
CloudBackup.Console.exe signin /server {url} /login {username} /pass {password} /key {encryption key}
These commands are only available in client version 4.3.8 and higher.
5. Backup
This action makes it possible to perform a command line backup. The following arguments will
be used:
CloudBackup.Console.exe backup /login <login name> /pass <password>
/key <encryption key> /server <server address> [/uid <unique id>]
/task <task name>
5.1 Arguments explained
/login <login name>
The login name of the user. The user name has a minimum length of 6 characters and a
maximum length of 150 characters. The user name must start with an alphanumerical character
and may contain one or more of the following characters: !#$%&()+,-.;@'~[]{}_\` and may include
whitespace. If the login name contains any special characters (any characters that may be
interpreted by the shell such as the pipe character, whitespace, semi-colon, double-colon,
percent and dollar signs, etc…), the login name should be placed within quotes. Please refer to
3
the following document for additional information: "Characters Allowed in BA.doc" which
describes the full username and password limitations.
/pass <password>
The password for the specified login name. The password has a minimum length of 6 characters
and a maximum length of 20 characters. If the password contains any special characters (any
characters that may be interpreted by the shell such as the pipe character, whitespace, semi-
colon, double-colon, percent and dollar signs, etc…), the password should be placed within
quotes. Please refer to the following document for additional information: "Characters Allowed
in BA.doc" which describes the full username and password limitations.
/key <key>
The encryption key of the user. The encryption key will be used to encrypt the stored files. The
encryption key has a minimum of 6 characters and a maximum of 40 characters. Only alpha-
numerical characters are allowed. If a key for the provided login name does not exist, the
application must register the provided key on the CloudBackup server. If the provided key does
not match the existing key for the provided login name, the application must issue an appropriate
error message and terminate with an exit value of 5.
/server <server address>
The network address or domain name of the CloudBackup Server specified
as http://<servername> or https://<server name>.
/uid <unique id>
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 <task name>
4
The name of the task that needs to be executed. The actual task definition is read by the agent
Value
Meaning
0
Completed successfully
1
Command line error or unknown error
2
Completed successfully with skipped resources
3
Completed successfully with not found resources
4
Completed successfully with not found resources and skipped resources
5
Completed unsuccessfully
6
Completed unsuccessfully with skipped resources
7
Completed unsuccessfully with not found resources
8
Completed unsuccessfully with not found resources and skipped resources
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. This argument is optional but
mutually exclusive when specifying a list of files and/or folders to be backed up. However, either
this option or the list of files and/or folders must be specified.
1
The command line client does not offer functionality to create such a task definition. It is
assumed that the actual task definition has been created by the user. Either by using a properly
installed version of the OnlineBackupClient software or by manually creating the correct
definition via a text editor.
5.2 Output
As output and when the command progresses, the backup command will print the list of files
backed up on standard output, one line for each file (full path must be shown). When the backup
completed successfully, it will print ‘backup completed successfully’ and exit with a status value
of 0. If during the backup problems are encountered with files and/or folders which cause these
items to be skipped, an appropriate notification (including the full path) must be printed to
standard error. If a fatal error was encountered during the backup, a detailed error message
must be printed to standard error and the client must exit with an appropriate exit value
according to the following list:
5
Loading...