Модуль google.cloud.gcp_compute_external_vpn_gateway_info — Сбор информации о GCP ExternalVpnGateway

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_external_vpn_gateway_info.

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

Описание

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

Требования

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

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, который нужно использовать.
...	...

Примечания

Примечание

для аутентификации можно установить 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 an external vpn gateway
  gcp_compute_external_vpn_gateway_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
resources сложный	Список ресурсов Возвращается: всегда
description строка	Необязательное описание этого ресурса. Возвращается: успех
interfaces сложный	Список интерфейсов на этом внешнем шлюзе VPN. Возвращается: успех
id целое число	Числовой ID этого интерфейса. Допустимые значения основаны на типе избыточности этого внешнего шлюза VPN * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY`. Возвращается: успех
ipAddress строка	IP-адрес интерфейса во внешнем шлюзе VPN. Поддерживается только IPv4. Этот IP-адрес может быть как из вашего локального шлюза, так и из шлюза VPN другого поставщика облачных услуг, он не может быть IP-адресом из Google Compute Engine. Возвращается: успех
name строка	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается:* успех
redundancyType строка	Указывает тип избыточности этого внешнего шлюза 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_external_vpn_gateway_info_module.html