Модуль google.cloud.gcp_compute_external_vpn_gateway – Создаёт GCP ExternalVpnGateway

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_external_vpn_gateway.

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

Описание

Представляет шлюз VPN, управляемый вне GCP.

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип credentials — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description строка	Необязательное описание данного ресурса.
env_type строка	Указывает, в какой среде Ansible вы запускаете этот модуль. Это следует устанавливать только в случае необходимости. Это изменяет только строку User Agent для любых запросов API.
interfaces список / элементы=словарь	Список интерфейсов на этом внешнем шлюзе VPN.
id целое число	Числовой идентификатор этого интерфейса. Допустимые значения зависят от типа избыточности этого внешнего шлюза VPN: * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` .
ip_address строка	IP-адрес интерфейса во внешнем шлюзе VPN. Поддерживается только IPv4. Этот IP-адрес может быть либо из вашего шлюза в локальной сети, либо из шлюза VPN другого поставщика облачных услуг, но не из Google Compute Engine.
name строка / обязательно	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project строка	Проект Google Cloud Platform для использования.
redundancy_type строка	Указывает тип избыточности этого внешнего шлюза VPN. Некоторые допустимые значения включают: “FOUR_IPS_REDUNDANCY”, “SINGLE_IP_INTERNALLY_REDUNDANT”, “TWO_IPS_REDUNDANCY”.
scopes список / элементы=строка	Массив используемых областей.
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, представляющей его.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран тип machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран в качестве типа.
state строка	Указывает, должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/beta/externalVpnGateways
для аутентификации вы можете установить 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.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a external vpn gateway
  google.cloud.gcp_compute_external_vpn_gateway:
    name: test_object
    redundancy_type: SINGLE_IP_INTERNALLY_REDUNDANT
    descrpition: An externalyl managed VPN gateway
    interfaces:
    - id: 0
      ip_address: 8.8.8.8
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ	Описание
description строка	Необязательное описание этого ресурса. Возвращается: успешно
interfaces сложный тип	Список интерфейсов на этом внешнем VPN шлюзе. Возвращается: успешно
id целое число	Числовой идентификатор для этого интерфейса. Допустимые значения основаны на типе избыточности этого внешнего VPN шлюза * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` . Возвращается: успешно
ipAddress строка	IP-адрес интерфейса во внешнем VPN шлюзе. Поддерживается только IPv4. Этот IP-адрес может быть либо из вашего шлюза на локальной сети, либо из VPN шлюза другого облачного провайдера, он не может быть IP-адресом Google Compute Engine. Возвращается: успешно
name строка	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается:* успешно
redundancyType строка	Указывает тип избыточности этого внешнего 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_external_vpn_gateway_module.html