barman-wal-restore(1)

1BARMAN-WAL-RESTORE(1)            Version 3.0.1           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 EnterpriseDB.
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       --spool-dir SPOOL_DIR
54              Specifies   spool   directory   for   WAL  files.   Defaults  to
55              '/var/tmp/walrestore'
56
57       -P, --partial
58              retrieve also partial WAL files (.partial)
59
60       -z, --gzip
61              transfer the WAL files compressed with gzip
62
63       -j, --bzip2
64              transfer the WAL files compressed with bzip2
65
66       -c CONFIG, --config CONFIG
67              configuration file on the Barman server
68
69       -t, --test
70              test both the connection and the configuration of the  requested
71              PostgreSQL  server in Barman to make sure it is ready to receive
72              WAL files.  With this  option,  the  'WAL_NAME'  and  'WAL_DEST'
73              mandatory arguments are ignored.
74

EXIT STATUS

76       0      Success
77
78       1      The  remote  get-wal command failed, most likely because the re‐
79              quested WAL could not be found.
80
81       2      The SSH connection to the Barman server failed.
82
83       Other non-zero codes
84              Failure
85

BUGS

90       Barman has been extensively tested, and is currently being used in sev‐
91       eral  production environments.  However, we cannot exclude the presence
92       of bugs.
93
94       Any bug can be reported via the Github issue tracker.
95

RESOURCES

97       • Homepage: <https://www.pgbarman.org/>
98
99       • Documentation: <https://docs.pgbarman.org/>
100
101       • Professional support: <https://www.enterprisedb.com/>
102

COPYING

104       Barman is the property of EnterpriseDB UK Limited and its code is  dis‐
105       tributed under GNU General Public License v3.
106
107       © Copyright EnterpriseDB UK Limited 2011-2022
108

AUTHORS

110       EnterpriseDB <https://www.enterprisedb.com>.
111
112
113
114Barman User manuals              June 27, 2022           BARMAN-WAL-RESTORE(1)