1BARMAN-CLOUD-BACKUP-LIST(1) Version 3.9.0 BARMAN-CLOUD-BACKUP-LIST(1)
2
6 barman-cloud-backup-list - List backups stored in the Cloud
7
9 barman-cloud-backup-list [OPTIONS] SOURCE_URL SERVER_NAME
10
12 This script can be used to list backups previously made with bar‐
13 man-cloud-backup command. Currently AWS S3, Azure Blob Storage and
14 Google Cloud Storage are supported.
15 This script and Barman are administration tools for disaster recovery
17 of PostgreSQL servers written in Python and maintained by EnterpriseDB.
18
20 usage: barman-cloud-backup-list [-V] [--help] [-v | -q] [-t]
21 [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}]
22 [--endpoint-url ENDPOINT_URL]
23 [-P AWS_PROFILE] [--profile AWS_PROFILE]
24 [--read-timeout READ_TIMEOUT]
25 [--azure-credential {azure-cli,managed-identity}]
26 [--format FORMAT]
27 source_url server_name
28 This script can be used to list backups made with barman-cloud-backup command.
30 Currently AWS S3, Azure Blob Storage and Google Cloud Storage are supported.
31 positional arguments:
33 source_url URL of the cloud source, such as a bucket in AWS S3.
34 For example: `s3://bucket/path/to/folder`.
35 server_name the name of the server as configured in Barman.
36 optional arguments:
38 -V, --version show program's version number and exit
39 --help show this help message and exit
40 -v, --verbose increase output verbosity (e.g., -vv is more than -v)
41 -q, --quiet decrease output verbosity (e.g., -qq is less than -q)
42 -t, --test Test cloud connectivity and exit
43 --cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
44 The cloud provider to use as a storage backend
45 --format FORMAT Output format (console or json). Default console.
46 Extra options for the aws-s3 cloud provider:
48 --endpoint-url ENDPOINT_URL
49 Override default S3 endpoint URL with the given one
50 -P AWS_PROFILE, --aws-profile AWS_PROFILE
51 profile name (e.g. INI section in AWS credentials
52 file)
53 --profile AWS_PROFILE
54 profile name (deprecated: replaced by --aws-profile)
55 --read-timeout READ_TIMEOUT
56 the time in seconds until a timeout is raised when
57 waiting to read from a connection (defaults to 60
58 seconds)
59 Extra options for the azure-blob-storage cloud provider:
61 --azure-credential {azure-cli,managed-identity}, --credential {azure-cli,managed-identity}
62 Optionally specify the type of credential to use when
63 authenticating with Azure. If omitted then Azure Blob
64 Storage credentials will be obtained from the
65 environment and the default Azure authentication flow
66 will be used for authenticating with all other Azure
67 services. If no credentials can be found in the
68 environment then the default Azure authentication flow
69 will also be used for Azure Blob Storage.
70
72 For Boto:
73 • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
75 uration.html
76 For AWS:
78 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
80 ting-set-up.html
81 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
83 ting-started.html.
84 For Azure Blob Storage:
86 • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
88 ta-operations-cli#set-environment-variables-for-authorization-parame‐
89 ters
90 • https://docs.microsoft.com/en-us/python/api/azure-stor‐
92 age-blob/?view=azure-python
93 For Google Cloud Storage: * Credentials:
95 https://cloud.google.com/docs/authentication/getting-started#set‐
96 ting_the_environment_variable
97 Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
99 ed at the moment.
100
102 If using --cloud-provider=aws-s3:
103 • boto3
105 If using --cloud-provider=azure-blob-storage:
107 • azure-storage-blob
109 • azure-identity (optional, if you wish to use DefaultAzureCredential)
111 If using --cloud-provider=google-cloud-storage * google-cloud-storage
113
115 0 Success
116 1 The list command was not successful
118 2 The connection to the cloud provider failed
120 3 There was an error in the command input
122 Other non-zero codes
124 Failure
125
127 Barman has been extensively tested, and is currently being used in sev‐
128 eral production environments. However, we cannot exclude the presence
129 of bugs.
130 Any bug can be reported via the GitHub issue tracker.
132
134 • Homepage: <https://www.pgbarman.org/>
135 • Documentation: <https://docs.pgbarman.org/>
137 • Professional support: <https://www.enterprisedb.com/>
139
141 Barman is the property of EnterpriseDB UK Limited and its code is dis‐
142 tributed under GNU General Public License v3.
143 © Copyright EnterpriseDB UK Limited 2011-2023
145
147 EnterpriseDB <https://www.enterprisedb.com>.
148Barman User manuals October 3, 2023 BARMAN-CLOUD-BACKUP-LIST(1)