google.cloud.gcp_compute_target_vpn_gateway – Создаёт GCP TargetVpnGateway

Примечание

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_target_vpn_gateway.

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

Описание

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка		Необязательное описание этого ресурса.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Это поле не нужно устанавливать, если вы не знаете, что делаете. Это поле влияет только на строку User-Agent для любых запросов API.
name строка / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network словарь / обязательно		Сеть, для которой этот VPN-шлюз принимает трафик. Это поле представляет ссылку на ресурс сети в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, можно добавить `register: имя-ресурса` к задаче gcp_compute_network, а затем установить это поле сети на "{{ имя-ресурса }}"
project строка		Проект Google Cloud Platform, который нужно использовать.
region строка / обязательно		Регион, в котором должен находиться шлюз.
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/v1/targetVpnGateways
для аутентификации вы можете установить 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 address
  google.cloud.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
  google.cloud.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
  google.cloud.gcp_compute_target_vpn_gateway:
    name: test_object
    region: us-west1
    network: "{{ network }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Возвращаемое значение	Описание
creationTimestamp строка	успех	Маркер создания в формате RFC3339.
description строка	успех	Необязательное описание этого ресурса.
forwardingRules список / элементы=строка	успех	Список ссылок на ресурсы ForwardingRule, связанные с этим VPN-шлюзом.
id целое число	успех	Уникальный идентификатор ресурса.
name строка	успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network словарь	успех	Сеть, для которой этот VPN-шлюз принимает трафик.
region строка	успех	Регион, в котором должен находиться шлюз.
tunnels список / элементы=строка	успех	Список ссылок на ресурсы VpnTunnel, связанные с этим 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_target_vpn_gateway_module.html