1BARMAN-CLOUD-WAL-RESTORE(1)      Version 2.12      BARMAN-CLOUD-WAL-RESTORE(1)
2
3
4

NAME

6       barman-cloud-wal-restore  - Restore PostgreSQL WAL files from the Cloud
7       using restore_command
8

SYNOPSIS

10       barman-cloud-wal-restore  [OPTIONS]  SOURCE_URL  SERVER_NAME   WAL_NAME
11       WAL_PATH
12

DESCRIPTION

14       This script can be used as a restore_command to download WAL files pre‐
15       viously archived with barman-cloud-wal-archive command.  Currently only
16       AWS S3 is supported.
17
18       This  script  and Barman are administration tools for disaster recovery
19       of PostgreSQL servers written in Python and maintained by 2ndQuadrant.
20

POSITIONAL ARGUMENTS

22       SOURCE_URL
23              URL of the cloud source, such as a bucket in AWS S3.  For  exam‐
24              ple:  s3://BUCKET_NAME/path/to/folder  (where BUCKET_NAME is the
25              bucket you have created in AWS).
26
27       SERVER_NAME
28              the name of the server as configured in Barman.
29
30       WAL_NAME
31              the name of the WAL file, equivalent of `%f' keyword  (according
32              to `restore_command').
33
34       WAL_PATH
35              the value of the `%p' keyword (according to `restore_command').
36

OPTIONS

38       -h, –help
39              show a help message and exit
40
41       -V, –version
42              show program’s version number and exit
43
44       -t, –test
45              test connectivity to the cloud destination and exit
46
47       -P, –profile
48              profile name (e.g. INI section in AWS credentials file)
49
50       -e ENCRYPT, –encrypt ENCRYPT
51              enable  server-side  encryption  with  the  given method for the
52              transfer.  Allowed methods: AES256 and aws:kms.
53
54       –endpoint-url
55              override the default S3 URL construction mechanism by specifying
56              an endpoint.
57

REFERENCES

59       For Boto:
60
61       · https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
62         uration.html
63
64       For AWS:
65
66       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-
67         up.html
68
69       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-
70         started.html.
71

DEPENDENCIES

73       · boto3
74

EXIT STATUS

76       0      Success
77
78       Not zero
79              Failure
80

BUGS

82       Barman has been extensively tested, and is currently being used in sev‐
83       eral  production environments.  However, we cannot exclude the presence
84       of bugs.
85
86       Any bug can be reported via the Github issue tracker.
87

RESOURCES

89       · Homepage: <http://www.pgbarman.org/>
90
91       · Documentation: <http://docs.pgbarman.org/>
92
93       · Professional support: <http://www.2ndQuadrant.com/>
94

COPYING

96       Barman is the property of 2ndQuadrant Limited and its code is  distrib‐
97       uted under GNU General Public License v3.
98
99       Copyright   (C)   2011-2020   2ndQuadrant  Ltd  -  <http://www.2ndQuad‐
100       rant.com/>.
101

AUTHORS

103       2ndQuadrant <http://www.2ndQuadrant.com>.
104
105
106
107Barman User manuals            November 5, 2020    BARMAN-CLOUD-WAL-RESTORE(1)