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

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

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

Обзор

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

Псевдонимы: gcp_compute_https_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 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 строка	успех	Значение заголовка 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.

Статус

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

Авторы

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_https_health_check_info_module.html