google.cloud.gcp_compute_https_health_check_info – Сбор информации о GCP HttpsHealthCheck

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.1).

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_https_health_check_info.

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

Обзор

Сбор информации о GCP HttpsHealthCheck

Требования

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

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. Каждый дополнительный фильтр в списке будет добавлен как условие AND (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, используя переменную среды gcp_service_account_file.
для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a HTTPS health check
  gcp_compute_https_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 строка	успех	Значение заголовка хоста в запросе HTTPS проверки работоспособности. Если оставить пустым (значение по умолчанию), будет использован публичный IP-адрес от имени, от которого выполняется эта проверка работоспособности.
	id целое число	успех	Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
	name строка	успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	port целое число	успех	Номер TCP-порта для запроса HTTPS проверки работоспособности. Значение по умолчанию — 80.
	requestPath строка	успех	Путь запроса HTTPS проверки работоспособности. Значение по умолчанию — /.
	timeoutSec целое число	успех	Время ожидания (в секундах) перед признанием ошибки. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше checkIntervalSec.
	unhealthyThreshold целое число	успех	Здоровый экземпляр будет помечен как нездоровый после этого количества последовательных ошибок. Значение по умолчанию — 2.

Авторы

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.10/collections/google/cloud/gcp_compute_https_health_check_info_module.html