1% BARMAN-CLOUD-CHECK-WAL-ARCHIVE(1) Barman User manuals | Version 2.17 2% EnterpriseDB <http://www.enterprisedb.com> 3% December 1, 2021 4 5# NAME 6 7barman-cloud-check-wal-archive - Check a WAL archive destination for a new PostgreSQL cluster 8 9 10# SYNOPSIS 11 12barman-cloud-check-wal-archive [*OPTIONS*] *SOURCE_URL* *SERVER_NAME* 13 14 15# DESCRIPTION 16 17Check that the WAL archive destination for *SERVER_NAME* is safe to use 18for a new PostgreSQL cluster. With no optional args (the default) this 19check will pass if the WAL archive is empty and fail otherwise. 20 21This script and Barman are administration tools for disaster recovery 22of PostgreSQL servers written in Python and maintained by EnterpriseDB. 23 24 25# POSITIONAL ARGUMENTS 26 27SOURCE_URL 28: URL of the cloud source, such as a bucket in AWS S3. 29 For example: `s3://BUCKET_NAME/path/to/folder` (where `BUCKET_NAME` 30 is the bucket you have created in AWS). 31 32SERVER_NAME 33: the name of the server as configured in Barman. 34 35# OPTIONS 36 37-h, --help 38: show a help message and exit 39 40-V, --version 41: show program's version number and exit 42 43-v, --verbose 44: increase output verbosity (e.g., -vv is more than -v) 45 46-q, --quiet 47: decrease output verbosity (e.g., -qq is less than -q) 48 49-t, --test 50: test connectivity to the cloud destination and exit 51 52--timeline 53: A positive integer specifying the earliest timeline for which 54 associated WALs should cause the check to fail. 55 The check will pass if all WAL content in the archive relates 56 to earlier timelines. If any WAL files are on this timeline or 57 greater then the check will fail. 58 59--cloud-provider {aws-s3,azure-blob-storage} 60: the cloud provider to which the backup should be uploaded 61 62-P, --profile 63: profile name (e.g. INI section in AWS credentials file) 64 65--endpoint-url 66: override the default S3 URL construction mechanism by specifying an endpoint. 67 68 69# REFERENCES 70 71For Boto: 72 73* https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html 74 75For AWS: 76 77* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html 78* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html. 79 80For Azure Blob Storage: 81 82* https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters 83* https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python 84 85 86# DEPENDENCIES 87 88If using `--cloud-provider=aws-s3`: 89 90* boto3 91 92If using `--cloud-provider=azure-blob-storage`: 93 94* azure-storage-blob 95* azure-identity (optional, if you wish to use DefaultAzureCredential) 96 97 98# EXIT STATUS 99 1000 101: Success 102 1031 104: Failure 105 1062 107: Error running the check 108 109 110# BUGS 111 112Barman has been extensively tested, and is currently being used in several 113production environments. However, we cannot exclude the presence of bugs. 114 115Any bug can be reported via the Github issue tracker. 116 117 118# RESOURCES 119 120* Homepage: <http://www.pgbarman.org/> 121* Documentation: <http://docs.pgbarman.org/> 122* Professional support: <http://www.enterprisedb.com/> 123 124 125# COPYING 126 127Barman is the property of EnterpriseDB UK Limited 128and its code is distributed under GNU General Public License v3. 129 130© Copyright EnterpriseDB UK Limited 2011-2021 131