.\" Automatically generated by Pandoc 2.2.1 .\" .TH "BARMAN\-CLOUD\-BACKUP\-DELETE" "1" "January 24, 2024" "Barman User manuals" "Version 3.10.0" .hy .SH NAME .PP barman\-cloud\-backup\-delete \- Delete backups stored in the Cloud .SH SYNOPSIS .PP barman\-cloud\-backup\-delete [\f[I]OPTIONS\f[]] \f[I]SOURCE_URL\f[] \f[I]SERVER_NAME\f[] .SH DESCRIPTION .PP This script can be used to delete backups previously made with the \f[C]barman\-cloud\-backup\f[] command. Currently AWS S3, Azure Blob Storage and Google Cloud Storage are supported. .PP The target backups can be specified either using the backup ID (as returned by barman\-cloud\-backup\-list) or by retention policy. Retention policies are the same as those for Barman server and work as described in the Barman manual: all backups not required to meet the specified policy will be deleted. .PP When a backup is successfully deleted any unused WALs associated with that backup are removed. WALs are only considered unused if: .IP "1." 3 There are no older backups than the deleted backup \f[I]or\f[] all older backups are archival backups. .IP "2." 3 The WALs pre\-date the begin_wal value of the oldest remaining backup. .IP "3." 3 The WALs are not required by any archival backups present in cloud storage. .PP Note: The deletion of each backup involves three separate delete requests to the cloud provider (once for the backup files, once for the backup.info file and once for any associated WALs). If you have a significant number of backups accumulated in cloud storage then deleting by retention policy could result in a large number of delete requests. .PP This script and Barman are administration tools for disaster recovery of PostgreSQL servers written in Python and maintained by EnterpriseDB. .SH Usage .IP .nf \f[C] usage:\ barman\-cloud\-backup\-delete\ [\-V]\ [\-\-help]\ [\-v\ |\ \-q]\ [\-t] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-cloud\-provider\ {aws\-s3,azure\-blob\-storage,google\-cloud\-storage}] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-endpoint\-url\ ENDPOINT_URL] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-P\ AWS_PROFILE]\ [\-\-profile\ AWS_PROFILE] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-read\-timeout\ READ_TIMEOUT] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-azure\-credential\ {azure\-cli,managed\-identity} \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-b\ BACKUP_ID]\ [\-m\ MINIMUM_REDUNDANCY] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-r\ RETENTION_POLICY]\ [\-\-dry\-run] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-batch\-size\ DELETE_BATCH_SIZE] \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ source_url\ server_name This\ script\ can\ be\ used\ to\ delete\ backups\ made\ with\ barman\-cloud\-backup command.\ Currently\ AWS\ S3,\ Azure\ Blob\ Storage\ and\ Google\ Cloud\ Storage\ are supported. positional\ arguments: \ \ source_url\ \ \ \ \ \ \ \ \ \ \ \ URL\ of\ the\ cloud\ source,\ such\ as\ a\ bucket\ in\ AWS\ S3. \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ For\ example:\ `s3://bucket/path/to/folder`. \ \ server_name\ \ \ \ \ \ \ \ \ \ \ the\ name\ of\ the\ server\ as\ configured\ in\ Barman. optional\ arguments: \ \ \-V,\ \-\-version\ \ \ \ \ \ \ \ \ show\ program\[aq]s\ version\ number\ and\ exit \ \ \-\-help\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ show\ this\ help\ message\ and\ exit \ \ \-v,\ \-\-verbose\ \ \ \ \ \ \ \ \ increase\ output\ verbosity\ (e.g.,\ \-vv\ is\ more\ than\ \-v) \ \ \-q,\ \-\-quiet\ \ \ \ \ \ \ \ \ \ \ decrease\ output\ verbosity\ (e.g.,\ \-qq\ is\ less\ than\ \-q) \ \ \-t,\ \-\-test\ \ \ \ \ \ \ \ \ \ \ \ Test\ cloud\ connectivity\ and\ exit \ \ \-\-cloud\-provider\ {aws\-s3,azure\-blob\-storage,google\-cloud\-storage} \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ cloud\ provider\ to\ use\ as\ a\ storage\ backend \ \ \-b\ BACKUP_ID,\ \-\-backup\-id\ BACKUP_ID \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Backup\ ID\ of\ the\ backup\ to\ be\ deleted \ \ \-m\ MINIMUM_REDUNDANCY,\ \-\-minimum\-redundancy\ MINIMUM_REDUNDANCY \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ minimum\ number\ of\ backups\ that\ should\ always\ be\ available. \ \ \-r\ RETENTION_POLICY,\ \-\-retention\-policy\ RETENTION_POLICY \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ If\ specified,\ delete\ all\ backups\ eligible\ for\ deletion \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ according\ to\ the\ supplied\ retention\ policy.\ Syntax: \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ REDUNDANCY\ value\ |\ RECOVERY\ WINDOW\ OF\ value\ {DAYS\ | \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ WEEKS\ |\ MONTHS} \ \ \-\-dry\-run\ \ \ \ \ \ \ \ \ \ \ \ \ Find\ the\ objects\ which\ need\ to\ be\ deleted\ but\ do\ not \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ delete\ them \ \ \-\-batch\-size\ DELETE_BATCH_SIZE \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ The\ maximum\ number\ of\ objects\ to\ be\ deleted\ in\ a \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ single\ request\ to\ the\ cloud\ provider.\ If\ unset\ then \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ maximum\ allowed\ batch\ size\ for\ the\ specified\ cloud \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ provider\ will\ be\ used\ (1000\ for\ aws\-s3,\ 256\ for\ azure\- \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ blob\-storage\ and\ 100\ for\ google\-cloud\-storage). Extra\ options\ for\ the\ aws\-s3\ cloud\ provider: \ \ \-\-endpoint\-url\ ENDPOINT_URL \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Override\ default\ S3\ endpoint\ URL\ with\ the\ given\ one \ \ \-P\ AWS_PROFILE,\ \-\-aws\-profile\ AWS_PROFILE \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ profile\ name\ (e.g.\ INI\ section\ in\ AWS\ credentials \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ file) \ \ \-\-profile\ AWS_PROFILE \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ profile\ name\ (deprecated:\ replaced\ by\ \-\-aws\-profile) \ \ \-\-read\-timeout\ READ_TIMEOUT \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ time\ in\ seconds\ until\ a\ timeout\ is\ raised\ when \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ waiting\ to\ read\ from\ a\ connection\ (defaults\ to\ 60 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ seconds) Extra\ options\ for\ the\ azure\-blob\-storage\ cloud\ provider: \ \ \-\-azure\-credential\ {azure\-cli,managed\-identity},\ \-\-credential\ {azure\-cli,managed\-identity} \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Optionally\ specify\ the\ type\ of\ credential\ to\ use\ when \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ authenticating\ with\ Azure.\ If\ omitted\ then\ Azure\ Blob \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Storage\ credentials\ will\ be\ obtained\ from\ the \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ environment\ and\ the\ default\ Azure\ authentication\ flow \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ will\ be\ used\ for\ authenticating\ with\ all\ other\ Azure \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ services.\ If\ no\ credentials\ can\ be\ found\ in\ the \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ environment\ then\ the\ default\ Azure\ authentication\ flow \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ will\ also\ be\ used\ for\ Azure\ Blob\ Storage. \f[] .fi .SH REFERENCES .PP For Boto: .IP \[bu] 2 .PP For AWS: .IP \[bu] 2 .IP \[bu] 2 . .PP For Azure Blob Storage: .IP \[bu] 2 .IP \[bu] 2 .PP For Google Cloud Storage: .IP \[bu] 2 Credentials: .RS 2 .PP Only authentication with \f[C]GOOGLE_APPLICATION_CREDENTIALS\f[] env is supported at the moment. .RE .SH DEPENDENCIES .PP If using \f[C]\-\-cloud\-provider=aws\-s3\f[]: .IP \[bu] 2 boto3 .PP If using \f[C]\-\-cloud\-provider=azure\-blob\-storage\f[]: .IP \[bu] 2 azure\-storage\-blob .IP \[bu] 2 azure\-identity (optional, if you wish to use DefaultAzureCredential) .PP If using \f[C]\-\-cloud\-provider=google\-cloud\-storage\f[] .IP \[bu] 2 google\-cloud\-storage .SH EXIT STATUS .TP .B 0 Success .RS .RE .TP .B 1 The delete operation was not successful .RS .RE .TP .B 2 The connection to the cloud provider failed .RS .RE .TP .B 3 There was an error in the command input .RS .RE .TP .B Other non\-zero codes Failure .RS .RE .SH BUGS .PP Barman has been extensively tested, and is currently being used in several production environments. However, we cannot exclude the presence of bugs. .PP Any bug can be reported via the GitHub issue tracker. .SH RESOURCES .IP \[bu] 2 Homepage: .IP \[bu] 2 Documentation: .IP \[bu] 2 Professional support: .SH COPYING .PP Barman is the property of EnterpriseDB UK Limited and its code is distributed under GNU General Public License v3. .PP © Copyright EnterpriseDB UK Limited 2011\-2023 .SH AUTHORS EnterpriseDB .