XBCLOUD(1)

📦
version 9.7.1~rc1 · 4 versions
, in ubuntu stonking

🎀 NAME 🎀

hiii bestie 💖 you've landed on xbcloud(1), from the User Commands corner of the manual. Welcome to the group chat where we talk about managing your backups on cloud services, and yes she is that girl. ✨

🦋 DESCRIPTION 🦋

okay so first things first, here's the version flex:

./bin/xbcloud Ver 9.7.1-rc1 for Linux (x86_64) (revision id: b1c9c341)

And the legal bit, which we do not skip, bestie, we read it:

Copyright © 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.

Anywayyy, what does she actually do? She manages backups on the cloud services. That's it, that's the whole vibe. 🫶

🌸 Usage:

no cap, there are exactly three moves she knows, and every single one has [OPTIONS...] you can sprinkle in:

./bin/xbcloud put [OPTIONS...] <NAME>
./bin/xbcloud get [OPTIONS...] <NAME> [FILES...]
./bin/xbcloud delete [OPTIONS...] <NAME> [FILES...]

and here's what each one eats, lowkey:

  • put — uploads a backup from STDIN into the cloud service under the name you give it. 💖
  • get — streams the backup you specified, or just individual FILES, from the cloud service into STDOUT. 🌈
  • delete — deletes the backup you specified, or individual FILES, from the cloud service. 💀 (yes, she will actually do it, no take-backs)

💅 OPTIONS 💅

everything she'll let you tweak, one by one, because we do not gatekeep:

  • -c, --defaults-file=name — the name of the config file she should read. Give her no extension and she'll add the default one (think .ini or .cnf) herself, iconic.
  • -?, --help — display this help and dip. 🧚
  • -V, --version — display the version and dip. ⭐
  • --storage=name — say which storage type you're on: S3/SWIFT/GOOGLE/AZURE.
  • --swift-auth-version=name — which Swift authentication version to use.
  • --swift-container=name — the Swift container your backups get stored into.
  • --swift-user=name — Swift user name.
  • --swift-user-id=name — Swift user ID.
  • --swift-auth-url=name — base URL of the SWIFT authentication service.
  • --swift-storage-url=name — URL of the object-store endpoint. Usually she receives this from the authentication service; set it here to override that value. 💫
  • --swift-key=name — Swift key.
  • --swift-tenant=name — the tenant name. Both --swift-tenant and --swift-tenant-id are optional, but pls do not pass them together, that's the rule.
  • --swift-tenant-id=name — the tenant ID. Same energy: both --swift-tenant and --swift-tenant-id are optional, but never specify them 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=# — how many chunk uploads go down in parallel, fr fr.
  • --fifo-streams=# — how many parallel fifo stream threads.
  • --fifo-dir=name — the directory to read/write the Named Pipe in. In put mode, xbcloud reads from named pipes; in get mode, xbcloud writes to named pipes. 🦋
  • --fifo-timeout=# — how many seconds she waits for the other end to open the stream. Default is 60 seconds.
  • --timeout=# — how many seconds to wait for activity on the TCP connection. Setting this to 0 means no timeout. Default is 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. That's STANDARD|STANDARD_IA|GLACIER|... and the ... 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 the azurite emulator, use --azure-development-storage. She 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 the server SSL certificate. 👀 she said what she said, this one is exactly as spicy as it sounds.
  • --md5 — upload the MD5 file into the backup dir.
  • --verbose — turn ON cURL tracing, if you're nosy like that (me too).
  • --curl-retriable-errors=name — add a new curl error code as retriable. Got multiple codes? Use a comma separated list of codes.
  • --http-retriable-errors=name — add a new http error code as retriable. Got multiple codes? Comma separated list of codes, same deal.

and that's the whole page, bestie 🫶 this one came straight from the XBCLOUD(1) manual — xbcloud Ver 9.7.1-rc1 for Lin... — dated September 2026. go be a cloud backup main character. 💅👑

📦 where this page comes from