OS Manuals

/usr/bin/fdbcli

A Distributed database designed to handle large volumes of structured data across clusters of commodity servers

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

FoundationDB CLI 7.3 (v7.3.79)
usage: /usr/bin/fdbcli [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.
  --log-dir PATH Specifes the output directory for trace files. If
                 unspecified, defaults to the current directory. Has
                 no effect unless --log is specified.
  --log-group 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 log files. xml (the default) and json
                 are supported. Has no effect unless --log is specified.
  --exec CMDS    Immediately executes the semicolon separated CLI commands
                 and then exits.
  --no-status    Disables the initial status check done when starting
                 the CLI.
  --api-version  APIVERSION
                 Specifies the version of the API for the CLI to use.
  --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.
  --knob-KNOBNAME KNOBVALUE
                 Changes a knob option. KNOBNAME should be lowercase.
  --debug-tls    Prints the TLS configuration and certificate chain, then exits.
                 Useful in reporting and diagnosing TLS issues.
  --build-flags  Print build information and exit.
  --memory       Resident memory limit of the CLI (defaults to 8GiB).
  --use-future-protocol-version
                 Use the simulated future protocol version to connect to the cluster.
                 This option can be used testing purposes only!
  -v, --version  Print FoundationDB CLI version information and exit.
  -h, --help     Display this help and exit.
Options (19)
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
--log-group 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 log files.help
--exec CMDSImmediately executes the semicolon separated CLI commands and then exits.help
--no-statusDisables the initial status check done when starting the CLI.help
--api-versionAPIVERSION Specifies the version of the API for the CLI to use.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
--knob-KNOBNAME KNOBVALUEChanges a knob option.help
--debug-tlsPrints the TLS configuration and certificate chain, then exits.help
--build-flagsPrint build information and exit.help
--memoryResident memory limit of the CLI (defaults to 8GiB).help
--use-future-protocol-versionUse the simulated future protocol version to connect to the cluster.help
-v, --versionPrint FoundationDB CLI 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.