Spec-Zone.ru › Ansible

Модуль community.postgresql.postgresql_alter_system — изменение параметра конфигурации сервера PostgreSQL

Примечание

Этот модуль входит в коллекцию community.postgresql (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.postgresql. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.postgresql.postgresql_alter_system.

Добавлено в community.postgresql 3.13.0

  • Краткое описание
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Поддерживает PostgreSQL 14 или более позднюю версию.
  • Позволяет изменить параметр конфигурации сервера PostgreSQL.
  • Модуль использует команду ALTER SYSTEM и применяет изменения, перезагружая конфигурацию сервера.
  • Для некоторых параметров требуется перезапустить PostgreSQL. См. возвращаемое значение restart_required.

Требования

На узле, где выполняется этот модуль, необходимы следующие компоненты.

  • psycopg2 >= 2.5.1

Параметры

Параметр

Комментарии

ca_cert

псевдонимы: ssl_rootcert

строка

Указывает имя файла, содержащего сертификат или сертификаты центра сертификации (CA) для SSL.

Если файл существует, будет проверено, что сертификат сервера подписан одним из этих центров.

connect_params

словарь

добавлено в community.postgresql 2.3.0

Любые дополнительные параметры, передаваемые в libpg.

Эти параметры имеют приоритет.

По умолчанию: {}

login_db

строка

Имя базы данных для подключения.

login_host

псевдонимы: host

строка

Узел, на котором запущена база данных.

Если при подключении с помощью localhost возникают проблемы, попробуйте вместо него использовать 127.0.0.1.

По умолчанию: ""

login_password

строка

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

По умолчанию: ""

login_port

псевдонимы: port

целое число

Порт базы данных для подключения.

Псевдоним port устарел и будет удалён в следующем основном выпуске. Вместо него используйте login_port.

По умолчанию: 5432

login_unix_socket

псевдонимы: unix_socket

строка

Путь к сокету домена Unix для локальных подключений.

По умолчанию: ""

login_user

псевдонимы: login

строка

Имя пользователя, которое модуль использует для установки сеанса PostgreSQL.

По умолчанию: "postgres"

param

строка / обязательный

Имя параметра сервера PostgreSQL.

session_role

строка

После подключения переключиться на session_role. Указанная session_role должна быть ролью, членом которой является текущий login_user.

Проверка прав для команд SQL выполняется так, как если бы изначально выполнил вход пользователь session_role.

ssl_cert

путь

добавлено в community.postgresql 2.4.0

Указывает имя файла клиентского сертификата SSL.

ssl_key

путь

добавлено в community.postgresql 2.4.0

Указывает расположение секретного ключа, используемого для клиентского сертификата.

ssl_mode

строка

Определяет, будет ли согласовано защищённое SSL-подключение TCP/IP к серверу и какой приоритет оно будет иметь.

Дополнительные сведения о режимах см. на странице https://www.postgresql.org/docs/current/static/libpq-ssl.html.

Значение по умолчанию prefer соответствует значению по умолчанию в libpq.

Варианты:

  • "allow"
  • "disable"
  • "prefer" ← (по умолчанию)
  • "require"
  • "verify-ca"
  • "verify-full"

trust_input

логическое значение

Если false, проверять значения параметров на потенциальную опасность.

Использовать false имеет смысл только в том случае, если возможны SQL-инъекции.

Варианты:

  • false
  • true ← (по умолчанию)

value

строка / обязательный

Задаваемое значение параметра.

Указывайте значение в соответствующих единицах измерения!

Для параметров, связанных с памятью, целочисленного типа допустимы значения kB, MB, GB и TB.

Используйте _RESET для выполнения ALTER SYSTEM RESET param, которая удалит соответствующую запись из postgresql.auto.conf. Всегда возвращает changed=True.

Для логических параметров передавайте строку "on" или "off".

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Модуль можно запускать в режиме check_mode: он возвращает прогноз изменения состояния, не изменяя целевой узел.

Примечания

Примечание

  • Для некоторых параметров требуется перезапуск сервера PostgreSQL. См. официальную документацию: https://www.postgresql.org/docs/current/view-pg-settings.html.
  • По умолчанию предполагается, что вы входите в систему под учётной записью postgres на узле или переключаетесь на неё с помощью sudo.
  • Чтобы избежать ошибки «Peer authentication failed for user postgres», используйте пользователя postgres в качестве become_user.
  • Этот модуль использует psycopg — адаптер Python для баз данных PostgreSQL. Перед использованием модуля необходимо убедиться, что на узле установлен psycopg2 >= 2.5.1 или psycopg3 >= 3.1.8.
  • Если удалённый узел является сервером PostgreSQL (по умолчанию это так), PostgreSQL также должен быть установлен на удалённом узле.
  • В системах на базе Ubuntu перед использованием этого модуля установите на удалённый узел пакеты postgresql, libpq-dev и python3-psycopg2.

См. также

См. также

community.postgresql.postgresql_info

Сбор информации о серверах PostgreSQL.

Конфигурация сервера PostgreSQL

Общие сведения о конфигурации сервера PostgreSQL.

Справочник по представлению PostgreSQL pg_catalog.pg_settings

Полный справочник по документации представления pg_catalog.pg_settings.

Справочник по команде PostgreSQL ALTER SYSTEM

Полный справочник по документации команды ALTER SYSTEM.

Примеры

- name: Set work_mem
  community.postgresql.postgresql_alter_system:
    param: work_mem
    value: 1024

- name: Reset work_mem
  community.postgresql.postgresql_alter_system:
    param: work_mem
    value: _RESET

- name: Set TimeZone parameter (careful, case sensitive)
  community.postgresql.postgresql_alter_system:
    param: TimeZone
    value: 'Europe/Paris'

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

attrs

словарь

Атрибуты параметра из pg_catalog.pg_settings, которые не изменяются.

Возвращается: при успехе

Пример: {"boot_val": 4096, "context": "user", "max_val": 2147483647, "min_val": 64, "unit": "kB", "vartype": "integer"}

diff

словарь

Словарь с ключами before и after.

Каждый ключ содержит словарь пар «ключ-значение», представляющих изменяемые столбцы и значения параметра, полученные из отношения pg_catalog.pg_settings.

Возвращается: при успехе

Пример: {"after": {"pending_restart": false, "setting": 8192}, "before": {"pending_restart": false, "setting": 4096}}

executed_queries

список / элементы — строки

Список выполненных запросов, кроме SELECT.

В режиме проверки возвращается запрос, который должен был бы выполниться в обычном режиме.

Возвращается: при успехе

Пример: ["ALTER SYSTEM SET shared_preload_libraries = ''"]

restart_required

логическое значение

Указывает, требуется ли перезапуск PostgreSQL.

Добавлено для удобства. Это значение также можно определить по возвращаемому значению diff[“after”][“pending_restart”].

Возвращается: при успехе

Пример: true

Авторы

  • Andrew Klychkov (@Andersson007)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Сообщить о проблеме
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/postgresql/postgresql_alter_system_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API