модуль google.cloud.gcp_compute_https_health_check_info — сбор сведений о GCP HttpsHealthCheck
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: 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
Параметры
Параметр | Описание |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для запросов к API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который будет использоваться. |
scopes list / элементы=string | Массив используемых областей действия |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной окружения
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной окружения
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной окружения
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной окружения
GCP_ACCESS_TOKEN. - Для аутентификации можно задать 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 complex | Список ресурсов Возвращается: всегда |
|
checkIntervalSec integer |
Как часто (в секундах) отправляется проверка работоспособности. Значение по умолчанию — 5 секунд. Возвращается: при успехе |
|
creationTimestamp string |
Время создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успехе |
|
healthyThreshold integer |
Неисправный до этого экземпляр будет считаться исправным после указанного количества последовательных успешных проверок. Значение по умолчанию — 2. Возвращается: при успехе |
|
host string |
Значение заголовка host в запросе HTTPS-проверки работоспособности. Если оставить поле пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется эта проверка. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор ресурса. Этот идентификатор задается сервером. Возвращается: при успехе |
|
name string |
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успехе |
|
port integer |
Номер TCP-порта для запроса HTTPS-проверки работоспособности. Значение по умолчанию — 443. Возвращается: при успехе |
|
requestPath string |
Путь запроса для HTTPS-проверки работоспособности. Значение по умолчанию — /. Возвращается: при успехе |
|
timeoutSec integer |
Время ожидания (в секундах) до фиксации сбоя. Значение по умолчанию — 5 секунд. Значение timeoutSec не может быть больше значения checkIntervalSec. Возвращается: при успехе |
|
unhealthyThreshold integer |
Исправный до этого экземпляр будет считаться неисправным после указанного количества последовательных неудачных проверок. Значение по умолчанию — 2. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_https_health_check_info_module.html
