1% BARMAN-CLOUD-BACKUP-DELETE(1) Barman User manuals | Version 2.17 2% EnterpriseDB <http://www.enterprisedb.com> 3% December 1, 2021 4 5# NAME 6 7barman-cloud-backup-keep - Flag backups which should be kept forever 8 9 10# SYNOPSIS 11 12barman-cloud-backup-keep [*OPTIONS*] *SOURCE_URL* *SERVER_NAME* *BACKUP_ID* 13 14 15# DESCRIPTION 16 17This script can be used to flag backups previously made with 18`barman-cloud-backup` as archival backups. Archival backups are kept forever 19regardless of any retention policies applied. 20 21This script and Barman are administration tools for disaster recovery 22of PostgreSQL servers written in Python and maintained by EnterpriseDB. 23 24 25# POSITIONAL ARGUMENTS 26 27SOURCE_URL 28: URL of the cloud source, such as a bucket in AWS S3. 29 For example: `s3://BUCKET_NAME/path/to/folder` (where `BUCKET_NAME` 30 is the bucket you have created in AWS). 31 32SERVER_NAME 33: the name of the server as configured in Barman. 34 35BACKUP_ID 36: a valid Backup ID for a backup in cloud storage 37 38# OPTIONS 39 40-h, --help 41: show a help message and exit 42 43-V, --version 44: show program's version number and exit 45 46-v, --verbose 47: increase output verbosity (e.g., -vv is more than -v) 48 49-q, --quiet 50: decrease output verbosity (e.g., -qq is less than -q) 51 52-t, --test 53: test connectivity to the cloud destination and exit 54 55--target *RECOVERY_TARGET* 56: Specify the recovery target for the archival backup. 57 Possible values for *RECOVERY_TARGET* are: 58 59 - *full*: The backup can always be used to recover to the latest point 60 in time. To achieve this, Barman will retain all WALs needed to 61 ensure consistency of the backup and all subsequent WALs. 62 - *standalone*: The backup can only be used to recover the server to 63 its state at the time the backup was taken. Barman will only retain 64 the WALs needed to ensure consistency of the backup. 65 66-s, --status 67: Report the archival status of the backup. This will either be the 68 recovery target of *full* or *standalone* for archival backups or 69 *nokeep* for backups which have not been flagged as archival. 70 71-r, --release 72: Release the keep flag from this backup. This will remove its archival 73 status and make it available for deletion, either directly or by 74 retention policy. 75 76--cloud-provider {aws-s3,azure-blob-storage} 77: the cloud provider to which the backup should be uploaded 78 79-P, --profile 80: profile name (e.g. INI section in AWS credentials file) 81 82--endpoint-url 83: override the default S3 URL construction mechanism by specifying an endpoint. 84 85 86# REFERENCES 87 88For Boto: 89 90* https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html 91 92For AWS: 93 94* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html 95* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html. 96 97For Azure Blob Storage: 98 99* https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters 100* https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python 101 102 103# DEPENDENCIES 104 105If using `--cloud-provider=aws-s3`: 106 107* boto3 108 109If using `--cloud-provider=azure-blob-storage`: 110 111* azure-storage-blob 112* azure-identity (optional, if you wish to use DefaultAzureCredential) 113 114 115# EXIT STATUS 116 1170 118: Success 119 120Not zero 121: Failure 122 123 124# BUGS 125 126Barman has been extensively tested, and is currently being used in several 127production environments. However, we cannot exclude the presence of bugs. 128 129Any bug can be reported via the Github issue tracker. 130 131 132# RESOURCES 133 134* Homepage: <http://www.pgbarman.org/> 135* Documentation: <http://docs.pgbarman.org/> 136* Professional support: <http://www.enterprisedb.com/> 137 138 139# COPYING 140 141Barman is the property of EnterpriseDB UK Limited 142and its code is distributed under GNU General Public License v3. 143 144© Copyright EnterpriseDB UK Limited 2011-2021