Модуль google.cloud.gcp_compute_region_health_check_info – Сбор информации о GCP RegionHealthCheck
Примечание
Этот модуль входит в состав коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: google.cloud.gcp_compute_region_health_check_info.
Обзор
- Сбор информации о GCP RegionHealthCheck
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 для использования. |
region строка | Регион, в котором находится региональный Health Check. |
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 region health check
gcp_compute_region_health_check_info:
region: us-central1
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 |
Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: успешно |
|
grpcHealthCheck complex |
Вложенный объектный ресурс. Возвращается: успешно |
|
grpcServiceName string |
Имя службы gRPC для проверки работоспособности. Значение grpcServiceName имеет следующие значения по соглашению: * Пустое serviceName означает общее состояние всех служб на бэкэнде. * Непустое serviceName означает работоспособность этой службы gRPC, как определено владельцем службы. grpcServiceName может быть только ASCII. Возвращается: успешно |
|
port integer |
Номер порта для запроса проверки работоспособности. Должен быть указан, если portName и portSpecification не установлены или если port_specification имеет значение USE_FIXED_PORT. Допустимые значения — от 1 до 65535. Возвращается: успешно |
|
portName string |
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены и port, и port_name, приоритет имеет port. Возвращается: успешно |
|
portSpecification string |
Указывает, как выбирается порт для проверки работоспособности, может быть одним из следующих значений: * `USE_FIXED_PORT`: Номер порта в поле `port` используется для проверки работоспособности. * `USE_NAMED_PORT`: `portName` используется для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup номер порта, указанный для каждой конечной точки сети, используется для проверки работоспособности. Для других бэкэндов используется порт или именованный порт, указанный в службе Backend Service. Если не указано, проверка работоспособности gRPC следует поведению, указанному в полях `port` и `portName`. Возвращается: успешно |
|
healthyThreshold integer |
Неработоспособный экземпляр будет помечен как работоспособный после такого количества последовательных успехов. Значение по умолчанию — 2. Возвращается: успешно |
|
http2HealthCheck complex |
Вложенный объектный ресурс. Возвращается: успешно |
|
host string |
Значение заголовка host в запросе проверки работоспособности HTTP2. Если оставлено пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. Возвращается: успешно |
|
port integer |
Номер TCP-порта для запроса проверки работоспособности HTTP2. Значение по умолчанию — 443. Возвращается: успешно |
|
portName string |
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены и port, и port_name, приоритет имеет port. Возвращается: успешно |
|
portSpecification string |
Указывает, как выбирается порт для проверки работоспособности, может быть одним из следующих значений: * `USE_FIXED_PORT`: Номер порта в поле `port` используется для проверки работоспособности. * `USE_NAMED_PORT`: `portName` используется для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup номер порта, указанный для каждой конечной точки сети, используется для проверки работоспособности. Для других бэкэндов используется порт или именованный порт, указанный в службе Backend Service. Если не указано, проверка работоспособности HTTP2 следует поведению, указанному в полях `port` и `portName`. Возвращается: успешно |
|
proxyHeader string |
Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных на бэкэнд. Возвращается: успешно |
|
requestPath string |
Путь запроса проверки работоспособности HTTP2. Значение по умолчанию — /. Возвращается: успешно |
|
response string |
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII. Returned: success |
|
httpHealthCheck complex |
Вложенный объектный ресурс. Returned: success |
|
host string |
Значение заголовка host в запросе проверки работоспособности HTTP. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. Returned: success |
|
port integer |
Номер TCP-порта для запроса проверки работоспособности HTTP. Значение по умолчанию — 80. Returned: success |
|
portName string |
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port. Returned: success |
|
portSpecification string |
Указывает, как выбирается порт для проверки работоспособности; может принимать одно из следующих значений: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта в поле `port`. * `USE_NAMED_PORT`: для проверки работоспособности используется `portName`. * `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки работоспособности используется порт, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности HTTP следует поведению, указанному в полях `port` и `portName`. Returned: success |
|
proxyHeader string |
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных в бэкэнд. Returned: success |
|
requestPath string |
Путь запроса запроса проверки работоспособности HTTP. Значение по умолчанию — /. Returned: success |
|
response string |
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII. Returned: success |
|
httpsHealthCheck complex |
Вложенный объектный ресурс. Returned: success |
|
host string |
Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. Returned: success |
|
port integer |
Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 443. Returned: success |
|
portName string |
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port. Returned: success |
|
portSpecification string |
Указывает, как выбирается порт для проверки работоспособности; может принимать одно из следующих значений: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта в поле `port`. * `USE_NAMED_PORT`: для проверки работоспособности используется `portName`. * `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки работоспособности используется порт, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе бэкэнда. Если не указано, проверка работоспособности HTTPS следует поведению, указанному в полях `port` и `portName`. Returned: success |
|
proxyHeader string |
Указывает тип заголовка прокси-сервера для добавления перед отправкой данных в бэкэнд. Returned: success |
|
requestPath string |
Путь запроса запроса проверки работоспособности HTTPS. Значение по умолчанию — /. Returned: success |
|
response string |
Байты для сопоставления с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII. Returned: success |
|
id integer |
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. Возвращено: success |
|
logConfig complex |
Настройка ведения журналов для этой проверки работоспособности. Возвращено: success |
|
enable boolean |
Указывает, следует ли экспортировать журналы. По умолчанию это значение false, что означает, что ведение журнала проверки работоспособности выполняться не будет. Возвращено: success |
|
name string |
Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов, и оно должно соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращено: success |
|
region string |
Регион, в котором находится региональная проверка работоспособности. Возвращено: success |
|
sslHealthCheck complex |
Вложенный объектный ресурс. Возвращено: success |
|
port integer |
Номер порта TCP для запроса проверки работоспособности SSL. Значение по умолчанию — 443. Возвращено: success |
|
portName string |
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port. Возвращено: success |
|
portSpecification string |
Указывает, как выбирается порт для проверки работоспособности; может принимать одно из следующих значений: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта в поле `port`. * `USE_NAMED_PORT`: для проверки работоспособности используется поле `portName`. * `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки работоспособности используется порт, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе Backend Service. Если не указано, проверка работоспособности SSL следует поведению, указанному в полях `port` и `portName`. Возвращено: success |
|
proxyHeader string |
Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкэнд. Возвращено: success |
|
request string |
Прикладные данные, которые необходимо отправить после установления SSL-соединения (значение по умолчанию — пустое). Если поля request и response пусты, само установление соединения будет указывать на работоспособность. Данные запроса могут быть только ASCII. Возвращено: success |
|
response string |
Байты, которые необходимо сравнить с началом данных ответа. Если оставить пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII. Возвращено: success |
|
tcpHealthCheck complex |
Вложенный объектный ресурс. Возвращено: success |
|
port integer |
Номер порта TCP для запроса проверки работоспособности TCP. Значение по умолчанию — 80. Возвращено: success |
|
portName string |
Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port. Возвращено: success |
|
portSpecification string |
Указывает, как выбирается порт для проверки работоспособности; может принимать одно из следующих значений: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта в поле `port`. * `USE_NAMED_PORT`: для проверки работоспособности используется поле `portName`. * `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки работоспособности используется порт, указанный для каждой конечной точки сети. Для других бэкэндов для проверки работоспособности используется порт или именованный порт, указанный в службе Backend Service. Если не указано, проверка работоспособности TCP следует поведению, указанному в полях `port` и `portName`. Возвращено: success |
|
proxyHeader string |
Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкэнд. Возвращено: success |
|
request string |
Данные приложения, которые отправляются после установления TCP-соединения (значение по умолчанию — пустое). Если и запрос, и ответ пусты, установление соединения само по себе указывает на работоспособность. Данные запроса могут быть только ASCII. Возвращаемое значение: success |
|
response string |
Байты для сравнения с началом данных ответа. Если поле пустое (значение по умолчанию), любой ответ указывает на работоспособность. Данные ответа могут быть только ASCII. Возвращаемое значение: success |
|
timeoutSec integer |
Время ожидания (в секундах) до признания сбоя. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше checkIntervalSec. Возвращаемое значение: success |
|
type string |
Указывает тип проверки работоспособности: TCP, SSL, HTTP или HTTPS. Если не указано, по умолчанию используется TCP. Должно быть указано ровно одно поле для протокола, которое должно соответствовать полю type. Возвращаемое значение: success |
|
unhealthyThreshold integer |
Здоровый до этого экземпляр будет помечен как неработоспособный после этого количества последовательных сбоев. Значение по умолчанию — 2. Возвращаемое значение: success |
Ссылки на сборку
© 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_region_health_check_info_module.html
