BARMAN-CLOUD-BACKUP-SHOW(1)

✨ BARMAN-CLOUD-BACKUP-SHOW(1) ✨

okay bestie, welcome to Barman's cloud backup show page β€” this is the one that spills the tea on a backup you already made. πŸ’…


🌸 NAME 🌸

barman-cloud-backup-show β€” the Barman-cloud Commands girlies πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

barman-cloud-backup-show
                [ { -V | --version } ]
                [ --help ]
                [ { { -v | --verbose } | { -q | --quiet } } ]
                [ { -t | --test } ]
                [ --cloud-provider { aws-s3 | azure-blob-storage | google-cloud-storage } ]
                [ --endpoint-url ENDPOINT_URL ]
                [ { -P | --aws-profile } AWS_PROFILE ]
                [ --profile AWS_PROFILE ]
                [ --read-timeout READ_TIMEOUT ]
                [ --addressing-style { auto | virtual | path } ]
                [ --sse-customer-key SSE_CUSTOMER_KEY ]
                [ { --azure-credential | --credential } { azure-cli | managed-identity | default } ]
                [ --format FORMAT ]
                SOURCE_URL SERVER_NAME BACKUP_ID

πŸ’– DESCRIPTION πŸ’–

So this little script displays detailed information about one specific backup β€” the kind you made with the barman-cloud-backup command. ✨

The output is giving the same energy as barman show-backup from the barman show-backup command reference, except it has fewer information. Not a bug, that's just the vibe. πŸ™ˆ

Note: For GCP, only authentication with the GOOGLE_APPLICATION_CREDENTIALS env is supported. If you wanna use an alternative GCP universe (like S3NS/T-Systems), set the GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variable to the universe domain you want. 🌈

πŸŽ€ PARAMETERS πŸŽ€

the main characters (positional args)

  • BACKUP_ID β€” the ID of the backup, bestie. You can use a shortcut instead of the backup ID, no stress. πŸ’œ
  • SERVER_NAME β€” the name of the server that holds the backup you wanna display. πŸ‘‘
  • SOURCE_URL β€” the URL of the cloud source, like a bucket in AWS S3. For example: s3://bucket/path/to/folder. πŸ“

the options, periodt

  • -V / --version β€” show the version and dip out. ✌️
  • --help β€” show this help message and exit. 🫢
  • -v / --verbose β€” crank the output verbosity up (e.g., -vv is more than -v). πŸ”₯
  • -q / --quiet β€” turn the output verbosity down (e.g., -qq is less than -q). 🀫
  • -t / --test β€” test the cloud connectivity, then exit. 🌐
  • --cloud-provider β€” the cloud provider you're using as a storage backend. Allowed options are:
    • aws-s3.
    • azure-blob-storage.
    • google-cloud-storage.
  • --format β€” output format (console or json). Default is console. πŸ’…

πŸ”₯ EXTRA OPTIONS FOR THE AWS CLOUD PROVIDER πŸ”₯

  • --endpoint-url β€” override the default S3 endpoint URL with the one you give it.
  • -P / --aws-profile β€” profile name (e.g. INI section in the AWS credentials file).
  • --profile (deprecated) β€” profile name (e.g. INI section in the AWS credentials file) β€” this one's been replaced by --aws-profile. πŸ‘‹
  • --read-timeout β€” the time in seconds until a timeout is raised while waiting to read from a connection (defaults to 60 seconds).
  • --sse-customer-key β€” the customer-provided encryption key (SSE-C) to use for decrypting data in S3. The value must be a file:// URI pointing to a file containing a base64-encoded 256-bit (32-byte) key (e.g. file:///etc/barman/sse-c.b64). πŸ”
Important: All backups and WAL files for a given server must be encrypted with the same SSE-C key. Mixing SSE-C-encrypted and unencrypted objects, or using different keys across backups, will cause barman commands to fail when S3 rejects requests with a mismatched or missing key. πŸ’€
  • --addressing-style β€” the S3 addressing style to use when connecting to S3-compatible cloud storage. This option is a lifesaver when you're using custom S3 endpoints (like MinIO) that might need a specific addressing style. Allowed options:
    • auto (default): uses the addressing style determined by the boto3 library.
    • virtual: uses virtual-hosted-style addressing (bucket-name.s3.amazonaws.com).
    • path: uses path-style addressing (s3.amazonaws.com/bucket-name).

πŸ’œ EXTRA OPTIONS FOR THE AZURE CLOUD PROVIDER πŸ’œ

  • --azure-credential / --credential β€” optionally specify the type of credential to use when authenticating with Azure. If you omit it, then Azure Blob Storage credentials will be obtained from the environment and the default Azure authentication flow will be used for authenticating with all other Azure services. And if no credentials can be found in the environment, then the default Azure authentication flow will also be used for Azure Blob Storage. ✨ Allowed options are:
    • azure-cli.
    • managed-identity.
    • default.

⭐ AUTHOR ⭐

EnterpriseDB πŸ‘‘


Β© Copyright EnterpriseDB UK Limited 2011-2026


and that's the whole page, bestie πŸ’– Barman 3.20, dated Sep 29, 2026 β€” go show off those backups, you main character πŸ¦‹πŸ’…βœ¨

πŸ“¦ where this page comes from