OS Manuals

/usr/share/barman/bin/barman-cloud-backup-delete

Backup and Recovery Manager for PostgreSQL

From barman 3.20.1-r3 (enterprise-packages), captured 2026-11-08 by running barman-cloud-backup-delete --help (exit 0). permalink

Also provided by 1 other package version
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]
                                  [--addressing-style {auto,virtual,path}]
                                  [--azure-credential {azure-cli,managed-identity,default}]
                                  [--sse-customer-key SSE_CUSTOMER_KEY] [-b BACKUP_ID]
                                  [-m MINIMUM_REDUNDANCY] [-r RETENTION_POLICY] [--dry-run]
                                  [--batch-size DELETE_BATCH_SIZE] [--check-object-lock]
                                  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.

options:
  -V, --version         show program'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).
  --check-object-lock   Check for S3 Object Lock before deleting to skip deletion of locked
                        objects. This option adds overhead as it requires a request to the object
                        store for each object of the base backup to delete.

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)
  --addressing-style {auto,virtual,path}
                        the addressing style to use for S3 requests. Valid values are 'auto'
                        (default), 'virtual' (virtual-hosted-style), or 'path' (path-style)
  --sse-customer-key SSE_CUSTOMER_KEY
                        Path to a file containing the customer-provided encryption key (SSE-C) to
                        use for decrypting data in S3, specified as a file:// URI (e.g.
                        file:///path/to/key.b64). The file must contain a base64-encoded 256-bit
                        key.

Extra options for the azure-blob-storage cloud provider:
  --azure-credential {azure-cli,managed-identity,default}, --credential {azure-cli,managed-identity,default}, --default {azure-cli,managed-identity,default}
                        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.
Options (14)
OptionDescriptionSource
-V, --versionshow program's version number and exithelp
--helpshow this help message and exithelp
-v, --verboseincrease output verbosity (e.g., -vv is more than -v)help
-q, --quietdecrease output verbosity (e.g., -qq is less than -q)help
-t, --testTest cloud connectivity and exithelp
--cloud-provider aws-s3The cloud provider to use as a storage backendhelp
--dry-runFind the objects which need to be deleted but do not delete themhelp
--batch-size DELETE_BATCH_SIZEThe maximum number of objects to be deleted in a single request to the cloud provider.help
--check-object-lockCheck for S3 Object Lock before deleting to skip deletion of locked objects.help
--endpoint-url ENDPOINT_URLOverride default S3 endpoint URL with the given onehelp
--profile AWS_PROFILEprofile name (deprecated: replaced by --aws-profile)help
--read-timeout READ_TIMEOUTthe time in seconds until a timeout is raised when waiting to read from a connection (defaults to 60 seconds)help
--addressing-style autothe addressing style to use for S3 requests.help
--sse-customer-key SSE_CUSTOMER_KEYPath to a file containing the customer-provided encryption key (SSE-C) to use for decrypting data in S3, specified as a file:// URI (e.g. file:///path/to/key.b64).help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.