Arangobackup Options
Usage: arangobackup <operation> [<options>]
The --operation option can be passed as positional argument to specify the
desired action.
General
| Name | Type | Description |
|---|---|---|
abort |
boolean | Enterprise Edition only 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 |
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 exit This 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 file Default: [] |
dump-dependencies |
boolean | Dump dependency graph This is a command, no value needs to be specified. The process terminates after executing the command. |
dump-options |
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 |
boolean | Enterprise Edition only 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 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: "" |
log |
string… | The global or topic-specific log level Default: ["info"]Deprecated in: v3.5.0 |
max-wait-for-lock |
double | 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 |
operation |
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 |
string | Enterprise Edition only Filename of the Rclone configuration file used forfile transfer (upload/download operation) Default: "" |
remote-path |
string | Enterprise Edition only Remote Rclone path of directory used to store or receive backups (upload/download operation) Default: "" |
status-id |
string | Enterprise Edition only 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 |
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 |
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. Introduced in: v3.9.0 |
Log
| Name | Type | Description |
|---|---|---|
log.color |
boolean | Use colors for TTY logging This option can be specified without value to enable it. Default: dynamic (e.g. true) |
log.escape-control-chars |
boolean | Escape control characters when logging This option can be specified without value to enable it. Default: trueIntroduced in: v3.9.0 |
log.escape-unicode-chars |
boolean | Escape unicode characters when logging This option can be specified without value to enable it. Default: falseIntroduced in: v3.9.0 |
log.file |
string | Shortcut for ‘--log.output file:// Default: "-" |
log.file-group |
string | Group to use for new log file, user must be a member of this group Default: ""Introduced in: v3.4.5 |
log.file-mode |
string | Mode to use for new log file, umask will be applied as well Default: ""Introduced in: v3.4.5 |
log.force-direct |
boolean | Do not start a seperate thread for logging This option can be specified without value to enable it. Default: false |
log.foreground-tty |
boolean | Also log to tty if backgrounded This option can be specified without value to enable it. Default: dynamic (e.g. false) |
log.hostname |
string | Hostname to use in log message (empty for none, use ‘auto’ to automatically figure out hostname) Default: ""Introduced in: v3.8.0 |
log.ids |
boolean | Log unique message ids This option can be specified without value to enable it. Default: trueIntroduced in: v3.5.0 |
log.level |
string… | The global or topic-specific log level Default: ["info"] |
log.line-number |
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 value to enable it. Default: false |
log.max-entry-length |
uint32 | Maximum length of a log entry (in bytes) Default: 134217728Introduced in: v3.7.9 |
log.output |
string… | Log destination(s), e.g. file:///path/to/file (any ‘$PID’ will be replaced with the process id) Default: [] |
log.performance |
boolean | Shortcut for ‘--log.level performance=trace’ This option can be specified without value to enable it. Default: falseDeprecated in: v3.5.0 |
log.prefix |
string | Prefix log message with this string Default: "" |
log.process |
boolean | Show process identifier (pid) in log message This option can be specified without value to enable it. Default: trueIntroduced in: v3.8.0 |
log.request-parameters |
boolean | Include full URLs and HTTP request parameters in trace logs This option can be specified without value to enable it. Default: true |
log.role |
boolean | Log server role This option can be specified without value to enable it. Default: false |
log.shorten-filenames |
boolean | Shorten filenames in log output (use with --log.line-number) This option can be specified without value to enable it. Default: true |
log.structured-param |
string… | Toggle usage of log category parameter in structured log messages Default: []Introduced in: v3.10.0 |
log.thread |
boolean | Show thread identifier in log message This option can be specified without value to enable it. Default: false |
log.thread-name |
boolean | Show thread name in log message This option can be specified without value to enable it. Default: false |
log.time-format |
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” Introduced in: v3.5.0 |
log.use-json-format |
boolean | Use json output format This option can be specified without value to enable it. Default: falseIntroduced in: v3.8.0 |
log.use-local-time |
boolean | Use local timezone instead of UTC This option can be specified without value to enable it. Default: falseDeprecated in: v3.5.0 |
log.use-microtime |
boolean | Use microtime instead This option can be specified without value to enable it. Default: falseDeprecated in: v3.5.0 |
Random
| Name | Type | Description |
|---|---|---|
random.generator |
uint32 | Random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not for Windows), 5 = WinCrypt (Windows only) Default: 1Possible values: 1, 2, 3, 4 |
Server
| Name | Type | Description |
|---|---|---|
server.authentication |
boolean | 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 seconds Default: 5 |
server.database |
string | Database name to use when connecting Default: "_system" |
server.endpoint |
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 |
uint64 | Maximum packet size (in bytes) for client/server communication Default: 1073741824 |
server.password |
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 |
double | Request timeout in seconds Default: 1200 |
server.username |
string | Username to use when connecting Default: "root" |
SSL
| Name | Type | Description |
|---|---|---|
ssl.protocol |
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: 5Possible values: 1, 2, 3, 4, 5, 6, 9 |