1% BARMAN-CLOUD-BACKUP-LIST(1) Barman User manuals | Version 2.17
2% EnterpriseDB <http://www.enterprisedb.com>
3% December 1, 2021
4
5# NAME
6
7barman-cloud-backup-list - List backups stored in the Cloud
8
9
10# SYNOPSIS
11
12barman-cloud-backup-list [*OPTIONS*] *SOURCE_URL* *SERVER_NAME*
13
14
15# DESCRIPTION
16
17This script can be used to list backups previously made with
18`barman-cloud-backup` command. Currently AWS S3 and Azure Blob Storage
19are supported.
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--format {json,console}
53:    output format (default: 'console')
54
55--cloud-provider {aws-s3,azure-blob-storage}
56:    the cloud provider to which the backup should be uploaded
57
58-P, --profile
59:    profile name (e.g. INI section in AWS credentials file)
60
61--endpoint-url
62:    override the default S3 URL construction mechanism by specifying an endpoint.
63
64# REFERENCES
65
66For Boto:
67
68* https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
69
70For AWS:
71
72* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html
73* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html.
74
75For Azure Blob Storage:
76
77* https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
78* https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
79
80# DEPENDENCIES
81
82If using `--cloud-provider=aws-s3`:
83
84* boto3
85
86If using `--cloud-provider=azure-blob-storage`:
87
88* azure-storage-blob
89* azure-identity (optional, if you wish to use DefaultAzureCredential)
90
91# EXIT STATUS
92
930
94:   Success
95
96Not zero
97:   Failure
98
99
100# BUGS
101
102Barman has been extensively tested, and is currently being used in several
103production environments. However, we cannot exclude the presence of bugs.
104
105Any bug can be reported via the Github issue tracker.
106
107# RESOURCES
108
109* Homepage: <http://www.pgbarman.org/>
110* Documentation: <http://docs.pgbarman.org/>
111* Professional support: <http://www.enterprisedb.com/>
112
113
114# COPYING
115
116Barman is the property of EnterpriseDB UK Limited
117and its code is distributed under GNU General Public License v3.
118
119© Copyright EnterpriseDB UK Limited 2011-2021
120