Это многостраничная версия текущего раздела для печати. .

Справочник команд

pgBackRest справочник команд со всеми параметрами для резервного копирования, восстановления, архивирования и операций управления

1: Команда справки (help)
2: Команда сервера (server)
3: Команда проверки доступности сервера (server-ping)
4: Команда версии (version)

Введение

Команды используются для выполнения различных функций pgBackRest. Здесь перечислены исчерпывающе все параметры команд, то есть каждый параметр, применимый к команде, указан вместе с этой командой, даже если он применим к одной или нескольким другим командам. Это включает все параметры, которые также могут быть настроены в pgbackrest.conf.

Опции, не являющиеся логическими, настроенные в pgbackrest.conf, могут быть сброшены на значения по умолчанию на командной строке с использованием префикса reset-. Эта функция может использоваться для восстановления резервной копии непосредственно на сервере репозитория. Обычно pgBackRest выдает ошибку, поскольку видит, что хост базы данных удалённый, и восстановление не может выполняться удалённо. Добавив --reset-pg1-host на командной строке, pgBackRest проигнорирует удалённый хост базы данных и выполнит восстановление локально. Возможно, потребуется передать новый --pg1-path, чтобы заставить восстановление произойти в определённом пути, i.e, а не в пути, использованном на хосте базы данных.

Предикат no- может использоваться для установки логического параметра в значение false из командной строки.

Любая опция может быть установлена в переменной среды с использованием префикса PGBACKREST_ и имени опции в верхнем регистре, заменяя - на _, e.g. pg1-path превращается в PGBACKREST_PG1_PATH, а stanza — в PGBACKREST_STANZA. Логические опции представляются так же, как в файле конфигурации, e.g. Варианты PGBACKREST_COMPRESS="n" и reset-* не допускаются. Опции, которые могут быть указаны несколько раз в командной строке или в файле конфигурации, могут быть представлены путём разделения значений двоеточиями, e.g. PGBACKREST_DB_INCLUDE="db1:db2".

Опции командной строки переопределяют опции среды, которые переопределяют опции файлов конфигурации.

См. Введение в конфигурацию для получения сведений о типах параметров

Команды

Команда	Краткое описание
`annotate`	Добавление, изменение или удаление аннотаций резервной копии после её создания.
`archive-get`	Получение архивированных сегментов WAL для восстановления, PITR или восстановления реплики.
`archive-push`	Принятие сегментов WAL от PostgreSQL и передача их в настроенные репозитории.
`backup`	Создание резервных копий в целевом репозитории (по умолчанию — репозиторий с наивысшим приоритетом).
`check`	Проверить конфигурацию резервной копии/stanza и архива, а также состояние архивирования WAL.
`expire`	Удалить резервные копии и архивированные WAL на основе настроенных политик хранения.
`help`	Показать справку по команде и параметрам на уровне общего, командного или параметрического.
`info`	Отобразить состояние/stanza и резервной копии/метаданные в текстовом или JSON формате.
`repo-get`	Прочитать файлы репозитория (например, `cat`) для администрирования, анализа и тестирования.
`repo-ls`	Вывести список файлов/путей репозитория (например, `ls`) для администрирования, анализа и тестирования.
`restore`	Восстановление из резервной копии (последняя по умолчанию) с необязательным восстановлением до определённого момента времени.
`server`	Запуск сервера pgBackRest TLS для удалённого доступа без SSH.
`server-ping`	Проверка доступности сервера pgBackRest TLS для подтверждения установления соединения.
`stanza-create`	Создание метаданных stanza во всех настроенных репозиториях.
`stanza-delete`	Постоянное удаление всех резервных копий и архивов для stanza.
`stanza-upgrade`	Обновление метаданных stanza после обновления основной версии PostgreSQL.
`start`	Разрешить повторный запуск процессов pgBackRest после предыдущего `stop`.
`stop`	Запретить запуск новых процессов pgBackRest и по желанию принудительно остановить работающие.
`verify`	Проверить корректность данных резервной копии и архива в репозитории.
`version`	Отобразить установленную версию pgBackRest.

1 - Команда справки (help)

Справочник по параметрам и поведению команды pgBackRest help.

Предоставляется три уровня справки. Если команда не указана, будет отображена общая справка. Если указана команда (e.g. pgbackrest help backup), будет отображено полное описание команды вместе со списком допустимых параметров. Если указать параметр вместе с командой (e.g. pgbackrest help backup type), будет отображено полное описание параметра применительно к команде.

Опции команды

Показать сведения о параметре помощи (`--help`)

Показать справку.

Отображает справку даже если команда help не указана и переопределяет опцию --version.

default: n
example: --help

Параметр отображения версии (`--version`)

Показать версию.

Отображает версию даже если не указаны команды version или help.

default: n
example: --version

2 - Команда сервера (server)

Справочник по параметрам и поведению команды pgBackRest server.

Сервер pgBackRest позволяет осуществлять доступ с удалённых хостов без использования протокола SSH.

Опции команды

TLS Параметр адреса сервера (`--tls-server-address`)

Адрес сервера TLS.

IP-адрес, на котором сервер будет слушать запросы клиентов.

default: localhost
example: --tls-server-address=*

TLS Параметр авторизованных клиентов сервера (`--tls-server-auth`)

TLS сервер авторизованных клиентов.

Клиенты авторизуются на сервере путём проверки их сертификата и проверки соответствия имени субъекта (CN) сертификата списку на сервере, настроенного с помощью опции tls-server-auth.

Клиентский CN может быть авторизован для любого количества stanza, указав список, разделённый запятыми, в опции tls-server-auth, или для всех stanza, указав tls-server-auth=client-cn=*. Для клиентского CN нельзя указывать подстановочные знаки.

example: --tls-server-auth=client-cn=stanza1,stanza2

TLS Параметр сертификатов удостоверяющих центров сервера (`--tls-server-ca-file`)

TLS сертификаты удостоверяющих центров сервера.

Проверяет, что сертификаты клиентов подписаны доверенным центром сертификации.

example: --tls-server-ca-file=/path/to/server.ca

TLS Параметр сертификата сервера (`--tls-server-cert-file`)

Файл сертификата сервера TLS.

Отправляется клиенту для отображения идентичности сервера.

example: --tls-server-cert-file=/path/to/server.crt

Ключевая опция сервера TLS (`--tls-server-key-file`)

Файл ключа сервера TLS.

Проверяет, что сертификат сервера был отправлен его владельцем.

example: --tls-server-key-file=/path/to/server.key

Параметр порта сервера TLS (`--tls-server-port`)

Порт сервера TLS.

Порт, на котором сервер будет слушать запросы клиентов.

default: 8432
allowed: [1, 65535]
example: --tls-server-port=8000

Общие параметры

Разрешить запуск от имени root (`--allow-root`)

Разрешите команде выполняться от имени пользователя root.

По умолчанию только команда restore может выполняться от пользователя root, поскольку она предназначена для тщательного управления принадлежностью файлов. Выполнение других команд от пользователя root может привести к созданию файлов (например, в репозитории), принадлежащих root, и, как следствие, недоступных для пользователя PostgreSQL, что вызовет сбой последующих команд.

Включите этот параметр, чтобы запустить команду от имени root. Однако гораздо лучше запускать pgBackRest от пользователя, владеющего репозиторием и кластером PostgreSQL.

default: n
example: --allow-root

Опция размера буфера (`--buffer-size`)

Размер буфера для операций ввода-вывода.

Размер буфера, используемый для копирования, сжатия, шифрования и других операций. Количество используемых буферов зависит от параметров, и каждая операция может использовать дополнительную память, например, сжатие gz может потребовать дополнительно 256KiB памяти.

Допустимые значения: 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB и 16MiB.

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

Параметр конфигурации (`--config`)

Конфигурационный файл pgBackRest.

Используйте этот параметр для указания другого файла конфигурации, отличного от файла по умолчанию.

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

Путь включения конфигурации (`--config-include-path`)

Путь к дополнительным файлам конфигурации pgBackRest.

Конфигурационные файлы, существующие в указанном расположении с расширением .conf, будут объединены с конфигурационным файлом pgBackRest, в результате чего будет создан один конфигурационный файл.

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

Путь к конфигурации (`--config-path`)

Базовый путь файлов конфигурации pgBackRest.

Этот параметр используется для переопределения пути по умолчанию для параметров --config и --config-include-path, если они не заданы непосредственно в командной строке.

Например, передача только --config-path=/conf/pgbackrest приводит к установке значения по умолчанию для --config в /conf/pgbackrest/pgbackrest.conf и значения по умолчанию для --config-include-path в /conf/pgbackrest/conf.d.

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

Параметр тайм-аута ввода-вывода (`--io-timeout`)

Тайм-аут ввода-вывода.

Тайм-аут, в секундах, используемый для соединений и операций чтения/записи.

Примечание: вся операция чтения/записи не должна завершаться в течение этого тайм-аута, но должна быть сделана какая-либо прогресс, даже если это всего лишь один байт.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Установка параметра приоритета процесса (`--priority`)

Установите приоритет процесса.

Определяет, какой приоритет (то есть уровень «приоритетности») будет присвоен процессу планировщиком ядра. Положительные значения уменьшают приоритет, отрицательные — увеличивают. В большинстве случаев у процессов нет разрешения повышать свой приоритет.

allowed: [-20, 19]
example: --priority=19

Опция тайм-аута протокола (`--protocol-timeout`)

Тайм-аут протокола.

Задаёт тайм-аут, в секундах, на который локальный или удалённый процесс будет ждать получения нового сообщения на уровне протокола. Это предотвращает бесконечное ожидание сообщения процессами.

NOTE: параметр protocol-timeout должен быть больше, чем параметр db-timeout.

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

Параметр Keep Alive (`--sck-keep-alive`)

Включить keep-alive.

Включает сообщения keep-alive для сетевых соединений.

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

Параметр количества Keep Alive (`--tcp-keep-alive-count`)

Количество keep-alive.

Указывает количество сообщений-keep-alive TCP, которые могут быть потеряны, прежде чем соединение будет признано неработоспособным.

Этот параметр доступен на системах, которые поддерживают опцию сокета TCP_KEEPCNT.

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

Параметр простоя Keep Alive (`--tcp-keep-alive-idle`)

Время простоя для поддержания соединения.

Указывает количество времени (в секундах) без сетевой активности, по истечении которого операционная система должна отправить сообщение-keep-alive TCP.

Этот параметр доступен на системах, которые поддерживают опцию сокета TCP_KEEPIDLE.

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

Параметр интервала Keep Alive (`--tcp-keep-alive-interval`)

Интервал времени для keep-alive.

Указывает количество времени (в секундах), по истечении которого сообщение keep-alive TCP, не подтверждённое получателем, должно быть повторно отправлено.

Этот параметр доступен на системах, которые поддерживают опцию сокета TCP_KEEPINTVL.

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

Списки шифров TLSv1.2 (параметр `--tls-cipher-12`)

Разрешённые наборы шифров TLSv1.2

Все соединения TLS между клиентом pgBackRest и сервером зашифрованы. По умолчанию также зашифрованы соединения с объектными хранилищами (например, S3).

NOTE: Минимальный уровень безопасности для любого соединения по транспортному протоколу — TLSv1.2

Доступные наборы шифров можно настроить при необходимости. Приведённый пример — разумный выбор, если у вас нет особых требований к безопасности. Если не установлено (по умолчанию), применяется значение по умолчанию библиотеки OpenSSL.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Списки шифров TLSv1.3 (параметр) (`--tls-cipher-13`)

Разрешённые наборы шифров TLSv1.3

Все соединения TLS между клиентом pgBackRest и сервером зашифрованы. По умолчанию также зашифрованы соединения с объектными хранилищами (например, S3).

NOTE: Минимальный уровень безопасности для любого соединения по транспортному протоколу — TLSv1.2

Доступные наборы шифров можно настроить при необходимости. Если не установлено (значение по умолчанию), применяется значение по умолчанию библиотеки OpenSSL.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Параметры журналирования

Опция уровня журналирования консоли (`--log-level-console`)

Уровень ведения журнала для консоли.

Поддерживаются следующие уровни журналирования:

off — ведение журнала отключено (не рекомендуется)
error — ведение журнала только ошибок
warn — ведение журнала предупреждений и ошибок
info — ведение журнала информации, предупреждений и ошибок
detail — ведение журнала деталей, информации, предупреждений и ошибок
debug — ведение журнала отладки, деталей, информации, предупреждений и ошибок
trace — ведение журнала трассировки (очень подробная отладка), отладки, информации, предупреждений и ошибок

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

Опция уровня журналирования файла (`--log-level-file`)

Уровень ведения журнала для файлов.

Поддерживаются следующие уровни журналирования:

off — ведение журнала отключено (не рекомендуется)
error — ведение журнала только ошибок
warn — ведение журнала предупреждений и ошибок
info — ведение журнала информации, предупреждений и ошибок
detail — ведение журнала деталей, информации, предупреждений и ошибок
debug — ведение журнала отладки, деталей, информации, предупреждений и ошибок
trace — ведение журнала трассировки (очень подробная отладка), отладки, информации, предупреждений и ошибок

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

Опция уровня журнала стандартных ошибок (`--log-level-stderr`)

Уровень ведения журнала для stderr.

Указывает, какие уровни журналов будут выводиться в stderr вместо stdout (указано в log-level-console). Временная метка и процесс не будут выводиться в stderr.

Поддерживаются следующие уровни журналирования:

off — ведение журнала отключено (не рекомендуется)
error — ведение журнала только ошибок
warn — ведение журнала предупреждений и ошибок
info — ведение журнала информации, предупреждений и ошибок
detail — ведение журнала деталей, информации, предупреждений и ошибок
debug — ведение журнала отладки, деталей, информации, предупреждений и ошибок
trace — ведение журнала трассировки (очень подробная отладка), отладки, информации, предупреждений и ошибок

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

Параметр пути журнала (`--log-path`)

Путь, по которому хранятся файлы журналов.

Путь к журналу задаёт местоположение для хранения файлов журналов pgBackRest. Примечание: если log-level-file=off, то путь к журналу не требуется.

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

Опция временной метки журнала (`--log-timestamp`)

Включите метку времени в ведении журнала.

Включает метку времени в журнале консоли и файлов. Этот параметр отключен в особых ситуациях, таких как генерация документации.

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

3 - Команда проверки доступности сервера (server-ping)

Справочник по параметрам и поведению команды pgBackRest server-ping.

Проверьте доступность сервера pgBackRest TLS с помощью ping, чтобы убедиться, что он принимает соединения. Это служит проверкой работоспособности, так как аутентификация не выполняется.

Если на командной строке не указан хост, будет использован параметр tls-server-host.

Опции команды

TLS Параметр адреса сервера (`--tls-server-address`)

Адрес сервера TLS.

IP-адрес, на котором сервер будет слушать запросы клиентов.

default: localhost
example: --tls-server-address=*

Параметр порта сервера TLS (`--tls-server-port`)

Порт сервера TLS.

Порт, на котором сервер будет слушать запросы клиентов.

default: 8432
allowed: [1, 65535]
example: --tls-server-port=8000

Общие параметры

Разрешить запуск от имени root (`--allow-root`)

Разрешите команде выполняться от имени пользователя root.

По умолчанию только команда restore может выполняться от пользователя root, поскольку она предназначена для тщательного управления принадлежностью файлов. Выполнение других команд от пользователя root может привести к созданию файлов (например, в репозитории), принадлежащих root, и, как следствие, недоступных для пользователя PostgreSQL, что вызовет сбой последующих команд.

Включите этот параметр, чтобы запустить команду от имени root. Однако гораздо лучше запускать pgBackRest от пользователя, владеющего репозиторием и кластером PostgreSQL.

default: n
example: --allow-root

Опция размера буфера (`--buffer-size`)

Размер буфера для операций ввода-вывода.

Размер буфера, используемый для копирования, сжатия, шифрования и других операций. Количество используемых буферов зависит от параметров, и каждая операция может использовать дополнительную память, например, сжатие gz может потребовать дополнительно 256KiB памяти.

Допустимые значения: 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB и 16MiB.

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

Параметр конфигурации (`--config`)

Конфигурационный файл pgBackRest.

Используйте этот параметр для указания другого файла конфигурации, отличного от файла по умолчанию.

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

Путь включения конфигурации (`--config-include-path`)

Путь к дополнительным файлам конфигурации pgBackRest.

Конфигурационные файлы, существующие в указанном расположении с расширением .conf, будут объединены с конфигурационным файлом pgBackRest, в результате чего будет создан один конфигурационный файл.

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

Путь к конфигурации (`--config-path`)

Базовый путь файлов конфигурации pgBackRest.

Этот параметр используется для переопределения пути по умолчанию для параметров --config и --config-include-path, если они не заданы непосредственно в командной строке.

Например, передача только --config-path=/conf/pgbackrest приводит к установке значения по умолчанию для --config в /conf/pgbackrest/pgbackrest.conf и значения по умолчанию для --config-include-path в /conf/pgbackrest/conf.d.

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

Параметр тайм-аута ввода-вывода (`--io-timeout`)

Тайм-аут ввода-вывода.

Тайм-аут, в секундах, используемый для соединений и операций чтения/записи.

Примечание: вся операция чтения/записи не должна завершаться в течение этого тайм-аута, но должна быть сделана какая-либо прогресс, даже если это всего лишь один байт.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Установка параметра приоритета процесса (`--priority`)

Установите приоритет процесса.

Определяет, какой приоритет (то есть уровень «приоритетности») будет присвоен процессу планировщиком ядра. Положительные значения уменьшают приоритет, отрицательные — увеличивают. В большинстве случаев у процессов нет разрешения повышать свой приоритет.

allowed: [-20, 19]
example: --priority=19

Параметр Keep Alive (`--sck-keep-alive`)

Включить keep-alive.

Включает сообщения keep-alive для сетевых соединений.

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

Параметр количества Keep Alive (`--tcp-keep-alive-count`)

Количество keep-alive.

Указывает количество сообщений-keep-alive TCP, которые могут быть потеряны, прежде чем соединение будет признано неработоспособным.

Этот параметр доступен на системах, которые поддерживают опцию сокета TCP_KEEPCNT.

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

Параметр простоя Keep Alive (`--tcp-keep-alive-idle`)

Время простоя для поддержания соединения.

Указывает количество времени (в секундах) без сетевой активности, по истечении которого операционная система должна отправить сообщение-keep-alive TCP.

Этот параметр доступен на системах, которые поддерживают опцию сокета TCP_KEEPIDLE.

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

Параметр интервала Keep Alive (`--tcp-keep-alive-interval`)

Интервал времени для keep-alive.

Указывает количество времени (в секундах), по истечении которого сообщение keep-alive TCP, не подтверждённое получателем, должно быть повторно отправлено.

Этот параметр доступен на системах, которые поддерживают опцию сокета TCP_KEEPINTVL.

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

Списки шифров TLSv1.2 (параметр `--tls-cipher-12`)

Разрешённые наборы шифров TLSv1.2

Все соединения TLS между клиентом pgBackRest и сервером зашифрованы. По умолчанию также зашифрованы соединения с объектными хранилищами (например, S3).

NOTE: Минимальный уровень безопасности для любого соединения по транспортному протоколу — TLSv1.2

Доступные наборы шифров можно настроить при необходимости. Приведённый пример — разумный выбор, если у вас нет особых требований к безопасности. Если не установлено (по умолчанию), применяется значение по умолчанию библиотеки OpenSSL.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Списки шифров TLSv1.3 (параметр) (`--tls-cipher-13`)

Разрешённые наборы шифров TLSv1.3

Все соединения TLS между клиентом pgBackRest и сервером зашифрованы. По умолчанию также зашифрованы соединения с объектными хранилищами (например, S3).

NOTE: Минимальный уровень безопасности для любого соединения по транспортному протоколу — TLSv1.2

Доступные наборы шифров можно настроить при необходимости. Если не установлено (значение по умолчанию), применяется значение по умолчанию библиотеки OpenSSL.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Параметры журналирования

Опция уровня журналирования консоли (`--log-level-console`)

Уровень ведения журнала для консоли.

Поддерживаются следующие уровни журналирования:

off — ведение журнала отключено (не рекомендуется)
error — ведение журнала только ошибок
warn — ведение журнала предупреждений и ошибок
info — ведение журнала информации, предупреждений и ошибок
detail — ведение журнала деталей, информации, предупреждений и ошибок
debug — ведение журнала отладки, деталей, информации, предупреждений и ошибок
trace — ведение журнала трассировки (очень подробная отладка), отладки, информации, предупреждений и ошибок

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

Опция уровня журналирования файла (`--log-level-file`)

Уровень ведения журнала для файлов.

Поддерживаются следующие уровни журналирования:

off — ведение журнала отключено (не рекомендуется)
error — ведение журнала только ошибок
warn — ведение журнала предупреждений и ошибок
info — ведение журнала информации, предупреждений и ошибок
detail — ведение журнала деталей, информации, предупреждений и ошибок
debug — ведение журнала отладки, деталей, информации, предупреждений и ошибок
trace — ведение журнала трассировки (очень подробная отладка), отладки, информации, предупреждений и ошибок

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

Опция уровня журнала стандартных ошибок (`--log-level-stderr`)

Уровень ведения журнала для stderr.

Указывает, какие уровни журналов будут выводиться в stderr вместо stdout (указано в log-level-console). Временная метка и процесс не будут выводиться в stderr.

Поддерживаются следующие уровни журналирования:

off — ведение журнала отключено (не рекомендуется)
error — ведение журнала только ошибок
warn — ведение журнала предупреждений и ошибок
info — ведение журнала информации, предупреждений и ошибок
detail — ведение журнала деталей, информации, предупреждений и ошибок
debug — ведение журнала отладки, деталей, информации, предупреждений и ошибок
trace — ведение журнала трассировки (очень подробная отладка), отладки, информации, предупреждений и ошибок

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

Параметр пути журнала (`--log-path`)

Путь, по которому хранятся файлы журналов.

Путь к журналу задаёт местоположение для хранения файлов журналов pgBackRest. Примечание: если log-level-file=off, то путь к журналу не требуется.

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

Опция временной метки журнала (`--log-timestamp`)

Включите метку времени в ведении журнала.

Включает метку времени в журнале консоли и файлов. Этот параметр отключен в особых ситуациях, таких как генерация документации.

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

4 - Команда версии (version)

Справочник по параметрам и поведению команды pgBackRest version

Отображает установленную версию pgBackRest.

Опции команды

Параметр вывода (`--output`)

Тип вывода.

Поддерживаются следующие типы вывода:

text — Отображает установленную версию pgBackRest в виде текста.
num — Отображает установленную версию pgBackRest в виде целого числа.

default: text
example: --output=num

Справочник команд

Введение

Команды

1 - Команда справки (help)

Опции команды

Показать сведения о параметре помощи (--help)

Параметр отображения версии (--version)

2 - Команда сервера (server)

Опции команды

TLS Параметр адреса сервера (--tls-server-address)

TLS Параметр авторизованных клиентов сервера (--tls-server-auth)

TLS Параметр сертификатов удостоверяющих центров сервера (--tls-server-ca-file)

TLS Параметр сертификата сервера (--tls-server-cert-file)

Ключевая опция сервера TLS (--tls-server-key-file)

Параметр порта сервера TLS (--tls-server-port)

Общие параметры

Разрешить запуск от имени root (--allow-root)

Опция размера буфера (--buffer-size)

Параметр конфигурации (--config)

Путь включения конфигурации (--config-include-path)

Путь к конфигурации (--config-path)

Параметр тайм-аута ввода-вывода (--io-timeout)

Установка параметра приоритета процесса (--priority)

Опция тайм-аута протокола (--protocol-timeout)

Параметр Keep Alive (--sck-keep-alive)

Параметр количества Keep Alive (--tcp-keep-alive-count)

Параметр простоя Keep Alive (--tcp-keep-alive-idle)

Параметр интервала Keep Alive (--tcp-keep-alive-interval)

Списки шифров TLSv1.2 (параметр --tls-cipher-12)

Списки шифров TLSv1.3 (параметр) (--tls-cipher-13)

Параметры журналирования

Опция уровня журналирования консоли (--log-level-console)

Опция уровня журналирования файла (--log-level-file)

Опция уровня журнала стандартных ошибок (--log-level-stderr)

Параметр пути журнала (--log-path)

Опция временной метки журнала (--log-timestamp)

3 - Команда проверки доступности сервера (server-ping)

Опции команды

TLS Параметр адреса сервера (--tls-server-address)

Параметр порта сервера TLS (--tls-server-port)

Общие параметры

Разрешить запуск от имени root (--allow-root)

Опция размера буфера (--buffer-size)

Параметр конфигурации (--config)

Путь включения конфигурации (--config-include-path)

Путь к конфигурации (--config-path)

Параметр тайм-аута ввода-вывода (--io-timeout)

Установка параметра приоритета процесса (--priority)

Параметр Keep Alive (--sck-keep-alive)

Параметр количества Keep Alive (--tcp-keep-alive-count)

Параметр простоя Keep Alive (--tcp-keep-alive-idle)

Параметр интервала Keep Alive (--tcp-keep-alive-interval)

Списки шифров TLSv1.2 (параметр --tls-cipher-12)

Списки шифров TLSv1.3 (параметр) (--tls-cipher-13)

Параметры журналирования

Опция уровня журналирования консоли (--log-level-console)

Опция уровня журналирования файла (--log-level-file)

Опция уровня журнала стандартных ошибок (--log-level-stderr)

Параметр пути журнала (--log-path)

Опция временной метки журнала (--log-timestamp)

4 - Команда версии (version)

Опции команды

Параметр вывода (--output)

Показать сведения о параметре помощи (`--help`)

Параметр отображения версии (`--version`)

TLS Параметр адреса сервера (`--tls-server-address`)

TLS Параметр авторизованных клиентов сервера (`--tls-server-auth`)

TLS Параметр сертификатов удостоверяющих центров сервера (`--tls-server-ca-file`)

TLS Параметр сертификата сервера (`--tls-server-cert-file`)

Ключевая опция сервера TLS (`--tls-server-key-file`)

Параметр порта сервера TLS (`--tls-server-port`)

Разрешить запуск от имени root (`--allow-root`)

Опция размера буфера (`--buffer-size`)

Параметр конфигурации (`--config`)

Путь включения конфигурации (`--config-include-path`)

Путь к конфигурации (`--config-path`)

Параметр тайм-аута ввода-вывода (`--io-timeout`)

Установка параметра приоритета процесса (`--priority`)

Опция тайм-аута протокола (`--protocol-timeout`)

Параметр Keep Alive (`--sck-keep-alive`)

Параметр количества Keep Alive (`--tcp-keep-alive-count`)

Параметр простоя Keep Alive (`--tcp-keep-alive-idle`)

Параметр интервала Keep Alive (`--tcp-keep-alive-interval`)

Списки шифров TLSv1.2 (параметр `--tls-cipher-12`)

Списки шифров TLSv1.3 (параметр) (`--tls-cipher-13`)

Опция уровня журналирования консоли (`--log-level-console`)

Опция уровня журналирования файла (`--log-level-file`)

Опция уровня журнала стандартных ошибок (`--log-level-stderr`)

Параметр пути журнала (`--log-path`)

Опция временной метки журнала (`--log-timestamp`)

TLS Параметр адреса сервера (`--tls-server-address`)

Параметр порта сервера TLS (`--tls-server-port`)

Разрешить запуск от имени root (`--allow-root`)

Опция размера буфера (`--buffer-size`)

Параметр конфигурации (`--config`)

Путь включения конфигурации (`--config-include-path`)

Путь к конфигурации (`--config-path`)

Параметр тайм-аута ввода-вывода (`--io-timeout`)

Установка параметра приоритета процесса (`--priority`)

Параметр Keep Alive (`--sck-keep-alive`)

Параметр количества Keep Alive (`--tcp-keep-alive-count`)

Параметр простоя Keep Alive (`--tcp-keep-alive-idle`)

Параметр интервала Keep Alive (`--tcp-keep-alive-interval`)

Списки шифров TLSv1.2 (параметр `--tls-cipher-12`)

Списки шифров TLSv1.3 (параметр) (`--tls-cipher-13`)

Опция уровня журналирования консоли (`--log-level-console`)

Опция уровня журналирования файла (`--log-level-file`)

Опция уровня журнала стандартных ошибок (`--log-level-stderr`)

Параметр пути журнала (`--log-path`)

Опция временной метки журнала (`--log-timestamp`)

Параметр вывода (`--output`)