pgBackRest Command Reference

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 be 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 --pg1-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 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.

See Configuration Introduction for information on option types

Archive Get Command (archive-get)

This command is used by PostgreSQL to restore a backup, perform PITR, or as an alternative to streaming for keeping a replica up to date. WAL segments are required for PostgreSQL recovery or to maintain a replica.

When multiple repositories are configured, WAL will be fetched from the repositories in priority order (e.g. repo1, repo2, etc.). In general it is better if faster/cheaper storage has higher priority. If a repository is specified with the --repo option then only that repository will be searched.

The archive-get command is configured and generated by pgBackRest during a restore for use by PostgreSQL. See Point-in-Time Recovery for an example.

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.

default: 128MiB
allowed: 0-4PiB
example: --archive-get-queue-max=1GiB

2.1.3

Retry Missing WAL Segment Option (--archive-missing-retry)

Retry missing WAL segment

Retry a WAL segment that was previously reported as missing by the archive-get command when in asynchronous mode. This prevents notifications in the spool path from a prior restore from being used and possibly causing a recovery failure if consistency has not been reached.

Disabling this option allows PostgreSQL to more reliably recognize when the end of the WAL in the archive has been reached, which permits it to switch over to streaming from the primary. With retries enabled, a steady stream of WAL being archived will cause PostgreSQL to continue getting WAL from the archive rather than switch to streaming.

When disabling this option it is important to ensure that the spool path for the stanza is empty. The restore command does this automatically if the spool path is configured at restore time. Otherwise, it is up to the user to ensure the spool path is empty.

default: y
example: --no-archive-missing-retry

2.1.4

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 I/O operations.

Buffer size used for copy, compress, encrypt, and other operations. The number of buffers used depends on options and each operation may use additional memory, e.g. gz compression may use an additional 256KiB of memory.

Allowed values are 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB, and 16MiB.

default: 1MiB
example: --buffer-size=2MiB

2.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

pgBackRest may generate a command string, e.g. when the restore command generates the restore_command setting. The command used to run the pgBackRest process will be used in this case unless the cmd option is provided.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

2.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

2.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

Sets the network compression level when compress-type=none and the command is not run on the same host as the repository. Compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress-type does not equal none 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.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

2.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

2.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: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

2.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 start-fast=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.9

I/O Timeout Option (--io-timeout)

I/O timeout.

Timeout, in seconds, used for connections and read/write operations.

Note that the entire read/write operation does not need to complete within this timeout but some progress must be made, even if it is only a single byte.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

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

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

2.2.15

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-get command 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.16

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.2.17

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

2.2.18

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

Specifies the amount of time (in seconds) with no network activity after which the operating system should send a TCP keep-alive message.

This option is available on systems that support the TCP_KEEPIDLE socket option.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

2.2.19

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

Specifies the amount of time (in seconds) after which a TCP keep-alive message that has not been acknowledged should be retransmitted.

This option is available on systems that support the TCP_KEEPINTVL socket option.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

2.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

Azure container used to store the repository.

pgBackRest repositories can be stored in the container root by setting repo-path=/ but it is usually best to specify a prefix, such as /repo, so logs and other Azure-generated content can also be stored in the container.

example: --repo1-azure-container=pg-backup

2.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

2.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

2.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

GCS 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 GCS-generated content can also be stored in the bucket.

example: --repo1-gcs-bucket=/pg-backup

2.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

2.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

2.4.9

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.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

2.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

2.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

2.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

2.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

2.4.15

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

2.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

2.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

2.4.18

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.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

2.4.20

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.21

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.22

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.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

The AWS endpoint should be valid for the selected region.

For custom/test configurations the repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port, and repo-storage-verify-tls options may be useful.

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

2.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

2.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

2.4.26

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.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

2.4.28

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.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

2.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

2.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

2.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

2.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

This option provides the ability to enable/disable verification of the storage (e.g. S3, Azure) server TLS certificate. Disabling should only be used for testing or other scenarios where a certificate has been self-signed.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

2.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

Archive Push Command (archive-push)

Accepts a WAL segment from PostgreSQL and archives it in each repository defined by the indexed repo-path option (see the Repository section for information on configuring repositories). The WAL segment may be pushed immediately to the archive or stored locally depending on the value of archive-async. With multiple repositories configured, archive-push will attempt to push to as many repositories as possible.

The archive-push is intended to be configured and called by PostgreSQL. See Configure Archiving for an example.

3.1

Command Options

3.1.1

Asynchronous Archiving Option (--archive-async)

Push/get WAL segments asynchronously.

default: n
example: --archive-async

3.1.2

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

3.1.3

Check WAL Headers Option (--archive-header-check)

Check PostgreSQL version/id in WAL headers.

Enabled by default, this option checks the WAL header against the PostgreSQL version and system identifier to ensure that the WAL is being copied to the correct stanza. This is in addition to checking pg_control against the stanza and verifying that WAL is being copied from the same PostgreSQL data directory where pg_control is located.

Therefore, disabling this check is fairly safe but should only be done when needed, e.g. if the WAL is encrypted.

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

3.1.4

Check Archive Mode Option (--archive-mode-check)

Check the PostgreSQL archive_mode setting.

Enabled by default, this option disallows PostgreSQL archive_mode=always.

WAL segments pushed from a standby server might be logically the same as WAL segments pushed from the primary but have different checksums. Disabling archiving from multiple sources is recommended to avoid conflicts.

CAUTION:

If this option is disabled then it is critical to ensure that only one archiver is writing to the repository via the archive-push command.

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

3.1.5

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:

pgBackRest will notify PostgreSQL that the WAL was successfully archived, then DROP IT.
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.

allowed: 0-4PiB
example: --archive-push-queue-max=1TiB

Deprecated Name: archive-queue-max

3.1.6

Archive Timeout Option (--archive-timeout)

Archive timeout.

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 I/O operations.

default: 1MiB
example: --buffer-size=2MiB

3.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

3.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

3.2.4

Compress Option (--compress)

Use file compression.

Backup files are compatible with command-line compression tools.

This option is now deprecated. The compress-type option should be used instead.

default: y
example: --no-compress

3.2.5

Compress Level Option (--compress-level)

File compression level.

Sets the level to be used for file compression when compress-type does not equal none or compress=y (deprecated).

The following are the defaults levels based on compress-type when compress-level is not specified:

bz2 - 9
gz - 6
lz4 - 1
zst - 3

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

3.2.6

Network Compress Level Option (--compress-level-network)

Network compression level.

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

3.2.7

Compress Type Option (--compress-type)

File compression type.

The following compression types are supported:

none - no compression
bz2 - bzip2 compression format
gz - gzip compression format
lz4 - lz4 compression format (not available on all platforms)
zst - Zstandard compression format (not available on all platforms)

default: gz
example: --compress-type=none

3.2.8

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

3.2.9

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

3.2.10

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

3.2.11

Database Timeout Option (--db-timeout)

Database query timeout.

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.12

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

3.2.13

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.14

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

3.2.15

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.16

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.17

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

3.2.18

Spool Path Option (--spool-path)

Path where transient data is stored.

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

3.2.19

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

3.2.20

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

3.2.21

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

3.2.22

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

3.4.2

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

3.4.3

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

3.4.4

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.5

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

3.4.6

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

3.4.7

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

3.4.8

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

3.4.9

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

3.4.10

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

3.4.11

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

3.4.12

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

3.4.13

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

3.4.14

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

3.4.15

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

3.4.16

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

3.4.17

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.18

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

3.4.19

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

3.4.20

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

3.4.21

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

3.4.22

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

3.4.23

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

3.4.24

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

3.4.25

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.26

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

3.4.27

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.28

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

3.4.29

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

3.4.30

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

3.4.31

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

3.4.32

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

3.4.33

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

3.5

Stanza Options

3.5.1

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

Backup Command (backup)

When multiple repositories are configured, pgBackRest will backup to the highest priority repository (e.g. repo1) unless the --repo option is specified.

pgBackRest does not have a built-in scheduler so it's best to run it from cron or some other scheduling mechanism.

See Perform a Backup for more details and examples.

4.1

Command Options

4.1.1

Check Archive Option (--archive-check)

Check that WAL segments are in the archive before backup completes.

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.

It is best if the archive-push and backup commands have the same compress-type (e.g. lz4) when using this option. Otherwise, the WAL segments will need to be recompressed with the compress-type used by the backup, which can be fairly expensive depending on how much WAL was generated during the backup.

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

Check Archive Mode Option (--archive-mode-check)

Check the PostgreSQL archive_mode setting.

CAUTION:

If this option is disabled then it is critical to ensure that only one archiver is writing to the repository via the archive-push command.

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

4.1.4

Archive Timeout Option (--archive-timeout)

Archive timeout.

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

4.1.5

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.6

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.7

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.8

Expire Auto Option (--expire-auto)

Automatically run the expire command after a successful backup.

The setting is enabled by default. Use caution when disabling this option as doing so will result in retaining all backups and archives indefinitely, which could cause your repository to run out of space. The expire command will need to be run regularly to prevent this from happening.

default: y
example: --expire-auto

4.1.9

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.10

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.

default: 1GiB
allowed: 1-1TiB
example: --manifest-save-threshold=8GiB

4.1.11

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.12

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.13

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.

default: n
example: --start-fast

4.1.14

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.15

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 I/O operations.

default: 1MiB
example: --buffer-size=2MiB

4.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

4.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

4.2.4

Compress Option (--compress)

Use file compression.

Backup files are compatible with command-line compression tools.

This option is now deprecated. The compress-type option should be used instead.

default: y
example: --no-compress

4.2.5

Compress Level Option (--compress-level)

File compression level.

bz2 - 9
gz - 6
lz4 - 1
zst - 3

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

4.2.6

Network Compress Level Option (--compress-level-network)

Network compression level.

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

4.2.7

Compress Type Option (--compress-type)

File compression type.

The following compression types are supported:

none - no compression
bz2 - bzip2 compression format
gz - gzip compression format
lz4 - lz4 compression format (not available on all platforms)
zst - Zstandard compression format (not available on all platforms)

default: gz
example: --compress-type=none

4.2.8

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

4.2.9

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

4.2.10

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

4.2.11

Database Timeout Option (--db-timeout)

Database query timeout.

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.12

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.13

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

4.2.14

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.15

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

4.2.16

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.17

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.18

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

4.2.19

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

4.2.20

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

4.2.21

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

4.2.22

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

4.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

4.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

4.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

4.4.5

Repository Bundles Option (--repo-bundle)

Bundle files in repository.

Bundle (combine) smaller files to reduce the total number of files written to the repository. Writing fewer files is generally more efficient, especially on object stores such as S3. In addition, zero-length files are not stored (except in the manifest), which saves time and space.

default: n
example: --repo1-bundle

4.4.6

Repository Bundle Limit Option (--repo-bundle-limit)

Limit for file bundles.

Size limit for files that will be included in bundles. Files larger than this size will be stored separately.

Bundled files cannot be reused when a backup is resumed, so this option controls the files that can be resumed, i.e. higher values result in fewer resumable files.

default: 2MiB
allowed: 8KiB-1PiB
example: --repo1-bundle-limit=10MiB

4.4.7

Repository Bundle Size Option (--repo-bundle-size)

Target size for file bundles.

Defines the total size of files that will be added to a single bundle. Most bundles will be smaller than this size but it is possible that some will be slightly larger, so do not set this option to the maximum size that your file system allows.

In general, it is not a good idea to set this option too high because retries will need to redo the entire bundle.

default: 20MiB
allowed: 1MiB-1PiB
example: --repo1-bundle-size=10MiB

4.4.8

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.9

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

4.4.10

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

4.4.11

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

4.4.12

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.13

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

4.4.14

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 and repo-retention-full-type is count (default), 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. If repo-retention-full-type is time, then this value will default to removing archives that are earlier than the oldest full backup retained after satisfying the repo-retention-full setting.

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.15

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.16

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.17

Full Retention Option (--repo-retention-full)

Full backup retention count/time.

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.18

Full Retention Type Option (--repo-retention-full-type)

Retention type for full backups.

Determines whether the repo-retention-full setting represents a time period (days) or count of full backups to keep. If set to time then full backups older than repo-retention-full will be removed from the repository if there is at least one backup that is equal to or greater than the repo-retention-full setting. For example, if repo-retention-full is 30 (days) and there are 2 full backups: one 25 days old and one 35 days old, no full backups will be expired because expiring the 35 day old backup would leave only the 25 day old backup, which would violate the 30 day retention policy of having at least one backup 30 days old before an older one can be expired. Archived WAL older than the oldest full backup remaining will be automatically expired unless repo-retention-archive-type and repo-retention-archive are explicitly set.

default: count
example: --repo1-retention-full-type=time

4.4.19

Backup History Retention Option (--repo-retention-history)

Days of backup history manifests to retain.

A copy of the backup manifest is stored in the backup.history path when a backup completes. By default these files are never expired since they are useful for data mining, e.g. measuring backup and WAL growth over time.

Set repo-retention-history to define the number of days of backup history manifests to retain. Unexpired backups are always kept in the backup history. Specify repo-retention-history=0 to retain the backup history only for unexpired backups.

When a full backup history manifest is expired, all differential and incremental backup history manifests associated with the full backup also expire.

allowed: 0-9999999
example: --repo1-retention-history=365

4.4.20

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

4.4.21

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

4.4.22

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

4.4.23

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

4.4.24

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.25

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

4.4.26

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.27

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

4.4.28

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

4.4.29

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

4.4.30

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

4.4.31

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

4.4.32

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

4.5

Stanza Options

4.5.1

PostgreSQL Database Option (--pg-database)

PostgreSQL database.

The database name used when connecting to PostgreSQL. The default is usually best but some installations may not contain this database.

Note that for legacy reasons the setting of the PGDATABASE environment variable will be ignored.

default: postgres
example: --pg1-database=backupdb

4.5.2

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.3

PostgreSQL Host Certificate Authority File Option (--pg-host-ca-file)

PostgreSQL host certificate authority file.

Use a CA file other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

4.5.4

PostgreSQL Host Certificate Authority Path Option (--pg-host-ca-path)

PostgreSQL host certificate authority path.

Use a CA path other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-path=/etc/pki/tls/certs

4.5.5

PostgreSQL Host Certificate File Option (--pg-host-cert-file)

PostgreSQL host certificate file.

Sent to PostgreSQL host to prove client identity.

example: --pg1-host-cert-file=/path/to/client.crt

4.5.6

PostgreSQL Host Command Option (--pg-host-cmd)

PostgreSQL host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and PostgreSQL hosts. If not defined, the PostgreSQL host command will be set the same as the local command.

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

Deprecated Name: db-cmd

4.5.7

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config

4.5.8

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

4.5.9

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: CFGOPTDEF_CONFIG_PATH
example: --pg1-host-config-path=/conf/pgbackrest

4.5.10

PostgreSQL Host Key File Option (--pg-host-key-file)

PostgreSQL host key file.

Proves client certificate was sent by owner.

example: --pg1-host-key-file=/path/to/client.key

4.5.11

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.12

PostgreSQL Host Protocol Type Option (--pg-host-type)

PostgreSQL host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --pg1-host-type=tls

4.5.13

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.14

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

4.5.15

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.16

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.

example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path

4.5.17

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

Check Command (check)

The check command validates that pgBackRest and the archive_command setting are configured correctly for archiving and backups for the specified stanza. It will attempt to check all repositories and databases that are configured for the host on which the command is run. 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 PostgreSQL or 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.

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

5.1.2

Check Archive Mode Option (--archive-mode-check)

Check the PostgreSQL archive_mode setting.

CAUTION:

If this option is disabled then it is critical to ensure that only one archiver is writing to the repository via the archive-push command.

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

5.1.3

Archive Timeout Option (--archive-timeout)

Archive timeout.

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

5.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

5.2

General Options

5.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

5.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

5.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

5.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

5.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

5.2.8

Database Timeout Option (--db-timeout)

Database query timeout.

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

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

5.2.10

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

5.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

5.2.12

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

5.2.13

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

5.2.14

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

5.2.15

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

5.2.16

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

5.4.2

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

5.4.3

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

5.4.4

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.5

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

5.4.6

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

5.4.7

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

5.4.8

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

5.4.9

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

5.4.10

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

5.4.11

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

5.4.12

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

5.4.13

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

5.4.14

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

5.4.15

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

5.4.16

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

5.4.17

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.18

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

5.4.19

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

5.4.20

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

5.4.21

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

5.4.22

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

5.4.23

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

5.4.24

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

5.4.25

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.26

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

5.4.27

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.28

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

5.4.29

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

5.4.30

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

5.4.31

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

5.4.32

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

5.4.33

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

5.5

Stanza Options

5.5.1

PostgreSQL Database Option (--pg-database)

PostgreSQL database.

default: postgres
example: --pg1-database=backupdb

5.5.2

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.3

PostgreSQL Host Certificate Authority File Option (--pg-host-ca-file)

PostgreSQL host certificate authority file.

Use a CA file other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

5.5.4

PostgreSQL Host Certificate Authority Path Option (--pg-host-ca-path)

PostgreSQL host certificate authority path.

Use a CA path other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-path=/etc/pki/tls/certs

5.5.5

PostgreSQL Host Certificate File Option (--pg-host-cert-file)

PostgreSQL host certificate file.

Sent to PostgreSQL host to prove client identity.

example: --pg1-host-cert-file=/path/to/client.crt

5.5.6

PostgreSQL Host Command Option (--pg-host-cmd)

PostgreSQL host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and PostgreSQL hosts. If not defined, the PostgreSQL host command will be set the same as the local command.

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

Deprecated Name: db-cmd

5.5.7

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config

5.5.8

PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)

pgBackRest database host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

5.5.9

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: CFGOPTDEF_CONFIG_PATH
example: --pg1-host-config-path=/conf/pgbackrest

5.5.10

PostgreSQL Host Key File Option (--pg-host-key-file)

PostgreSQL host key file.

Proves client certificate was sent by owner.

example: --pg1-host-key-file=/path/to/client.key

5.5.11

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.12

PostgreSQL Host Protocol Type Option (--pg-host-type)

PostgreSQL host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --pg1-host-type=tls

5.5.13

PostgreSQL Host User Option (--pg-host-user)

PostgreSQL host logon user when pg-host is set.

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

Deprecated Name: db-user

5.5.14

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

5.5.15

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.16

PostgreSQL Socket Path Option (--pg-socket-path)

PostgreSQL unix socket path.

example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path

5.5.17

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

Expire Command (expire)

pgBackRest does full backup rotation based on the retention type which can be a count or a time period. When a count is specified, then expiration is not concerned with when the backups were created but with how many must be retained. Differential and Incremental backups are count-based but will always be expired when the backup they depend on is expired. See sections Full Backup Retention and Differential Backup Retention for details and examples. Archived WAL is retained by default for backups that have not expired, however, although not recommended, this schedule can be modified per repository with the retention-archive options. See section Archive Retention for details and examples.

The expire command is run automatically after each successful backup and can also be run by the user. When run by the user, expiration will occur as defined by the retention settings for each configured repository. If the --repo option is provided, expiration will occur only on the specified repository. Expiration can also be limited by the user to a specific backup set with the --set option and, unless the --repo option is specified, all repositories will be searched and any matching the set criteria will be expired. It should be noted that the archive retention schedule will be checked and performed any time the expire command is run.

6.1

Command Options

6.1.1

Set Option (--set)

Backup set to expire.

The specified backup set (i.e. the backup label provided and all of its dependent backups, if any) will be expired regardless of backup retention rules except that at least one full backup must remain in the repository.

WARNING:

Use this option with extreme caution — it will permanently remove all backups and archives not required to make a backup consistent from the pgBackRest repository for the specified backup set. This process may negate the ability to perform PITR. If --repo-retention-full and/or --repo-retention-archive options are configured, then it is recommended that you override these options by setting their values to the maximum while performing adhoc expiration in order to prevent an unintended expiration of archives.

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

6.2

General Options

6.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

6.2.2

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

6.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

6.2.4

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

6.2.5

Dry Run Option (--dry-run)

Execute a dry-run for the command.

The --dry-run option is a command-line only option and can be passed when it is desirable to determine what modifications will be made by the command without the command actually making any modifications.

default: n
example: --dry-run

6.2.6

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

6.2.7

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.2.8

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

6.2.9

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

6.2.10

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

6.2.11

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

6.2.12

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

6.2.13

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

6.3

Log Options

6.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

6.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

6.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

6.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

6.3.5

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.4

Repository Options

6.4.1

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

6.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

6.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

6.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

6.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.4.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

6.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

6.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

6.4.9

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

6.4.10

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.

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

Deprecated Name: retention-archive

6.4.11

Archive Retention Type Option (--repo-retention-archive-type)

Backup type for WAL retention.

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

Deprecated Name: retention-archive-type

6.4.12

Differential Retention Option (--repo-retention-diff)

Number of differential backups to retain.

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

Deprecated Name: retention-diff

6.4.13

Full Retention Option (--repo-retention-full)

Full backup retention count/time.

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

Deprecated Name: retention-full

6.4.14

Full Retention Type Option (--repo-retention-full-type)

Retention type for full backups.

default: count
example: --repo1-retention-full-type=time

6.4.15

Backup History Retention Option (--repo-retention-history)

Days of backup history manifests to retain.

allowed: 0-9999999
example: --repo1-retention-history=365

6.4.16

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

6.4.17

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

6.4.18

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

6.4.19

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

6.4.20

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.4.21

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

6.4.22

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.4.23

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

6.4.24

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

6.4.25

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

6.4.26

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

6.4.27

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

6.4.28

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

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 (e.g. pgbackrest help backup) 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 (e.g. pgbackrest help backup type) then a full description of the option as it applies to the command will be displayed.

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.

Each stanza has a separate section and it is possible to limit output to a single stanza with the --stanza option. The stanza 'status' gives a brief indication of the stanza's health. If this is 'ok' then pgBackRest is functioning normally. If there are multiple repositories, then a status of 'mixed' indicates that the stanza is not in a healthy state on one or more of the repositories; in this case the state of the stanza will be detailed per repository. For cases in which an error on a repository occurred that is not one of the known error codes, then an error code of 'other' will be used and the full error details will be provided. The 'wal archive min/max' shows the minimum and maximum WAL currently stored in the archive and, in the case of multiple repositories, will be reported across all repositories unless the --repo option is set. Note that there may be gaps due to archive retention policies or other reasons.

The 'backup/expire running' message will appear beside the 'status' information if one of those commands is currently running on the host.

The backups are displayed oldest to newest. The oldest backup will always be a full backup (indicated by an F at the end of the label) but the newest backup can be full, differential (ends with D), or incremental (ends with I).

The 'timestamp start/stop' defines the time period when the backup ran. The 'timestamp stop' can be used to determine the backup to use when performing Point-In-Time Recovery. More information about Point-In-Time Recovery can be found in the Point-In-Time Recovery section.

The 'wal start/stop' defines the WAL range that is required to make the database consistent when restoring. The backup command will ensure that this WAL range is in the archive before completing.

The 'database size' is the full uncompressed size of the database while 'database backup size' is the amount of data in the database to actually back up (these will be the same for full backups).

The 'repo' indicates in which repository this backup resides. The 'backup set size' includes all the files from this backup and any referenced backups in the repository that are required to restore the database from this backup while 'backup size' includes only the files in this backup (these will also be the same for full backups). Repository sizes reflect compressed file sizes if compression is enabled in pgBackRest.

The 'backup reference list' contains the additional backups that are required to restore this backup.

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.1.3

Type Option (--type)

Filter on backup type.

Filter the output using one of the following backup types: full, incr, diff.

example: --type=full

8.2

General Options

8.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

8.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

8.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

8.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

8.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

8.2.8

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

8.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

8.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

8.2.11

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

8.2.12

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

8.2.13

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

8.2.14

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

8.2.15

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

8.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

8.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

8.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

8.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

8.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

8.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

8.4.9

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

8.4.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

8.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

8.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

8.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

8.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

8.4.15

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

8.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

8.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

8.4.18

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.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

8.4.20

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

8.4.21

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

8.4.22

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

8.4.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

8.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

8.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

8.4.26

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.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

8.4.28

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.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

8.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

8.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

8.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

8.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

8.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

Repository Get Command (repo-get)

Similar to the unix cat command but works on any supported repository type. This command requires a fully qualified file name and is primarily for administration, investigation, and testing. It is not a required part of a normal pgBackRest setup.

If the repository is encrypted then repo-get will automatically decrypt the file. Files are not automatically decompressed but the output can be piped through the appropriate decompression command, e.g. gzip -d.

If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the --repo option is specified.

9.1

Command Options

9.1.1

Ignore Missing Option (--ignore-missing)

Ignore missing source file.

Exit with 1 if the source file is missing but don't throw an error.

default: n
example: --ignore-missing

9.2

General Options

9.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

9.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

9.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

9.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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

9.2.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

9.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

9.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

9.2.8

Database Timeout Option (--db-timeout)

Database query timeout.

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.9

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

9.2.10

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

9.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

9.2.12

Raw Data Option (--raw)

Do not transform data.

Do not transform (i.e, encrypt, decompress, etc.) data for the current command.

default: n
example: --raw

9.2.13

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

9.2.14

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

9.2.15

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

9.2.16

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

9.2.17

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

9.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

9.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

9.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

9.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

9.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

9.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

9.4.9

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

9.4.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

9.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

9.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

9.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

9.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

9.4.15

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

9.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

9.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

9.4.18

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.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

9.4.20

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

9.4.21

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

9.4.22

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

9.4.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

9.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

9.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

9.4.26

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.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

9.4.28

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.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

9.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

9.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

9.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

9.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

9.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

Repository List Command (repo-ls)

Similar to the unix ls command but works on any supported repository type. This command accepts a path, absolute or relative to the repository path defined by the --repo-path option, and is primarily for administration, investigation, and testing. It is not a required part of a normal pgBackRest setup.

The default text output prints one file name per line. JSON output is available by specifying --output=json.

If more than one repository is configured, the command will default to the highest priority repository (e.g. repo1) unless the --repo option is specified.

10.1

Command Options

10.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)$"

10.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.

In JSON format the available fields are:

name - file/link/path name (and partial path when recursing).
type - file, path, or link.
size - size in bytes (files only).
time - time last modified (files only).
destination - link destination (links only).

default: text
example: --output=json

10.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

10.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

10.2

General Options

10.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

10.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

10.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

10.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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

10.2.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

10.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

10.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

10.2.8

Database Timeout Option (--db-timeout)

Database query timeout.

NOTE:

The db-timeout option must be less than the protocol-timeout option.

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

10.2.9

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

10.2.10

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

10.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

10.2.12

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

10.2.13

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

10.2.14

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

10.2.15

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

10.2.16

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

10.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

10.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

10.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

10.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

10.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

10.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

10.4.9

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

10.4.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

10.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

10.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

10.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

10.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

10.4.15

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

10.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

10.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

10.4.18

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.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

10.4.20

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

10.4.21

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

10.4.22

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

10.4.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

10.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

10.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

10.4.26

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.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

10.4.28

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.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

10.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

10.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

10.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

10.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

10.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

Restore Command (restore)

The restore command automatically defaults to selecting the latest backup from the first repository where backups exist (see Quick Start - Restore a Backup). The order in which the repositories are checked is dictated by the pgbackrest.conf (e.g. repo1 will be checked before repo2). To select from a specific repository, the --repo option can be passed (e.g. --repo=1). The --set option can be passed if a backup other than the latest is desired.

When PITR of --type=time or --type=lsn is specified, then the target time or target lsn must be specified with the --target option. If a backup is not specified via the --set option, then the configured repositories will be checked, in order, for a backup that contains the requested time or lsn. If no matching backup is found, the latest backup from the first repository containing backups will be used for --type=time while no backup will be selected for --type=lsn. For other types of PITR, e.g. xid, the --set option must be provided if the target is prior to the latest backup. See Point-in-Time Recovery for more details and examples.

Replication slots are not included per recommendation of PostgreSQL. See Backing Up The Data Directory in the PostgreSQL documentation for more information.

11.1

Command Options

11.1.1

Archive Mode Option (--archive-mode)

Preserve or disable archiving on restored cluster.

This option allows archiving to be preserved or disabled on a restored cluster. This is useful when the cluster must be promoted to do some work but is not intended to become the new primary. In this case it is not a good idea to push WAL from the cluster into the repository.

The following modes are supported:

off - disable archiving by setting archive_mode=off.
preserve - preserve current archive_mode setting.

NOTE: This option is not available on PostgreSQL < 12.

default: preserve
example: --archive-mode=off

11.1.2

Exclude Database Option (--db-exclude)

Restore excluding the specified databases.

Databases excluded will be restored as sparse, zeroed files to save space but still allow PostgreSQL to perform recovery. After recovery, those databases will not be accessible but can be removed with the drop database command. The --db-exclude option can be passed multiple times to specify more than one database to exclude.

When used in combination with the --db-include option, --db-exclude will only apply to standard system databases (template0, template1, and postgres).

example: --db-exclude=db_main

11.1.3

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 unless specifically excluded.

The --db-include option can be passed multiple times to specify more than one database to include.

See Restore Selected Databases for additional information and caveats.

example: --db-include=db_main

11.1.4

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

11.1.5

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

11.1.6

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

11.1.7

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

11.1.8

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

11.1.9

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

11.1.10

Map All Tablespaces Option (--tablespace-map-all)

Restore all tablespaces into the specified directory.

Tablespaces are restored into their original locations by default. This behavior can be modified for each tablespace with the tablespace-map option, but it is sometimes 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

11.1.11

Target Option (--target)

Recovery target.

Defines the recovery target when --type is lsn, name, xid, or time. If the target is prior to the latest backup and --type is not time or lsn, then use the --set option to specify the backup set.

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

11.1.12

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

11.1.13

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 lsn, 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

11.1.14

Target Timeline Option (--target-timeline)

Recover along a timeline.

See recovery_target_timeline in the PostgreSQL docs for more information.

example: --target-timeline=3

11.1.15

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.
lsn - recover to the LSN (Log Sequence Number) specified in --target. This option is only supported on PostgreSQL >= 10.
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

11.2

General Options

11.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

11.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

11.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

11.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

11.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

11.2.8

Delta Option (--delta)

Restore or backup using checksums.

default: n
example: --delta

11.2.9

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

11.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

11.2.11

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

11.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

11.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

11.2.14

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

11.2.15

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

11.2.16

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

11.2.17

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

11.2.18

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

11.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

11.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

11.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

11.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

11.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

11.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

11.4.9

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

11.4.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

11.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

11.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

11.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

11.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

11.4.15

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

11.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

11.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

11.4.18

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

11.4.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

11.4.20

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

11.4.21

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

11.4.22

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

11.4.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

11.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

11.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

11.4.26

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.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

11.4.28

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.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

11.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

11.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

11.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

11.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

11.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

11.5

Stanza Options

11.5.1

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

Server Command (server)

The pgBackRest server allows access to remote hosts without using the SSH protocol.

12.1

Command Options

12.1.1

TLS Server Address Option (--tls-server-address)

TLS server address.

IP address the server will listen on for client requests.

default: localhost
example: --tls-server-address=::*

12.1.2

TLS Server Authorized Clients Option (--tls-server-auth)

TLS server authorized clients.

Clients are authorized on the server by verifying their certificate and checking their certificate CN (Common name) against a list on the server configured with the tls-server-auth option.

A client CN can be authorized for as many stanzas as needed by repeating the tls-server-auth option, or for all stanzas by specifying tls-server-auth=client-cn=*. Wildcards may not be specified for the client CN.

example: --tls-server-auth=client-cn=stanza1

12.1.3

TLS Server Certificate Authorities Option (--tls-server-ca-file)

TLS server certificate authorities.

Checks that client certificates are signed by a trusted certificate authority.

example: --tls-server-ca-file=/path/to/server.ca

12.1.4

TLS Server Certificate Option (--tls-server-cert-file)

TLS server certificate file.

Sent to the client to show the server identity.

example: --tls-server-cert-file=/path/to/server.crt

12.1.5

TLS Server Key Option (--tls-server-key-file)

TLS server key file.

Proves server certificate was sent by the owner.

example: --tls-server-key-file=/path/to/server.key

12.1.6

TLS Server Port Option (--tls-server-port)

TLS server port.

Port the server will listen on for client requests.

default: 8432
allowed: 1-65535
example: --tls-server-port=8000

12.2

General Options

12.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

12.2.2

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

12.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

12.2.4

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

12.2.5

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

12.2.6

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.7

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

12.2.8

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

12.2.9

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

12.2.10

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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 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

Server Ping Command (server-ping)

Ping a pgBackRest TLS server to ensure it is accepting connections. This serves as an aliveness check only since no authentication is attempted.

If no host is specified on the command-line then the tls-server-host option will be used.

13.1

Command Options

13.1.1

TLS Server Address Option (--tls-server-address)

TLS server address.

IP address the server will listen on for client requests.

default: localhost
example: --tls-server-address=::*

13.1.2

TLS Server Port Option (--tls-server-port)

TLS server port.

Port the server will listen on for client requests.

default: 8432
allowed: 1-65535
example: --tls-server-port=8000

13.2

General Options

13.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

13.2.2

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

13.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

13.2.4

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

13.2.5

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

13.2.6

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

13.2.7

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

13.2.8

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

13.2.9

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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 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

Stanza Create Command (stanza-create)

The stanza-create command must be run after the stanza has been configured in pgbackrest.conf. If there is more than one repository configured, the stanza will be created on each. See Create the Stanza for more information and an example.

14.1

Command Options

14.1.1

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

14.2

General Options

14.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

14.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

14.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

14.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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

14.2.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

14.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

14.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

14.2.8

Database Timeout Option (--db-timeout)

Database query timeout.

NOTE:

The db-timeout option must be less than the protocol-timeout option.

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

14.2.9

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

14.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

14.2.11

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

14.2.12

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

14.2.13

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

14.2.14

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

14.2.15

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

14.2.16

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

14.2.17

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

14.3

Log Options

14.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

14.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

14.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

14.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

14.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

14.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

14.4

Repository Options

14.4.1

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

14.4.2

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

14.4.3

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

14.4.4

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.4.5

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

14.4.6

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

14.4.7

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

14.4.8

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

14.4.9

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

14.4.10

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

14.4.11

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

14.4.12

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

14.4.13

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

14.4.14

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

14.4.15

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

14.4.16

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

14.4.17

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.4.18

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

14.4.19

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

14.4.20

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

14.4.21

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

14.4.22

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

14.4.23

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

14.4.24

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

14.4.25

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.4.26

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

14.4.27

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.4.28

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

14.4.29

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

14.4.30

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

14.4.31

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

14.4.32

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

14.4.33

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

14.5

Stanza Options

14.5.1

PostgreSQL Database Option (--pg-database)

PostgreSQL database.

default: postgres
example: --pg1-database=backupdb

14.5.2

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.5.3

PostgreSQL Host Certificate Authority File Option (--pg-host-ca-file)

PostgreSQL host certificate authority file.

Use a CA file other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

14.5.4

PostgreSQL Host Certificate Authority Path Option (--pg-host-ca-path)

PostgreSQL host certificate authority path.

Use a CA path other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-path=/etc/pki/tls/certs

14.5.5

PostgreSQL Host Certificate File Option (--pg-host-cert-file)

PostgreSQL host certificate file.

Sent to PostgreSQL host to prove client identity.

example: --pg1-host-cert-file=/path/to/client.crt

14.5.6

PostgreSQL Host Command Option (--pg-host-cmd)

PostgreSQL host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and PostgreSQL hosts. If not defined, the PostgreSQL host command will be set the same as the local command.

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

Deprecated Name: db-cmd

14.5.7

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config

14.5.8

PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)

pgBackRest database host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

14.5.9

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: CFGOPTDEF_CONFIG_PATH
example: --pg1-host-config-path=/conf/pgbackrest

14.5.10

PostgreSQL Host Key File Option (--pg-host-key-file)

PostgreSQL host key file.

Proves client certificate was sent by owner.

example: --pg1-host-key-file=/path/to/client.key

14.5.11

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.5.12

PostgreSQL Host Protocol Type Option (--pg-host-type)

PostgreSQL host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --pg1-host-type=tls

14.5.13

PostgreSQL Host User Option (--pg-host-user)

PostgreSQL host logon user when pg-host is set.

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

Deprecated Name: db-user

14.5.14

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

14.5.15

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

14.5.16

PostgreSQL Socket Path Option (--pg-socket-path)

PostgreSQL unix socket path.

example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path

14.5.17

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

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 host where the stanza-delete command will be run.
Run the stanza-delete command.

Once the command successfully completes, it is the responsibility of the user to remove the stanza from all pgBackRest configuration files and/or environment variables.

A stanza may only be deleted from one repository at a time. To delete the stanza from multiple repositories, repeat the stanza-delete command for each repository while specifying the --repo option.

15.1

Command Options

15.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

15.2

General Options

15.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

15.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

15.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

15.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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

15.2.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

15.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

15.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

15.2.8

Database Timeout Option (--db-timeout)

Database query timeout.

NOTE:

The db-timeout option must be less than the protocol-timeout option.

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

15.2.9

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

15.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

15.2.11

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

15.2.12

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

15.2.13

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

15.2.14

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

15.2.15

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

15.2.16

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

15.2.17

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

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

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

15.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

15.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

15.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

15.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

15.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

15.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

15.4.9

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

15.4.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

15.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

15.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

15.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

15.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

15.4.15

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

15.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

15.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

15.4.18

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.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

15.4.20

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

15.4.21

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

15.4.22

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

15.4.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

15.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

15.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

15.4.26

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.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

15.4.28

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.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

15.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

15.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

15.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

15.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

15.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

15.5

Stanza Options

15.5.1

PostgreSQL Database Option (--pg-database)

PostgreSQL database.

default: postgres
example: --pg1-database=backupdb

15.5.2

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.3

PostgreSQL Host Certificate Authority File Option (--pg-host-ca-file)

PostgreSQL host certificate authority file.

Use a CA file other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

15.5.4

PostgreSQL Host Certificate Authority Path Option (--pg-host-ca-path)

PostgreSQL host certificate authority path.

Use a CA path other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-path=/etc/pki/tls/certs

15.5.5

PostgreSQL Host Certificate File Option (--pg-host-cert-file)

PostgreSQL host certificate file.

Sent to PostgreSQL host to prove client identity.

example: --pg1-host-cert-file=/path/to/client.crt

15.5.6

PostgreSQL Host Command Option (--pg-host-cmd)

PostgreSQL host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and PostgreSQL hosts. If not defined, the PostgreSQL host command will be set the same as the local command.

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

Deprecated Name: db-cmd

15.5.7

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config

15.5.8

PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)

pgBackRest database host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

15.5.9

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: CFGOPTDEF_CONFIG_PATH
example: --pg1-host-config-path=/conf/pgbackrest

15.5.10

PostgreSQL Host Key File Option (--pg-host-key-file)

PostgreSQL host key file.

Proves client certificate was sent by owner.

example: --pg1-host-key-file=/path/to/client.key

15.5.11

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.12

PostgreSQL Host Protocol Type Option (--pg-host-type)

PostgreSQL host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --pg1-host-type=tls

15.5.13

PostgreSQL Host User Option (--pg-host-user)

PostgreSQL host logon user when pg-host is set.

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

Deprecated Name: db-user

15.5.14

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

15.5.15

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

15.5.16

PostgreSQL Socket Path Option (--pg-socket-path)

PostgreSQL unix socket path.

example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path

15.5.17

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

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 command run. If there is more than one repository configured on the host, the stanza will be created on each. If the database is offline use the --no-online option.

16.1

Command Options

16.1.1

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

16.2

General Options

16.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

16.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

16.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

16.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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

16.2.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

16.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

16.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

16.2.8

Database Timeout Option (--db-timeout)

Database query timeout.

NOTE:

The db-timeout option must be less than the protocol-timeout option.

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

16.2.9

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

16.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

16.2.11

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

16.2.12

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

16.2.13

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

16.2.14

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

16.2.15

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

16.2.16

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

16.2.17

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

16.3

Log Options

16.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

16.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

16.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

16.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

16.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

16.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

16.4

Repository Options

16.4.1

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

16.4.2

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

16.4.3

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

16.4.4

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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

16.4.5

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

16.4.6

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

16.4.7

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

16.4.8

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

16.4.9

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

16.4.10

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

16.4.11

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

16.4.12

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

16.4.13

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

16.4.14

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

16.4.15

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

16.4.16

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

16.4.17

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

16.4.18

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

16.4.19

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

16.4.20

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

16.4.21

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

16.4.22

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

16.4.23

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

16.4.24

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

16.4.25

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

16.4.26

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

16.4.27

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

16.4.28

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

16.4.29

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

16.4.30

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

16.4.31

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

16.4.32

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

16.4.33

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

16.5

Stanza Options

16.5.1

PostgreSQL Database Option (--pg-database)

PostgreSQL database.

default: postgres
example: --pg1-database=backupdb

16.5.2

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

16.5.3

PostgreSQL Host Certificate Authority File Option (--pg-host-ca-file)

PostgreSQL host certificate authority file.

Use a CA file other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

16.5.4

PostgreSQL Host Certificate Authority Path Option (--pg-host-ca-path)

PostgreSQL host certificate authority path.

Use a CA path other than the system default for connecting to the PostgreSQL host.

example: --pg1-host-ca-path=/etc/pki/tls/certs

16.5.5

PostgreSQL Host Certificate File Option (--pg-host-cert-file)

PostgreSQL host certificate file.

Sent to PostgreSQL host to prove client identity.

example: --pg1-host-cert-file=/path/to/client.crt

16.5.6

PostgreSQL Host Command Option (--pg-host-cmd)

PostgreSQL host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and PostgreSQL hosts. If not defined, the PostgreSQL host command will be set the same as the local command.

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

Deprecated Name: db-cmd

16.5.7

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: db-config

16.5.8

PostgreSQL Host Configuration Include Path Option (--pg-host-config-include-path)

pgBackRest database host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

16.5.9

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: CFGOPTDEF_CONFIG_PATH
example: --pg1-host-config-path=/conf/pgbackrest

16.5.10

PostgreSQL Host Key File Option (--pg-host-key-file)

PostgreSQL host key file.

Proves client certificate was sent by owner.

example: --pg1-host-key-file=/path/to/client.key

16.5.11

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

16.5.12

PostgreSQL Host Protocol Type Option (--pg-host-type)

PostgreSQL host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --pg1-host-type=tls

16.5.13

PostgreSQL Host User Option (--pg-host-user)

PostgreSQL host logon user when pg-host is set.

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

Deprecated Name: db-user

16.5.14

PostgreSQL Path Option (--pg-path)

PostgreSQL data directory.

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

Deprecated Name: db-path

16.5.15

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

16.5.16

PostgreSQL Socket Path Option (--pg-socket-path)

PostgreSQL unix socket path.

example: --pg1-socket-path=/var/run/postgresql

Deprecated Name: db-socket-path

16.5.17

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

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. See Starting and Stopping for more information and examples.

17.1

General Options

17.1.1

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

17.1.2

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

17.1.3

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

17.1.4

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

17.1.5

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

17.1.6

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

17.2

Log Options

17.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

17.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

17.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

17.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

17.2.5

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

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. See Starting and Stopping for more information and examples.

18.1

Command Options

18.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

18.2

General Options

18.2.1

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

18.2.2

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

18.2.3

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

18.2.4

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

18.2.5

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

18.2.6

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

18.3

Log Options

18.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

18.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

18.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

18.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

18.3.5

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

Verify Command (verify)

Verify determines if the backups and archives in the repository are valid.

19.1

Command Options

19.1.1

Output Option (--output)

Output type.

Output may be none (default) or text. Requesting text generates ouput to stdout.

default: none
example: --output=text

19.1.2

Verbose Option (--verbose)

Verbose output.

Verbose defaults to false, providing a minimal response with important information about errors in the repository. Specifying true provides more information about what was successfully verified.

default: n
example: --verbose

19.2

General Options

19.2.1

Buffer Size Option (--buffer-size)

Buffer size for I/O operations.

default: 1MiB
example: --buffer-size=2MiB

19.2.2

pgBackRest Command Option (--cmd)

pgBackRest command.

CAUTION:

Wrapping the pgBackRest command may cause unpredictable behavior and is not recommended.

example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

19.2.3

SSH Client Command Option (--cmd-ssh)

SSH client command.

Use a specific SSH client command when an alternate is desired or the ssh command is not in $PATH.

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

19.2.4

Network Compress Level Option (--compress-level-network)

Network compression level.

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

19.2.5

Config Option (--config)

pgBackRest configuration file.

Use this option to specify a different configuration file than the default.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

19.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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

19.2.7

Config Path Option (--config-path)

Base path of pgBackRest configuration files.

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

19.2.8

I/O Timeout Option (--io-timeout)

I/O timeout.

default: 60
allowed: 0.1-3600
example: --io-timeout=120

19.2.9

Neutral Umask Option (--neutral-umask)

Use a neutral umask.

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

19.2.10

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

19.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

19.2.12

Keep Alive Option (--sck-keep-alive)

Keep-alive enable.

Enables keep-alive messages on socket connections.

default: y
example: --no-sck-keep-alive

19.2.13

Stanza Option (--stanza)

Defines the stanza.

example: --stanza=main

19.2.14

Keep Alive Count Option (--tcp-keep-alive-count)

Keep-alive count.

Specifies the number of TCP keep-alive messages that can be lost before the connection is considered dead.

This option is available on systems that support the TCP_KEEPCNT socket option.

allowed: 1-32
example: --tcp-keep-alive-count=3

19.2.15

Keep Alive Idle Option (--tcp-keep-alive-idle)

Keep-alive idle time.

allowed: 1-3600
example: --tcp-keep-alive-idle=60

19.2.16

Keep Alive Interval Option (--tcp-keep-alive-interval)

Keep-alive interval time.

allowed: 1-900
example: --tcp-keep-alive-interval=30

19.3

Log Options

19.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

19.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

19.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

19.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

19.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

19.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

19.4

Repository Options

19.4.1

Set Repository Option (--repo)

Set repository.

Set the repository for a command to operate on.

For example, this option may be used to perform a restore from a specific repository, rather than letting pgBackRest choose.

allowed: 1-256
example: --repo=1

19.4.2

Azure Repository Container Option (--repo-azure-container)

Azure repository container.

example: --repo1-azure-container=pg-backup

19.4.3

Azure Repository Key Type Option (--repo-azure-key-type)

Azure repository key type.

The following types are supported for authorization:

shared - Shared key
sas - Shared access signature

default: shared
example: --repo1-azure-key-type=sas

19.4.4

Azure Repository URI Style Option (--repo-azure-uri-style)

Azure URI Style.

The following URI styles are supported:

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

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

19.4.5

Repository Cipher Type Option (--repo-cipher-type)

Cipher used to encrypt the repository.

The following cipher 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

19.4.6

GCS Repository Bucket Option (--repo-gcs-bucket)

GCS repository bucket.

example: --repo1-gcs-bucket=/pg-backup

19.4.7

GCS Repository Endpoint Option (--repo-gcs-endpoint)

GCS repository endpoint.

Endpoint used to connect to the storage service. May be updated to use a local GCS server or alternate endpoint.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

19.4.8

GCS Repository Key Type Option (--repo-gcs-key-type)

GCS repository key type.

The following types are supported for authorization:

auto - Authorize using the instance service account.
service - Service account from locally stored key.
token - For local testing, e.g. fakegcs.

default: service
example: --repo1-gcs-key-type=auto

19.4.9

Repository Host Option (--repo-host)

Repository host when operating remotely via SSH.

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

Deprecated Name: backup-host

19.4.10

Repository Host Certificate Authority File Option (--repo-host-ca-file)

Repository host certificate authority file.

Use a CA file other than the system default for connecting to the repository host.

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

19.4.11

Repository Host Certificate Authority Path Option (--repo-host-ca-path)

Repository host certificate authority path.

Use a CA path other than the system default for connecting to the repository host.

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

19.4.12

Repository Host Certificate File Option (--repo-host-cert-file)

Repository host certificate file.

Sent to repository host to prove client identity.

example: --repo1-host-cert-file=/path/to/client.crt

19.4.13

Repository Host Command Option (--repo-host-cmd)

Repository host pgBackRest command.

Required only if the path to the pgBackRest command is different on the local and repository hosts. If not defined, the repository host command will be set the same as the local command.

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

Deprecated Name: backup-cmd

19.4.14

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: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Deprecated Name: backup-config

19.4.15

Repository Host Configuration Include Path Option (--repo-host-config-include-path)

pgBackRest repository host configuration include path.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

19.4.16

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: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

19.4.17

Repository Host Key File Option (--repo-host-key-file)

Repository host key file.

Proves client certificate was sent by owner.

example: --repo1-host-key-file=/path/to/client.key

19.4.18

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

19.4.19

Repository Host Protocol Type Option (--repo-host-type)

Repository host protocol type.

The following protocol types are supported:

ssh - Secure Shell.
tls - pgBackRest TLS server.

default: ssh
example: --repo1-host-type=tls

19.4.20

Repository Host User Option (--repo-host-user)

Repository host user when repo-host is set.

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

Deprecated Name: backup-user

19.4.21

Repository Path Option (--repo-path)

Path where backups and archive are stored.

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

19.4.22

S3 Repository Bucket Option (--repo-s3-bucket)

S3 repository bucket.

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

19.4.23

S3 Repository Endpoint Option (--repo-s3-endpoint)

S3 repository endpoint.

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

19.4.24

S3 Repository Key Type Option (--repo-s3-key-type)

S3 repository key type.

The following types are supported:

shared - Shared keys
auto - Automatically retrieve temporary credentials
web-id - Automatically retrieve web identity credentials

default: shared
example: --repo1-s3-key-type=auto

19.4.25

S3 Repository KMS Key ID Option (--repo-s3-kms-key-id)

S3 repository KMS key.

Setting this option enables S3 server-side encryption using the specified AWS key management service key.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

19.4.26

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

19.4.27

S3 Repository Role Option (--repo-s3-role)

S3 repository role.

The AWS role name (not the full ARN) used to retrieve temporary credentials when repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

19.4.28

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

19.4.29

Repository Storage CA File Option (--repo-storage-ca-file)

Repository storage CA file.

Use a CA file other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-file, repo-s3-ca-file

19.4.30

Repository Storage TLS CA Path Option (--repo-storage-ca-path)

Repository storage CA path.

Use a CA path other than the system default for storage (e.g. S3, Azure) certificates.

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

Deprecated Names: repo-azure-ca-path, repo-s3-ca-path

19.4.31

Repository Storage Host Option (--repo-storage-host)

Repository storage host.

Connect to a host other than the storage (e.g. S3, Azure) endpoint. This is typically used for testing.

example: --repo1-storage-host=127.0.0.1

Deprecated Names: repo-azure-host, repo-s3-host

19.4.32

Repository Storage Port Option (--repo-storage-port)

Repository storage port.

Port to use when connecting to the storage (e.g. S3, Azure) endpoint (or host if specified).

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

Deprecated Names: repo-azure-port, repo-s3-port

19.4.33

Repository Storage Certificate Verify Option (--repo-storage-verify-tls)

Repository storage certificate verify.

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

Deprecated Names: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

19.4.34

Repository Type Option (--repo-type)

Type of storage used for the repository.

The following repository types are supported:

azure - Azure Blob Storage Service
cifs - Like posix, but disables links and directory fsyncs
gcs - Google Cloud Storage
posix - Posix-compliant file systems
s3 - AWS Simple Storage Service

When an NFS mount is used as a posix repository, the same rules apply to pgBackRest as described in the PostgreSQL documentation: Creating a Database Cluster - File Systems.

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

Version Command (version)

Displays installed pgBackRest version.