CLI Reference

Feb 13, 2023

Requirements

CLI (Command Line Interface) is available only on Linux platform.

Synopsis

qbackupc <Command> [<Arg> ...]

Available Commands

Command Description
help Outputs command help
create-project Creates project template
backup Runs backup
list-backup Outputs backup history
restore Runs restore
update-history Gets missing backup history from storage
register-license-key Registers license key

Operation Flow

  1. Create a project
    • Create project template using create-project command
    • Edit project.xml manually
  2. Backup
    • Run backup using backup command
  3. Restore
    • Output backup history using list-backup command to specify restore target.
    • Restore files using restore command

update-history

If you cannot find backup history using list-backup command, run update-history command to get missing backup history from storage.

help

Outputs command help.

Synopsis

qbackupc help [<Command>]

Examples

Outputs qbackupc help

qbackupc help

Ouptput create-project command help

qbackupc help create-project

create-project

Creates project template.

Synopsis

qbackupc create-project
--project <value>
--storage <value>

Options

--project (string) The project name.

--storage (string) The type of storage. Valid choices are: local | sftp | s3 | google | azure | oracle | rackspace | b2 | s3-compatible | swift

local Local File System
sftp SFTP
s3 Amazon S3
google Google Cloud Storage
azure Microsoft Azure Storage
oracle Oracle Storage Cloud Service
rackspace Rackspace Cloud Files
b2 Backblaze B2 Cloud Storage
s3-compatible S3 Compatible Storage
swift OpenStack Swift

Examples

Create project for Amazon S3 storage

qbackupc create-project --project MyProject --storage s3

create-project

create-project command creates a project configuration file in the project folder. Before you run backup command, you need to edit the project configuration file manually. For more information, see Project configuration file.

backup

Runs backup.

Synopsis

qbackupc backup
--project <value>
[--encryption-password <value>]
[--http-proxy-host <value>]
[--http-proxy-port <value>]
[--https-proxy-host <value>]
[--https-proxy-port <value>]
[--socks-proxy-host <value>]
[--socks-proxy-port <value>]
[--http-non-proxy-hosts <value>]
[--no-format]

Options

--project (string) The project name.

--encryption-password (string) The encryption password.

--http-proxy-host (string) The HTTP proxy host

--http-proxy-port (integer) The HTTP proxy port

--https-proxy-host (string) The HTTPS proxy host

--https-proxy-port (integer) The HTTPS proxy port

--socks-proxy-host (string) The SOCKS proxy host

--socks-proxy-port (integer) The SOCKS proxy port

--http-non-proxy-hosts (string) No proxy for HTTP/HTTPS

--no-format (boolean) Outputs without format

Examples

Run backup

qbackupc backup --project MyProject
Example output 
{
    "startTime":"2016-05-04T15:16:28.519+09:00",
    "hash":"509c2eef7e03eca0dd8c1c7b98e5fbad3b8773f7f7cf016ee07901c1972072ce",
    "status":"SUCCEEDED",
    "elapsedMilliSec":11270,
    "totalSizeInBytes":866570190,
    "writtenSizeInBytes":344649758,
    "numFiles":2253,
    "numCreatedFiles":2253,
    "numUpdatedFiles":0,
    "numNotUpdatedFiles":0,
    "numFailedFiles":0
}

list-backup

Outputs backup history.

Synopsis

qbackupc list-backup
--project <value>
[--no-format]

Options

--project (string) The project name.

--no-format (boolean) Outputs without format

Examples

Outputs backup history

qbackupc list-backup --project MyProject
Example output 
[
    {
        "startTime":"2016-05-04T15:16:28.519+09:00",
        "hash":"509c2eef7e03eca0dd8c1c7b98e5fbad3b8773f7f7cf016ee07901c1972072ce",
        "status":"SUCCEEDED",
        "elapsedMilliSec":11270,
        "totalSizeInBytes":866570190,
        "writtenSizeInBytes":344649758,
        "numFiles":2253,
        "numCreatedFiles":2253,
        "numUpdatedFiles":0,
        "numNotUpdatedFiles":0,
        "numFailedFiles":0
    },
    {
        "startTime":"2016-05-04T17:31:13.386+09:00",
        "hash":"30d58239fa676f2c55ce8f9ae9dfb93d7cefe9fc06a9a875ba6952b0ea15b2e6",
        "status":"SUCCEEDED",
        "elapsedMilliSec":1451,
        "totalSizeInBytes":5,
        "writtenSizeInBytes":455,
        "numFiles":1,
        "numCreatedFiles":1,
        "numUpdatedFiles":0,
        "numNotUpdatedFiles":0,
        "numFailedFiles":0
    }
]

restore

Runs restore.

Synopsis

qbackupc restore
--project <value>
[--encryption-password <value>]
[--http-proxy-host <value>]
[--http-proxy-port <value>]
[--https-proxy-host <value>]
[--https-proxy-port <value>]
[--socks-proxy-host <value>]
[--socks-proxy-port <value>]
[--http-non-proxy-hosts <value>]
[--hash <value>]
[--destination <value>]
[--restore-file-tree]
[--overwrite]
[--disable-cache]
[--no-format]

Options

--project (string) The project name.

--encryption-password (string) Encryption password.

--http-proxy-host (string) The HTTP proxy host

--http-proxy-port (integer) The HTTP proxy port

--https-proxy-host (string) The HTTPS proxy host

--https-proxy-port (integer) The HTTPS proxy port

--socks-proxy-host (string) The SOCKS proxy host

--socks-proxy-port (integer) The SOCKS proxy port

--http-non-proxy-hosts (string) No proxy for HTTP/HTTPS

--hash (string) The hash of backup to be restored. More than or equal to 1 character is acceptable. If the hash specified, the backup history item will be searched by forward match of specified hash, the search is processed from new backup to old backup. I the hash does not specified, the latest backup will be restored.

--destination (string) The absolute path to destination folder. If the path does not specified, files are restored to original path.

--restore-file-tree (boolean) Creates file tree. This option is applied when --destination is specified.

--overwrite (boolean) Overwrites if file exists.

--disable-cache (boolean) Do not create cache.

--no-format (boolean) Outputs without format

Examples

Run restore without hash, without destination.

qbackupc restore --project MyProject

Run restore without hash, with destination

qbackupc restore --project MyProject --destination /home/user/restore

Run restore with hash, with destination

qbackupc restore --project MyProject --hash 509c --destination /home/user/restore
Example output 
{
    "startTime":"2016-05-04T15:16:28.519+09:00",
    "hash":"509c2eef7e03eca0dd8c1c7b98e5fbad3b8773f7f7cf016ee07901c1972072ce",
    "status":"SUCCEEDED",
    "elapsedMilliSec":11270,
    "totalSizeInBytes":866570190,
    "writtenSizeInBytes":344649758,
    "numFiles":2253,
    "numCreatedFiles":2253,
    "numUpdatedFiles":0,
    "numNotUpdatedFiles":0,
    "numFailedFiles":0
}

update-history

Gets missing backup history from storage.

Synopsis

qbackupc update-history
--project <value>
[--encryption-password <value>]
[--http-proxy-host <value>]
[--http-proxy-port <value>]
[--https-proxy-host <value>]
[--https-proxy-port <value>]
[--socks-proxy-host <value>]
[--socks-proxy-port <value>]
[--http-non-proxy-hosts <value>]

Options

--project (string) The project name.

--encryption-password (string) The encryption password.

--http-proxy-host (string) The HTTP proxy host

--http-proxy-port (integer) The HTTP proxy port

--https-proxy-host (string) The HTTPS proxy host

--https-proxy-port (integer) The HTTPS proxy port

--socks-proxy-host (string) The SOCKS proxy host

--socks-proxy-port (integer) The SOCKS proxy port

--http-non-proxy-hosts (string) No proxy for HTTP/HTTPS

Examples

qbackupc update-history --project MyProject

register-license-key

Registers license key.

Synopsis

qbackupc register-license-key
--id <value>
--license-key <value>

Options

--id (string) The ID.

--license-key (string) The license key.

Examples

qbackupc register-license-key --id <your id> --license-key <your license key>

Project configuration file

Location

[qBackup data folder]/projects/[ProjectName]/project.xml

Windows

%APPDATA%\qBackup\projects\[ProjectName]\project.xml
(Example)
C:\Users\user\AppData\Roaming\qBackup\projects\MyProject\project.xml

Mac

[user.home]/Library/Application Support/qBackup/projects/[ProjectName]/project.xml
(Example)
/Users/user/Library/Application Support/qBackup/projects/MyProject/project.xml

Linux

[user.home]/.qBackup/projects/[ProjectName]/project.xml
(Example)
/Users/user/.qBackup/projects/MyProject/project.xml

File format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include></include>
        <include></include>
    </includes>
    <excludes>
        <exclude></exclude>
        <exclude></exclude>
    </excludes>
    <excludePatterns>
        <excludePattern>*.iso</excludePattern>
        <excludePattern>*.tmp</excludePattern>
    </excludePatterns>
    <excludeHiddenFiles></excludeHiddenFiles>
    <excludeSystemFiles></excludeSystemFiles>
    [Storage]
    <compress></compress>
    <encrypt></encrypt>
    <encryptionPassword></encryptionPassword>
    <blockSize></blockSize>
    <logBackupCreatedFiles></logBackupCreatedFiles>
    <logBackupUpdatedFiles></logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles></logBackupNotUpdatedFiles>
    <logBackupFailedFiles></logBackupFailedFiles>
    <logRestoreCreatedFiles></logRestoreCreatedFiles>
    <logRestoreUpdatedFiles></logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles></logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles></logRestoreFailedFiles>
    <continueOnError></continueOnError>
    <checkLoops></checkLoops>
    <maxLocalThreads></maxLocalThreads>
    <maxStorageThreads></maxStorageThreads>
</project>
Field Required Description
includes Required The absolute paths to file and folder to be backup
excludes   The absolute paths to file and folder to exclude from backup
excludePatterns   The patterns to exclude from backup
excludeHiddenFiles   Excludes hidden files from backup
(true | false)
Default: false
excludeSystemFiles   Excludes system files from backup. This property is applied on Windows.
(true | false)
Default: false
[Storage] Required

Local File System

SFTP

Amazon S3

Google Cloud Storage

Microsoft Azure Storage

Oracle Storage Cloud Service

Rackspace Cloud Files

Backblaze B2 Cloud Storage

S3 Compatible Storage

OpenStack Swift
compress   Compress
(true | false)
Default: true
encrypt   Encrypt
(true | false)
Default: false
encryptionPassword (Required) Encryption password
blockSize   The block size to read backup source (Byte).
Default: 5242880 (5MB)
Min: 1048576 (1MB)
Max: 104857600 (100MB)
logBackupCreatedFiles   Creates backup log of newly created files
(true | false)
Default: false
logBackupUpdatedFiles   Creates backup log of updated files
(true | false)
Default: false
logBackupNotUpdatedFiles   Creates backup log of files already backed up
(true | false)
Default: false
logBackupFailedFiles   Creates backup log of failed files
(true | false)
Default: false
logRestoreCreatedFiles   Creates restore log of newly created files
(true | false)
Default: false
logRestoreUpdatedFiles   Creates restore log of updated files (overwritten)
(true | false)
Default: false
logRestoreNotUpdatedFiles   Creates restore log of not updated files (skipped to overwrite)
(true | false)
Default: false
logRestoreFailedFiles   Creates restore log of failed files
(true | false)
Default: false
continueOnError   Continues backup/restore on error if possible
(true | false)
Default: false
checkLoops   Checks file system loops. This check cause low performance. Enable only if you encounter any problem.
(true | false)
Default: false
maxLocalThreads   Max number of threads to read/write local files
0 for the number of logical CPU cores
Default: 0
maxStorageThreads   Max number of threads to read/write storage files (objects)
0 for the number of logical CPU cores.
Default: 0

encryptionPassword

  • encryptionPassword is required if encrypt is true.
  • encryptionPassword is overwritten by command option --encryption-password

Local File System

<localStorage>
    <path></path>
</localStorage>
Field Required Description
path Required The absolute path to folder in which to save backup data
Example (Local File System)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <localStorage>
        <path>C:\Users\user\qbackup-storage</path>
    </localStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

SFTP

<sftpStorage>
    <host></host>
    <port></port>
    <path></path>
    <user></user>
    <password></password>
    <privateKeyPath></privateKeyPath>
    <passphrase></passphrase>
    <strictHostKeyChecking></strictHostKeyChecking>
    <knownHostsPath></knownHostsPath>
</sftpStorage>
Field Required Description
host Required The host name or IP address
port   The port number
Default: 22
path Required The path to folder in which to save backup data
user   The user name
password   The password
privateKeyPath   The absolute path to private key file
passphrase   The passphrase of the private key
strictHostKeyChecking   Checks host key
("ask" | "yes" | "no")
Default: "ask"
* Command Line Interface does not support "ask" option. Add host key to ssh_known_hosts or set strictHostKeyChecking to "no".
knownHostsPath   The path to checked host key entries
Default: [qBackup data folder]/ssh_known_hosts
Example (SFTP)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <sftpStorage>
        <host>example.com</host>
        <port>22</port>
        <path>/home/user/qbackup-storage</path>
        <user>user</user>
        <privateKeyPath>C:\Users\user\.ssh\id_rsa</privateKeyPath>
    </sftpStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

Amazon S3

<s3Storage>
    <credentialsPath></credentialsPath>
    <profileName></profileName>
    <accessKeyId></accessKeyId>
    <secretAccessKey></secretAccessKey>
    <bucketName></bucketName>
    <prefix>/prefix>
    <region></region>
    <storageClass></storageClass>
    <serverSideEncryption></serverSideEncryption>
    <endpoint></endpoint>
</s3Storage>
Field Required Description
credentialsPath (Required) The absolute path to credentials file. Blank for the default path.
profileName (Required) The profile name of credentials file
accessKeyId (Required) The Access Key ID
secretAccessKey (Required) The Secret Access Key
bucketName Required The bucket name
prefix   The prefix
region   Region
(
us-east-1
us-east-2
us-west-1
us-west-2
us-gov-west-1
us-gov-east-1
eu-west-1
eu-west-2
eu-west-3
eu-central-1
eu-central-2
eu-north-1
eu-south-1
eu-south-2
ap-east-1
ap-southeast-1
ap-southeast-2
ap-southeast-3
ap-southeast-4
ap-northeast-1
ap-northeast-2
ap-northeast-3
ap-south-1
ap-south-2
sa-east-1
ca-central-1
cn-north-1
cn-northwest-1
me-central-1
me-south-1
af-south-1
us-iso-east-1
us-isob-east-1
us-iso-west-1
)
storageClass   The storage class
(
STANDARD
STANDARD_IA
ONEZONE_IA
GLACIER_IR
INTELLIGENT_TIERING
REDUCED_REDUNDANCY
)
Default: STANDARD
serverSideEncryption   Enable server side encryption
(
AES256
aws:kms
)
endpoint   The endpoint

Authentication

  • If both the accessKeyId and the secretAccessKey are specified, accessKeyId and secretAccessKey will be used; otherwise credentials file and profileName will be used.
Example (Amazon S3)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <s3Storage>
        <accessKeyId>Your Access Key ID</accessKeyId>
        <secretAccessKey>Your Secret Access Key</secretAccessKey>
        <bucketName>Your Bucket name</bucketName>
        <region>ap-southeast-1</region>
        <storageClass>REDUCED_REDUNDANCY</storageClass>
        <serverSideEncryption>AES256</serverSideEncryption>
    </s3Storage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

Google Cloud Storage

<googleCloudStorage>
    <serviceAccountKeyPath></serviceAccountKeyPath>
    <bucketName></bucketName>
    <prefix></prefix>
    <location></location>
    <storageClass></storageClass>
    <projectId></projectId>
</googleCloudStorage>
Field Required Description
serviceAccountKeyPath (Required) The absolute path to service account key file. Blank for the default path.
bucketName Required The bucket name
prefix   The prefix
location   The location
(
ASIA
EU
US
NORTHAMERICA-NORTHEAST1
NORTHAMERICA-NORTHEAST2
US-CENTRAL1
US-EAST1
US-EAST4
US-EAST5
US-SOUTH1
US-WEST1
US-WEST2
US-WEST3
US-WEST4
SOUTHAMERICA-EAST1
SOUTHAMERICA-WEST1
EUROPE-CENTRAL2
EUROPE-NORTH1
EUROPE-SOUTHWEST1
EUROPE-WEST1
EUROPE-WEST2
EUROPE-WEST3
EUROPE-WEST4
EUROPE-WEST6
EUROPE-WEST8
EUROPE-WEST9
ASIA-EAST1
ASIA-EAST2
ASIA-NORTHEAST1
ASIA-NORTHEAST2
ASIA-NORTHEAST3
ASIA-SOUTH1
ASIA-SOUTH2
ASIA-SOUTHEAST1
ASIA-SOUTHEAST2
ME-WEST1
AUSTRALIA-SOUTHEAST1
AUSTRALIA-SOUTHEAST2
ASIA1
EUR4
NAM4
)
Default: US
storageClass   The storage class
(
STANDARD
NEARLINE
COLDLINE
ARCHIVE
DURABLE_REDUCED_AVAILABILITY
)
Default: STANDARD
projectId   The project ID
Example (Google Cloud Storage)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <googleCloudStorage>
        <serviceAccountKeyPath>C:\Users\user\.gcloud-credentials.json</serviceAccountKeyPath>
        <bucketName>Your Bucket Name</bucketName>
        <location>ASIA-EAST1</location>
        <storageClass>DURABLE_REDUCED_AVAILABILITY</storageClass>
    </googleCloudStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

Microsoft Azure Storage

<azureStorage>
    <accountName></accountName>
    <accountKey></accountKey>
    <containerName></containerName>
    <prefix></prefix>
    <endpoint></endpoint>
</azureStorage>
Field Required Description
accountName Required The storage account name
accountKey Required The storage account key
containerName Required The container name
prefix   The prefix
endpoint   The endpoint
Example (Microsoft Azure Storage)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <azureStorage>
        <accountName>Your Account Name</accountName>
        <accountKey>Your Accout Key</accountKey>
        <containerName>Your Container Name</containerName>
    </azureStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

Oracle Storage Cloud Service

<oracleCloudStorage>
    <identityDomainId></identityDomainId>
    <userName></userName>
    <password></password>
    <endpoint></endpoint>
    <containerName></containerName>
    <prefix></prefix>
    <serviceInstanceName></serviceInstanceName>
</oracleCloudStorage>
Field Required Description
identityDomainId Required The identity domain ID
userName Required The user name
password Required The password
endpoint Required The endpoint
containerName Required The container name
prefix   The prefix
serviceInstanceName   The service instance name
Example (Oracle Storage Cloud Service)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <oracleCloudStorage>
        <identityDomainId></identityDomainId>
        <userName>Your User Name</userName>
        <password>Your Password</password>
        <endpoint>Your Endpoint</endpoint>
        <containerName>Your Container Name</containerName>
    </oracleCloudStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

Rackspace Cloud Files

<rackspaceStorage>
    <userName></userName>
    <apiKey></apiKey>
    <regionId></regionId>
    <containerName></containerName>
    <prefix></prefix>
</rackspaceStorage>
Field Required Description
userName Required The user name
apiKey Required The API Key
regionId Required The region ID
(
IAD : Northern Virginia
DFW : Dallas
ORD : Chicago
LON : London
HKG : Hong Kong
SYD : Sydney
)
containerName Required The container name
prefix   The prefix
Example (Rackspace Cloud Files)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <rackspaceStorage>
        <userName>Your User Name</userName>
        <apiKey>Your API Key</apiKey>
        <regionId>HKG</regionId>
        <containerName>Your Container Name</containerName>
    </rackspaceStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

Backblaze B2 Cloud Storage

<b2Storage>
    <applicationKeyId></applicationKeyId>
    <applicationKey></applicationKey>
    <bucketName></bucketName>
    <prefix></prefix>
</b2Storage>
Field Required Description
applicationKeyId Required The Application Key ID
applicationKey Required The Application Key
bucketName Required The bucket name
prefix   The prefix

* accountId has been deleted since v1.12.1.0.

Example (Backblaze B2 Cloud Storage)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <b2Storage>
        <applicationKeyId>Your Appliaction Key ID</applicationKeyId>
        <applicationKey>Your Appliaction Key</applicationKey>
        <bucketName>Your Bucket Name</bucketName>
    </b2Storage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

S3 Compatible Storage

<s3CompatibleStorage>
    <credentialsPath></credentialsPath>
    <profileName></profileName>
    <accessKeyId></accessKeyId>
    <secretAccessKey></secretAccessKey>
    <endpoint></endpoint>
    <bucketName></bucketName>
    <prefix>/prefix>
</s3CompatibleStorage>
Field Required Description
credentialsPath (Required) The absolute path to credentials file. Blank for the default path.
profileName (Required) The profile name of credentials file
accessKeyId (Required) The Access Key ID
secretAccessKey (Required) The Secret Access Key
endpoint Required The endpoint
bucketName Required The bucket name
prefix   The prefix
Example (S3 Compatible Storage)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <s3CompatibleStorage>
        <accessKeyId>Your Access Key ID</accessKeyId>
        <secretAccessKey>Your Secret Access Key</secretAccessKey>
        <endpoint>Endpoint of the S3 Compatible Storage</endpoint>
        <bucketName>Your Bucket Name</bucketName>
    </s3CompatibleStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>

OpenStack Swift

<swiftStorage>
    <authUrl></authUrl>
    <projectId></projectId>
    <regionId>dallas</regionId>
    <userId></userId>
    <password></password>
    <containerName></containerName>
    <prefix></prefix>
</swiftStorage>
Field Required Description
authUrl Required The authentication URL
projectId Required The project ID
regionId Required The region ID
userId Required The user ID
password Required The password
containerName Required The container name
prefix   The prefix
Example (OpenStack Swift)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<project>
    <includes>
        <include>C:\Users\user\Documents\test.txt</include>
        <include>C:\Users\user\Pictures</include>
        <include>C:\Users\user\Music</include>
    </includes>
    <excludes>
        <exclude>C:\Users\user\Pictures\secret.jpg</exclude>
        <exclude>C:\Users\user\Pictures\old</exclude>
    </excludes>
    <excludeHiddenFiles>false</excludeHiddenFiles>
    <excludeSystemFiles>false</excludeSystemFiles>
    <swiftStorage>
        <authUrl>https://identity.open.softlayer.com</authUrl>
        <projectId>Your Project ID</projectId>
        <regionId>dallas</regionId>
        <userId>Your User ID</userId>
        <password>Your Password</password>
        <containerName>Your Container Name</containerName>
    </swiftStorage>
    <compress>true</compress>
    <encrypt>true</encrypt>
    <encryptionPassword>mypassword</encryptionPassword>
    <blockSize>5242880</blockSize>
    <logBackupCreatedFiles>false</logBackupCreatedFiles>
    <logBackupUpdatedFiles>false</logBackupUpdatedFiles>
    <logBackupNotUpdatedFiles>false</logBackupNotUpdatedFiles>
    <logBackupFailedFiles>false</logBackupFailedFiles>
    <logRestoreCreatedFiles>false</logRestoreCreatedFiles>
    <logRestoreUpdatedFiles>false</logRestoreUpdatedFiles>
    <logRestoreNotUpdatedFiles>false</logRestoreNotUpdatedFiles>
    <logRestoreFailedFiles>false</logRestoreFailedFiles>
    <continueOnError>false</continueOnError>
    <checkLoops>false</checkLoops>
    <maxLocalThreads>0</maxLocalThreads>
    <maxStorageThreads>0</maxStorageThreads>
</project>