Модуль google.cloud.gcp_compute_target_tcp_proxy_info – Сбор информации о GCP TargetTcpProxy

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. раздел Требования.

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_compute_target_tcp_proxy_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор информации о GCP TargetTcpProxy

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
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 target TCP proxy
  gcp_compute_target_tcp_proxy_info:
    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])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается:* успешно
proxyBind булево	Это поле применяется только в том случае, если у правила переадресации, ссылающегося на этот целевой прокси-сервер, свойство loadBalancingScheme установлено в INTERNAL_SELF_MANAGED. Возвращается: успешно
proxyHeader строка	Указывает тип заголовка прокси-сервера, который следует добавить перед отправкой данных в бэкенд. Возвращается: успешно
service словарь	Ссылка на ресурс BackendService. Возвращается: успешно

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекции

© 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_target_tcp_proxy_info_module.html