1BARMAN-CLOUD-BACKUP-DELETE(1) Version 3.9.0 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 usage: barman-cloud-backup-keep [-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 (-r | -s | --target {full,standalone})
27 source_url server_name backup_id
28 This script can be used to tag backups in cloud storage as archival backups
30 such that they will not be deleted. Currently AWS S3, Azure Blob Storage and
31 Google Cloud Storage are supported.
32 positional arguments:
34 source_url URL of the cloud source, such as a bucket in AWS S3.
35 For example: `s3://bucket/path/to/folder`.
36 server_name the name of the server as configured in Barman.
37 backup_id the backup ID of the backup to be kept
38 optional arguments:
40 -V, --version show program's version number and exit
41 --help show this help message and exit
42 -v, --verbose increase output verbosity (e.g., -vv is more than -v)
43 -q, --quiet decrease output verbosity (e.g., -qq is less than -q)
44 -t, --test Test cloud connectivity and exit
45 --cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
46 The cloud provider to use as a storage backend
47 -r, --release If specified, the command will remove the keep
48 annotation and the backup will be eligible for
49 deletion
50 -s, --status Print the keep status of the backup
51 --target {full,standalone}
52 Specify the recovery target for this backup
53 Extra options for the aws-s3 cloud provider:
55 --endpoint-url ENDPOINT_URL
56 Override default S3 endpoint URL with the given one
57 -P AWS_PROFILE, --aws-profile AWS_PROFILE
58 profile name (e.g. INI section in AWS credentials
59 file)
60 --profile AWS_PROFILE
61 profile name (deprecated: replaced by --aws-profile)
62 --read-timeout READ_TIMEOUT
63 the time in seconds until a timeout is raised when
64 waiting to read from a connection (defaults to 60
65 seconds)
66 Extra options for the azure-blob-storage cloud provider:
68 --azure-credential {azure-cli,managed-identity}, --credential {azure-cli,managed-identity}
69 Optionally specify the type of credential to use when
70 authenticating with Azure. If omitted then Azure Blob
71 Storage credentials will be obtained from the
72 environment and the default Azure authentication flow
73 will be used for authenticating with all other Azure
74 services. If no credentials can be found in the
75 environment then the default Azure authentication flow
76 will also be used for Azure Blob Storage.
77
79 For Boto:
80 • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
82 uration.html
83 For AWS:
85 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
87 ting-set-up.html
88 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
90 ting-started.html.
91 For Azure Blob Storage:
93 • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
95 ta-operations-cli#set-environment-variables-for-authorization-parame‐
96 ters
97 • https://docs.microsoft.com/en-us/python/api/azure-stor‐
99 age-blob/?view=azure-python
100 For Google Cloud Storage: * Credentials:
102 https://cloud.google.com/docs/authentication/getting-started#set‐
103 ting_the_environment_variable
104 Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
106 ed at the moment.
107
109 If using --cloud-provider=aws-s3:
110 • boto3
112 If using --cloud-provider=azure-blob-storage:
114 • azure-storage-blob
116 • azure-identity (optional, if you wish to use DefaultAzureCredential)
118 If using --cloud-provider=google-cloud-storage * google-cloud-storage
120
122 0 Success
123 1 The keep command was not successful
125 2 The connection to the cloud provider failed
127 3 There was an error in the command input
129 Other non-zero codes
131 Failure
132
134 Barman has been extensively tested, and is currently being used in sev‐
135 eral production environments. However, we cannot exclude the presence
136 of bugs.
137 Any bug can be reported via the GitHub issue tracker.
139
141 • Homepage: <https://www.pgbarman.org/>
142 • Documentation: <https://docs.pgbarman.org/>
144 • Professional support: <https://www.enterprisedb.com/>
146
148 Barman is the property of EnterpriseDB UK Limited and its code is dis‐
149 tributed under GNU General Public License v3.
150 © Copyright EnterpriseDB UK Limited 2011-2023
152
154 EnterpriseDB <https://www.enterprisedb.com>.
155Barman User manuals October 3, 2023 BARMAN-CLOUD-BACKUP-DELETE(1)