barman-wal-restore(1)

1BARMAN-WAL-RESTORE(1)            Version 3.9.0           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       --port PORT
46              the port used for the ssh connection to the Barman server.
47
48       -s SECONDS, --sleep SECONDS
49              sleep  for SECONDS after a failure of get-wal request.  Defaults
50              to 0 (nowait).
51
52       -p JOBS, --parallel JOBS
53              specifies the number of files to peek and transfer in  parallel,
54              defaults to 0 (disabled).
55
56       --spool-dir SPOOL_DIR
57              Specifies   spool   directory   for   WAL  files.   Defaults  to
58              '/var/tmp/walrestore'
59
60       -P, --partial
61              retrieve also partial WAL files (.partial)
62
63       -z, --gzip
64              transfer the WAL files compressed with gzip
65
66       -j, --bzip2
67              transfer the WAL files compressed with bzip2
68
69       -c CONFIG, --config CONFIG
70              configuration file on the Barman server
71
72       -t, --test
73              test both the connection and the configuration of the  requested
74              PostgreSQL  server in Barman to make sure it is ready to receive
75              WAL files.  With this  option,  the  'WAL_NAME'  and  'WAL_DEST'
76              mandatory arguments are ignored.
77

EXIT STATUS

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

BUGS

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

RESOURCES

100       • Homepage: <https://www.pgbarman.org/>
101
102       • Documentation: <https://docs.pgbarman.org/>
103
104       • Professional support: <https://www.enterprisedb.com/>
105

COPYING

107       Barman is the property of EnterpriseDB UK Limited and its code is  dis‐
108       tributed under GNU General Public License v3.
109
110       © Copyright EnterpriseDB UK Limited 2011-2023
111

AUTHORS

113       EnterpriseDB <https://www.enterprisedb.com>.
114
115
116
117Barman User manuals             October 3, 2023          BARMAN-WAL-RESTORE(1)