Модуль google.cloud.gcp_compute_target_vpn_gateway – Создает GCP TargetVpnGateway

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

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

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

Краткое описание

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / required	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Необязательное описание этого ресурса.
env_type string	Указывает, в какой среде Ansible вы запускаете этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
name string / required	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
network dictionary / required	Сеть, для которой этот шлюз VPN принимает трафик. Это поле представляет собой ссылку на ресурс сети в GCP. Его можно указать двумя способами. Во-первых, вы можете разместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` в задачу gcp_compute_network, а затем установить это поле сети в «{{ name-of-resource }}»
project string	Проект Google Cloud Platform для использования.
region string / required	Регион, в котором должен находиться этот шлюз.
scopes list / elements=string	Массив областей, которые будут использоваться
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде строки JSON, которая его представляет.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state string	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

API Reference: 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.
Для аутентификации вы можете установить access_token, используя переменную среды GCP_ACCESS_TOKEN.
Для аутентификации вы можете установить auth_kind, используя переменную среды GCP_AUTH_KIND.
Для аутентификации вы можете установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
Параметры 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_target_vpn_gateway_module.html