Scroll to navigation

BARMAN-WAL-ARCHIVE(1) Barman BARMAN-WAL-ARCHIVE(1)

NAME

barman-wal-archive - Barman-cli Commands

SYNOPSIS

barman-wal-archive


    [ { -h | --help } ]


    [ { -V | --version } ]


    [ { -U | --user } USER ]


    [ --port PORT ]


    [ { -c | --config } CONFIG ]


    [ { -t | --test } ]


    [ --md5 ]


    BARMAN_HOST SERVER_NAME WAL_PATH


DESCRIPTION

This script can be utilized in the archive_command of a Postgres server to transfer WAL files to a Barman host using the put-wal command (introduced in Barman 2.6). It establishes an SSH connection to the Barman host, enabling seamless integration of Barman within Postgres clusters for improved business continuity.

Exit Statuses are:

  • 0 for SUCCESS.
  • non-zero for FAILURE.

PARAMETERS

The server name configured in Barman for the Postgres server from which the WAL file is retrieved.
The host of the Barman server.
The value of the '%p' keyword (according to archive_command).
Display a help message and exit.
Display the program's version number and exit.
Specify the user for the SSH connection to the Barman server (defaults to barman).
Define the port used for the SSH connection to the Barman server.
Specify the configuration file on the Barman server.
Test the connection and configuration of the specified Postgres server in Barman to ensure it is ready to receive WAL files. This option ignores the mandatory argument WAL_PATH.
Use MD5 instead of SHA256 as the hash algorithm to calculate the checksum of the WAL file when transmitting it to the Barman server. This is used to maintain compatibility with older server versions, as older versions of Barman server used to support only MD5.

AUTHOR

EnterpriseDB

COPYRIGHT

© Copyright EnterpriseDB UK Limited 2011-2025

March 20, 2025 3.13