Scroll to navigation

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

NAME

barman-cloud-check-wal-archive - Barman-cloud Commands

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 ]


                [ { --azure-credential | --credential }


                  { azure-cli | managed-identity | default } ]


                [ --timeline TIMELINE ]


                DESTINATION_URL SERVER_NAME


Description

Verify that the WAL archive destination for a server is suitable for use with a new Postgres cluster. By default, the check will succeed if the WAL archive is empty or if the target bucket is not found. Any other conditions will result in a failure.

NOTE:

For GCP, only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported.


Parameters

Name of the server that needs to be checked.
URL of the cloud destination, such as a bucket in AWS S3. For example: s3://bucket/path/to/folder.
Show version and exit.
show this help message and exit.
Increase output verbosity (e.g., -vv is more than -v).
Decrease output verbosity (e.g., -qq is less than -q).
Test cloud connectivity and exit.
The cloud provider to use as a storage backend.

Allowed options are:

  • aws-s3.
  • azure-blob-storage.
  • google-cloud-storage.

The earliest timeline whose WALs should cause the check to fail.

Extra options for the AWS cloud provider

Override default S3 endpoint URL with the given one.
Profile name (e.g. INI section in AWS credentials file).
Profile name (e.g. INI section in AWS credentials file) - replaced by --aws-profile.
The time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds).

Extra options for the Azure cloud provider

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

© Copyright EnterpriseDB UK Limited 2011-2025

April 24, 2025 3.13