Модуль google.cloud.gcp_compute_router_info — сбор информации о маршрутизаторе GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_router_info.
Краткое описание
- Сбор информации о маршрутизаторе GCP
Требования
Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.
- 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 и 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 router
gcp_compute_router_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
resources complex | Список ресурсов Возвращается: всегда |
|
bgp complex |
Сведения BGP, относящиеся к этому маршрутизатору. Возвращается: при успехе |
|
advertisedGroups list / элементы=string |
Заданный пользователем список групп префиксов для анонсирования в пользовательском режиме. Это поле можно заполнить только при advertiseMode=CUSTOM; его значение анонсируется всем соседям маршрутизатора. Эти группы будут анонсироваться в дополнение к указанным префиксам. Оставьте это поле пустым, чтобы не анонсировать пользовательские группы. Это поле перечисления принимает единственное допустимое значение: ALL_SUBNETS. Возвращается: при успехе |
|
advertisedIpRanges complex |
Заданный пользователем список отдельных диапазонов IP-адресов для анонсирования в пользовательском режиме. Это поле можно заполнить только при advertiseMode=CUSTOM; его значение анонсируется всем соседям маршрутизатора. Эти диапазоны IP-адресов будут анонсироваться в дополнение к указанным группам. Оставьте это поле пустым, чтобы не анонсировать пользовательские диапазоны IP-адресов. Возвращается: при успехе |
|
description string |
Описание диапазона IP-адресов, заданное пользователем. Возвращается: при успехе |
|
range string |
Анонсируемый диапазон IP-адресов. Значение должно быть строкой в формате CIDR. Возвращается: при успехе |
|
advertiseMode string |
Заданный пользователем флаг, определяющий режим анонсирования. Возвращается: при успехе |
|
asn integer |
Локальный номер автономной системы BGP (ASN). Должен быть частным ASN, соответствующим RFC6996, 16- или 32-разрядным. Значение фиксируется для этого ресурса маршрутизатора. Все VPN-туннели, подключенные к этому маршрутизатору, будут использовать один и тот же локальный ASN. Возвращается: при успехе |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе |
|
description string |
Необязательное описание этого ресурса. Возвращается: при успехе |
|
id integer |
Уникальный идентификатор ресурса. Возвращается: при успехе |
|
name string |
Имя ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой; последний символ не может быть дефисом. Возвращается: при успехе |
|
network dictionary |
Ссылка на сеть, к которой относится этот маршрутизатор. Возвращается: при успехе |
|
region string |
Регион, в котором находится маршрутизатор. Возвращается: при успехе |
Ссылки на коллекцию
© 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_router_info_module.html
