Модуль google.cloud.gcp_compute_http_health_check_info – Сбор информации о GCP HttpHealthCheck
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: 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
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
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. - для аутентификации можно установить access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - для аутентификации можно установить 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. Возвращается: успех |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_http_health_check_info_module.html
