OS Manuals

/usr/bin/xbcloud

Open source hot backup tool for InnoDB and XtraDB databases

From percona-xtrabackup-8.0 8.0.35.36-r7 (enterprise-packages), captured 2026-11-08 by running xbcloud --help (exit 0). permalink

/usr/bin/xbcloud  Ver 8.0.35-36 for Linux (x86_64) (revision id: 7233322c)
Copyright (C) 2015, 2021 Percona LLC and/or its affiliates.
This software comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to modify and redistribute it under the GPL license.

Manage backups on the cloud services.

Usage:
  /usr/bin/xbcloud put [OPTIONS...] <NAME> upload backup from STDIN into the cloud service with given name.
  /usr/bin/xbcloud get [OPTIONS...] <NAME> [FILES...] stream specified backup or individual files from the cloud service into STDOUT.
  /usr/bin/xbcloud delete [OPTIONS...] <NAME> [FILES...] delete specified backup or individual files from the cloud service.

Options:
  -c, --defaults-file=name
                      Name of config file to read; if no extension is given,
                      default extension (e.g., .ini or .cnf) will be added
  -?, --help          Display this help and exit.
  -V, --version       Display version and exit.
  --storage=name      Specify storage type S3/SWIFT/GOOGLE/AZURE.
  --swift-auth-version=name
                      Swift authentication verison to use.
  --swift-container=name
                      Swift container to store backups into.
  --swift-user=name   Swift user name.
  --swift-user-id=name
                      Swift user ID.
  --swift-auth-url=name
                      Base URL of SWIFT authentication service.
  --swift-storage-url=name
                      URL of object-store endpoint. Usually received from
                      authentication service. Specify to override this value.
  --swift-key=name    Swift key.
  --swift-tenant=name The tenant name. Both the --swift-tenant and
                      --swift-tenant-id options are optional, but should not be
                      specified together.
  --swift-tenant-id=name
                      The tenant ID. Both the --swift-tenant and
                      --swift-tenant-id options are optional, but should not be
                      specified together.
  --swift-project=name
                      The project name.
  --swift-project-id=name
                      The project ID.
  --swift-domain=name The user domain name.
  --swift-domain-id=name
                      The user domain ID.
  --swift-project-domain=name
                      The project domain name.
  --swift-project-domain-id=name
                      The project domain ID.
  --swift-password=name
                      The password of the user.
  --swift-region=name The region object-store endpoint.
  --parallel=#        Number of parallel chunk uploads.
  --fifo-streams=#    Number of parallel fifo stream threads.
  --fifo-dir=name     Directory to read/write Named Pipe. On put mode, xbcloud
                      read from named pipes. On get mode, xbcloud writes to
                      named pipes.
  --fifo-timeout=#    How many seconds to wait for other end to open the
                      stream. Default 60 seconds
  --timeout=#         How many seconds to wait for activity on TCP connection.
                      Setting this to 0 means no timeout. Default 120 seconds
  --max-retries=#     Number of retries of chunk uploads/downloads after a
                      failure (Default 10).
  --max-backoff=#     Maximum backoff delay in milliseconds in between chunk
                      uploads/downloads retries (Default 300000).
  --s3-region=name    S3 region.
  --s3-endpoint=name  S3 endpoint.
  --s3-access-key=name
                      S3 access key.
  --s3-secret-key=name
                      S3 secret key.
  --s3-session-token=name
                      S3 session token.
  --s3-storage-class=name
                      S3 storage class. STANDARD|STANDARD_IA|GLACIER|...
                      ... is meant for passing custom storage class names
                      provided by other S3 implementations such as MinIO
                      CephRadosGW, etc.
  --s3-bucket=name    S3 bucket.
  --s3-bucket-lookup=name
                      Bucket lookup method.
  --s3-api-version=name
                      S3 API version.
  --azure-storage-account=name
                      AZURE storage account.
  --azure-container-name=name
                      AZURE container name.
  --azure-access-key=name
                      AZURE access key.
  --azure-development-storage
                      To run against azurite emulator use
                      --azure-development-storage. It can work with the default
                      credentials provided by azurite. For example, it uses
                      http://127.0.0.1:10000 as the default endpoint, which can
                      be overwritten by --azure-endpoint. Users can also
                      provide --azure-access-key,  --azure-storage-account,
                      --azure-container-name
  --azure-endpoint=name
                      Azure cloud storage endpoint.
  --azure-tier-class=name
                      Azure cloud tier class. Hot|Cool|Archive
  --google-region=name
                      Google cloud storage region.
  --google-endpoint=name
                      Google cloud storage endpoint.
  --google-access-key=name
                      Google cloud storage access key.
  --google-secret-key=name
                      Google cloud storage secret key.
  --google-session-token=name
                      Google cloud storage session token.
  --google-storage-class=name
                      Google cloud storage class.
                      STANDARD|NEARLINE|COLDLINE|ARCHIVE
  --google-bucket=name
                      Google cloud storage bucket.
  --cacert=name       CA certificate file.
  --header=name       Extra header.
  --insecure          Do not verify server SSL certificate.
  --md5               Upload MD5 file into the backup dir.
  --verbose           Turn ON cURL tracing.
  --curl-retriable-errors=name
                      Add a new curl error code as retriable. For multiple
                      codes, use a comma separated list of codes.
  --http-retriable-errors=name
                      Add a new http error code as retriable. For multiple
                      codes, use a comma separated list of codes.
Options (54)
OptionDescriptionSource
-c, --defaults-file nameName of config file to read;help
-?, --helpDisplay this help and exit.help
-V, --versionDisplay version and exit.help
--storage nameSpecify storage type S3/SWIFT/GOOGLE/AZURE.help
--swift-auth-version nameSwift authentication verison to use.help
--swift-container nameSwift container to store backups into.help
--swift-user nameSwift user name.help
--swift-user-id nameSwift user ID.help
--swift-auth-url nameBase URL of SWIFT authentication service.help
--swift-storage-url nameURL of object-store endpoint.help
--swift-key nameSwift key.help
--swift-tenant-id nameThe tenant ID.help
--swift-project nameThe project name.help
--swift-project-id nameThe project ID.help
--swift-domain-id nameThe user domain ID.help
--swift-project-domain nameThe project domain name.help
--swift-project-domain-id nameThe project domain ID.help
--swift-password nameThe password of the user.help
--parallel #Number of parallel chunk uploads.help
--fifo-streams #Number of parallel fifo stream threads.help
--fifo-dir nameDirectory to read/write Named Pipe.help
--fifo-timeout #How many seconds to wait for other end to open the stream.help
--timeout #How many seconds to wait for activity on TCP connection.help
--max-retries #Number of retries of chunk uploads/downloads after a failure (Default 10).help
--max-backoff #Maximum backoff delay in milliseconds in between chunk uploads/downloads retries (Default 300000).help
--s3-region nameS3 region.help
--s3-endpoint nameS3 endpoint.help
--s3-access-key nameS3 access key.help
--s3-secret-key nameS3 secret key.help
--s3-session-token nameS3 session token.help
--s3-storage-class nameS3 storage class.help
--s3-bucket nameS3 bucket.help
--s3-bucket-lookup nameBucket lookup method.help
--s3-api-version nameS3 API version.help
--azure-storage-account nameAZURE storage account.help
--azure-container-name nameAZURE container name.help
--azure-access-key nameAZURE access key.help
--azure-development-storageTo run against azurite emulator usehelp
--azure-endpoint nameAzure cloud storage endpoint.help
--azure-tier-class nameAzure cloud tier class.help
--google-region nameGoogle cloud storage region.help
--google-endpoint nameGoogle cloud storage endpoint.help
--google-access-key nameGoogle cloud storage access key.help
--google-secret-key nameGoogle cloud storage secret key.help
--google-session-token nameGoogle cloud storage session token.help
--google-storage-class nameGoogle cloud storage class.help
--google-bucket nameGoogle cloud storage bucket.help
--cacert nameCA certificate file.help
--header nameExtra header.help
--insecureDo not verify server SSL certificate.help
--md5Upload MD5 file into the backup dir.help
--verboseTurn ON cURL tracing.help
--curl-retriable-errors nameAdd a new curl error code as retriable.help
--http-retriable-errors nameAdd a new http error code as retriable.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.