gcp_compute_router_facts – Сбор фактов о маршрутизаторе GCP
Новое в версии 2.7.
Обзор
- Сбор фактов о маршрутизаторе GCP
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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. - Значения переменных окружения будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: a router facts
gcp_compute_router_facts:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие значения возврата описаны здесь, а ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| items сложный тип | всегда | Список элементов | |||
| bgp сложный тип | успех | Информация BGP, специфичная для этого маршрутизатора. | |||
| advertise_mode строка | успех | Указанный пользователем флаг, указывающий, какой режим использовать для рекламы. Допустимые значения этого перечисления: DEFAULT, CUSTOM. | |||
| advertised_groups список | успех | Список указанных пользователем групп префиксов для рекламы в режиме custom. Это поле может быть заполнено только в том случае, если advertiseMode — CUSTOM и реклама осуществляется всем peer-маршрутизаторам. Эти группы будут рекламироваться дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать никакие дополнительные группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS. | |||
| advertised_ip_ranges сложный тип | успех | Список отдельных диапазонов IP-адресов, указанных пользователем для рекламы в режиме custom. Это поле может быть заполнено только в том случае, если advertiseMode — CUSTOM и реклама осуществляется всем peer-маршрутизаторам. Эти диапазоны IP-адресов будут рекламироваться дополнительно к любым указанным группам. Оставьте это поле пустым, чтобы не рекламировать никакие дополнительные диапазоны IP-адресов. | |||
| description строка | успех | Пользовательское описание диапазона IP-адресов. | |||
| range строка | успех | Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR. | |||
| asn целое число | успех | Локальный номер автономной системы BGP (ASN). Должен быть частным ASN по RFC6996, либо 16-разрядным, либо 32-разрядным. Значение будет фиксированным для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут иметь одинаковый локальный ASN. | |||
| creation_timestamp строка | успех | Дата и время создания в формате RFC3339. | |||
| description строка | успех | Необязательное описание этого ресурса. | |||
| id целое число | успех | Уникальный идентификатор ресурса. | |||
| name строка | успех | Имя ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |||
| network словарь | успех | Ссылка на сеть, к которой принадлежит этот маршрутизатор. | |||
| region строка | успех | Регион расположения маршрутизатора. | |||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом 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_router_facts_module.html
