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