arangobackup Options

The startup options of the arangobackup executable

Usage: arangobackup <operation> [<options>]

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

General

`--abort`

Enterprise Edition

Type: boolean

Abort the transfer with the 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.

`--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”.

`--configuration`

Type: string

The configuration file or “none”.

`--define`

Type: string…

Define a value for a @key@ entry in the configuration file using the syntax "key=value".

`--dump-dependencies`

Type: boolean

Dump the dependency graph of the feature phases (internal) and exit.

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

`--dump-options`

Type: boolean

Dump all available startup options in JSON format and exit.

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

`--force`

Enterprise Edition

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.

`--honor-nsswitch`

Type: boolean

Allow hostname lookup configuration via /etc/nsswitch.conf if on Linux/glibc.

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

`--identifier`

Type: string

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

`--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.

`--label`

Type: string

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

`--log`

Deprecated in: v3.5.0

Type: string…

Set the topic-specific log level, using --log level for the general topic or --log topic=level for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.

Default: info

`--max-wait-for-lock`

Type: double

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

Default: 60

`--max-wait-for-restart`

Type: double

The maximum time to wait (in seconds) for the server to restart after a restore operation before reporting an error; if zero, arangobackup does not wait to check that the server restarts and simply returns the result of the restore request (restore operation).

`--operation`

Type: string

The 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

Type: string

A path to the rclone configuration file to use forfile transfer (upload/download operation).

`--remote-path`

Enterprise Edition

Type: string

The remote rclone path of a directory to use to store or receive backups (upload/download operation).

`--status-id`

Enterprise Edition

Type: string

Return 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.

`--use-splice-syscall`

Introduced in: v3.9.4

Type: boolean

Use the splice() syscall for file copying (may not be supported on all filesystems).

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

Default: true

Available on Linux only.

Format	Example	Description
`timestamp`	1553766923000	Unix timestamps, in seconds
`timestamp-millis`	1553766923000.123	Unix timestamps, in seconds, with millisecond precision
`timestamp-micros`	1553766923000.123456	Unix timestamps, in seconds, with microsecond precision
`uptime`	987654	seconds since server start
`uptime-millis`	987654.123	seconds since server start, with millisecond precision
`uptime-micros`	987654.123456	seconds since server start, with microsecond precision
`utc-datestring`	2019-03-28T09:55:23Z	UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ
`utc-datestring-millis`	2019-03-28T09:55:23.123Z	like `utc-datestring`, but with millisecond precision
`local-datestring`	2019-03-28T10:55:23	local date and time in format YYYY-MM-DDTHH:MM:SS

Key	Value
`time`	date/time of log message, in format specified by `--log.time-format`
`prefix`	only emitted if `--log.prefix` is set
`pid`	process id, only emitted if `--log.process` is set
`tid`	thread id, only emitted if `--log.thread` is set
`thread`	thread name, only emitted if `--log.thread-name` is set
`role`	server role (1 character), only emitted if `--log.role` is set
`level`	log level (e.g. `"WARN"`, `"INFO"`)
`file`	source file name of log message, only emitted if `--log.line-number` is set
`line`	source file line of log message, only emitted if `--log.line-number` is set
`function`	source file function name, only emitted if `--log.line-number` is set
`topic`	log topic name
`id`	log id (5 digit hexadecimal string), only emitted if `--log.ids` is set
`hostname`	hostname if `--log.hostname` is set
`message`	the actual log message payload

arangobackup Options

General

--abort

--allow-inconsistent

--check-configuration

--config

--configuration

--define

--dump-dependencies

--dump-options

--force

--honor-nsswitch

--identifier

--ignore-version

--label

--log

--max-wait-for-lock

--max-wait-for-restart

--operation

--rclone-config-file

--remote-path

--status-id

--use-splice-syscall

--version

--version-json

log

--log.color

--log.escape-control-chars

--log.escape-unicode-chars

--log.file

--log.file-group

--log.file-mode

--log.force-direct

--log.foreground-tty

--log.hostname

--log.ids

--log.level

--log.line-number

--log.max-entry-length

--log.max-queued-entries

--log.output

--log.performance

--log.prefix

--log.process

--log.request-parameters

--log.role

--log.shorten-filenames

--log.structured-param

--log.thread

--log.thread-name

--log.time-format

--log.use-json-format

--log.use-local-time

--log.use-microtime

random

--random.generator

server

--server.authentication

--server.connection-timeout

--server.database

--server.endpoint

--server.max-packet-size

--server.password

--server.request-timeout

--server.username

ssl

--ssl.protocol

`--abort`

`--allow-inconsistent`

`--check-configuration`

`--config`

`--configuration`

`--define`

`--dump-dependencies`

`--dump-options`

`--force`

`--honor-nsswitch`

`--identifier`

`--ignore-version`

`--label`

`--log`

`--max-wait-for-lock`

`--max-wait-for-restart`

`--operation`

`--rclone-config-file`

`--remote-path`

`--status-id`

`--use-splice-syscall`

`--version`

`--version-json`

`--log.color`

`--log.escape-control-chars`

`--log.escape-unicode-chars`

`--log.file`

`--log.file-group`

`--log.file-mode`

`--log.force-direct`

`--log.foreground-tty`

`--log.hostname`

`--log.ids`

`--log.level`

`--log.line-number`

`--log.max-entry-length`

`--log.max-queued-entries`

`--log.output`

`--log.performance`

`--log.prefix`

`--log.process`

`--log.request-parameters`

`--log.role`

`--log.shorten-filenames`

`--log.structured-param`

`--log.thread`

`--log.thread-name`

`--log.time-format`

`--log.use-json-format`

`--log.use-local-time`

`--log.use-microtime`

`--random.generator`

`--server.authentication`

`--server.connection-timeout`

`--server.database`

`--server.endpoint`

`--server.max-packet-size`

`--server.password`

`--server.request-timeout`

`--server.username`

`--ssl.protocol`