OS Manuals

/usr/bin/barman-wal-restore

Barman with CloudNative PG additions

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

usage: barman-wal-restore [-h] [-V] [-U USER] [--port PORT] [-s SECONDS] [-p JOBS]
                          [--spool-dir SPOOL_DIR] [-P] [-z | -j | --keep-compression] [-c CONFIG]
                          [-t]
                          BARMAN_HOST SERVER_NAME WAL_NAME WAL_DEST

This script will be used as a 'restore_command' based on the get-wal feature of Barman. A ssh
connection will be opened to the Barman host.

positional arguments:
  BARMAN_HOST           The host of the Barman server.
  SERVER_NAME           The server name configured in Barman from which WALs are taken.
  WAL_NAME              The value of the '%f' keyword (according to 'restore_command').
  WAL_DEST              The value of the '%p' keyword (according to 'restore_command').

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -U USER, --user USER  The user used for the ssh connection to the Barman server. Defaults to
                        'barman'.
  --port PORT           The port used for the ssh connection to the Barman server.
  -s SECONDS, --sleep SECONDS
                        Sleep for SECONDS after a failure of get-wal request. Defaults to 0
                        (nowait).
  -p JOBS, --parallel JOBS
                        Specifies the number of files to peek and transfer in parallel. Defaults
                        to 0 (disabled).
  --spool-dir SPOOL_DIR
                        Specifies spool directory for WAL files. Defaults to
                        '/var/tmp/walrestore'.
  -P, --partial         retrieve also partial WAL files (.partial)
  -z, --gzip            Transfer the WAL files compressed with gzip
  -j, --bzip2           Transfer the WAL files compressed with bzip2
  --keep-compression    Preserve compression during transfer, decompress once received
  -c CONFIG, --config CONFIG
                        configuration file on the Barman server
  -t, --test            test both the connection and the configuration of the requested PostgreSQL
                        server in Barman to make sure it is ready to receive WAL files. With this
                        option, the 'wal_name' and 'wal_dest' mandatory arguments are ignored.
Options (10)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-V, --versionshow program's version number and exithelp
-U, --user USERThe user used for the ssh connection to the Barman server.help
--port PORTThe port used for the ssh connection to the Barman server.help
--spool-dir SPOOL_DIRSpecifies spool directory for WAL files.help
-P, --partialretrieve also partial WAL files (.partial)help
-z, --gzipTransfer the WAL files compressed with gziphelp
-j, --bzip2Transfer the WAL files compressed with bzip2help
--keep-compressionPreserve compression during transfer, decompress once receivedhelp
-t, --testtest both the connection and the configuration of the requested PostgreSQL server in Barman to make sure it is ready to receive WAL files.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.