google.cloud.gcp_compute_interconnect_attachment – Создаёт GCP InterconnectAttachment

Примечание

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

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

Для использования в плейбуке укажите: google.cloud.gcp_compute_interconnect_attachment.

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

Описание

Представляет ресурс InterconnectAttachment (присоединение VLAN). Подробнее см. Создание присоединений VLAN.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_enabled boolean	Варианты: no yes Значение по умолчанию: "true"	Включено или выключено подключение VLAN. При использовании типа PARTNER это предварительно активирует соединение Interconnect.
auth_kind string / required	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
bandwidth string		Пропускная способность для присоединения Interconnect. Для присоединений типа DEDICATED пользователь может установить пропускную способность. Для присоединений типа PARTNER пропускную способность должен установить Google Partner, управляющий соединением Interconnect. Только для чтения для типа PARTNER, изменяемый для PARTNER_PROVIDER и DEDICATED. Значение по умолчанию BPS_10G. Некоторые допустимые значения: "BPS_50M", "BPS_100M", "BPS_200M", "BPS_300M", "BPS_400M", "BPS_500M", "BPS_1G", "BPS_2G", "BPS_5G", "BPS_10G", "BPS_20G", "BPS_50G"
candidate_subnets list / elements=string		До 16 кандидатских префиксов, которые могут использоваться для ограничения выделения cloudRouterIpAddress и customerRouterIpAddress для этого подключения. Все префиксы должны находиться в пространстве адресов link-local (169.254.0.0/16) и быть не длиннее /29 (/28, /27 и т.д.). Google попытается выбрать неиспользуемый /29 из предоставленного префикса(ов). Запрос завершится ошибкой, если все возможные /29 уже заняты на стороне Google. Если не указано, Google случайным образом выберет неиспользуемый /29 из всего пространства link-local.
description string		Необязательное описание этого ресурса.
edge_availability_domain string		Желаемая область доступности для подключения. Доступно только для типа PARTNER при создании. Для повышения надёжности клиенты должны настроить пару подключений, по одному на область доступности. Выбранная область доступности будет предоставлена Partner через ключ сопряжения, чтобы предоставленный канал располагался в указанной области. Если не указано, значение по умолчанию AVAILABILITY_DOMAIN_ANY.
env_type string		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это влияет только на строку User Agent для всех запросов API.
interconnect string		URL базового объекта Interconnect, через который будет проходить трафик этого подключения. Требуется, если тип DEDICATED, не должен быть установлен, если тип PARTNER.
name string / required		Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять 1–63 символа и соответствовать RFC1035. То есть имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
project string		Проект Google Cloud Platform для использования.
region string / required		Регион, в котором находится региональное подключение Interconnect.
router dictionary / required		URL маршрутизатора cloud для использования динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение InterconnectAttachment. InterconnectAttachment автоматически подключит Interconnect к сети и региону, в котором настроен маршрутизатор Cloud. Это поле представляет собой ссылку на ресурс Router в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Альтернативно, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_router, а затем установить это поле router в "{{ имя-ресурса }}"
scopes list / elements=string		Массив используемых областей
service_account_contents jsonarg		Содержание файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, его представляющей.
service_account_email string		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file path		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state string	Варианты: present ← absent	Требуется ли существование данного объекта в GCP
type string		Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED. Некоторые допустимые значения: "DEDICATED", "PARTNER", "PARTNER_PROVIDER"
vlan_tag8021q integer		Тег VLAN IEEE 802.1Q для этого подключения в диапазоне 2-4094. При использовании типа PARTNER будет управляться входящей стороной.

Примеры

- name: create a interconnect attachment
  google.cloud.gcp_compute_interconnect_attachment:
    name: test_object
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    interconnect: https://googleapis.com/compute/v1/projects/test_project/global/interconnects/...
    router: https://googleapis.com/compute/v1/projects/test_project/regions/us-central1/routers/...
    service_account_file: "/tmp/auth.pem"
    state: present
  register: disk

Возвращаемые значения

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

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