OS Manuals

/usr/bin/backup_agent

From foundationdb-7.3-compat 7.3.79-r7 (enterprise-packages), captured 2026-11-08 by running backup_agent --help (exit 0). permalink

FoundationDB 7.3 (v7.3.79)
Usage: backup_agent [OPTIONS]

  -C CONNFILE    The path of a file containing the connection string for the
                 FoundationDB cluster. The default is first the value of the
                 FDB_CLUSTER_FILE environment variable, then `./fdb.cluster',
                 then `/etc/foundationdb/fdb.cluster'.
  --log          Enables trace file logging for the CLI session.
  --logdir PATH  Specifes the output directory for trace files. If
                 unspecified, defaults to the current directory. Has
                 no effect unless --log is specified.
  --loggroup LOG_GROUP
                 Sets the LogGroup field with the specified value for all
                 events in the trace output (defaults to `default').
  --trace-format FORMAT
                 Select the format of the trace files. xml (the default) and json are supported.
                 Has no effect unless --log is specified.
  -m SIZE, --memory SIZE
                 Memory limit. The default value is 8GiB. When specified
                 without a unit, MiB is assumed.
  --tls-certificate-file CERTFILE
                 The path of a file containing the TLS certificate and CA
                 chain.
  --tls-ca-file CERTAUTHFILE
                 The path of a file containing the CA certificates chain.
  --tls-key-file KEYFILE
                 The path of a file containing the private key corresponding
                 to the TLS certificate.
  --tls-password PASSCODE
                 The passphrase of encrypted private key
  --tls-verify-peers CONSTRAINTS
                 The constraints by which to validate TLS peers. The contents
                 and format of CONSTRAINTS are plugin-specific.
  --build-flags  Print build information and exit.
  -v, --version  Print version information and exit.
  -h, --help     Display this help and exit.

  BLOB CREDENTIALS
     Blob account secret keys can optionally be omitted from blobstore:// URLs, in which case they will be
     loaded, if possible, from 1 or more blob credentials definition files.

     These files can be specified with the --blob-credentials argument described above or via the environment variable
     FDB_BLOB_CREDENTIALS, whose value is a colon-separated list of files.  The command line takes priority over
     over the environment but all files from both sources are used.

     At connect time, the specified files are read in order and the first matching account specification (user@host)
     will be used to obtain the secret key.

     The JSON schema is:
        { "accounts" : { "user@host" : { "secret" : "SECRETKEY" }, "user2@host2" : { "secret" : "SECRET" } } }
Options (13)
OptionDescriptionSource
-C CONNFILEThe path of a file containing the connection string for the FoundationDB cluster.help
--logEnables trace file logging for the CLI session.help
--logdir PATHSpecifes the output directory for trace files.help
--loggroup LOG_GROUPSets the LogGroup field with the specified value for all events in the trace output (defaults to `default').help
--trace-format FORMATSelect the format of the trace files.help
--tls-certificate-file CERTFILEThe path of a file containing the TLS certificate and CA chain.help
--tls-ca-file CERTAUTHFILEThe path of a file containing the CA certificates chain.help
--tls-key-file KEYFILEThe path of a file containing the private key corresponding to the TLS certificate.help
--tls-password PASSCODEThe passphrase of encrypted private keyhelp
--tls-verify-peers CONSTRAINTSThe constraints by which to validate TLS peers.help
--build-flagsPrint build information and exit.help
-v, --versionPrint version information and exit.help
-h, --helpDisplay this help and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.