gcp_compute_http_health_check_info – Сбор информации о GCP HttpHealthCheck

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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор информации о GCP HttpHealthCheck
Этот модуль назывался gcp_compute_http_health_check_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_compute_http_health_check_facts

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API.
filters список		Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка		Проект Google Cloud Platform для использования.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо как строка JSON, представляющая его.
service_account_email строка		Дополнительно адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file с использованием переменной среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents с использованием переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email с использованием переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с использованием переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с использованием переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a HTTP health check
  gcp_compute_http_health_check_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ		Возвращаемое значение	Описание
resources сложный		всегда	Список ресурсов
	checkIntervalSec целое число	успех	Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд.
	creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
	description строка	успех	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
	healthyThreshold целое число	успех	Неуспешный до сих пор экземпляр будет помечен как успешный после этого количества последовательных успехов. Значение по умолчанию — 2.
	host строка	успех	Значение заголовка хоста в запросе проверки работоспособности HTTP. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес от имени которого выполняется эта проверка работоспособности.
	id целое число	успех	Уникальный идентификатор ресурса. Этот идентификатор задается сервером.
	name строка	успех	Имя ресурса. Указывается клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	port целое число	успех	Номер TCP-порта для запроса проверки работоспособности HTTP. Значение по умолчанию — 80.
	requestPath строка	успех	Путь запроса для проверки работоспособности HTTP. Значение по умолчанию — /.
	timeoutSec целое число	успех	Время ожидания (в секундах) до объявления ошибки. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec имел большее значение, чем checkIntervalSec.
	unhealthyThreshold целое число	успех	Успешный до сих пор экземпляр будет помечен как неуспешный после этого количества последовательных ошибок. Значение по умолчанию — 2.

Статус

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

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/gcp_compute_http_health_check_info_module.html