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 на хосте.
Этот модуль использует psycopg2, адаптер базы данных Python PostgreSQL. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля. Если удалённый хост является сервером PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удалённом хосте. Для систем на базе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удалённом хосте перед использованием этого модуля.
Аутентификация по умолчанию предполагает, что вы вошли в систему или используете sudo с учётной записью postgres на хосте.
Этот модуль использует psycopg2, адаптер базы данных Python PostgreSQL. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля. Если удалённый хост является сервером PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удалённом хосте. Для систем на базе Ubuntu установите пакеты postgresql, libpq-dev, и python-psycopg2 на удалённом хосте перед использованием этого модуля.
Для параметра ca_cert требуется как минимум версия Postgres 8.4 и psycopg2 версии 2.4.3.

Примеры

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