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

Примечание

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

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_target_vpn_gateway_info.

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

Обзор

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

Требования

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

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 для использования.
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 target vpn gateway
  gcp_compute_target_vpn_gateway_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
creationTimestamp строка	Дата и время создания в формате RFC3339. Возвращается: успех
description строка	Необязательное описание данного ресурса. Возвращается: успех
forwardingRules список / элементы=строка	Список ссылок на ресурсы ForwardingRule, связанные с этим VPN шлюзом. Возвращается: успех
id целое число	Уникальный идентификатор ресурса. Возвращается: успех
name строка	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. Возвращается:* успех
network словарь	Сеть, для которой данный VPN шлюз принимает трафик. Возвращается: успех
region строка	Регион, в котором должен размещаться этот шлюз. Возвращается: успех
tunnels список / элементы=строка	Список ссылок на ресурсы VpnTunnel, связанные с этим VPN шлюзом. Возвращается: успех

Авторы

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_vpn_gateway_info_module.html