Модуль google.cloud.gcp_compute_vpn_tunnel_info — Сбор информации о GCP VpnTunnel
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_vpn_tunnel_info.
Описание
- Сбор информации о GCP VpnTunnel
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип аутентификации accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible запущен этот модуль. Это поле не следует устанавливать, если вы не знаете, что делаете. Это поле изменяет только строку User Agent для всех API-запросов. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform для использования. |
region строка / обязательно | Регион, в котором расположен туннель. |
scopes список / элементы=строка | Массив используемых областей |
| ... |
Примечания
Примечание
- для аутентификации можно установить 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: 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"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Key | Description |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
creationTimestamp string |
Метка времени создания в текстовом формате RFC3339. Возвращается: успех |
|
description string |
Необязательное описание этого ресурса. Возвращается: успех |
|
id string |
Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. Возвращается: успех |
|
ikeVersion integer |
Версия протокола IKE, используемая при установлении VPN-туннеля с шлюзом VPN-партнера. Допустимые версии IKE — 1 или 2. Версия по умолчанию — 2. Возвращается: успех |
|
localTrafficSelector list / elements=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 шлюза HA GCP VPN-партнера, к которому подключен этот VPN-туннель. Если указано, VPN-туннель автоматически будет использовать тот же идентификатор vpn_gateway_interface в шлюзе GCP VPN-партнера. Возвращается: успех |
|
peerIp string |
IP-адрес шлюза VPN-партнера. Поддерживается только IPv4. Возвращается: успех |
|
region string |
Регион, в котором расположен туннель. Возвращается: успех |
|
remoteTrafficSelector list / elements=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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_vpn_tunnel_info_module.html
