barman-wal-restore(1)

1BARMAN-WAL-RESTORE(1)             Version 2.8            BARMAN-WAL-RESTORE(1)
2
3
4

NAME

6       barman-wal-restore - `restore_command' based on Barman’s get-wal
7

SYNOPSIS

9       barman-wal-restore [OPTIONS] BARMAN_HOST SERVER_NAME WAL_NAME WAL_DEST
10

DESCRIPTION

12       This  script can be used as a `restore_command' for PostgreSQL servers,
13       retrieving WAL files using the `get-wal' feature  of  Barman.   An  SSH
14       connection  will  be opened to the Barman host.  barman-wal-restore al‐
15       lows the integration of Barman in PostgreSQL clusters for better  busi‐
16       ness continuity results.
17
18       This  script  and Barman are administration tools for disaster recovery
19       of PostgreSQL servers written in Python and maintained by 2ndQuadrant.
20

POSITIONAL ARGUMENTS

22       BARMAN_HOST
23              the host of the Barman server.
24
25       SERVER_NAME
26              the server name configured in Barman from which WALs are taken.
27
28       WAL_NAME
29              the value of the `%f' keyword (according to `restore_command').
30
31       WAL_DEST
32              the value of the `%p' keyword (according to `restore_command').
33

OPTIONS

35       -h, –help
36              show a help message and exit
37
38       -V, –version
39              show program’s version number and exit
40
41       -U USER, –user USER
42              the user used for the ssh connection to the Barman server.   De‐
43              faults to `barman'.
44
45       -s SECONDS, –sleep SECONDS
46              sleep  for SECONDS after a failure of get-wal request.  Defaults
47              to 0 (nowait).
48
49       -p JOBS, –parallel JOBS
50              specifies the number of files to peek and transfer in  parallel,
51              defaults to 0 (disabled).
52
53       -z, –gzip
54              transfer the WAL files compressed with gzip
55
56       -j, –bzip2
57              transfer the WAL files compressed with bzip2
58
59       -c CONFIG, –config CONFIG
60              configuration file on the Barman server
61
62       -t, –test
63              test  both the connection and the configuration of the requested
64              PostgreSQL server in Barman to make sure it is ready to  receive
65              WAL  files.   With  this  option,  the `WAL_NAME' and `WAL_DEST'
66              mandatory arguments are ignored.
67

EXIT STATUS

69       0      Success
70
71       Not zero
72              Failure
73

BUGS

78       Barman has been extensively tested, and is currently being used in sev‐
79       eral  production environments.  However, we cannot exclude the presence
80       of bugs.
81
82       Any bug can be reported via the Github issue tracker.
83

RESOURCES

85       · Homepage: <http://www.pgbarman.org/>
86
87       · Documentation: <http://docs.pgbarman.org/>
88
89       · Professional support: <http://www.2ndQuadrant.com/>
90

COPYING

92       Barman is the property of 2ndQuadrant Limited and its code is  distrib‐
93       uted under GNU General Public License v3.
94
95       Copyright   (C)   2011-2019   2ndQuadrant  Ltd  -  <http://www.2ndQuad‐
96       rant.com/>.
97

AUTHORS

99       2ndQuadrant <http://www.2ndQuadrant.com>.
100
101
102
103Barman User manuals              May 17, 2019            BARMAN-WAL-RESTORE(1)