1BARMAN-CLOUD-BACKUP-DELETE(1) Version 3.0.1 BARMAN-CLOUD-BACKUP-DELETE(1)
2
6 barman-cloud-backup-keep - Flag backups which should be kept forever
7
9 barman-cloud-backup-keep [OPTIONS] SOURCE_URL SERVER_NAME BACKUP_ID
10
12 This script can be used to flag backups previously made with bar‐
13 man-cloud-backup as archival backups. Archival backups are kept forev‐
14 er regardless of any retention policies applied.
15 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 SERVER_NAME
26 the name of the server as configured in Barman.
27 BACKUP_ID
29 a valid Backup ID for a backup in cloud storage
30
32 -h, –help
33 show a help message and exit
34 -V, –version
36 show program's version number and exit
37 -v, –verbose
39 increase output verbosity (e.g., -vv is more than -v)
40 -q, –quiet
42 decrease output verbosity (e.g., -qq is less than -q)
43 -t, –test
45 test connectivity to the cloud destination and exit
46 –target RECOVERY_TARGET
48 Specify the recovery target for the archival backup. Possible
49 values for RECOVERY_TARGET are:
50 • full: The backup can always be used to recover to the latest
52 point in time. To achieve this, Barman will retain all WALs
53 needed to ensure consistency of the backup and all subsequent
54 WALs.
55 • standalone: The backup can only be used to recover the server
57 to its state at the time the backup was taken. Barman will
58 only retain the WALs needed to ensure consistency of the back‐
59 up.
60 -s, –status
62 Report the archival status of the backup. This will either be
63 the recovery target of full or standalone for archival backups
64 or nokeep for backups which have not been flagged as archival.
65 -r, –release
67 Release the keep flag from this backup. This will remove its
68 archival status and make it available for deletion, either di‐
69 rectly or by retention policy.
70 –cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
72 the cloud provider to which the backup should be uploaded
73 -P, –profile
75 profile name (e.g. INI section in AWS credentials file)
76 –endpoint-url
78 override the default S3 URL construction mechanism by specifying
79 an endpoint.
80 –credential {azure-cli,managed-identity}
82 optionally specify the type of credential to use when authenti‐
83 cating with Azure Blob Storage. If omitted then the credential
84 will be obtained from the environment. If no credentials can be
85 found in the environment then the default Azure authentication
86 flow will be used.
87
89 For Boto:
90 • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
92 uration.html
93 For AWS:
95 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
97 ting-set-up.html
98 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
100 ting-started.html.
101 For Azure Blob Storage:
103 • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
105 ta-operations-cli#set-environment-variables-for-authorization-parame‐
106 ters
107 • https://docs.microsoft.com/en-us/python/api/azure-stor‐
109 age-blob/?view=azure-python
110 For Google Cloud Storage: * Credentials:
112 https://cloud.google.com/docs/authentication/getting-started#set‐
113 ting_the_environment_variable
114 Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
116 ed at the moment.
117
119 If using --cloud-provider=aws-s3:
120 • boto3
122 If using --cloud-provider=azure-blob-storage:
124 • azure-storage-blob
126 • azure-identity (optional, if you wish to use DefaultAzureCredential)
128 If using --cloud-provider=google-cloud-storage * google-cloud-storage
130
132 0 Success
133 1 The keep command was not successful
135 2 The connection to the cloud provider failed
137 3 There was an error in the command input
139 Other non-zero codes
141 Failure
142
144 Barman has been extensively tested, and is currently being used in sev‐
145 eral production environments. However, we cannot exclude the presence
146 of bugs.
147 Any bug can be reported via the Github issue tracker.
149
151 • Homepage: <https://www.pgbarman.org/>
152 • Documentation: <https://docs.pgbarman.org/>
154 • Professional support: <https://www.enterprisedb.com/>
156
158 Barman is the property of EnterpriseDB UK Limited and its code is dis‐
159 tributed under GNU General Public License v3.
160 © Copyright EnterpriseDB UK Limited 2011-2022
162
164 EnterpriseDB <https://www.enterprisedb.com>.
165Barman User manuals June 27, 2022 BARMAN-CLOUD-BACKUP-DELETE(1)