Модуль google.cloud.gcp_compute_vpn_tunnel_info — сбор сведений о GCP VpnTunnel
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_vpn_tunnel_info.
Краткое описание
- Сбор сведений о GCP VpnTunnel
Требования
На хосте, который выполняет этот модуль, должны быть установлены следующие компоненты.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает среду Ansible, в которой выполняется этот модуль. Не следует задавать этот параметр, если вы не уверены в своих действиях. Этот параметр изменяет только строку User Agent для всех запросов к API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 and filter2). |
project string | Проект Google Cloud Platform, который будет использоваться. |
region string / обязательный | Регион, в котором находится туннель. |
scopes list / элементы=string | Массив областей доступа, которые будут использоваться |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей это содержимое. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано значение machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- для аутентификации можно задать 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: get info on a vpn tunnel
gcp_compute_vpn_tunnel_info:
region: us-west1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Возвращается: при успехе |
|
id string |
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. Возвращается: при успехе |
|
ikeVersion integer |
Версия протокола IKE, используемая при установлении VPN-туннеля с одноранговым VPN-шлюзом. Допустимые версии IKE — 1 или 2. Версия по умолчанию — 2. Возвращается: при успехе |
|
localTrafficSelector list / элементы=string |
Локальный селектор трафика, используемый при установлении VPN-туннеля с одноранговым VPN-шлюзом. Значение должно быть строкой в формате CIDR, например `192.168.0.0/16`. Диапазоны не должны пересекаться. Поддерживается только IPv4. Возвращается: при успехе |
|
name string |
Имя ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной латинской буквой, а все последующие — дефисом, строчной латинской буквой или цифрой, за исключением последнего символа, которым не может быть дефис. Возвращается: при успехе |
|
peerExternalGateway dictionary |
URL внешнего VPN-шлюза на стороне узла-партнера, к которому подключен этот VPN-туннель. Возвращается: при успехе |
|
peerExternalGatewayInterface integer |
Идентификатор интерфейса внешнего VPN-шлюза, к которому подключен этот VPN-туннель. Возвращается: при успехе |
|
peerGcpGateway dictionary |
URL VPN-шлюза HA GCP на стороне узла-партнера, к которому подключен этот VPN-туннель. Если указан этот параметр, VPN-туннель будет автоматически использовать тот же идентификатор vpn_gateway_interface на одноранговом VPN-шлюзе GCP. Возвращается: при успехе |
|
peerIp string |
IP-адрес однорангового VPN-шлюза. Поддерживается только IPv4. Возвращается: при успехе |
|
region string |
Регион, в котором находится туннель. Возвращается: при успехе |
|
remoteTrafficSelector list / элементы=string |
Удаленный селектор трафика, используемый при установлении VPN-туннеля с одноранговым VPN-шлюзом. Значение должно быть строкой в формате CIDR, например `192.168.0.0/16`. Диапазоны не должны пересекаться. Поддерживается только IPv4. Возвращается: при успехе |
|
router dictionary |
URL ресурса маршрутизатора, используемого для динамической маршрутизации. Возвращается: при успехе |
|
string |
Общий секрет, используемый для установления защищенного сеанса между шлюзом Cloud VPN и одноранговым VPN-шлюзом. Возвращается: при успехе |
|
string |
Хеш общего секрета. Возвращается: при успехе |
|
targetVpnGateway dictionary |
URL целевого VPN-шлюза, с которым связан этот VPN-туннель. Возвращается: при успехе |
|
vpnGateway dictionary |
URL VPN-шлюза, с которым связан этот VPN-туннель. Этот параметр необходимо использовать при создании ресурса VPN-шлюза высокой доступности. Возвращается: при успехе |
|
vpnGatewayInterface integer |
Идентификатор интерфейса VPN-шлюза, с которым связан этот 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_vpn_tunnel_info_module.html