1BARMAN-CLOUD-BACKUP-LIST(1) Version 3.0.1 BARMAN-CLOUD-BACKUP-LIST(1)
2
3
4
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
16 This script and Barman are administration tools for disaster recovery
17 of PostgreSQL servers written in Python and maintained by EnterpriseDB.
18
20 SOURCE_URL
21 URL of the cloud source, such as a bucket in AWS S3. For exam‐
22 ple: s3://BUCKET_NAME/path/to/folder (where BUCKET_NAME is the
23 bucket you have created in AWS).
24
25 SERVER_NAME
26 the name of the server as configured in Barman.
27
29 -h, –help
30 show a help message and exit
31
32 -V, –version
33 show program's version number and exit
34
35 -v, –verbose
36 increase output verbosity (e.g., -vv is more than -v)
37
38 -q, –quiet
39 decrease output verbosity (e.g., -qq is less than -q)
40
41 -t, –test
42 test connectivity to the cloud destination and exit
43
44 –format {json,console}
45 output format (default: `console')
46
47 –cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
48 the cloud provider to which the backup should be uploaded
49
50 -P, –profile
51 profile name (e.g. INI section in AWS credentials file)
52
53 –endpoint-url
54 override the default S3 URL construction mechanism by specifying
55 an endpoint.
56
57 –credential {azure-cli,managed-identity}
58 optionally specify the type of credential to use when authenti‐
59 cating with Azure Blob Storage. If omitted then the credential
60 will be obtained from the environment. If no credentials can be
61 found in the environment then the default Azure authentication
62 flow will be used.
63
65 For Boto:
66
67 • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
68 uration.html
69
70 For AWS:
71
72 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
73 ting-set-up.html
74
75 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
76 ting-started.html.
77
78 For Azure Blob Storage:
79
80 • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
81 ta-operations-cli#set-environment-variables-for-authorization-parame‐
82 ters
83
84 • https://docs.microsoft.com/en-us/python/api/azure-stor‐
85 age-blob/?view=azure-python
86
87 For Google Cloud Storage: * Credentials:
88 https://cloud.google.com/docs/authentication/getting-started#set‐
89 ting_the_environment_variable
90
91 Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
92 ed at the moment.
93
95 If using --cloud-provider=aws-s3:
96
97 • boto3
98
99 If using --cloud-provider=azure-blob-storage:
100
101 • azure-storage-blob
102
103 • azure-identity (optional, if you wish to use DefaultAzureCredential)
104
105 If using --cloud-provider=google-cloud-storage * google-cloud-storage
106
108 0 Success
109
110 1 The list command was not successful
111
112 2 The connection to the cloud provider failed
113
114 3 There was an error in the command input
115
116 Other non-zero codes
117 Failure
118
120 Barman has been extensively tested, and is currently being used in sev‐
121 eral production environments. However, we cannot exclude the presence
122 of bugs.
123
124 Any bug can be reported via the Github issue tracker.
125
127 • Homepage: <https://www.pgbarman.org/>
128
129 • Documentation: <https://docs.pgbarman.org/>
130
131 • Professional support: <https://www.enterprisedb.com/>
132
134 Barman is the property of EnterpriseDB UK Limited and its code is dis‐
135 tributed under GNU General Public License v3.
136
137 © Copyright EnterpriseDB UK Limited 2011-2022
138
140 EnterpriseDB <https://www.enterprisedb.com>.
141
142
143
144Barman User manuals June 27, 2022 BARMAN-CLOUD-BACKUP-LIST(1)