модуль google.cloud.gcp_compute_region_target_https_proxy_info — сбор информации о GCP RegionTargetHttpsProxy
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_region_target_https_proxy_info.
Краткое описание
- Сбор информации о GCP RegionTargetHttpsProxy
Требования
На хосте, который выполняет этот модуль, должны быть установлены следующие компоненты.
- 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. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project строка | Проект Google Cloud Platform, который следует использовать. |
region строка / обязательный | Регион, в котором находится региональный прокси-сервер. |
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 target HTTPS proxy
gcp_compute_region_target_https_proxy_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources сложный тип | Список ресурсов Возвращается: всегда |
|
creationTimestamp строка |
Время создания в текстовом формате RFC3339. Возвращается: при успешном выполнении |
|
description строка |
Необязательное описание этого ресурса. Возвращается: при успешном выполнении |
|
id целое число |
Уникальный идентификатор ресурса. Возвращается: при успешном выполнении |
|
name строка |
Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успешном выполнении |
|
region строка |
Регион, в котором находится региональный прокси-сервер. Возвращается: при успешном выполнении |
|
sslCertificates список / элементы=строка |
Список ресурсов RegionSslCertificate, используемых для аутентификации соединений между пользователями и балансировщиком нагрузки. В настоящее время необходимо указать ровно один SSL-сертификат. Возвращается: при успешном выполнении |
|
urlMap словарь |
Ссылка на ресурс RegionUrlMap, который определяет сопоставление URL-адресов с RegionBackendService. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_target_https_proxy_info_module.html
