pgBackRest Command Reference
1
Introduction
Commands are used to execute the various pgBackRest functions. Here the command options are listed exhaustively, that is, each option applicable to a command is listed with that command even if it applies to one or more other commands. This includes all the options that may also configured in pgbackrest.conf.
Non-boolean options configured in pgbackrest.conf can be reset to default on the command-line by using the reset- prefix. This feature may be used to restore a backup directly on a repository host. Normally, pgBackRest will error because it can see that the database host is remote and restores cannot be done remotely. By adding --reset-pg1-host on the command-line, pgBackRest will ignore the remote database host and restore locally. It may be necessary to pass a new --pg-path to force the restore to happen in a specific path, i.e. not the path used on the database host.
The no- prefix may be used to set a boolean option to false on the command-line.
Any option may be set in an environment variable using the PGBACKREST_ prefix and the option name in all caps replacing - with _, e.g. pg1-path becomes PGBACKREST_PG1_PATH and stanza becomes PGBACKREST_STANZA. Boolean options are represented as they would be in a configuration file, e.g. PGBACKREST_COMPRESS="n", and reset-* variants are not allowed. Options that that can be specified multiple times on the command-line or in a config file can be represented by separating the values with colons, e.g. PGBACKREST_DB_INCLUDE="db1:db2".
Command-line options override environment options which override config file options.
2
Archive Get Command (archive-get)
WAL segments are required for restoring a PostgreSQL cluster or maintaining a replica.
2.1
Command Options
2.1.1
Asynchronous Archiving Option (--archive-async)
Push/get WAL segments asynchronously.
Enables asynchronous operation for the archive-push and archive-get commands.
Asynchronous operation is more efficient because it can reuse connections and take advantage of parallelism. See the spool-path, archive-get-queue-max, and archive-push-queue-max options for more information.

    default: n
    example: --archive-async

2.1.2
Maximum Archive Get Queue Size Option (--archive-get-queue-max)
Maximum size of the pgBackRest archive-get queue.
Specifies the maximum size of the archive-get queue when archive-async is enabled. The queue is stored in the spool-path and is used to speed providing WAL to PostgreSQL.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.

    default: 134217728
    allowed: 0-4503599627370496
    example: --archive-get-queue-max=1073741824

2.1.3
Archive Timeout Option (--archive-timeout)
Archive timeout.
Set maximum time, in seconds, to wait for each WAL segment to reach the pgBackRest archive repository. The timeout applies to the check and backup commands when waiting for WAL segments required for backup consistency to be archived.

    default: 60
    allowed: 0.1-86400
    example: --archive-timeout=30

2.2
General Options
2.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

2.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

2.2.3
Compress Option (--compress)
Use gzip file compression.
Backup files are compatible with command-line gzip tools.

    default: y
    example: --no-compress

2.2.4
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

2.2.5
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

2.2.6
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

2.2.7
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

2.2.8
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

2.2.9
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

2.2.10
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

2.2.11
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

2.2.12
Process Maximum Option (--process-max)
Max processes to use for compress/transfer.
Each process will perform compression and transfer to make the command run faster, but don't set process-max so high that it impacts database performance.

    default: 1
    allowed: 1-999
    example: --process-max=4

2.2.13
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

2.2.14
Spool Path Option (--spool-path)
Path where transient data is stored.
This path is used to store data for the asynchronous archive-push and archive-get command.
The asynchronous archive-push command writes acknowledgements into the spool path when it has successfully stored WAL in the archive (and errors on failure) so the foreground process can quickly notify PostgreSQL. Acknowledgement files are very small (zero on success and a few hundred bytes on error).
The asynchronous archive-push process queues WAL in the spool path so it can be provided very quickly when PostgreSQL requests it. Moving files to PostgreSQL is most efficient when the spool path is on the same filesystem as pg_xlog/pg_wal.
The data stored in the spool path is not strictly temporary since it can and should survive a reboot. However, loss of the data in the spool path is not a problem. pgBackRest will simply recheck each WAL segment to ensure it is safely archived for archive-push and rebuild the queue for archive-get.
The spool path is intended to be located on a local Posix-compatible filesystem, not a remote filesystem such as NFS or CIFS.

    default: /var/spool/pgbackrest
    example: --spool-path=/backup/db/spool

2.2.15
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

2.3
Log Options
2.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

2.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

2.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

2.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

2.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

2.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

2.4
Repository Options
2.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

2.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
2.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
2.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
2.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

2.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

2.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
2.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
2.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

2.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

2.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

2.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

2.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

2.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

2.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

2.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

2.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

2.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
2.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

2.5
Stanza Options
2.5.1
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
3
Archive Push Command (archive-push)
The WAL segment may be pushed immediately to the archive or stored locally depending on the value of archive-async
3.1
Command Options
3.1.1
Asynchronous Archiving Option (--archive-async)
Push/get WAL segments asynchronously.
Enables asynchronous operation for the archive-push and archive-get commands.
Asynchronous operation is more efficient because it can reuse connections and take advantage of parallelism. See the spool-path, archive-get-queue-max, and archive-push-queue-max options for more information.

    default: n
    example: --archive-async

3.1.2
Maximum Archive Push Queue Size Option (--archive-push-queue-max)
Maximum size of the PostgreSQL archive queue.
After the limit is reached, the following will happen:

1. pgBackRest will notify PostgreSQL that the WAL was successfully archived, then DROP IT.
2. A warning will be output to the Postgres log.

If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability.
In asynchronous mode the entire queue will be dropped to prevent spurts of WAL getting through before the queue limit is exceeded again.
The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop completely. Better to lose the backup than have PostgreSQL go down.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.

    allowed: 0-4503599627370496
    example: --archive-push-queue-max=1GB

Deprecated Name: archive-queue-max
3.1.3
Archive Timeout Option (--archive-timeout)
Archive timeout.
Set maximum time, in seconds, to wait for each WAL segment to reach the pgBackRest archive repository. The timeout applies to the check and backup commands when waiting for WAL segments required for backup consistency to be archived.

    default: 60
    allowed: 0.1-86400
    example: --archive-timeout=30

3.2
General Options
3.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

3.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

3.2.3
Compress Option (--compress)
Use gzip file compression.
Backup files are compatible with command-line gzip tools.

    default: y
    example: --no-compress

3.2.4
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

3.2.5
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

3.2.6
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

3.2.7
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

3.2.8
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

3.2.9
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

3.2.10
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

3.2.11
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

3.2.12
Process Maximum Option (--process-max)
Max processes to use for compress/transfer.
Each process will perform compression and transfer to make the command run faster, but don't set process-max so high that it impacts database performance.

    default: 1
    allowed: 1-999
    example: --process-max=4

3.2.13
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

3.2.14
Spool Path Option (--spool-path)
Path where transient data is stored.
This path is used to store data for the asynchronous archive-push and archive-get command.
The asynchronous archive-push command writes acknowledgements into the spool path when it has successfully stored WAL in the archive (and errors on failure) so the foreground process can quickly notify PostgreSQL. Acknowledgement files are very small (zero on success and a few hundred bytes on error).
The asynchronous archive-push process queues WAL in the spool path so it can be provided very quickly when PostgreSQL requests it. Moving files to PostgreSQL is most efficient when the spool path is on the same filesystem as pg_xlog/pg_wal.
The data stored in the spool path is not strictly temporary since it can and should survive a reboot. However, loss of the data in the spool path is not a problem. pgBackRest will simply recheck each WAL segment to ensure it is safely archived for archive-push and rebuild the queue for archive-get.
The spool path is intended to be located on a local Posix-compatible filesystem, not a remote filesystem such as NFS or CIFS.

    default: /var/spool/pgbackrest
    example: --spool-path=/backup/db/spool

3.2.15
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

3.3
Log Options
3.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

3.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

3.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

3.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

3.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

3.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

3.4
Repository Options
3.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

3.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
3.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
3.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
3.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

3.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

3.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
3.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
3.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

3.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

3.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

3.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

3.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

3.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

3.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

3.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

3.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

3.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
3.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

3.5
Stanza Options
3.5.1
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
4
Backup Command (backup)
pgBackRest does not have a built-in scheduler so it's best to run it from cron or some other scheduling mechanism.
4.1
Command Options
4.1.1
Check Archive Option (--archive-check)
Check that WAL segments are in the archive before backup completes.
Checks that all WAL segments required to make the backup consistent are present in the WAL archive. It's a good idea to leave this as the default unless you are using another method for archiving.
This option must be enabled if archive-copy is enabled.

    default: y
    example: --no-archive-check

4.1.2
Copy Archive Option (--archive-copy)
Copy WAL segments needed for consistency to the backup.
This slightly paranoid option protects against corruption in the WAL segment archive by storing the WAL segments required for consistency directly in the backup. WAL segments are still stored in the archive so this option will use additional space.
On restore, the WAL segments will be present in pg_xlog/pg_wal and PostgreSQL will use them in preference to calling the restore_command.
The archive-check option must be enabled if archive-copy is enabled.

    default: n
    example: --archive-copy

4.1.3
Archive Timeout Option (--archive-timeout)
Archive timeout.
Set maximum time, in seconds, to wait for each WAL segment to reach the pgBackRest archive repository. The timeout applies to the check and backup commands when waiting for WAL segments required for backup consistency to be archived.

    default: 60
    allowed: 0.1-86400
    example: --archive-timeout=30

4.1.4
Backup from Standby Option (--backup-standby)
Backup from the standby cluster.
Enable backup from standby to reduce load on the primary cluster. This option requires that both the primary and standby hosts be configured.

    default: n
    example: --backup-standby

4.1.5
Page Checksums Option (--checksum-page)
Validate data page checksums.
Directs pgBackRest to validate all data page checksums while backing up a cluster. This option is automatically enabled when data page checksums are enabled on the cluster.
Failures in checksum validation will not abort a backup. Rather, warnings will be emitted in the log (and to the console with default settings) and the list of invalid pages will be stored in the backup manifest.

    example: --no-checksum-page

4.1.6
Path/File Exclusions Option (--exclude)
Exclude paths/files from the backup.
All exclusions are relative to $PGDATA. If the exclusion ends with / then only files in the specified directory will be excluded, e.g. --exclude=junk/ will exclude all files in the $PGDATA/junk directory but include the directory itself. If the exclusion does not end with / then the file may match the exclusion exactly or match with / appended to the exclusion, e.g. --exclude=junk will exclude the $PGDATA/junk directory and all the files it contains.
Be careful using this feature -- it is very easy to exclude something critical that will make the backup inconsistent. Be sure to test your restores!
All excluded files will be logged at info level along with the exclusion rule. Be sure to audit the list of excluded files to ensure nothing unexpected is being excluded.
NOTE:
Exclusions are not honored on delta restores. Any files/directories that were excluded by the backup will be removed on delta restore.
This option should not be used to exclude PostgreSQL logs from a backup. Logs can be moved out of the PGDATA directory using the PostgreSQL log_directory setting, which has the benefit of allowing logs to be preserved after a restore.
Multiple exclusions may be specified on the command-line or in a configuration file.

    example: --exclude=junk/

4.1.7
Force Option (--force)
Force an offline backup.
When used with --no-start-stop a backup will be run even if pgBackRest thinks that PostgreSQL is running. This option should be used with extreme care as it will likely result in a bad backup.
There are some scenarios where a backup might still be desirable under these conditions. For example, if a server crashes and the database cluster volume can only be mounted read-only, it would be a good idea to take a backup even if postmaster.pid is present. In this case it would be better to revert to the prior backup and replay WAL, but possibly there is a very important transaction in a WAL segment that did not get archived.

    default: n
    example: --force

4.1.8
Manifest Save Threshold Option (--manifest-save-threshold)
Manifest save threshold during backup.
Defines how often the manifest will be saved during a backup. Saving the manifest is important because it stores the checksums and allows the resume function to work efficiently. The actual threshold used is 1% of the backup size or manifest-save-threshold, whichever is greater.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024.

    default: 1073741824
    allowed: 1-1099511627776
    example: --manifest-save-threshold=5G

4.1.9
Online Option (--online)
Perform an online backup.
Specifying --no-online prevents pgBackRest from running pg_start_backup() and pg_stop_backup() on the database cluster. In order for this to work PostgreSQL should be shut down and pgBackRest will generate an error if it is not.
The purpose of this option is to allow offline backups. The pg_xlog/pg_wal directory is copied as-is and archive-check is automatically disabled for the backup.

    default: y
    example: --no-online

4.1.10
Resume Option (--resume)
Allow resume of failed backup.
Defines whether the resume feature is enabled. Resume can greatly reduce the amount of time required to run a backup after a previous backup of the same type has failed. It adds complexity, however, so it may be desirable to disable in environments that do not require the feature.

    default: y
    example: --no-resume

4.1.11
Start Fast Option (--start-fast)
Force a checkpoint to start backup quickly.
Forces a checkpoint (by passing y to the fast parameter of pg_start_backup()) so the backup begins immediately. Otherwise the backup will start after the next regular checkpoint.
This feature only works in PostgreSQL >= 8.4.

    default: n
    example: --start-fast

4.1.12
Stop Auto Option (--stop-auto)
Stop prior failed backup on new backup.
This will only be done if an exclusive advisory lock can be acquired to demonstrate that the prior failed backup process has really stopped.
This feature relies on pg_is_in_backup() so only works on PostgreSQL >= 9.3.
This feature is not supported for PostgreSQL >= 9.6 since backups are run in non-exclusive mode.
The setting is disabled by default because it assumes that pgBackRest is the only process doing exclusive online backups. It depends on an advisory lock that only pgBackRest sets so it may abort other processes that do exclusive online backups. Note that base_backup and pg_dump are safe to use with this setting because they do not call pg_start_backup() so are not exclusive.

    default: n
    example: --stop-auto

4.1.13
Type Option (--type)
Backup type.
The following backup types are supported:

- full - all database cluster files will be copied and there will be no dependencies on previous backups.
- incr - incremental from the last successful backup.
- diff - like an incremental backup but always based on the last full backup.

    default: incr
    example: --type=full

4.2
General Options
4.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

4.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

4.2.3
Compress Option (--compress)
Use gzip file compression.
Backup files are compatible with command-line gzip tools.

    default: y
    example: --no-compress

4.2.4
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

4.2.5
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

4.2.6
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

4.2.7
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

4.2.8
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

4.2.9
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

4.2.10
Delta Option (--delta)
Restore or backup using checksums.
During a restore, by default the PostgreSQL data and tablespace directories are expected to be present but empty. This option performs a delta restore using checksums.
During a backup, this option will use checksums instead of the timestamps to determine if files will be copied.

    default: n
    example: --delta

4.2.11
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

4.2.12
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

4.2.13
Process Maximum Option (--process-max)
Max processes to use for compress/transfer.
Each process will perform compression and transfer to make the command run faster, but don't set process-max so high that it impacts database performance.

    default: 1
    allowed: 1-999
    example: --process-max=4

4.2.14
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

4.2.15
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

4.3
Log Options
4.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

4.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

4.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

4.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

4.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

4.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

4.4
Repository Options
4.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

4.4.2
Repository Hardlink Option (--repo-hardlink)
Hardlink files between backups in the repository.
Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each backup is a full backup at the file-system level. Be careful, though, because modifying files that are hard-linked can affect all the backups in the set.

    default: n
    example: --repo1-hardlink

Deprecated Name: hardlink
4.4.3
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

4.4.4
Archive Retention Option (--repo-retention-archive)
Number of backups worth of continuous WAL to retain.
NOTE:
WAL segments required to make a backup consistent are always retained until the backup is expired regardless of how this option is configured.
If this value is not set, then the archive to expire will default to the repo-retention-full (or repo-retention-diff) value corresponding to the repo-retention-archive-type if set to full (or diff). This will ensure that WAL is only expired for backups that are already expired.
This option must be set if repo-retention-archive-type is set to incr. If disk space is at a premium, then this setting, in conjunction with repo-retention-archive-type, can be used to aggressively expire WAL segments. However, doing so negates the ability to perform PITR from the backups with expired WAL and is therefore not recommended.

    allowed: 1-9999999
    example: --repo1-retention-archive=2

Deprecated Name: retention-archive
4.4.5
Archive Retention Type Option (--repo-retention-archive-type)
Backup type for WAL retention.
If set to full pgBackRest will keep archive logs for the number of full backups defined by repo-retention-archive. If set to diff (differential) pgBackRest will keep archive logs for the number of full and differential backups defined by repo-retention-archive, meaning if the last backup taken was a full backup, it will be counted as a differential for the purpose of repo-retention. If set to incr (incremental) pgBackRest will keep archive logs for the number of full, differential, and incremental backups defined by repo-retention-archive. It is recommended that this setting not be changed from the default which will only expire WAL in conjunction with expiring full backups.

    default: full
    example: --repo1-retention-archive-type=diff

Deprecated Name: retention-archive-type
4.4.6
Differential Retention Option (--repo-retention-diff)
Number of differential backups to retain.
When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept until the full backups they depend on expire.

    allowed: 1-9999999
    example: --repo1-retention-diff=3

Deprecated Name: retention-diff
4.4.7
Full Retention Option (--repo-retention-full)
Number of full backups to retain.
When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When the option is not defined a warning will be issued. If indefinite retention is desired then set the option to the max value.

    allowed: 1-9999999
    example: --repo1-retention-full=2

Deprecated Name: retention-full
4.4.8
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

4.4.9
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

4.4.10
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

4.4.11
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

4.4.12
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

4.4.13
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

4.4.14
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

4.4.15
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

4.4.16
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
4.4.17
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

4.5
Stanza Options
4.5.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
4.5.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
4.5.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
4.5.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

4.5.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

4.5.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
4.5.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
4.5.8
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
4.5.9
PostgreSQL Port Option (--pg-port)
PostgreSQL port.
Port that PostgreSQL is running on. This usually does not need to be specified as most PostgreSQL clusters run on the default port.

    default: 5432
    allowed: 0-65535
    example: --pg1-port=6543

Deprecated Name: db-port
4.5.10
PostgreSQL Socket Path Option (--pg-socket-path)
PostgreSQL unix socket path.
The unix socket directory that was specified when PostgreSQL was started. pgBackRest will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.

    allowed: 0-65535
    example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path
4.5.11
PostgreSQL Database User Option (--pg-user)
PostgreSQL database user.
The database user name used when connecting to PostgreSQL. If not specified pgBackRest will connect with the local OS user or PGUSER.

    example: --pg1-user=backupuser

5
Check Command (check)
The check command validates that pgBackRest and the archive_command setting are configured correctly for archiving and backups. It detects misconfigurations, particularly in archiving, that result in incomplete backups because required WAL segments did not reach the archive. The command can be run on the database or the repository host. The command may also be run on the standby host, however, since pg_switch_xlog()/pg_switch_wal() cannot be performed on the standby, the command will only test the repository configuration.
Note that pg_create_restore_point('pgBackRest Archive Check') and pg_switch_xlog()/pg_switch_wal() are called to force PostgreSQL to archive a WAL segment. Restore points are only supported in PostgreSQL >= 9.1 so for older versions the check command may fail if there has been no write activity since the last log rotation, therefore it is recommended that activity be generated by the user if there have been no writes since the last WAL switch before running the check command.
5.1
Command Options
5.1.1
Check Archive Option (--archive-check)
Check that WAL segments are in the archive before backup completes.
Checks that all WAL segments required to make the backup consistent are present in the WAL archive. It's a good idea to leave this as the default unless you are using another method for archiving.
This option must be enabled if archive-copy is enabled.

    default: y
    example: --no-archive-check

5.1.2
Archive Timeout Option (--archive-timeout)
Archive timeout.
Set maximum time, in seconds, to wait for each WAL segment to reach the pgBackRest archive repository. The timeout applies to the check and backup commands when waiting for WAL segments required for backup consistency to be archived.

    default: 60
    allowed: 0.1-86400
    example: --archive-timeout=30

5.1.3
Backup from Standby Option (--backup-standby)
Backup from the standby cluster.
Enable backup from standby to reduce load on the primary cluster. This option requires that both the primary and standby hosts be configured.

    default: n
    example: --backup-standby

5.2
General Options
5.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

5.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

5.2.3
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

5.2.4
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

5.2.5
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

5.2.6
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

5.2.7
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

5.2.8
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

5.2.9
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

5.2.10
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

5.2.11
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

5.3
Log Options
5.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

5.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

5.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

5.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

5.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

5.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

5.4
Repository Options
5.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

5.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
5.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
5.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
5.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

5.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

5.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
5.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
5.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

5.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

5.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

5.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

5.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

5.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

5.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

5.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

5.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

5.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
5.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

5.5
Stanza Options
5.5.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
5.5.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
5.5.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
5.5.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

5.5.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

5.5.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
5.5.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
5.5.8
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
5.5.9
PostgreSQL Port Option (--pg-port)
PostgreSQL port.
Port that PostgreSQL is running on. This usually does not need to be specified as most PostgreSQL clusters run on the default port.

    default: 5432
    allowed: 0-65535
    example: --pg1-port=6543

Deprecated Name: db-port
5.5.10
PostgreSQL Socket Path Option (--pg-socket-path)
PostgreSQL unix socket path.
The unix socket directory that was specified when PostgreSQL was started. pgBackRest will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.

    allowed: 0-65535
    example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path
5.5.11
PostgreSQL Database User Option (--pg-user)
PostgreSQL database user.
The database user name used when connecting to PostgreSQL. If not specified pgBackRest will connect with the local OS user or PGUSER.

    example: --pg1-user=backupuser

6
Expire Command (expire)
pgBackRest does backup rotation but is not concerned with when the backups were created. If two full backups are configured for retention, pgBackRest will keep two full backups no matter whether they occur two hours or two weeks apart.
6.1
General Options
6.1.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

6.1.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

6.1.3
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

6.1.4
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

6.1.5
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

6.1.6
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

6.1.7
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

6.1.8
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

6.2
Log Options
6.2.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

6.2.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

6.2.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

6.2.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

6.2.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

6.2.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

6.3
Repository Options
6.3.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

6.3.2
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

6.3.3
Archive Retention Option (--repo-retention-archive)
Number of backups worth of continuous WAL to retain.
NOTE:
WAL segments required to make a backup consistent are always retained until the backup is expired regardless of how this option is configured.
If this value is not set, then the archive to expire will default to the repo-retention-full (or repo-retention-diff) value corresponding to the repo-retention-archive-type if set to full (or diff). This will ensure that WAL is only expired for backups that are already expired.
This option must be set if repo-retention-archive-type is set to incr. If disk space is at a premium, then this setting, in conjunction with repo-retention-archive-type, can be used to aggressively expire WAL segments. However, doing so negates the ability to perform PITR from the backups with expired WAL and is therefore not recommended.

    allowed: 1-9999999
    example: --repo1-retention-archive=2

Deprecated Name: retention-archive
6.3.4
Archive Retention Type Option (--repo-retention-archive-type)
Backup type for WAL retention.
If set to full pgBackRest will keep archive logs for the number of full backups defined by repo-retention-archive. If set to diff (differential) pgBackRest will keep archive logs for the number of full and differential backups defined by repo-retention-archive, meaning if the last backup taken was a full backup, it will be counted as a differential for the purpose of repo-retention. If set to incr (incremental) pgBackRest will keep archive logs for the number of full, differential, and incremental backups defined by repo-retention-archive. It is recommended that this setting not be changed from the default which will only expire WAL in conjunction with expiring full backups.

    default: full
    example: --repo1-retention-archive-type=diff

Deprecated Name: retention-archive-type
6.3.5
Differential Retention Option (--repo-retention-diff)
Number of differential backups to retain.
When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept until the full backups they depend on expire.

    allowed: 1-9999999
    example: --repo1-retention-diff=3

Deprecated Name: retention-diff
6.3.6
Full Retention Option (--repo-retention-full)
Number of full backups to retain.
When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When the option is not defined a warning will be issued. If indefinite retention is desired then set the option to the max value.

    allowed: 1-9999999
    example: --repo1-retention-full=2

Deprecated Name: retention-full
6.3.7
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

6.3.8
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

6.3.9
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

6.3.10
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

6.3.11
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

6.3.12
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

6.3.13
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

6.3.14
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

6.3.15
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
6.3.16
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

6.4
Stanza Options
6.4.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
6.4.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
6.4.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
6.4.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

6.4.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

6.4.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
6.4.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
7
Help Command (help)
Three levels of help are provided. If no command is specified then general help will be displayed. If a command is specified then a full description of the command will be displayed along with a list of valid options. If an option is specified in addition to a command then the a full description of the option as it applies to the command will be displayed.
8
Info Command (info)
The info command operates on a single stanza or all stanzas. Text output is the default and gives a human-readable summary of backups for the stanza(s) requested. This format is subject to change with any release.
For machine-readable output use --output=json. The JSON output contains far more information than the text output and is kept stable unless a bug is found.
8.1
Command Options
8.1.1
Output Option (--output)
Output format.
The following output types are supported:

- text - Human-readable summary of backup information.
- json - Exhaustive machine-readable backup information in JSON format.

    default: text
    example: --output=json

8.1.2
Set Option (--set)
Backup set to detail.
Details include a list of databases (with OIDs) in the backup set (excluding template databases), tablespaces (with OIDs) with the destination where they will be restored by default, and symlinks with the destination where they will be restored when --link-all is specified.

    example: --set=20150131-153358F_20150131-153401I

8.2
General Options
8.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

8.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

8.2.3
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

8.2.4
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

8.2.5
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

8.2.6
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

8.2.7
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

8.2.8
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

8.2.9
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

8.2.10
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

8.3
Log Options
8.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

8.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

8.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

8.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

8.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

8.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

8.4
Repository Options
8.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

8.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
8.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
8.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
8.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

8.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

8.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
8.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
8.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

8.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

8.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

8.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

8.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

8.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

8.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

8.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

8.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

8.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
8.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

9
Storage List Command (ls)
This is intended to be a general purpose list function, but for now it only works on the repository.
9.1
Command Options
9.1.1
Filter Output Option (--filter)
Filter output with a regular expression.
The filter is applied against the file/path names before they are output.

    example: --filter=(F|D|I)$

9.1.2
Output Option (--output)
Output format.
The following output types are supported:

- text - Simple list with one file/link/path name on each line.
- json - Detailed file/link/path information in JSON format.

    default: text
    example: --output=json

9.1.3
Recurse Subpaths Option (--recurse)
Include all subpaths in output.
All subpaths and their files will be included in the output.

    default: n
    example: --recurse

9.1.4
Sort Output Option (--sort)
Sort output ascending, descending, or none.
The following sort types are supported:

- asc - sort ascending.
- desc - sort descending.
- none - no sorting.

    default: asc
    example: --sort=desc

9.2
General Options
9.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

9.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

9.2.3
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

9.2.4
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

9.2.5
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

9.2.6
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

9.2.7
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

9.2.8
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

9.2.9
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

9.3
Log Options
9.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

9.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

9.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

9.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

9.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

9.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

9.4
Repository Options
9.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

9.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
9.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
9.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
9.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

9.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

9.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
9.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
9.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

9.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

9.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

9.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

9.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

9.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

9.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

9.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

9.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

9.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
9.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

10
Restore Command (restore)
This command is generally run manually, but there are instances where it might be automated.
10.1
Command Options
10.1.1
Include Database Option (--db-include)
Restore only specified databases.
This feature allows only selected databases to be restored. Databases not specifically included will be restored as sparse, zeroed files to save space but still allow PostgreSQL to perform recovery. After recovery the databases that were not included will not be accessible but can be removed with the drop database command.
NOTE:
built-in databases (template0, template1, and postgres) are always restored.
The --db-include option can be passed multiple times to specify more than one database to include.

    example: --db-include=db_main

10.1.2
Force Option (--force)
Force a restore.
By itself this option forces the PostgreSQL data and tablespace paths to be completely overwritten. In combination with --delta a timestamp/size delta will be performed instead of using checksums.

    default: n
    example: --force

10.1.3
Link All Option (--link-all)
Restore all symlinks.
By default symlinked directories and files are restored as normal directories and files in $PGDATA. This is because it may not be safe to restore symlinks to their original destinations on a system other than where the original backup was performed. This option restores all the symlinks just as they were on the original system where the backup was performed.

    default: n
    example: --link-all

10.1.4
Link Map Option (--link-map)
Modify the destination of a symlink.
Allows the destination file or path of a symlink to be changed on restore. This is useful for restoring to systems that have a different storage layout than the original system where the backup was generated.

    example: --link-map=pg_xlog=/data/xlog

10.1.5
Recovery Option Option (--recovery-option)
Set an option in recovery.conf.
See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on recovery.conf options (replace X.X with your PostgreSQL version). This option can be used multiple times.
NOTE:
The restore_command option will be automatically generated but can be overridden with this option. Be careful about specifying your own restore_command as pgBackRest is designed to handle this for you. Target Recovery options (recovery_target_name, recovery_target_time, etc.) are generated automatically by pgBackRest and should not be set with this option.
Since pgBackRest does not start PostgreSQL after writing the recovery.conf file, it is always possible to edit/check recovery.conf before manually restarting.

    example: --recovery-option=primary_conninfo=db.mydomain.com

10.1.6
Set Option (--set)
Backup set to restore.
The backup set to be restored. latest will restore the latest backup, otherwise provide the name of the backup to restore.

    default: latest
    example: --set=20150131-153358F_20150131-153401I

10.1.7
Tablespace Map Option (--tablespace-map)
Restore a tablespace into the specified directory.
Moves a tablespace to a new location during the restore. This is useful when tablespace locations are not the same on a replica, or an upgraded system has different mount points.
Since PostgreSQL 9.2 tablespace locations are not stored in pg_tablespace so moving tablespaces can be done with impunity. However, moving a tablespace to the data_directory is not recommended and may cause problems. For more information on moving tablespaces http://www.databasesoup.com/2013/11/moving-tablespaces.html is a good resource.

    example: --tablespace-map=ts_01=/db/ts_01

10.1.8
Map All Tablespaces Option (--tablespace-map-all)
Restore all tablespaces into the specified directory.
By default tablespaces are restored into their original locations and while this behavior can be modified by with the tablespace-map open it is sometime preferable to remap all tablespaces to a new directory all at once. This is particularly useful for development or staging systems that may not have the same storage layout as the original system where the backup was generated.
The path specified will be the parent path used to create all the tablespaces in the backup.

    example: --tablespace-map-all=/data/tablespace

10.1.9
Target Option (--target)
Recovery target.
Defines the recovery target when --type is name, xid, or time.

    example: --target=2015-01-30 14:15:11 EST

10.1.10
Target Action Option (--target-action)
Action to take when recovery target is reached.
This option is effective when hot_standby=on is configured in postgresql.conf, otherwise the cluster will be promoted when the target is reached or there is no more WAL in the archive.
The following actions are supported:

- pause - pause when recovery target is reached. (PostgreSQL >= 9.1)
- promote - promote and switch timeline when recovery target is reached. (PostgreSQL >= 9.1)
- shutdown - shutdown server when recovery target is reached. (PostgreSQL >= 9.5)

    default: pause
    example: --target-action=promote

10.1.11
Target Exclusive Option (--target-exclusive)
Stop just before the recovery target is reached.
Defines whether recovery to the target would be exclusive (the default is inclusive) and is only valid when --type is time or xid. For example, using --target-exclusive would exclude the contents of transaction 1007 when --type=xid and --target=1007. See the recovery_target_inclusive option in the PostgreSQL docs for more information.

    default: n
    example: --no-target-exclusive

10.1.12
Target Timeline Option (--target-timeline)
Recover along a timeline.
See recovery_target_timeline in the PostgreSQL docs for more information.

    example: --target-timeline=3

10.1.13
Type Option (--type)
Recovery type.
The following recovery types are supported:

- default - recover to the end of the archive stream.
- immediate - recover only until the database becomes consistent. This option is only supported on PostgreSQL >= 9.4.
- name - recover the restore point specified in --target.
- xid - recover to the transaction id specified in --target.
- time - recover to the time specified in --target.
- preserve - preserve the existing recovery.conf file.
- standby - add standby_mode=on to recovery.conf file so cluster will start in standby mode.
- none - no recovery.conf file is written so PostgreSQL will attempt to achieve consistency using WAL segments present in pg_xlog/pg_wal. Provide the required WAL segments or use the archive-copy setting to include them with the backup.

    default: default
    example: --type=xid

10.2
General Options
10.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

10.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

10.2.3
Compress Option (--compress)
Use gzip file compression.
Backup files are compatible with command-line gzip tools.

    default: y
    example: --no-compress

10.2.4
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

10.2.5
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

10.2.6
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

10.2.7
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

10.2.8
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

10.2.9
Delta Option (--delta)
Restore or backup using checksums.
During a restore, by default the PostgreSQL data and tablespace directories are expected to be present but empty. This option performs a delta restore using checksums.
During a backup, this option will use checksums instead of the timestamps to determine if files will be copied.

    default: n
    example: --delta

10.2.10
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

10.2.11
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

10.2.12
Process Maximum Option (--process-max)
Max processes to use for compress/transfer.
Each process will perform compression and transfer to make the command run faster, but don't set process-max so high that it impacts database performance.

    default: 1
    allowed: 1-999
    example: --process-max=4

10.2.13
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

10.2.14
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

10.3
Log Options
10.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

10.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

10.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

10.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

10.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

10.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

10.4
Repository Options
10.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

10.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
10.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
10.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
10.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

10.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

10.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
10.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
10.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

10.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

10.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

10.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

10.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

10.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

10.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

10.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

10.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

10.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
10.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

10.5
Stanza Options
10.5.1
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
11
Stanza Create Command (stanza-create)
The stanza-create command must be run on the host where the repository is located after the stanza has been configured in pgbackrest.conf.
11.1
Command Options
11.1.1
Backup from Standby Option (--backup-standby)
Backup from the standby cluster.
Enable backup from standby to reduce load on the primary cluster. This option requires that both the primary and standby hosts be configured.

    default: n
    example: --backup-standby

11.1.2
Online Option (--online)
Create on an online cluster.
Specifying --no-online prevents pgBackRest from connecting to PostgreSQL when creating the stanza.

    default: y
    example: --no-online

11.2
General Options
11.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

11.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

11.2.3
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

11.2.4
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

11.2.5
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

11.2.6
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

11.2.7
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

11.2.8
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

11.2.9
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

11.2.10
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

11.2.11
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

11.2.12
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

11.3
Log Options
11.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

11.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

11.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

11.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

11.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

11.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

11.4
Repository Options
11.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

11.4.2
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

11.4.3
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

11.4.4
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

11.4.5
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

11.4.6
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

11.4.7
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

11.4.8
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

11.4.9
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

11.4.10
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

11.4.11
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
11.4.12
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

11.5
Stanza Options
11.5.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
11.5.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
11.5.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
11.5.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

11.5.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

11.5.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
11.5.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
11.5.8
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
11.5.9
PostgreSQL Port Option (--pg-port)
PostgreSQL port.
Port that PostgreSQL is running on. This usually does not need to be specified as most PostgreSQL clusters run on the default port.

    default: 5432
    allowed: 0-65535
    example: --pg1-port=6543

Deprecated Name: db-port
11.5.10
PostgreSQL Socket Path Option (--pg-socket-path)
PostgreSQL unix socket path.
The unix socket directory that was specified when PostgreSQL was started. pgBackRest will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.

    allowed: 0-65535
    example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path
11.5.11
PostgreSQL Database User Option (--pg-user)
PostgreSQL database user.
The database user name used when connecting to PostgreSQL. If not specified pgBackRest will connect with the local OS user or PGUSER.

    example: --pg1-user=backupuser

12
Stanza Delete Command (stanza-delete)
The stanza-delete command removes data in the repository associated with a stanza.
WARNING:
Use this command with caution — it will permanently remove all backups and archives from the pgBackRest repository for the specified stanza.
To delete a stanza:

- Shut down the PostgreSQL cluster associated with the stanza (or use --force to override).
- Run the stop command on the repository host.
- Run the stanza-delete command on the repository host.

Once the command successfully completes, it is the responsibility of the user to remove the stanza from all pgBackRest configuration files.
12.1
Command Options
12.1.1
Force Option (--force)
Force stanza delete.
If PostgreSQL is still running for the stanza, then this option can be used to force the stanza to be deleted from the repository.

    default: n
    example: --no-force

12.2
General Options
12.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

12.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

12.2.3
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

12.2.4
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

12.2.5
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

12.2.6
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

12.2.7
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

12.2.8
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

12.2.9
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

12.2.10
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

12.2.11
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

12.2.12
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

12.3
Log Options
12.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

12.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

12.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

12.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

12.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

12.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

12.4
Repository Options
12.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

12.4.2
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

12.4.3
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

12.4.4
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

12.4.5
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

12.4.6
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

12.4.7
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

12.4.8
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

12.4.9
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

12.4.10
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

12.4.11
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
12.4.12
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

12.5
Stanza Options
12.5.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
12.5.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
12.5.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
12.5.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

12.5.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

12.5.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
12.5.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
12.5.8
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
12.5.9
PostgreSQL Port Option (--pg-port)
PostgreSQL port.
Port that PostgreSQL is running on. This usually does not need to be specified as most PostgreSQL clusters run on the default port.

    default: 5432
    allowed: 0-65535
    example: --pg1-port=6543

Deprecated Name: db-port
12.5.10
PostgreSQL Socket Path Option (--pg-socket-path)
PostgreSQL unix socket path.
The unix socket directory that was specified when PostgreSQL was started. pgBackRest will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.

    allowed: 0-65535
    example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path
12.5.11
PostgreSQL Database User Option (--pg-user)
PostgreSQL database user.
The database user name used when connecting to PostgreSQL. If not specified pgBackRest will connect with the local OS user or PGUSER.

    example: --pg1-user=backupuser

13
Stanza Upgrade Command (stanza-upgrade)
Immediately after upgrading PostgreSQL to a newer major version, the pg-path for all pgBackRest configurations must be set to the new database location and the stanza-upgrade run on the repository host. If the database is offline use the --no-online option.
13.1
Command Options
13.1.1
Backup from Standby Option (--backup-standby)
Backup from the standby cluster.
Enable backup from standby to reduce load on the primary cluster. This option requires that both the primary and standby hosts be configured.

    default: n
    example: --backup-standby

13.1.2
Online Option (--online)
Update an online cluster.
Specifying --no-online prevents pgBackRest from connecting to PostgreSQL when upgrading the stanza.

    default: y
    example: --no-online

13.2
General Options
13.2.1
Buffer Size Option (--buffer-size)
Buffer size for file operations.
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per process. An additional maximum of 256K per process may be used for zlib buffers.
Size can be entered in bytes (default) or KB, MB, GB, TB, or PB where the multiplier is a power of 1024. For example, the case-insensitive value 32k (or 32KB) can be used instead of 32768.
Allowed values, in bytes, are 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, and 16777216.

    default: 4194304
    example: --buffer-size=32K

13.2.2
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

13.2.3
Compress Level Option (--compress-level)
Compression level for stored files.
Sets the zlib level to be used for file compression when compress=y.

    default: 6
    allowed: 0-9
    example: --compress-level=9

13.2.4
Network Compress Level Option (--compress-level-network)
Compression level for network transfer when compress=n.
Sets the zlib level to be used for protocol compression when compress=n and the database cluster is not on the same host as the repository. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled.

    default: 3
    allowed: 0-9
    example: --compress-level-network=1

13.2.5
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

13.2.6
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

13.2.7
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

13.2.8
Database Timeout Option (--db-timeout)
Database query timeout.
Sets the timeout, in seconds, for queries against the database. This includes the pg_start_backup() and pg_stop_backup() functions which can each take a substantial amount of time. Because of this the timeout should be kept high unless you know that these functions will return quickly (i.e. if you have set startfast=y and you know that the database cluster will not generate many WAL segments during the backup).
NOTE:
The db-timeout option must be less than the protocol-timeout option.

    default: 1800
    allowed: 0.1-604800
    example: --db-timeout=600

13.2.9
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

13.2.10
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

13.2.11
Protocol Timeout Option (--protocol-timeout)
Protocol timeout.
Sets the timeout, in seconds, that the local or remote process will wait for a new message to be received on the protocol layer. This prevents processes from waiting indefinitely for a message.
NOTE:
The protocol-timeout option must be greater than the db-timeout option.

    default: 1830
    allowed: 0.1-604800
    example: --protocol-timeout=630

13.2.12
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

13.3
Log Options
13.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

13.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

13.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

13.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

13.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

13.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

13.4
Repository Options
13.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

13.4.2
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

13.4.3
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

13.4.4
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

13.4.5
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

13.4.6
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

13.4.7
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

13.4.8
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

13.4.9
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

13.4.10
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

13.4.11
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
13.4.12
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

13.5
Stanza Options
13.5.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
13.5.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
13.5.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
13.5.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

13.5.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

13.5.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
13.5.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
13.5.8
PostgreSQL Path Option (--pg-path)
PostgreSQL data directory.
This should be the same as the data_directory setting in postgresql.conf. Even though this value can be read from postgresql.conf or PostgreSQL it is prudent to set it in case those resources are not available during a restore or offline backup scenario.
The pg-path option is tested against the value reported by PostgreSQL on every online backup so it should always be current.

    example: --pg1-path=/data/db

Deprecated Name: db-path
13.5.9
PostgreSQL Port Option (--pg-port)
PostgreSQL port.
Port that PostgreSQL is running on. This usually does not need to be specified as most PostgreSQL clusters run on the default port.

    default: 5432
    allowed: 0-65535
    example: --pg1-port=6543

Deprecated Name: db-port
13.5.10
PostgreSQL Socket Path Option (--pg-socket-path)
PostgreSQL unix socket path.
The unix socket directory that was specified when PostgreSQL was started. pgBackRest will automatically look in the standard location for your OS so there is usually no need to specify this setting unless the socket directory was explicitly modified with the unix_socket_directory setting in postgresql.conf.

    allowed: 0-65535
    example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path
13.5.11
PostgreSQL Database User Option (--pg-user)
PostgreSQL database user.
The database user name used when connecting to PostgreSQL. If not specified pgBackRest will connect with the local OS user or PGUSER.

    example: --pg1-user=backupuser

14
Start Command (start)
If the pgBackRest processes were previously stopped using the stop command then they can be started again using the start command. Note that this will not immediately start up any pgBackRest processes but they are allowed to run.
14.1
General Options
14.1.1
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

14.1.2
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

14.1.3
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

14.1.4
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

14.1.5
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

14.1.6
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

14.1.7
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

14.2
Log Options
14.2.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

14.2.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

14.2.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

14.2.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

14.2.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

14.2.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

14.3
Repository Options
14.3.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

14.3.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
14.3.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
14.3.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
14.3.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

14.3.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

14.3.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
14.3.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
14.3.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

14.3.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

14.3.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

14.3.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

14.3.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

14.3.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

14.3.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

14.3.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

14.3.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

14.3.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
14.3.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

14.4
Stanza Options
14.4.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
14.4.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
14.4.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
14.4.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

14.4.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

14.4.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
14.4.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
15
Stop Command (stop)
Does not allow any new pgBackRest processes to run. By default running processes will be allowed to complete successfully. Use the --force option to terminate running processes.
pgBackRest processes will return an error if they are run after the stop command completes.
15.1
Command Options
15.1.1
Force Option (--force)
Force all pgBackRest processes to stop.
This option will send TERM signals to all running pgBackRest processes to effect a graceful but immediate shutdown. Note that this will also shutdown processes that were initiated on another system but have remotes running on the current system. For instance, if a backup was started on the backup server then running stop --force on the database server will shutdown the backup process on the backup server.

    default: n
    example: --force

15.2
General Options
15.2.1
SSH client command Option (--cmd-ssh)
Path to ssh client executable.
Use a specific SSH client when an alternate is desired or the ssh executable is not in $PATH.

    default: ssh
    example: --cmd-ssh=/usr/bin/ssh

15.2.2
Config Option (--config)
pgBackRest configuration file.
Use this option to specify a different configuration file than the default.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --config=/conf/pgbackrest/pgbackrest.conf

15.2.3
Config Include Path Option (--config-include-path)
Path to additional pgBackRest configuration files.
Configuration files existing in the specified location with extension .conf will be concatenated with the pgBackRest configuration file, resulting in one configuration file.

    default: /etc/pgbackrest/conf.d
    example: --config-include-path=/conf/pgbackrest/conf.d

15.2.4
Config Path Option (--config-path)
Base path of pgBackRest configuration files.
This setting is used to override the default base path setting for the --config and --config-include-path options unless they are explicitly set on the command-line.
For example, passing only --config-path=/conf/pgbackrest results in the --config default being set to /conf/pgbackrest/pgbackrest.conf and the --config-include-path default being set to /conf/pgbackrest/conf.d.

    default: /etc/pgbackrest
    example: --config-path=/conf/pgbackrest

15.2.5
Lock Path Option (--lock-path)
Path where lock files are stored.
The lock path provides a location for pgBackRest to create lock files to prevent conflicting operations from being run concurrently.

    default: /tmp/pgbackrest
    example: --lock-path=/backup/db/lock

15.2.6
Neutral Umask Option (--neutral-umask)
Use a neutral umask.
Sets the umask to 0000 so modes in the repository are created in a sensible way. The default directory mode is 0750 and default file mode is 0640. The lock and log directories set the directory and file mode to 0770 and 0660 respectively.
To use the executing user's umask instead specify neutral-umask=n in the config file or --no-neutral-umask on the command line.

    default: y
    example: --no-neutral-umask

15.2.7
Stanza Option (--stanza)
Defines the stanza.
A stanza is the configuration for a PostgreSQL database cluster that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres database cluster and therefore one stanza, whereas backup servers will have a stanza for every database cluster that needs to be backed up.
It is tempting to name the stanza after the primary cluster but a better name describes the databases contained in the cluster. Because the stanza name will be used for the primary and all replicas it is more appropriate to choose a name that describes the actual function of the cluster, such as app or dw, rather than the local cluster name, such as main or prod.

    example: --stanza=main

15.3
Log Options
15.3.1
Console Log Level Option (--log-level-console)
Level for console logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-console=error

15.3.2
File Log Level Option (--log-level-file)
Level for file logging.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: info
    example: --log-level-file=debug

15.3.3
Std Error Log Level Option (--log-level-stderr)
Level for stderr logging.
Specifies which log levels will output to stderr rather than stdout (specified by log-level-console). The timestamp and process will not be output to stderr.
The following log levels are supported:

- off - No logging at all (not recommended)
- error - Log only errors
- warn - Log warnings and errors
- info - Log info, warnings, and errors
- detail - Log detail, info, warnings, and errors
- debug - Log debug, detail, info, warnings, and errors
- trace - Log trace (very verbose debugging), debug, info, warnings, and errors

    default: warn
    example: --log-level-stderr=error

15.3.4
Log Path Option (--log-path)
Path where log files are stored.
The log path provides a location for pgBackRest to store log files. Note that if log-level-file=off then no log path is required.

    default: /var/log/pgbackrest
    example: --log-path=/backup/db/log

15.3.5
Log Subprocesses Option (--log-subprocess)
Enable logging in subprocesses.
Enable file logging for any subprocesses created by this process using the log level specified by log-level-file.

    default: n
    example: --log-subprocess

15.3.6
Log Timestamp Option (--log-timestamp)
Enable timestamp in logging.
Enables the timestamp in console and file logging. This option is disabled in special situations such as generating documentation.

    default: y
    example: --no-log-timestamp

15.4
Repository Options
15.4.1
Repository Cipher Type Option (--repo-cipher-type)
Cipher used to encrypt the repository.
The following repository types are supported:

- none - The repository is not encrypted
- aes-256-cbc - Advanced Encryption Standard with 256 bit key length

Note that encryption is always performed client-side even if the repository type (e.g. S3) supports encryption.

    default: none
    example: --repo1-cipher-type=aes-256-cbc

15.4.2
Repository Host Option (--repo-host)
Repository host when operating remotely via SSH.
Make sure that trusted SSH authentication is configured between the PostgreSQL host and the repository host.
When backing up and archiving to a locally mounted filesystem this setting is not required.

    example: --repo1-host=repo1.domain.com

Deprecated Name: backup-host
15.4.3
Repository Host Command Option (--repo-host-cmd)
pgBackRest exe path on the repository host.
Required only if the path to pgbackrest is different on the local and repository hosts. If not defined, the repository host exe path will be set the same as the local exe path.

    example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: backup-cmd
15.4.4
Repository Host Configuration Option (--repo-host-config)
pgBackRest repository host configuration file.
Sets the location of the configuration file on the repository host. This is only required if the repository host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config
15.4.5
Repository Host Configuration Include Path Option (--repo-host-config-include-path)
pgBackRest repository host configuration include path.
Sets the location of the configuration include path on the repository host. This is only required if the repository host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

15.4.6
Repository Host Configuration Path Option (--repo-host-config-path)
pgBackRest repository host configuration path.
Sets the location of the configuration path on the repository host. This is only required if the repository host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --repo1-host-config-path=/conf/pgbackrest

15.4.7
Repository Host Port Option (--repo-host-port)
Repository host port when repo-host is set.
Use this option to specify a non-default port for the repository host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --repo1-host-port=25

Deprecated Name: backup-ssh-port
15.4.8
Repository Host User Option (--repo-host-user)
Repository host user when repo-host is set.
Defines the user that will be used for operations on the repository host. Preferably this is not the postgres user but rather some other user like pgbackrest. If PostgreSQL runs on the repository host the postgres user can be placed in the pgbackrest group so it has read permissions on the repository without being able to damage the contents accidentally.

    default: pgbackrest
    example: --repo1-host-user=repo-user

Deprecated Name: backup-user
15.4.9
Repository Path Option (--repo-path)
Path where backups and archive are stored.
The repository is where pgBackRest stores backups and archives WAL segments.
It may be difficult to estimate in advance how much space you'll need. The best thing to do is take some backups then record the size of different types of backups (full/incr/diff) and measure the amount of WAL generated per day. This will give you a general idea of how much space you'll need, though of course requirements will likely change over time as your database evolves.

    default: /var/lib/pgbackrest
    example: --repo1-path=/backup/db/backrest

15.4.10
S3 Repository Bucket Option (--repo-s3-bucket)
S3 repository bucket.
S3 bucket used to store the repository.
pgBackRest repositories can be stored in the bucket root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other AWS generated content can also be stored in the bucket.

    example: --repo1-s3-bucket=pg-backup

15.4.11
S3 SSL CA File Option (--repo-s3-ca-file)
S3 SSL CA File.
Use a CA file other than the system default.

    example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt

15.4.12
S3 SSL CA Path Option (--repo-s3-ca-path)
S3 SSL CA Path.
Use a CA path other than the system default.

    example: --repo1-s3-ca-path=/etc/pki/tls/certs

15.4.13
S3 Repository Endpoint Option (--repo-s3-endpoint)
S3 repository endpoint.
The AWS end point should be valid for the selected region.

    example: --repo1-s3-endpoint=s3.amazonaws.com

15.4.14
S3 Repository Host Option (--repo-s3-host)
S3 repository host.
Connect to a host other than the end point. This is typically used for testing.

    example: --repo1-s3-host=127.0.0.1

15.4.15
S3 Repository Port Option (--repo-s3-port)
S3 repository port.
Port to use when connecting to the endpoint (or host if specified).

    default: 443
    allowed: 1-65535
    example: --repo1-s3-port=9000

15.4.16
S3 Repository Region Option (--repo-s3-region)
S3 repository region.
The AWS region where the bucket was created.

    example: --repo1-s3-region=us-east-1

15.4.17
S3 Repository URI Style Option (--repo-s3-uri-style)
S3 URI Style.
The following URI styles are supported:

- host - Connect to bucket.endpoint host.
- path - Connect to endpoint host and prepend bucket to URIs.

    default: host
    example: --repo1-s3-uri-style=path

15.4.18
S3 Repository Verify TLS Option (--repo-s3-verify-tls)
Verify S3 server certificate.
Disables verification of the S3 server certificate. This should only be used for testing or other scenarios where a certificate has been self-signed.

    default: y
    example: --no-repo1-s3-verify-tls

Deprecated Name: repo-s3-verify-ssl
15.4.19
Repository Type Option (--repo-type)
Type of storage used for the repository.
The following repository types are supported:

- cifs - Like posix, but disables links and directory fsyncs
- posix - Posix-compliant file systems
- s3 - AWS Simple Storage Service

    default: posix
    example: --repo1-type=cifs

15.5
Stanza Options
15.5.1
PostgreSQL Host Option (--pg-host)
PostgreSQL host for operating remotely via SSH.
Used for backups where the PostgreSQL host is different from the repository host.

    example: --pg1-host=db.domain.com

Deprecated Name: db-host
15.5.2
PostgreSQL Host Command Option (--pg-host-cmd)
pgBackRest exe path on the PostgreSQL host.
Required only if the path to pgbackrest is different on the local and PostgreSQL hosts. If not defined, the database host exe path will be set the same as the local exe path.

    example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Deprecated Name: db-cmd
15.5.3
PostgreSQL Host Configuration Option (--pg-host-config)
pgBackRest database host configuration file.
Sets the location of the configuration file on the PostgreSQL host. This is only required if the PostgreSQL host configuration file is in a different location than the local configuration file.

    default: /etc/pgbackrest/pgbackrest.conf
    example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config
15.5.4
PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)
pgBackRest database host configuration include path.
Sets the location of the configuration include path on the PostgreSQL host. This is only required if the PostgreSQL host configuration include path is in a different location than the local configuration include path.

    default: /etc/pgbackrest/conf.d
    example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

15.5.5
PostgreSQL Host Configuration Path Option (--pg-host-config-path)
pgBackRest database host configuration path.
Sets the location of the configuration path on the PostgreSQL host. This is only required if the PostgreSQL host configuration path is in a different location than the local configuration path.

    default: /etc/pgbackrest
    example: --pg1-host-config-path=/conf/pgbackrest

15.5.6
PostgreSQL Host Port Option (--pg-host-port)
PostgreSQL host port when pg-host is set.
Use this option to specify a non-default port for the PostgreSQL host protocol. Currently only SSH is supported

    allowed: 0-65535
    example: --pg1-host-port=25

Deprecated Name: db-ssh-port
15.5.7
PostgreSQL Host User Option (--pg-host-user)
PostgreSQL host logon user when pg-host is set.
This user will also own the remote pgBackRest process and will initiate connections to PostgreSQL. For this to work correctly the user should be the PostgreSQL database cluster owner which is generally postgres, the default.

    default: postgres
    example: --pg1-host-user=db_owner

Deprecated Name: db-user
16
Version Command (version)
Displays installed pgBackRest version.