Arangobackup Options

The --operation option can be passed as positional argument to specify the
desired action.

Global

Name

Type

Description

abort

boolean

Enterprise Edition onlyAbort transfer with given status-id (upload/download operation)This is a command, no value needs to be specified. The process terminates after executing the command.

allow-inconsistent

boolean

Whether to attempt to continue in face of errors; may result in inconsistent backup state (create operation)This option can be specified without value to enable it.Default: false

check-configuration

boolean

Check the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command.

config

string

The configuration file or ‘none’Default: ""

configuration

string

The configuration file or ‘none’Default: ""

define

string…

Define key=value for a @key@ entry in config fileDefault: []

dump-dependencies

boolean

Dump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.

dump-options

boolean

Dump configuration options in JSON formatThis is a command, no value needs to be specified. The process terminates after executing the command.

force

boolean

Enterprise Edition onlyAbort transactions if needed to ensure a consistent snapshot. This option can destroy the atomicity of your transactions in the presence of intermediate commits! Use it with great care and only if you really need a consistent backup at all costs (create operation)This option can be specified without value to enable it.Default: false

identifier

string

A unique identifier for a backup (restore/upload/download operation)Default: ""

ignore-version

boolean

Ignore stored version of a backup. Restore may not work if versions mismatch (restore operation)This option can be specified without value to enable it.Default: false

label

string

An additional label to add to the backup identifier (create operation)Default: ""

Maximum time to wait in seconds to acquire a lock on all necessary resources (create operation)Default: 60

max-wait-for-restart

double

Maximum time to wait in seconds for the server to restart after a restore operation before reporting an error; if zero, arangobackup will not wait to check that the server restarts and will simply return the result of the restore request (restore operation)Default: 0

Server

Require authentication credentials when connecting (does not affect the server-side authentication settings)This option can be specified without value to enable it.Default: false

server.connection-timeout

double

Connection timeout in secondsDefault: 5

server.database

string

Database name to use when connectingDefault: "_system"

server.endpoint

string

Endpoint to connect to. Use ‘none’ to start without a server. Use http+ssl:// or vst+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix://Default: "http+tcp://127.0.0.1:8529"

server.force-json

boolean

Force to not use VelocyPack for easier debuggingThis option can be specified without value to enable it.Default: falseIntroduced in: v3.6.0