gcp_compute_router_info – Сбор информации о маршрутизаторе GCP

Новая версия с версии 2.7.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

Сбор информации о маршрутизаторе GCP
Этот модуль назывался gcp_compute_router_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: gcp_compute_router_facts

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это только изменяет строку User Agent для всех запросов API.
filters список		Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2).
project строка		Проект Google Cloud Platform для использования.
region строка / обязательно		Регион, где находится маршрутизатор.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержание файла JSON учетной записи службы, либо в словаре, либо как строка JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбрана serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file, используя переменную среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
параметры 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 строка		успех	Флаг, заданный пользователем, указывающий, какой режим использовать для публикации. Допустимые значения этого поля перечисления: 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.9/modules/gcp_compute_router_info_module.html