google.cloud.gcp_compute_external_vpn_gateway – Создаёт шлюз GCP ExternalVpnGateway

Примечание

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

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

Для использования в плейбуке укажите: google.cloud.gcp_compute_external_vpn_gateway.

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

Описание

Представляет шлюз VPN, управляемый вне GCP.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка			Необязательное описание этого ресурса.
env_type строка			Указывает, в какой среде Ansible выполняется этот модуль. Это не нужно устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов API.
interfaces список / элементы=словарь			Список интерфейсов этого внешнего шлюза VPN.
	id целое число		Числовой идентификатор этого интерфейса. Допустимые значения зависят от типа резервирования этого внешнего шлюза VPN * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` .
	ip_address строка		IP-адрес интерфейса во внешнем шлюзе VPN. Поддерживается только IPv4. Этот IP-адрес может быть получен от вашего шлюза на предприятии или от шлюза VPN другого провайдера облачных сервисов, это не может быть IP-адрес из Google Compute Engine.
name строка / обязательно			Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project строка			Проект Google Cloud Platform, который следует использовать.
redundancy_type строка			Указывает тип резервирования этого внешнего шлюза VPN. Некоторые допустимые значения включают: "FOUR_IPS_REDUNDANCY", "SINGLE_IP_INTERNALLY_REDUNDANT", "TWO_IPS_REDUNDANCY"
scopes список / элементы=строка			Массив используемых областей
service_account_contents jsonarg			Содержание файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, которая его представляет.
service_account_email строка			Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь			Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state строка		Варианты: present ← absent	Нужно ли, чтобы данный объект существовал в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/beta/externalVpnGateways
для аутентификации можно установить 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: create a external vpn gateway
  google.cloud.gcp_compute_external_vpn_gateway:
    name: test_object
    redundancy_type: SINGLE_IP_INTERNALLY_REDUNDANT
    descrpition: An externalyl managed VPN gateway
    interfaces:
    - id: 0
      ip_address: 8.8.8.8
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ		Возвращаемое значение	Описание
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–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_external_vpn_gateway_module.html