barman-wal-archive(1)

1BARMAN-WAL-ARCHIVE(1)            Version 3.0.1           BARMAN-WAL-ARCHIVE(1)
2
3
4

NAME

6       barman-wal-archive - archive_command based on Barman's put-wal
7

SYNOPSIS

9       barman-wal-archive [OPTIONS] BARMAN_HOST SERVER_NAME WAL_PATH
10

DESCRIPTION

12       This  script  can be used in the archive_command of a PostgreSQL server
13       to ship WAL files to a Barman host using the 'put-wal' command  (intro‐
14       duced  in  Barman 2.6).  An SSH connection will be opened to the Barman
15       host.  barman-wal-archive allows the integration  of  Barman  in  Post‐
16       greSQL clusters for better business 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_PATH
29              the value of the '%p' keyword (according to 'archive_command').
30

OPTIONS

32       -h, --help
33              show a help message and exit
34
35       -V, --version
36              show program's version number and exit
37
38       -U USER, --user USER
39              the user used for the ssh connection to the Barman server.   De‐
40              faults to 'barman'.
41
42       -c CONFIG, --config CONFIG
43              configuration file on the Barman server
44
45       -t, --test
46              test  both the connection and the configuration of the requested
47              PostgreSQL server in Barman for WAL retrieval.   With  this  op‐
48              tion, the 'WAL_PATH' mandatory argument is ignored.
49

EXIT STATUS

51       0      Success
52
53       Not zero
54              Failure
55

BUGS

60       Barman has been extensively tested, and is currently being used in sev‐
61       eral production environments.  However, we cannot exclude the  presence
62       of bugs.
63
64       Any bug can be reported via the Github issue tracker.
65

RESOURCES

67       • Homepage: <https://www.pgbarman.org/>
68
69       • Documentation: <https://docs.pgbarman.org/>
70
71       • Professional support: <https://www.enterprisedb.com/>
72

COPYING

74       Barman  is the property of EnterpriseDB UK Limited and its code is dis‐
75       tributed under GNU General Public License v3.
76
77       © Copyright EnterpriseDB UK Limited 2011-2022
78

AUTHORS

80       EnterpriseDB <https://www.enterprisedb.com>.
81
82
83
84Barman User manuals              June 27, 2022           BARMAN-WAL-ARCHIVE(1)