gcp_compute_interconnect_attachment_info – Сбор информации о соединении GCP InterconnectAttachment

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

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

Обзор

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

Псевдонимы: gcp_compute_interconnect_attachment_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. Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2).
project строка		Проект Google Cloud Platform, который необходимо использовать.
region строка / обязательно		Регион, в котором находится соединение regional interconnect attachment.
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 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_PROVIDER и DEDICATED, по умолчанию BPS_10G.
	candidateSubnets list		успех	До 16 кандидатских префиксов, которые могут использоваться для ограничения выделения cloudRouterIpAddress и customerRouterIpAddress для этого подключения. Все префиксы должны находиться в пространстве адресов связи (169.254.0.0/16) и должны быть /29 или короче (/28, /27 и т. д.). Google попытается выбрать неиспользуемый /29 из предоставленного кандидатского префикса (префиксов). Запрос завершится ошибкой, если все возможные /29 заняты на внешнем узле Google. Если не указано, Google случайным образом выберет неиспользуемый /29 из всего пространства связи.
	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]. Необязательный BGP ASN для маршрутизатора, который должен быть предоставлен партнером уровня 3, если он настраивает BGP от имени клиента.
	privateInterconnectInfo complex		успех	Информация, специфичная для подключения к взаимосвязи. Этот параметр заполняется, если взаимосвязь, к которой он подключен, имеет тип DEDICATED.
		tag8021q integer	успех	Тег инкапсуляции 802.1q, который будет использоваться для трафика между Google и клиентом, входящего и исходящего из этой сети и региона.
	region string		успех	Регион, в котором находится региональное подключение к взаимосвязи.
	router dictionary		успех	URL маршрутизатора cloud для использования в динамическом маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение к взаимосвязи. Подключение к взаимосвязи автоматически подключит взаимосвязь к сети и региону, в котором настроен маршрутизатор Cloud.
	state string		успех	[Только вывод] Текущее состояние функциональности этого подключения.
	type string		успех	Тип подключения к взаимосвязи, который вы хотите создать. По умолчанию — DEDICATED.
	vlanTag8021q integer		успех	Тег VLAN IEEE 802.1Q для этого подключения в диапазоне 2-4094. При использовании типа PARTNER он будет управляться вышестоящей стороной.

Состояние

Не гарантируется обратная совместимость этого модуля. [превью]
Этот модуль поддерживается сообществом 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_interconnect_attachment_info_module.html