Provided by: barman-cli_3.14.1-1_all 
NAME
barman-backup - Barman Sub-Commands
SYNOPSIS
backup
[ --bwlimit KBPS ]
[ { -h | --help } ]
[ --incremental BACKUP_ID ]
[ --immediate-checkpoint ]
[ { -j | --jobs } PARALLEL_WORKERS ]
[ --jobs-start-batch-period PERIOD ]
[ --jobs-start-batch-size SIZE ]
[ --keepalive-interval SECONDS ]
[ --manifest ]
[ --name NAME ]
[ --no-immediate-checkpoint ]
[ --no-manifest ]
[ --no-retry ]
[ --retry-sleep SECONDS ]
[ --retry-times NUMBER ]
[ --reuse-backup { off | copy | link } ]
[ { --wait | -w } ]
[ --wait-timeout SECONDS ]
SERVER_NAME [ SERVER_NAME ... ]
DESCRIPTION
Execute a PostreSQL server backup. Barman will use the parameters specified in the Global and Server
configuration files. Specify all shortcut instead of the server name to execute backups from all servers
configured in the Barman node. You can also specify multiple server names in sequence to execute backups
for specific servers.
PARAMETERS
SERVER_NAME
Name of the server in barman node.
--bwlimit
Specify the maximum transfer rate in kilobytes per second. A value of 0 indicates no limit. This
setting overrides the bandwidth_limit configuration option.
-h / --help
Show a help message and exit. Provides information about command usage.
--incremental
Execute a block-level incremental backup. You must provide a BACKUP_ID or a shortcut to a previous
backup, which will serve as the parent backup for the incremental backup.
NOTE:
The backup to be and the parent backup must have backup_method=postgres.
--immediate-checkpoint
Forces the initial checkpoint to be executed as soon as possible, overriding any value set for the
immediate_checkpoint parameter in the configuration file.
-j / --jobs
Specify the number of parallel workers to use for copying files during the backup. This setting
overrides the parallel_jobs parameter if it's specified in the configuration file.
--jobs-start-batch-period
Specify the time period, in seconds, for starting a single batch of jobs. This value overrides the
parallel_jobs_start_batch_period parameter if it is set in the configuration file. The default is
1 second.
--jobs-start-batch-size
Specify the maximum number of parallel workers to initiate in a single batch. This value overrides
the parallel_jobs_start_batch_size parameter if it is defined in the configuration file. The
default is 10 workers.
--keepalive-interval
Specify an interval, in seconds, for sending a heartbeat query to the server to keep the libpq
connection active during a Rsync backup. The default is 60 seconds. A value of 0 disables the
heartbeat.
--manifest
Forces the creation of a backup manifest file upon completing a backup. Overrides the
autogenerate_manifest parameter from the configuration file. Applicable only to rsync backup
strategy.
--name Specify a friendly name for this backup which can be used in place of the backup ID in barman
commands.
--no-immediate-checkpoint
Forces the backup to wait for the checkpoint to be executed overriding any value set for the
immediate_checkpoint parameter in the configuration file.
--no-manifest
Disables the automatic creation of a backup manifest file upon completing a backup. This setting
overrides the autogenerate_manifest parameter from the configuration file and applies only to
rsync backup strategy.
--no-retry
There will be no retry in case of an error. It is the same as setting --retry-times 0.
--retry-sleep
Specify the number of seconds to wait after a failed copy before retrying. This setting applies to
both backup and recovery operations and overrides the basebackup_retry_sleep parameter if it is
defined in the configuration file.
--retry-times
Specify the number of times to retry the base backup copy in case of an error. This applies to
both backup and recovery operations and overrides the basebackup_retry_times parameter if it is
set in the configuration file.
--reuse-backup
Overrides the behavior of the reuse_backup option configured in the configuration file. The
possible values are:
• off: Do not reuse the last available backup.
• copy: Reuse the last available backup for a server and create copies of unchanged files (reduces
backup time).
• link (default): Reuse the last available backup for a server and create hard links to unchanged
files (saves both backup time and space).
NOTE:
This will only have any effect if the last available backup was executed with
backup_method=rsync.
--wait / -w
Wait for all necessary WAL files required by the base backup to be archived.
--wait-timeout
Specify the duration, in seconds, to wait for the required WAL files to be archived before timing
out.
SHORTCUTS
Use shortcuts instead of SERVER_NAME.
┌──────────┬───────────────────────┐
│ Shortcut │ Description │
├──────────┼───────────────────────┤
│ all │ All available servers │
└──────────┴───────────────────────┘
AUTHOR
EnterpriseDB
COPYRIGHT
© Copyright EnterpriseDB UK Limited 2011-2025
3.14 Jun 18, 2025 BARMAN-BACKUP(1)