Модуль google.cloud.gcp_compute_router_info — Сбор информации о маршрутизаторе GCP
Примечание
Этот модуль является частью коллекции google.cloud (версия 1.4.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (фильтр1 и фильтр2). |
project строка | Проект Google Cloud Platform для использования. |
region строка / обязательно | Регион, в котором находится маршрутизатор. |
scopes список / элементы=строка | Массив используемых областей |
service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, представляющая его. |
service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу 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 сложный | Список ресурсов Возвращается: всегда |
|
bgp сложный |
Информация BGP, специфичная для данного маршрутизатора. Возвращается: успех |
|
advertisedGroups список / элементы=строка |
Пользовательский список групп префиксов для рекламы в пользовательском режиме. Это поле может быть заполнено только если advertiseMode равен CUSTOM и рекламируется всем узлам маршрутизатора. Эти группы будут рекламироваться дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать никакие пользовательские группы. Это перечисление имеет единственное допустимое значение: ALL_SUBNETS. Возвращается: успех |
|
advertisedIpRanges сложный |
Пользовательский список отдельных IP-диапазонов для рекламы в пользовательском режиме. Это поле может быть заполнено только если advertiseMode равен CUSTOM и рекламируется всем узлам маршрутизатора. Эти IP-диапазоны будут рекламироваться дополнительно к любым указанным группам. Оставьте это поле пустым, чтобы не рекламировать никакие пользовательские IP-диапазоны. Возвращается: успех |
|
description строка |
Пользовательское описание для IP-диапазона. Возвращается: успех |
|
range строка |
IP-диапазон для рекламы. Значение должно быть строкой в формате CIDR. Возвращается: успех |
|
advertiseMode строка |
Пользовательский флаг, указывающий режим, используемый для рекламы. Возвращается: успех |
|
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 строка |
Регион, в котором находится маршрутизатор. Возвращается: успех |
Ссылки на сборку
© 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_router_info_module.html
