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

Новая версия с 2.7.

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

Обзор

Сбор информации о туннеле GCP VpnTunnel
Этот модуль назывался gcp_compute_vpn_tunnel_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_compute_vpn_tunnel_facts

Требования

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

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. Каждый дополнительный фильтр в списке будет добавлен как условие И (фильтр1 и фильтр2).
project строка		Проект Google Cloud Platform, который нужно использовать.
region строка / обязательно		Регион расположения туннеля.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.

Примечания

Примечание

для проверки подлинности можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
для проверки подлинности можно установить service_account_contents с помощью переменной среды c(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 строка	успех	Необязательное описание этого ресурса.
	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-туннель.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [бета]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/gcp_compute_vpn_tunnel_info_module.html