OS Manuals

/usr/bin/barman-cloud-restore

Backup and Recovery Manager for PostgreSQL

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

usage: barman-cloud-restore [-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}]
                            [--tablespace NAME:LOCATION]
                            [--snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE]
                            [--snapshot-recovery-zone GCP_ZONE]
                            [--sse-customer-key SSE_CUSTOMER_KEY] [--aws-region AWS_REGION]
                            [--gcp-zone GCP_ZONE] [--azure-resource-group AZURE_RESOURCE_GROUP]
                            [--target-tli TARGET_TLI]
                            [--target-lsn TARGET_LSN | --target-time TARGET_TIME]
                            source_url server_name backup_id recovery_dir

This script can be used to download a backup previously 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.
  backup_id             the backup ID
  recovery_dir          the path to a directory for recovery.

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
  --tablespace NAME:LOCATION
                        tablespace relocation rule
  --snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE
                        Instance where the disks recovered from the snapshots are attached
  --snapshot-recovery-zone GCP_ZONE
                        Zone containing the instance and disks for the snapshot recovery
                        (deprecated: replaced by --gcp-zone)
  --target-tli TARGET_TLI
                        target timeline
  --target-lsn TARGET_LSN
                        target LSN (Log Sequence Number)
  --target-time TARGET_TIME
                        target time. You can use any valid unambiguous representation. e.g: "YYYY-
                        MM-DD HH:MM:SS.mmm"

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.
  --aws-region AWS_REGION
                        Name of the AWS region where the instance and disks for snapshot recovery
                        are located

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.
  --azure-resource-group AZURE_RESOURCE_GROUP
                        Resource group containing the instance and disks for the snapshot recovery

Extra options for google-cloud-storage cloud provider:
  --gcp-zone GCP_ZONE   Zone containing the instance and disks for the snapshot recovery
Options (20)
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
--tablespace NAME:LOCATIONtablespace relocation rulehelp
--snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCEInstance where the disks recovered from the snapshots are attachedhelp
--snapshot-recovery-zone GCP_ZONEZone containing the instance and disks for the snapshot recovery (deprecated: replaced by --gcp-zone)help
--target-tli TARGET_TLItarget timelinehelp
--target-lsn TARGET_LSNtarget LSN (Log Sequence Number)help
--target-time TARGET_TIMEtarget time.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
--aws-region AWS_REGIONName of the AWS region where the instance and disks for snapshot recovery are locatedhelp
--azure-resource-group AZURE_RESOURCE_GROUPResource group containing the instance and disks for the snapshot recoveryhelp
--gcp-zone GCP_ZONEZone containing the instance and disks for the snapshot recoveryhelp

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