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 строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description -		Необязательное описание этого ресурса.
name - / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно содержать 1-63 символа и соответствовать RFC1035. То есть, имя должно содержать 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network - / обязательно		Сеть, для которой этот шлюз VPN принимает трафик. Это поле представляет ссылку на ресурс Network в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, можно добавить `register: имя-ресурса` к задаче gcp_compute_network, а затем установить это поле network в "{{ имя-ресурса }}"
project строка		Проект Google Cloud Platform, который использовать.
region - / обязательно		Регион, в котором должен находиться этот шлюз.
scopes список		Массив используемых областей действия.
service_account_contents строка		Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка, содержащая точное содержимое файла 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_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить 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: 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.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [бета]
Этот модуль поддерживается сообществом 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.8/modules/gcp_compute_target_vpn_gateway_module.html