barman-wal-archive(1)

1BARMAN-WAL-ARCHIVE(1)            Version 3.9.0           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       --port PORT
43              the port used for the ssh connection to the Barman server.
44
45       -c CONFIG, --config CONFIG
46              configuration file on the Barman server
47
48       -t, --test
49              test  both the connection and the configuration of the requested
50              PostgreSQL server in Barman for WAL retrieval.   With  this  op‐
51              tion, the 'WAL_PATH' mandatory argument is ignored.
52

EXIT STATUS

54       0      Success
55
56       Not zero
57              Failure
58

BUGS

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

RESOURCES

70       • Homepage: <https://www.pgbarman.org/>
71
72       • Documentation: <https://docs.pgbarman.org/>
73
74       • Professional support: <https://www.enterprisedb.com/>
75

COPYING

77       Barman  is the property of EnterpriseDB UK Limited and its code is dis‐
78       tributed under GNU General Public License v3.
79
80       © Copyright EnterpriseDB UK Limited 2011-2023
81

AUTHORS

83       EnterpriseDB <https://www.enterprisedb.com>.
84
85
86
87Barman User manuals             October 3, 2023          BARMAN-WAL-ARCHIVE(1)