google.cloud.gcp_compute_interconnect_attachment_info – Сбор информации о GCP InterconnectAttachment

Примечание

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

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_compute_interconnect_attachment_info.

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

Описание

Сбор информации о GCP InterconnectAttachment

Требования

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

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 an interconnect attachment
  gcp_compute_interconnect_attachment_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
resources complex			всегда	Список ресурсов
	adminEnabled boolean		успех	Включена или выключена привязка VLAN. При использовании типа PARTNER это предварительно активирует подключение межсетевого соединения.
	bandwidth string		успех	Зарезервированная пропускная способность для подключения межсетевого соединения. Для подключений типа DEDICATED пользователь может задать пропускную способность. Для подключений типа PARTNER пропускную способность должен задать Google Partner, который управляет межсетевым соединением. Только для вывода типа PARTNER, изменяемое для PARTNER_PROVIDER и DEDICATED, по умолчанию BPS_10G.
	candidateSubnets list / elements=string		успех	До 16 кандидатских префиксов, которые могут использоваться для ограничения распределения cloudRouterIpAddress и customerRouterIpAddress для этого подключения. Все префиксы должны находиться в пространстве адресов link-local (169.254.0.0/16) и должны быть /29 или короче (/28, /27 и т. д.). Google попытается выбрать неиспользуемый /29 из предоставленного кандидатского префикса (или префиксов). Запрос завершится ошибкой, если все возможные /29 уже используются на краю Google. Если не предоставлены, Google случайным образом выберет неиспользуемый /29 из всего пространства link-local.
	cloudRouterIpAddress string		успех	IPv4-адрес + длина префикса для настройки интерфейса маршрутизатора Cloud для этого подключения межсетевого соединения.
	creationTimestamp string		успех	Дата и время создания в формате RFC3339.
	customerRouterIpAddress string		успех	IPv4-адрес + длина префикса для настройки подинтерфейса маршрутизатора клиента для этого подключения межсетевого соединения.
	description string		успех	Необязательное описание этого ресурса.
	edgeAvailabilityDomain string		успех	Требуемый домен доступности для подключения. Доступен только для типа PARTNER во время создания. Для повышения надежности пользователи должны настроить пару подключений, по одному на домен доступности. Выбранный домен доступности будет предоставлен партнеру через ключ сопряжения, чтобы предоставленная линия находилась в указанном домене. Если не указано, значение по умолчанию — AVAILABILITY_DOMAIN_ANY.
	googleReferenceId string		успех	Идентификатор ссылки Google, используемый при подаче запросов в службу поддержки Google или для отладки проблем с подключением к обратному каналу.
	id string		успех	Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером.
	interconnect string		успех	URL базового объекта Interconnect, через который будет проходить трафик этого подключения. Требуется, если тип DEDICATED, не должен быть задан, если тип PARTNER.
	name string		успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов, и оно должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
	pairingKey string		успех	[Только для вывода типа PARTNER. Отсутствует для DEDICATED]. Непрозрачный идентификатор подключения PARTNER, используемый для инициирования подготовки с выбранным партнёром. Формат "XXXXX/region/domain".
	partnerAsn string		успех	[Только для вывода типа PARTNER. Отсутствует для DEDICATED]. Необязательный ASN BGP для маршрутизатора, который должен быть предоставлен партнёром уровня 3, если они настраивали BGP от имени клиента.
	privateInterconnectInfo complex		успех	Информация, специфичная для InterconnectAttachment. Это свойство заполняется, если межсетевое соединение, к которому он подключён, имеет тип DEDICATED.
		tag8021q integer	успех	Тег инкапсуляции 802.1q, используемый для трафика между Google и клиентом, входящего и исходящего из этой сети и региона.
	region string		успех	Регион, в котором находится региональное подключение межсетевого соединения.
	router dictionary		успех	URL маршрутизатора облака, который используется для динамического маршрутизирования. Этот маршрутизатор должен находиться в том же регионе, что и это подключение межсетевого соединения. InterconnectAttachment автоматически подключит Interconnect к сети и региону, в котором настроен маршрутизатор Cloud.
	state string		успех	[Только для вывода] Текущее состояние функциональности этого подключения.
	type string		успех	Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED.
	vlanTag8021q integer		успех	Тег VLAN IEEE 802.1Q для этого подключения в диапазоне 2-4094. При использовании типа PARTNER это будет управляться по потоку.

Авторы

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_interconnect_attachment_info_module.html