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

Примечание

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

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

Для использования в playbook укажите: 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.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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-туннеля с узлом VPN-шлюза. Допустимые версии IKE — 1 или 2. Версия по умолчанию — 2.
	localTrafficSelector список / элементы=строка	успех	Локальный селектор трафика, используемый при установлении VPN-туннеля с узлом VPN-шлюза. Значение должно быть строкой в формате CIDR, например `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4.
	name строка	успех	Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
	peerIp строка	успех	IP-адрес узла VPN-шлюза. Поддерживается только IPv4.
	region строка	успех	Регион, в котором расположен туннель.
	remoteTrafficSelector список / элементы=строка	успех	Удаленный селектор трафика, используемый при установлении VPN-туннеля с узлом VPN-шлюза. Значение должно быть строкой в формате CIDR, например `192.168.0.0/16`. Диапазоны должны быть непересекающимися. Поддерживается только IPv4.
	router словарь	успех	URL ресурса маршрутизатора, который будет использоваться для динамической маршрутизации.
	sharedSecret строка	успех	Секретный ключ, используемый для установки защищенной сессии между шлюзом Cloud VPN и узлом VPN-шлюза.
	sharedSecretHash строка	успех	Хеш секретного ключа.
	targetVpnGateway словарь	успех	URL целевого VPN-шлюза, к которому связан этот VPN-туннель.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/google/cloud/gcp_compute_vpn_tunnel_info_module.html