google.cloud.gcp_compute_vpn_tunnel_info – Сбор информации о GCP VpnTunnel

Примечание

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

Для его установки используйте: ansible-galaxy collection install google.cloud.

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

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

Обзор

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

Требования

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

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, который нужно использовать.
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.
Для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры service_account_email и service_account_file взаимоисключают друг друга.

Примеры

- name: get info on a vpn tunnel
  gcp_compute_vpn_tunnel_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ		Возвращаемое значение	Описание
resources сложный		всегда	Список ресурсов
	creationTimestamp строка	успех	Дата и время создания в формате RFC3339.
	description строка	успех	Необязательное описание этого ресурса.
	id строка	успех	Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
	ikeVersion целое число	успех	Версия протокола IKE, которая будет использоваться при установлении VPN-туннеля с peer VPN-шлюзом. Допустимые версии IKE — 1 или 2. Версия по умолчанию — 2.
	localTrafficSelector список / элементы=строка	успех	Локальный селектор трафика, используемый при установлении VPN-туннеля с peer VPN-шлюзом. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4.
	name строка	успех	Имя ресурса. Длина имени должна составлять 1–63 символа и соответствовать RFC1035. То есть имя должно иметь длину 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие — тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
	peerExternalGateway словарь	успех	URL внешнего VPN-шлюза на стороне peer, с которым связан этот VPN-туннель.
	peerExternalGatewayInterface целое число	успех	Идентификатор интерфейса внешнего VPN-шлюза, к которому подключен этот VPN-туннель.
	peerGcpGateway словарь	успех	URL peer HA GCP VPN-шлюза, к которому подключен этот VPN-туннель. Если указано, VPN-туннель будет автоматически использовать тот же идентификатор vpn_gateway_interface в peer GCP VPN-шлюзе.
	peerIp строка	успех	IP-адрес peer VPN-шлюза. Поддерживается только IPv4.
	region строка	успех	Регион, в котором расположен туннель.
	remoteTrafficSelector список / элементы=строка	успех	Селектор удаленного трафика, используемый при установлении VPN-туннеля с peer VPN-шлюзом. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4.
	router словарь	успех	URL ресурса маршрутизатора, используемого для динамической маршрутизации.
	sharedSecret строка	успех	Секретный ключ общего использования, используемый для настройки защищенного сеанса между VPN-шлюзом Cloud и peer VPN-шлюзом.
	sharedSecretHash строка	успех	Хэш секретного ключа общего использования.
	targetVpnGateway словарь	успех	URL целевого VPN-шлюза, с которым связан этот VPN-туннель.
	vpnGateway словарь	успех	URL VPN-шлюза, с которым связан этот VPN-туннель. Это необходимо, если создан ресурс высокодоступного VPN-шлюза.
	vpnGatewayInterface целое число	успех	Идентификатор интерфейса VPN-шлюза, с которым связан этот 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_vpn_tunnel_info_module.html