google.cloud.gcp_compute_interconnect_attachment – Создаёт соединение GCP InterconnectAttachment

Примечание

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

Для установки используйте: 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 это предварительно активирует соединение.
auth_kind string / required	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
bandwidth string		Пропускная способность выделенной пропускной способности для присоединения interconnect. Для присоединений типа DEDICATED пользователь может задать пропускную способность. Для присоединений типа PARTNER пропускную способность должен установить Google Partner, управляющий соединением. Только вывод для типа 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 для этого подключения. Все префиксы должны находиться в пространстве адресов link-local (169.254.0.0/16) и должны быть /29 или короче (/28, /27 и т. д.). Google попытается выбрать неиспользуемый /29 из предоставленного кандидатского префикса (префиксов). Запрос завершится ошибкой, если все возможные /29 уже заняты на краю Google. Если не указано, Google случайным образом выберет неиспользуемый /29 из всего пространства link-local.
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	Информация, специфичная для InterconnectAttachment. Этот параметр заполняется, если соединение, к которому он подключен, имеет тип DEDICATED.
	tag8021q integer	success	Тег инкапсуляции 802.1q, используемый для трафика между Google и клиентом, входящего и выходящего из этой сети и региона.
region string		success	Регион, в котором находится региональное подключение.
router dictionary		success	URL маршрутизатора облака, который будет использоваться для динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение. InterconnectAttachment автоматически подключит соединение к сети и региону, в котором настроен маршрутизатор Cloud.
state string		success	[Только для вывода] Текущее состояние функциональности этого подключения.
type string		success	Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED.
vlanTag8021q integer		success	Тег VLAN IEEE 802.1Q для этого подключения в диапазоне 2-4094. При использовании типа PARTNER он будет управляться по потоку.

Авторы

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.10/collections/google/cloud/gcp_compute_interconnect_attachment_module.html