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.
Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform для использования. | |
| region - / обязательно | Регион, в котором находится маршрутизатор. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а как строка с точным содержимым файла json учетной записи службы (валидный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| items сложное | всегда | Список элементов | |||
| bgp сложное | успех | Информация BGP, специфичная для этого маршрутизатора. | |||
| advertisedGroups список | успех | Пользовательский список групп префиксов для рекламы в пользовательском режиме. Это поле может быть заполнено только в случае, если advertiseMode имеет значение CUSTOM и рекламируется всем узлам-партнерам маршрутизатора. Эти группы будут рекламироваться помимо любых указанных префиксов. Оставьте это поле пустым для того, чтобы не рекламировать никакие пользовательские группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS. | |||
| advertisedIpRanges сложное | успех | Пользовательский список отдельных диапазонов IP-адресов для рекламы в пользовательском режиме. Это поле может быть заполнено только в случае, если advertiseMode имеет значение CUSTOM и рекламируется всем узлам-партнерам маршрутизатора. Эти диапазоны IP-адресов будут рекламироваться помимо любых указанных групп. Оставьте это поле пустым, чтобы не рекламировать никакие пользовательские диапазоны IP-адресов. | |||
| description строка | успех | Пользовательское описание для диапазона IP-адресов. | |||
| range строка | успех | Диапазон IP-адресов для рекламы. Значение должно быть строкой в формате CIDR. | |||
| advertiseMode строка | успех | Пользовательский флаг, указывающий, какой режим использовать для рекламы. Допустимые значения этого поля перечисления: DEFAULT, CUSTOM. | |||
| asn целое число | успех | Локальный номер автономной системы BGP (ASN). Должен быть частным ASN RFC6996, 16-разрядным или 32-разрядным. Значение будет фиксированным для данного ресурса маршрутизатора. Все VPN-туннели, которые соединяются с этим маршрутизатором, будут иметь тот же локальный ASN. | |||
| creationTimestamp строка | успех | Дата и время создания в формате RFC3339. | |||
| description строка | успех | Необязательное описание этого ресурса. | |||
| id целое число | успех | Уникальный идентификатор ресурса. | |||
| name строка | успех | Имя ресурса. Длина имени должна составлять 1–63 символа и соответствовать RFC1035. То есть, длина имени должна составлять 1–63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |||
| network словарь | успех | Ссылка на сеть, к которой принадлежит этот маршрутизатор. | |||
| region строка | успех | Регион, в котором находится маршрутизатор. | |||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/gcp_compute_router_facts_module.html
