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

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Описание

Простой модуль для проверки доступности удаленного сервера 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
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.

Примечания

Примечание

Аутентификация по умолчанию предполагает, что вы либо входите как пользователь, либо используете 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.

См. также

postgresql_info – Сбор информации о серверах PostgreSQL: Официальная документация по модулю 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
  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}

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/postgresql_ping_module.html