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

NAME

6       barman-cloud-restore - Restore a PostgreSQL backup from the Cloud
7

SYNOPSIS

9       barman-cloud-restore  [OPTIONS] SOURCE_URL SERVER_NAME BACKUP_ID RECOV‐
10       ERY_DIR
11

DESCRIPTION

13       This script can be used to download a backup previouslymade  with  bar‐
14       man-cloud-backup  command.   Currently  only  AWS S3 is supported.  Ta‐
15       blespaces are restored in the original location.
16
17       This script and Barman are administration tools for  disaster  recovery
18       of PostgreSQL servers written in Python and maintained by 2ndQuadrant.
19

POSITIONAL ARGUMENTS

21       SOURCE_URL
22              URL  of the cloud source, such as a bucket in AWS S3.  For exam‐
23              ple: s3://BUCKET_NAME/path/to/folder (where BUCKET_NAME  is  the
24              bucket you have created in AWS).
25
26       SERVER_NAME
27              the name of the server as configured in Barman.
28
29       BACKUP_ID
30              the ID of the backup to restore
31
32       RECOVERY_DIR
33              the path to a local directory for recovery (used as PGDATA).
34

OPTIONS

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

REFERENCES

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

DEPENDENCIES

71       · boto3
72

EXIT STATUS

74       0      Success
75
76       Not zero
77              Failure
78

BUGS

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

RESOURCES

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

COPYING

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

AUTHORS

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