1% BARMAN-WAL-RESTORE(1) Barman User manuals | Version 2.17 2% EnterpriseDB <http://www.enterprisedb.com> 3% December 1, 2021 4 5# NAME 6 7barman-wal-restore - 'restore_command' based on Barman's get-wal 8 9 10# SYNOPSIS 11 12barman-wal-restore [*OPTIONS*] *BARMAN_HOST* *SERVER_NAME* *WAL_NAME* *WAL_DEST* 13 14 15# DESCRIPTION 16 17This script can be used as a 'restore_command' for PostgreSQL servers, 18retrieving WAL files using the 'get-wal' feature of Barman. An SSH 19connection will be opened to the Barman host. 20`barman-wal-restore` allows the integration of Barman in PostgreSQL 21clusters for better business continuity results. 22 23This script and Barman are administration tools for disaster recovery 24of PostgreSQL servers written in Python and maintained by EnterpriseDB. 25 26 27# POSITIONAL ARGUMENTS 28 29BARMAN_HOST 30: the host of the Barman server. 31 32SERVER_NAME 33: the server name configured in Barman from which WALs are taken. 34 35WAL_NAME 36: the value of the '%f' keyword (according to 'restore_command'). 37 38WAL_DEST 39: the value of the '%p' keyword (according to 'restore_command'). 40 41# OPTIONS 42 43-h, --help 44: show a help message and exit 45 46-V, --version 47: show program's version number and exit 48 49-U *USER*, --user *USER* 50: the user used for the ssh connection to the Barman server. Defaults 51 to 'barman'. 52 53-s *SECONDS*, --sleep *SECONDS* 54: sleep for SECONDS after a failure of get-wal request. Defaults 55 to 0 (nowait). 56 57-p *JOBS*, --parallel *JOBS* 58: specifies the number of files to peek and transfer in parallel, 59 defaults to 0 (disabled). 60 61--spool-dir *SPOOL_DIR* 62: Specifies spool directory for WAL files. Defaults to '/var/tmp/walrestore' 63 64-P, --partial 65: retrieve also partial WAL files (.partial) 66 67-z, --gzip 68: transfer the WAL files compressed with gzip 69 70-j, --bzip2 71: transfer the WAL files compressed with bzip2 72 73-c *CONFIG*, --config *CONFIG* 74: configuration file on the Barman server 75 76 -t, --test 77: test both the connection and the configuration of the 78 requested PostgreSQL server in Barman to make sure it 79 is ready to receive WAL files. With this option, the 80 'WAL_NAME' and 'WAL\_DEST' mandatory arguments are ignored. 81 82# EXIT STATUS 83 840 85: Success 86 87Not zero 88: Failure 89 90 91# SEE ALSO 92 93`barman` (1), `barman` (5). 94 95 96# BUGS 97 98Barman has been extensively tested, and is currently being used in several 99production environments. However, we cannot exclude the presence of bugs. 100 101Any bug can be reported via the Github issue tracker. 102 103 104# RESOURCES 105 106* Homepage: <http://www.pgbarman.org/> 107* Documentation: <http://docs.pgbarman.org/> 108* Professional support: <http://www.enterprisedb.com/> 109 110 111# COPYING 112 113Barman is the property of EnterpriseDB UK Limited 114and its code is distributed under GNU General Public License v3. 115 116© Copyright EnterpriseDB UK Limited 2011-2021 117