Модуль google.cloud.gcp_compute_external_vpn_gateway — создает ExternalVpnGateway в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
description string | Необязательное описание этого ресурса. |
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это значение влияет только на строку User Agent для всех запросов API. |
interfaces list / элементы=словарь | Список интерфейсов этого внешнего VPN-шлюза. |
|
id integer |
Числовой идентификатор этого интерфейса. Допустимые значения зависят от типа резервирования этого внешнего VPN-шлюза: * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` . |
|
ip_address string |
IP-адрес интерфейса внешнего VPN-шлюза. Поддерживается только IPv4. Этот IP-адрес может принадлежать локальному шлюзу или VPN-шлюзу другого облачного провайдера; это не может быть IP-адрес Google Compute Engine. |
name string / обязательный | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, то есть первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. |
project string | Проект Google Cloud Platform, который следует использовать. |
redundancy_type string | Указывает тип резервирования этого внешнего VPN-шлюза. Допустимые варианты: “FOUR_IPS_REDUNDANCY”, “SINGLE_IP_INTERNALLY_REDUNDANT”, “TWO_IPS_REDUNDANCY” |
scopes list / элементы=строка | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей это содержимое. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
state string | Должен ли указанный объект существовать в GCP Варианты:
|
Примечания
Примечание
- Справочник 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 string | Необязательное описание этого ресурса. Возвращается: при успехе |
interfaces complex | Список интерфейсов этого внешнего VPN-шлюза. Возвращается: при успехе |
|
id integer |
Числовой идентификатор этого интерфейса. Допустимые значения зависят от типа резервирования этого внешнего VPN-шлюза: * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` . Возвращается: при успехе |
|
ipAddress string |
IP-адрес интерфейса внешнего VPN-шлюза. Поддерживается только IPv4. Этот IP-адрес может принадлежать локальному шлюзу или VPN-шлюзу другого облачного провайдера; это не может быть IP-адрес Google Compute Engine. Возвращается: при успехе |
name string | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, то есть первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успехе |
redundancyType string | Указывает тип резервирования этого внешнего VPN-шлюза. Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_external_vpn_gateway_module.html
