community.general.postgresql_ping – Проверка доступности удаленного сервера PostgreSQL

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.postgresql_ping.

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

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

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

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

psycopg2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca_cert строка		Указывает имя файла, содержащего сертификаты уполномоченной организации (CA). Если файл существует, сертификат сервера будет проверен на подпись одной из этих организаций. Псевдонимы: ssl_rootcert
db строка		Имя базы данных для подключения. Псевдонимы: login_db
login_host строка		Хост, на котором работает база данных.
login_password строка		Пароль для аутентификации.
login_unix_socket строка		Путь к сокету Unix доменной области для локальных подключений.
login_user строка	По умолчанию: "postgres"	Имя пользователя для аутентификации.
port целое число	По умолчанию: 5432	Порт базы данных для подключения. Псевдонимы: login_port
session_role строка добавлен в 0.2.0 от community.general		Переключение на роль session_role после подключения. Указанная роль session_role должна быть ролью, членом которой является текущий пользователь login_user. Проверка прав для команд SQL выполняется так, как будто роль session_role была той, которая изначально вошла в систему.
ssl_mode строка	Варианты: allow disable prefer ← require verify-ca verify-full	Определяет, будет ли установлено защищенное соединение SSL TCP/IP с сервером и с какой приоритетностью. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию `prefer` соответствует значению по умолчанию libpq.
trust_input булево добавлен в 0.2.0 от community.general	Варианты: no yes ←	Если `no`, проверьте, не представляет ли значение session_role потенциальной опасности. Использование `no` имеет смысл только в случае, если возможны SQL-инъекции через session_role.

Примечания

Примечание

По умолчанию аутентификация предполагает, что вы входите в систему или используете sudo для учетной записи postgres на хосте.
Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg2, адаптер базы данных Python для PostgreSQL. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
Если удаленный хост является сервером PostgreSQL (что является случаем по умолчанию), то PostgreSQL также должен быть установлен на удаленном хосте.
Для систем на основе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удаленном хосте перед использованием этого модуля.
Параметр ca_cert требует как минимум версии Postgres 8.4 и версии psycopg2 2.4.3.

См. также

community.general.postgresql_info: Официальная документация модуля community.general.postgresql_info.

Примеры

# PostgreSQL ping dbsrv server from the shell:
# ansible dbsrv -m postgresql_ping

# In the example below you need to generate certificates previously.
# See https://www.postgresql.org/docs/current/libpq-ssl.html for more information.
- name: PostgreSQL ping dbsrv server using not default credentials and ssl
  community.general.postgresql_ping:
    db: protected_db
    login_host: dbsrv
    login_user: secret
    login_password: secret_pass
    ca_cert: /root/root.crt
    ssl_mode: verify-full

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

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

Ключ	Возвращаемое значение	Описание
is_available булево	всегда	Доступность сервера PostgreSQL. Пример: True
server_version словарь	всегда	Версия сервера PostgreSQL. Пример: {'major': 10, 'minor': 1}

Авторы

Andrew Klychkov (@Andersson007)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/postgresql_ping_module.html