gcp_compute_target_vpn_gateway – Создаёт шлюз GCP TargetVpnGateway

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

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

Описание

Представляет шлюз VPN, работающий в GCP. Это виртуальное устройство управляется Google, но используется только вами.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind - / обязательно	Варианты: machineaccount serviceaccount application	Тип используемых учетных данных.
description -		Необязательное описание этого ресурса.
name - / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно содержать 1-63 символа и соответствовать RFC1035. То есть, имя должно содержать 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network - / обязательно		Сеть, для которой этот шлюз VPN принимает трафик.
project -	По умолчанию: null	Проект Google Cloud Platform для использования.
region - / обязательно		Регион, в котором должен находиться шлюз.
scopes -		Массив используемых областей.
service_account_email -		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file -		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state -	Варианты: present ← absent	Требуется ли существование данного объекта в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/targetVpnGateways
Для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: create a address
  gcp_compute_address:
      name: "address-vpngateway"
      region: us-west1
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: address

- name: create a network
  gcp_compute_network:
      name: "network-vpngateway"
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: network

- name: create a target vpn gateway
  gcp_compute_target_vpn_gateway:
      name: "test_object"
      region: us-west1
      network: "{{ network }}"
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

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

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

Ключ	Возвращённое значение	Описание
creation_timestamp строка	успех	Дата и время создания в формате RFC3339.
description строка	успех	Необязательное описание этого ресурса.
forwarding_rules список	успех	Список ссылок на ресурсы ForwardingRule, связанные с этим шлюзом VPN.
id целое число	успех	Уникальный идентификатор ресурса.
name строка	успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно содержать 1-63 символа и соответствовать RFC1035. То есть, имя должно содержать 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network словарь	успех	Сеть, для которой этот шлюз VPN принимает трафик.
region строка	успех	Регион, в котором должен находиться шлюз.
tunnels список	успех	Список ссылок на ресурсы VpnTunnel, связанные с этим шлюзом VPN.

Статус

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

Авторы

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