Arangobackup Options

Usage: arangobackup <operation> [<options>]

The —operation option can be passed as positional argument to specify thedesired action.

Global

NameTypeDescription
abortbooleanAbort transfer with given status-id (upload/download operation)This option can be specified without value to enable it.Default: false
allow-inconsistentbooleanWhether 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-configurationbooleanCheck the configuration and exitThis is a command, no value needs to be specified. The process terminates after executing the command.
configstringThe configuration file or ‘none’Default: ""
configurationstringThe configuration file or ‘none’Default: ""
definestring…Define key=value for a @key@ entry in config fileDefault: []
dump-dependenciesbooleanDump dependency graphThis is a command, no value needs to be specified. The process terminates after executing the command.
dump-optionsbooleanDump configuration options in JSON formatThis is a command, no value needs to be specified. The process terminates after executing the command.
forcebooleanAbort 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
identifierstringA unique identifier for a backup (restore/upload/download operation)Default: ""
ignore-versionbooleanIgnore 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
labelstringAn additional label to add to the backup identifier (create operation)Default: ""
logstring…The global or topic-specific log levelDefault: ["info"]Deprecated in: v3.5.0
max-wait-for-lockdoubleMaximum time to wait in seconds to acquire a lock on all necessary resources (create operation)Default: 60
max-wait-for-restartdoubleMaximum 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
operationstringOperation to perform (may be specified as positional argument without ‘—operation’)Default: "list"Possible values: “create”, “delete”, “download”, “list”, “restore”, “upload”
rclone-config-filestringFilename of the Rclone configuration file used forfile transfer (upload/download operation)Default: ""
remote-pathstringRemote Rclone path of directory used to store or receive backups (upload/download operation)Default: ""
status-idstringReturns the status of a transfer process (upload/download operation)Default: ""
versionbooleanReports the version and exitsThis is a command, no value needs to be specified. The process terminates after executing the command.

Log

NameTypeDescription
log.colorbooleanUse colors for TTY loggingThis option can be specified without value to enable it.Default: dynamic (e.g. true)
log.escapebooleanEscape characters when loggingThis option can be specified without value to enable it.Default: true
log.filestringShortcut for ‘—log.output file://'Default: &#34;-&#34;
log.file-groupstringGroup to use for new log file, user must be a member of this groupDefault: ""Introduced in: v3.4.5, v3.5.0
log.file-modestringMode to use for new log file, umask will be applied as wellDefault: ""Introduced in: v3.4.5, v3.5.0
log.force-directbooleanDo not start a seperate thread for loggingThis option can be specified without value to enable it.Default: false
log.foreground-ttybooleanAlso log to tty if backgroundedThis option can be specified without value to enable it.Default: dynamic (e.g. false)
log.idsbooleanLog unique message idsThis option can be specified without value to enable it.Default: trueIntroduced in: v3.5.0
log.keep-logrotatebooleanKeep the old log file after receiving a sighupThis option can be specified without value to enable it.Default: false
log.levelstring…The global or topic-specific log levelDefault: ["info"]
log.line-numberbooleanAppend line number and file nameThis option can be specified without value to enable it.Default: false
log.outputstring…Log destination(s), e.g. file:///path/to/file (Linux, macOS) or file://C:\path\to\file (Windows)Default: []
log.performancebooleanShortcut for ‘—log.level performance=trace’This option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.prefixstringPrefix log message with this stringDefault: ""
log.request-parametersbooleanInclude full URLs and HTTP request parameters in trace logsThis option can be specified without value to enable it.Default: true
log.rolebooleanLog server roleThis option can be specified without value to enable it.Default: false
log.shorten-filenamesbooleanShorten filenames in log output (use with —log.line-number)This option can be specified without value to enable it.Default: true
log.threadbooleanShow thread identifier in log messageThis option can be specified without value to enable it.Default: false
log.thread-namebooleanShow thread name in log messageThis option can be specified without value to enable it.Default: false
log.time-formatstringTime format to use in logsDefault: "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-local-timebooleanUse local timezone instead of UTCThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0
log.use-microtimebooleanUse microtime insteadThis option can be specified without value to enable it.Default: falseDeprecated in: v3.5.0

Random

NameTypeDescription
random.generatoruint32Random 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

NameTypeDescription
server.authenticationbooleanRequire 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-timeoutdoubleConnection timeout in secondsDefault: 5
server.databasestringDatabase name to use when connectingDefault: "_system"
server.endpointstringEndpoint 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-jsonbooleanForce to not use VelocyPack for easier debuggingThis option can be specified without value to enable it.Default: falseIntroduced in: v3.6.0
server.max-packet-sizeuint64Maximum packet size (in bytes) for client/server communicationDefault: 1073741824
server.passwordstringPassword to use when connecting. If not specified and authentication is required, the user will be prompted for a passwordDefault: ""
server.request-timeoutdoubleRequest timeout in secondsDefault: 1200
server.usernamestringUsername to use when connectingDefault: "root"

SSL

NameTypeDescription
ssl.protocoluint64Ssl 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