gcp_compute_target_vpn_gateway_facts – Сбор фактов о шлюзе TargetVpnGateway GCP
Новая версия с 2.7.
Обзор
- Сбор фактов о шлюзе GCP TargetVpnGateway
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project - | Значение по умолчанию: null | Проект Google Cloud Platform для использования. |
| region - / обязательно | Регион, в котором должен находиться шлюз. | |
| scopes - | Массив используемых областей видимости. | |
| service_account_email - | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в самом плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключают друг друга.
Примеры
- name: a target vpn gateway facts
gcp_compute_target_vpn_gateway_facts:
region: us-west1
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items сложный | всегда | Список элементов | |
| creation_timestamp строка | успех | Маркер времени создания в формате RFC3339. | |
| description строка | успех | Необязательное описание этого ресурса. | |
| forwarding_rules список | успех | Список ссылок на ресурсы ForwardingRule, связанные с этим VPN-шлюзом. | |
| id целое число | успех | Уникальный идентификатор ресурса. | |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы – дефис, строчная буква или цифра, за исключением последнего символа, который не может быть дефисом. | |
| network словарь | успех | Сеть, для которой этот VPN-шлюз принимает трафик. | |
| region строка | успех | Регион, в котором должен находиться шлюз. | |
| tunnels список | успех | Список ссылок на ресурсы VpnTunnel, связанные с этим VPN-шлюзом. | |
Статус
- Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gcp_compute_target_vpn_gateway_facts_module.html
