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

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_http_health_check_info.

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

Описание

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

Требования

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

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, используя переменную среды 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 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.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_http_health_check_info_module.html