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

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

Для его установки используйте: 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, используя переменную среды gcp_service_account_file.
Для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить 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 список / элементы=строка		успех	Список префиксов групп, указанных пользователем для рекламы в режиме custom. Это поле может быть заполнено только в случае, если advertiseMode равен CUSTOM и рекламируется всем peer-узлам маршрутизатора. Эти группы будут рекламироваться дополнительно к любым указанным префиксам. Оставьте это поле пустым, чтобы не рекламировать никакие дополнительные группы. Это поле перечисления имеет одно допустимое значение: ALL_SUBNETS.
		advertisedIpRanges сложное		успех	Список отдельных диапазонов IP-адресов, указанных пользователем для рекламы в режиме custom. Это поле может быть заполнено только в случае, если advertiseMode равен CUSTOM и рекламируется всем peer-узлам маршрутизатора. Эти диапазоны 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 строка			успех	Регион расположения маршрутизатора.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_router_info_module.html