1BARMAN-CLOUD-BACKUP(1)           Version 2.10           BARMAN-CLOUD-BACKUP(1)
2
3
4

NAME

6       barman-cloud-backup - Backup a PostgreSQL instance and stores it in the
7       Cloud
8

SYNOPSIS

10       barman-cloud-backup [OPTIONS] DESTINATION_URL SERVER_NAME
11

DESCRIPTION

13       This script can be used to perform a backup of a local  PostgreSQL  in‐
14       stance  and  ship  the  resulting tarball(s) to the Cloud.  It requires
15       read access to PGDATA and tablespaces (normally run as postgres  user).
16       Currently only 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       DESTINATION_URL
23              URL of the cloud destination, such as a bucket in AWS  S3.   For
24              example:  s3://BUCKET_NAME/path/to/folder  (where BUCKET_NAME is
25              the bucket you have created in AWS).
26
27       SERVER_NAME
28              the name of the server as configured in Barman.
29

OPTIONS

31       -h, –help
32              show a help message and exit
33
34       -V, –version
35              show program’s version number and exit
36
37       -v, –verbose
38              increase output verbosity (e.g., -vv is more than -v)
39
40       -q, –quiet
41              decrease output verbosity (e.g., -qq is less than -q)
42
43       -t, –test
44              test connectivity to the cloud destination and exit
45
46       -P, –profile
47              profile name (e.g. INI section in AWS credentials file)
48
49       -z, –gzip
50              gzip-compress the tar files when uploading to the cloud
51
52       -j, –bzip2
53              bzip2-compress the tar files when uploading to the cloud
54
55       -e, –encrypt
56              enable server-side encryption for the transfer.  Allowed values:
57              `AES256'|`aws:kms'.
58
59       -h, –host
60              host  or  Unix  socket for PostgreSQL connection (default: libpq
61              settings)
62
63       -p, –port
64              port for PostgreSQL connection (default: libpq settings)
65
66       -U, –user
67              user name for PostgreSQL connection (default: libpq settings)
68
69       –immediate-checkpoint
70              forces the initial checkpoint to be done as quickly as possible
71
72       -J JOBS, –jobs JOBS
73              number of subprocesses to upload data to S3 (default: 2)
74

REFERENCES

76       For Boto:
77
78       · https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
79         uration.html
80
81       For AWS:
82
83       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-
84         up.html
85
86       · http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-
87         started.html.
88
89       For libpq settings information:
90
91       · https://www.postgresql.org/docs/current/libpq-envars.html
92

DEPENDENCIES

94       · boto3
95

EXIT STATUS

97       0      Success
98
99       Not zero
100              Failure
101

BUGS

103       Barman has been extensively tested, and is currently being used in sev‐
104       eral production environments.  However, we cannot exclude the  presence
105       of bugs.
106
107       Any bug can be reported via the Github issue tracker.
108

RESOURCES

110       · Homepage: <http://www.pgbarman.org/>
111
112       · Documentation: <http://docs.pgbarman.org/>
113
114       · Professional support: <http://www.2ndQuadrant.com/>
115

COPYING

117       Barman  is the property of 2ndQuadrant Limited and its code is distrib‐
118       uted under GNU General Public License v3.
119
120       Copyright  (C)  2011-2019  2ndQuadrant   Ltd   -   <http://www.2ndQuad‐
121       rant.com/>.
122

AUTHORS

124       2ndQuadrant <http://www.2ndQuadrant.com>.
125
126
127
128Barman User manuals            December 5, 2019         BARMAN-CLOUD-BACKUP(1)