google.cloud.gcp_compute_external_vpn_gateway_info – Сбор информации о GCP ExternalVpnGateway

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.2).

Для его установки используйте: 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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.
для аутентификации можно установить 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"

Возвращаемые значения

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

Ключ			Возвращаемое значение	Описание
resources сложный			всегда	Список ресурсов
	description строка		успех	Необязательное описание этого ресурса.
	interfaces сложный		успех	Список интерфейсов в этом шлюзе внешней VPN.
		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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_external_vpn_gateway_info_module.html