Spec-Zone.ru › Ansible 2.11

google.cloud.gcp_compute_vpn_tunnel – Создаёт VPN-туннель GCP

Примечание

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

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

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

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

Описание

  • Ресурс VPN-туннеля.

Требования

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_kind
строка / обязательно
    Варианты:
  • application
  • machineaccount
  • serviceaccount
Тип используемых учетных данных.
description
строка
Необязательное описание этого ресурса.
env_type
строка
Указывает, в какой среде Ansible выполняется этот модуль.
Не следует устанавливать, если вы не знаете, что делаете.
Это только изменяет строку User Agent для всех запросов API.
ike_version
целое число
Значение по умолчанию:
"2"
Версия протокола IKE, используемая при установлении VPN-туннеля с соседним шлюзом VPN.
Допустимые версии IKE — 1 или 2. Версия по умолчанию — 2.
local_traffic_selector
список / элементы=строка
Локальный селектор трафика для использования при установлении VPN-туннеля с соседним шлюзом VPN. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися.
Поддерживается только IPv4.
name
строка / обязательно
Имя ресурса. Длина имени должна составлять 1–63 символа и соответствовать RFC1035. Точнее, длина имени должна составлять 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
peer_external_gateway
словарь
URL внешнего шлюза VPN со стороны соседа, с которым подключен этот VPN-туннель.
Это поле представляет ссылку на ресурс ExternalVpnGateway в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_external_vpn_gateway и затем установить это поле peer_external_gateway в "{{ имя-ресурса }}"
peer_external_gateway_interface
целое число
ID интерфейса внешнего шлюза VPN, к которому подключен этот VPN-туннель.
peer_gcp_gateway
словарь
URL шлюза VPN GCP со стороны соседа, к которому подключен этот VPN-туннель.
При указании этого значения VPN-туннель автоматически будет использовать тот же ID vpn_gateway_interface в соседнем шлюзе GCP VPN.
Это поле представляет ссылку на ресурс VpnGateway в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_vpn_gateway и затем установить это поле peer_gcp_gateway в "{{ имя-ресурса }}"
peer_ip
строка
IP-адрес соседнего шлюза VPN. Поддерживается только IPv4.
project
строка
Проект Google Cloud Platform, который нужно использовать.
region
строка / обязательно
Регион, в котором расположен туннель.
remote_traffic_selector
список / элементы=строка
Удаленный селектор трафика для использования при установлении VPN-туннеля с соседним шлюзом VPN. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися.
Поддерживается только IPv4.
router
словарь
URL ресурса маршрутизатора, который будет использоваться для динамической маршрутизации.
Это поле представляет ссылку на ресурс Router в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_router и затем установить это поле router в "{{ имя-ресурса }}"
scopes
список / элементы=строка
Массив используемых областей.
service_account_contents
jsonarg
Содержание файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, его представляющей.
service_account_email
строка
Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file
путь
Путь к файлу JSON учетной записи службы, если тип выбран serviceaccount.
shared_secret
строка / обязательно
Секретный ключ общего использования, используемый для установки защищенного сеанса между шлюзом Cloud VPN и соседним шлюзом VPN.
state
строка
    Варианты:
  • present ←
  • absent
Следует ли наличие объекта в GCP
target_vpn_gateway
словарь
URL целевого шлюза VPN, с которым связан этот VPN-туннель.
Это поле представляет ссылку на ресурс TargetVpnGateway в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_target_vpn_gateway и затем установить это поле target_vpn_gateway в "{{ имя-ресурса }}"
vpn_gateway
словарь
URL шлюза VPN, с которым связан этот VPN-туннель.
Это обязательно, если создается ресурс шлюза VPN с высокой доступностью.
Это поле представляет ссылку на ресурс VpnGateway в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_vpn_gateway и затем установить это поле vpn_gateway в "{{ имя-ресурса }}"
vpn_gateway_interface
целое число
ID интерфейса VPN-шлюза, с которым связан этот VPN-туннель.

Примечания

Примечание

  • Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels
  • Обзор Cloud VPN: https://cloud.google.com/vpn/docs/concepts/overview
  • Сети и маршрутизация туннелей: https://cloud.google.com/vpn/docs/concepts/choosing-networks-routing
  • для аутентификации можно установить 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 network
  google.cloud.gcp_compute_network:
    name: network-vpn-tunnel
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a router
  google.cloud.gcp_compute_router:
    name: router-vpn-tunnel
    network: "{{ network }}"
    bgp:
      asn: 64514
      advertise_mode: CUSTOM
      advertised_groups:
      - ALL_SUBNETS
      advertised_ip_ranges:
      - range: 1.2.3.4
      - range: 6.7.0.0/16
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: router

- name: create a target vpn gateway
  google.cloud.gcp_compute_target_vpn_gateway:
    name: gateway-vpn-tunnel
    region: us-west1
    network: "{{ network }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: gateway

- name: create a vpn tunnel
  google.cloud.gcp_compute_vpn_tunnel:
    name: test_object
    region: us-west1
    target_vpn_gateway: "{{ gateway }}"
    router: "{{ router }}"
    shared_secret: super secret
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ Возвращаемое значение Описание
creationTimestamp
string
success
Маркер времени создания в формате RFC3339.

description
string
success
Необязательное описание данного ресурса.

id
string
success
Уникальный идентификатор ресурса. Этот идентификатор задается сервером.

ikeVersion
integer
success
Версия протокола IKE, используемая при установлении VPN-туннеля с соседним VPN-шлюзом.
Допустимые версии IKE — 1 или 2. По умолчанию используется версия 2.

localTrafficSelector
list / elements=string
success
Селектор локального трафика для использования при установлении VPN-туннеля с соседним VPN-шлюзом. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися.
Поддерживается только IPv4.

name
string
success
Имя ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

peerExternalGateway
dictionary
success
URL внешнего VPN-шлюза на стороне соседа, к которому подключен данный VPN-туннель.

peerExternalGatewayInterface
integer
success
Идентификатор интерфейса внешнего VPN-шлюза, к которому подключен данный VPN-туннель.

peerGcpGateway
dictionary
success
URL HA GCP VPN-шлюза на стороне соседа, к которому подключен данный VPN-туннель.
Если указано, VPN-туннель автоматически будет использовать тот же идентификатор vpn_gateway_interface в сопряжённом GCP VPN-шлюзе.

peerIp
string
success
IP-адрес соседнего VPN-шлюза. Поддерживается только IPv4.

region
string
success
Регион, в котором находится туннель.

remoteTrafficSelector
list / elements=string
success
Селектор удалённого трафика для использования при установлении VPN-туннеля с соседним VPN-шлюзом. Значение должно быть строкой в формате CIDR, например, `192.168.0.0/16`. Диапазоны должны быть непересекающимися.
Поддерживается только IPv4.

router
dictionary
success
URL ресурса маршрутизатора, используемого для динамической маршрутизации.

sharedSecret
string
success
Секретный ключ, используемый для установки защищённой сессии между VPN-шлюзом Google Cloud и соседним VPN-шлюзом.

sharedSecretHash
string
success
Хеш секретного ключа.

targetVpnGateway
dictionary
success
URL целевого VPN-шлюза, с которым связан данный VPN-туннель.

vpnGateway
dictionary
success
URL VPN-шлюза, с которым связан данный VPN-туннель.
Это необходимо, если создаётся ресурс VPN-шлюза с высокой доступностью.

vpnGatewayInterface
integer
success
Идентификатор интерфейса 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API