1% BARMAN-WAL-ARCHIVE(1) Barman User manuals | Version 2.17
2% EnterpriseDB <http://www.enterprisedb.com>
3% December 1, 2021
4
5# NAME
6
7barman-wal-archive - `archive_command` based on Barman's put-wal
8
9
10# SYNOPSIS
11
12barman-wal-archive [*OPTIONS*] *BARMAN_HOST* *SERVER_NAME* *WAL_PATH*
13
14
15# DESCRIPTION
16
17This script can be used in the `archive_command` of a PostgreSQL
18server to ship WAL files to a Barman host using the 'put-wal' command
19(introduced in Barman 2.6).
20An SSH connection will be opened to the Barman host.
21`barman-wal-archive` allows the integration of Barman in PostgreSQL
22clusters for better business continuity results.
23
24This script and Barman are administration tools for disaster recovery
25of PostgreSQL servers written in Python and maintained by EnterpriseDB.
26
27
28# POSITIONAL ARGUMENTS
29
30BARMAN_HOST
31:    the host of the Barman server.
32
33SERVER_NAME
34:    the server name configured in Barman from which WALs are taken.
35
36WAL_PATH
37:    the value of the '%p' keyword (according to 'archive_command').
38
39# OPTIONS
40
41-h, --help
42:    show a help message and exit
43
44-V, --version
45:    show program's version number and exit
46
47-U *USER*, --user *USER*
48:    the user used for the ssh connection to the Barman server. Defaults
49     to 'barman'.
50
51-c *CONFIG*, --config *CONFIG*
52:    configuration file on the Barman server
53
54-t, --test
55:    test both the connection and the configuration of the
56     requested PostgreSQL server in Barman for WAL retrieval.
57     With this option, the 'WAL_PATH' mandatory argument is ignored.
58
59# EXIT STATUS
60
610
62:   Success
63
64Not zero
65:   Failure
66
67
68# SEE ALSO
69
70`barman` (1), `barman` (5).
71
72
73# BUGS
74
75Barman has been extensively tested, and is currently being used in several
76production environments. However, we cannot exclude the presence of bugs.
77
78Any bug can be reported via the Github issue tracker.
79
80
81# RESOURCES
82
83* Homepage: <http://www.pgbarman.org/>
84* Documentation: <http://docs.pgbarman.org/>
85* Professional support: <http://www.enterprisedb.com/>
86
87
88# COPYING
89
90Barman is the property of EnterpriseDB UK Limited
91and its code is distributed under GNU General Public License v3.
92
93© Copyright EnterpriseDB UK Limited 2011-2021
94