BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1)

πŸ’… barman-cloud-check-wal-archive β€” the vibe check for your WAL archive

okay bestie, so this is a page from the Barman manual, section 1 β€” it's barman-cloud-check-wal-archive, and it's the command that peeks at a WAL archive destination and is like "mm, is this ready for a brand new Postgres cluster or nah?" πŸ¦‹


✨ SYNOPSIS ✨

barman-cloud-check-wal-archive
                [ { -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 } ]
                [ { --azure-credential | --credential }
                  { azure-cli | managed-identity | default } ]
                [ --timeline TIMELINE ]
                DESTINATION_URL SERVER_NAME

πŸŽ€ DESCRIPTION πŸŽ€

So basically: this command verifies that the WAL archive destination for a server is actually suitable for use with a new Postgres cluster. vibe check complete πŸ’–

By default, the check succeeds if the WAL archive is empty. If there are any WAL files sitting in the archive, the check fails β€” unless you pass the --timeline option and all the existing WALs come from timelines earlier than the value you specified. then it's fine, no drama. 🌸

Note: the barman-cloud-check-wal-archive command performs an initial HeadBucket call to verify whether the target bucket already exists in the S3 storage. If the bucket does not exist, the command will attempt to automatically create it before performing the WAL archive check. πŸ‘‘
Note: this is the only Barman command that performs these operations (bucket existence check and automatic creation). main character energy, fr fr.
Note: for GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported. To use an alternative GCP universe (e.g. S3NS/T-Systems), set the GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variable to the desired universe domain. 🌈

🧚 PARAMETERS 🧚

  • SERVER_NAME β€” the name of the server that needs to be checked. like, who are we even checking, bestie? 🫢
  • DESTINATION_URL β€” the URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder. πŸ“
  • -V / --version β€” show version and exit. iconic, short, does one thing.
  • --help β€” show this help message and exit.
  • -v / --verbose β€” increase output verbosity (e.g. -vv is more than -v). the way she just keeps talking πŸ’€
  • -q / --quiet β€” decrease output verbosity (e.g. -qq is less than -q). shhh 🀫
  • -t / --test β€” test cloud connectivity and exit. just checking the signal real quick.
  • --cloud-provider β€” the cloud provider to use as a storage backend.

Allowed options are:

  • aws-s3.
  • azure-blob-storage.
  • google-cloud-storage.
  • --timeline β€” the earliest timeline whose WALs should cause the check to fail. ⏳

πŸ’œ Extra options for the AWS cloud provider πŸ’œ

  • --endpoint-url β€” override default S3 endpoint URL with the given one.
  • -P / --aws-profile β€” profile name (e.g. INI section in AWS credentials file).
  • --profile (deprecated) β€” profile name (e.g. INI section in AWS credentials file) β€” replaced by --aws-profile. it's giving legacy, ngl, use the new one πŸ₯²
  • --read-timeout β€” the time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds). ⏰
  • --addressing-style β€” the S3 addressing style to use when connecting to S3-compatible cloud storage. This option is useful when using custom S3 endpoints (such as MinIO) that may require 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 omitted 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. 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 β€” you ate that πŸ«ΆπŸ’… this was Barman 3.20, dated Sep 29, 2026. periodt. πŸŽ€βœ¨

πŸ“¦ where this page comes from