Модуль google.cloud.gcp_compute_region_health_check_info — сбор сведений о GCP RegionHealthCheck
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если в качестве типа учетных данных указано accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible запускается этот модуль. Не задавайте это значение, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для запросов к API. |
filters list / elements=string | Список пар значений фильтров. Список доступных фильтров приведен здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
region string | Регион, в котором находится региональная проверка работоспособности. |
scopes list / elements=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 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. Возвращается: при успешном выполнении |
|
httpHealthCheck complex |
Вложенный объект ресурса. Возвращается: при успешном выполнении |
|
host string |
Значение заголовка host в запросе проверки состояния HTTP. Если значение пустое (по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка состояния. Возвращается: при успешном выполнении |
|
port integer |
Номер порта TCP для запроса проверки состояния HTTP. Значение по умолчанию — 80. Возвращается: при успешном выполнении |
|
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. Если значение не задано, проверка состояния HTTP выполняется в соответствии с поведением, определяемым полями `port` и `portName`. Возвращается: при успешном выполнении |
|
proxyHeader string |
Указывает тип заголовка прокси, который добавляется перед отправкой данных на бэкенд. Возвращается: при успешном выполнении |
|
requestPath string |
Путь запроса проверки состояния HTTP. Значение по умолчанию — /. Возвращается: при успешном выполнении |
|
response string |
Байты для сопоставления с началом данных ответа. Если значение пустое (по умолчанию), любой ответ будет означать, что система работоспособна. Данные ответа могут содержать только символы ASCII. Возвращается: при успешном выполнении |
|
httpsHealthCheck complex |
Вложенный объект ресурса. Возвращается: при успешном выполнении |
|
host string |
Значение заголовка host в запросе проверки состояния HTTPS. Если значение пустое (по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка состояния. Возвращается: при успешном выполнении |
|
port integer |
Номер порта TCP для запроса проверки состояния HTTPS. Значение по умолчанию — 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. Если значение не задано, проверка состояния HTTPS выполняется в соответствии с поведением, определяемым полями `port` и `portName`. Возвращается: при успешном выполнении |
|
proxyHeader string |
Указывает тип заголовка прокси, который добавляется перед отправкой данных на бэкенд. Возвращается: при успешном выполнении |
|
requestPath string |
Путь запроса проверки состояния HTTPS. Значение по умолчанию — /. Возвращается: при успешном выполнении |
|
response string |
Байты для сопоставления с началом данных ответа. Если значение пустое (по умолчанию), любой ответ будет означать, что система работоспособна. Данные ответа могут содержать только символы ASCII. Возвращается: при успешном выполнении |
|
id integer |
Уникальный идентификатор ресурса. Этот идентификатор назначается сервером. Возвращается: при успешном выполнении |
|
logConfig complex |
Настройка ведения журналов для этой проверки состояния. Возвращается: при успешном выполнении |
|
enable boolean |
Указывает, следует ли экспортировать журналы. По умолчанию задано значение false, то есть журналы проверки состояния не ведутся. Возвращается: при успешном выполнении |
|
name string |
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успешном выполнении |
|
region string |
Регион, в котором находится региональная проверка состояния. Возвращается: при успешном выполнении |
|
sslHealthCheck complex |
Вложенный объект ресурса. Возвращается: при успешном выполнении |
|
port integer |
Номер порта TCP для запроса проверки состояния SSL. Значение по умолчанию — 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. Если значение не задано, проверка состояния SSL выполняется в соответствии с поведением, определяемым полями `port` и `portName`. Возвращается: при успешном выполнении |
|
proxyHeader string |
Указывает тип заголовка прокси, который добавляется перед отправкой данных на бэкенд. Возвращается: при успешном выполнении |
|
request string |
Данные приложения, отправляемые после установления SSL-соединения (по умолчанию значение пустое). Если request и response пусты, работоспособность будет подтверждаться самим фактом установления соединения. Данные запроса могут содержать только символы ASCII. Возвращается: при успешном выполнении |
|
response string |
Байты для сопоставления с началом данных ответа. Если значение пустое (по умолчанию), любой ответ будет означать, что система работоспособна. Данные ответа могут содержать только символы ASCII. Возвращается: при успешном выполнении |
|
tcpHealthCheck complex |
Вложенный объект ресурса. Возвращается: при успешном выполнении |
|
port integer |
Номер TCP-порта для запроса проверки состояния TCP. Значение по умолчанию — 80. Возвращается: при успешном выполнении |
|
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. Если значение не указано, проверка состояния TCP выполняется в соответствии с поведением, заданным полями `port` и `portName`. Возвращается: при успешном выполнении |
|
proxyHeader string |
Указывает тип заголовка прокси, который добавляется перед отправкой данных серверной части. Возвращается: при успешном выполнении |
|
request string |
Данные приложения, отправляемые после установления TCP-соединения (значение по умолчанию — пустая строка). Если поля request и response пусты, состояние считается работоспособным при одном лишь установлении соединения. Данные запроса могут содержать только символы ASCII. Возвращается: при успешном выполнении |
|
response string |
Байты, с которыми сравнивается начало данных ответа. Если значение не задано (значение по умолчанию), состояние считается работоспособным при любом ответе. Данные ответа могут содержать только символы ASCII. Возвращается: при успешном выполнении |
|
timeoutSec integer |
Время ожидания (в секундах) до фиксации сбоя. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно превышать checkIntervalSec. Возвращается: при успешном выполнении |
|
type string |
Указывает тип healthCheck: TCP, SSL, HTTP или HTTPS. Если значение не указано, используется TCP. Необходимо указать ровно одно поле проверки состояния для конкретного протокола, и оно должно соответствовать полю type. Возвращается: при успешном выполнении |
|
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_region_health_check_info_module.html