ArangoDB v3.9 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version at docs.arangodb.com

Arangobackup Options

Usage: arangobackup <operation> [<options>]

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

General

--abort

Enterprise Edition only

Type: boolean

Abort 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

Type: boolean

Whether to attempt to continue in face of errors; may result in inconsistent backup state (create operation)

This option can be specified without a value to enable it.

Default: false


--check-configuration

Type: boolean

Check the configuration and exit

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


--config

Type: string

The configuration file or 'none'

Default: ""


--configuration

Type: string

The configuration file or 'none'

Default: ""


--define

Type: string…

Define key=value for a @key@ entry in config file

Default: []


--dump-dependencies

Type: boolean

Dump dependency graph

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


--dump-options

Type: boolean

Dump configuration options in JSON format

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


--force

Enterprise Edition only

Type: boolean

Abort 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 a value to enable it.

Default: false


--identifier

Type: string

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

Default: ""


--ignore-version

Type: boolean

Ignore stored version of a backup. Restore may not work if versions mismatch (restore operation)

This option can be specified without a value to enable it.

Default: false


--label

Type: string

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

Default: ""


--log

Deprecated in: v3.5.0

Type: string…

The global or topic-specific log level

Default: ["info"]


--max-wait-for-lock

Type: double

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

Default: 60


--max-wait-for-restart

Type: 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


--operation

Type: string

Operation to perform (may be specified as positional argument without '--operation')

Default: "list"

Possible values: “create”, “delete”, “download”, “list”, “restore”, “upload”


--rclone-config-file

Enterprise Edition only

Type: string

Filename of the Rclone configuration file used forfile transfer (upload/download operation)

Default: ""


--remote-path

Enterprise Edition only

Type: string

Remote Rclone path of directory used to store or receive backups (upload/download operation)

Default: ""


--status-id

Enterprise Edition only

Type: string

Returns the status of a transfer process (upload/download operation)

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


--version

Type: boolean

Reports the version and exits

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


--version-json

Introduced in: v3.9.0

Type: boolean

Reports the version as JSON and exits

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

Log

--log.color

Type: boolean

Use colors for TTY logging

This option can be specified without a value to enable it.

Default: dynamic (e.g. true)


--log.escape-control-chars

Introduced in: v3.9.0

Type: boolean

Escape control characters when logging

This option can be specified without a value to enable it.

Default: true


--log.escape-unicode-chars

Introduced in: v3.9.0

Type: boolean

Escape unicode characters when logging

This option can be specified without a value to enable it.

Default: false


--log.file

Type: string

Shortcut for '--log.output file://<filename>'

Default: "-"


--log.file-group

Introduced in: v3.4.5

Type: string

Group to use for new log file, user must be a member of this group

Default: ""


--log.file-mode

Introduced in: v3.4.5

Type: string

Mode to use for new log file, umask will be applied as well

Default: ""


--log.force-direct

Type: boolean

Do not start a seperate thread for logging

This option can be specified without a value to enable it.

Default: false


--log.foreground-tty

Type: boolean

Also log to tty if backgrounded

This option can be specified without a value to enable it.

Default: dynamic (e.g. false)


--log.hostname

Introduced in: v3.8.0

Type: string

Hostname to use in log message (empty for none, use 'auto' to automatically figure out hostname)

Default: ""


--log.ids

Introduced in: v3.5.0

Type: boolean

Log unique message ids

This option can be specified without a value to enable it.

Default: true


--log.level

Type: string…

The global or topic-specific log level

Default: ["info"]


--log.line-number

Type: boolean

Include the function name, file name and line number of the source code that issues the log message. Format: [func@FileName.cpp:123]

This option can be specified without a value to enable it.

Default: false


--log.max-entry-length

Introduced in: v3.7.9

Type: uint32

Maximum length of a log entry (in bytes)

Default: 134217728


--log.output

Type: string…

Log destination(s), e.g. file:///path/to/file (any '$PID' will be replaced with the process id)

Default: []


--log.performance

Deprecated in: v3.5.0

Type: boolean

Shortcut for '--log.level performance=trace'

This option can be specified without a value to enable it.

Default: false


--log.prefix

Type: string

Prefix log message with this string

Default: ""


--log.process

Introduced in: v3.8.0

Type: boolean

Show process identifier (pid) in log message

This option can be specified without a value to enable it.

Default: true


--log.request-parameters

Type: boolean

Include full URLs and HTTP request parameters in trace logs

This option can be specified without a value to enable it.

Default: true


--log.role

Type: boolean

Log server role

This option can be specified without a value to enable it.

Default: false


--log.shorten-filenames

Type: boolean

Shorten filenames in log output (use with --log.line-number)

This option can be specified without a value to enable it.

Default: true


--log.thread

Type: boolean

Show thread identifier in log message

This option can be specified without a value to enable it.

Default: false


--log.thread-name

Type: boolean

Show thread name in log message

This option can be specified without a value to enable it.

Default: false


--log.time-format

Introduced in: v3.5.0

Type: string

Time format to use in logs

Default: "utc-datestring"

Possible values: “local-datestring”, “timestamp”, “timestamp-micros”, “timestamp-millis”, “uptime”, “uptime-micros”, “uptime-millis”, “utc-datestring”, “utc-datestring-millis”


--log.use-json-format

Introduced in: v3.8.0

Type: boolean

Use json output format

This option can be specified without a value to enable it.

Default: false


--log.use-local-time

Deprecated in: v3.5.0

Type: boolean

Use local timezone instead of UTC

This option can be specified without a value to enable it.

Default: false


--log.use-microtime

Deprecated in: v3.5.0

Type: boolean

Use microtime instead

This option can be specified without a value to enable it.

Default: false

Random

--random.generator

Type: uint32

Random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only)

Default: 1

Possible values: 1, 2, 3, 4

Server

--server.authentication

Type: boolean

Require authentication credentials when connecting (does not affect the server-side authentication settings)

This option can be specified without a value to enable it.

Default: false


--server.connection-timeout

Type: double

Connection timeout in seconds

Default: 5


--server.database

Type: string

Database name to use when connecting

Default: "_system"


--server.endpoint

Type: string…

Endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://

Default: ["http+tcp://127.0.0.1:8529"]


--server.max-packet-size

Type: uint64

Maximum packet size (in bytes) for client/server communication

Default: 1073741824


--server.password

Type: string

Password to use when connecting. If not specified and authentication is required, the user will be prompted for a password

Default: ""


--server.request-timeout

Type: double

Request timeout in seconds

Default: 1200


--server.username

Type: string

Username to use when connecting

Default: "root"

SSL

--ssl.protocol

Type: uint64

Ssl protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS)

Default: 5

Possible values: 1, 2, 3, 4, 5, 6, 9