gcp_compute_interconnect_attachment – Создаёт привязку GCP InterconnectAttachment

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

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

Обзор

Представляет ресурс привязки InterconnectAttachment (привязка VLAN). Для получения дополнительной информации см. Создание привязок VLAN.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_enabled boolean Добавлена в 2.9	Варианты: no yes	Включена или выключена привязка VLAN. При использовании типа PARTNER это предварительно активирует привязку межсетевого соединения.
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
bandwidth строка Добавлена в 2.9		Зарезервированная пропускная способность для привязки межсетевого соединения. Для привязок типа 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 список		До 16 кандидатских префиксов, которые могут быть использованы для ограничения выделения cloudRouterIpAddress и customerRouterIpAddress для этой привязки. Все префиксы должны находиться в пространстве адресов link-local (169.254.0.0/16) и должны быть /29 или короче (/28, /27 и т. д.). Google попытается выбрать неиспользуемый /29 из предоставленного кандидатского префикса(ов). Запрос завершится ошибкой, если все возможные /29 заняты на внешнем интерфейсе Google. Если не указаны, Google случайным образом выберет неиспользуемый /29 из всего пространства link-local.
description строка		Необязательное описание этого ресурса.
edge_availability_domain строка		Желаемый домен доступности для привязки. Доступно только для типа PARTNER при создании. Для повышения надёжности клиенты должны настроить пару привязок, по одной на домен доступности. Выбранный домен доступности будет предоставлен партнёру через ключ сопряжения, чтобы предоставленный канал находился в указанном домене. Если не указано, значение по умолчанию — AVAILABILITY_DOMAIN_ANY.
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Необходимо устанавливать только в том случае, если вы знаете, что делаете. Это влияет только на строку User Agent для всех запросов к API.
interconnect строка		URL базового объекта Interconnect, через который будет проходить трафик этой привязки. Требуется, если тип — DEDICATED; не должен быть установлен, если тип — PARTNER.
name строка / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project строка		Проект Google Cloud Platform, который необходимо использовать.
region строка / обязательно		Регион, в котором находится региональная привязка межсетевого соединения.
router словарь / обязательно		URL маршрутизатора cloud, который будет использоваться для динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и эта привязка межсетевого соединения. Привязка межсетевого соединения автоматически соединит межсетевое соединение с сетью и регионом, в котором настроен маршрутизатор Cloud. Это поле представляет ссылку на ресурс Router в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_router, а затем установить это поле маршрутизатора на "{{ имя-ресурса }}"
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное в словаре или в строке JSON.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Должен ли данный объект существовать в GCP
type строка		Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED. Некоторые допустимые значения включают: "DEDICATED", "PARTNER", "PARTNER_PROVIDER"
vlan_tag8021q целое число		Тег VLAN IEEE 802.1Q для этой привязки в диапазоне от 2 до 4094. При использовании типа PARTNER эта функция будет управляться в upstream.

Примечания

Примечание

для аутентификации можно задать 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: create a interconnect attachment
  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		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-адрес + длина префикса, который должен быть настроен на интерфейсе маршрутизатора облака для данного подключения к межсетевому соединению.
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 базового объекта межсетевого соединения, через который будет проходить трафик данного подключения. Требуется, если тип 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]. Необязательный BGP ASN для маршрутизатора, который должен быть предоставлен партнером уровня 3, если он настроен BGP от имени клиента.
privateInterconnectInfo complex		success	Информация, специфичная для InterconnectAttachment. Это свойство заполняется, если межсетевое соединение, к которому прикреплено это подключение, имеет тип DEDICATED.
	tag8021q integer	success	Тег инкапсуляции 802.1q, который должен использоваться для трафика между Google и клиентом, входящего в эту сеть и регион.
region string		success	Регион, в котором находится региональное подключение к межсетевому соединению.
router dictionary		success	URL маршрутизатора облака, который будет использоваться для динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение к межсетевому соединению. InterconnectAttachment автоматически подключит межсетевое соединение к сети и региону, в котором настроен маршрутизатор облака.
state string		success	[Только для вывода] Текущее состояние функциональности этого подключения.
type string		success	Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED.
vlanTag8021q integer		success	Тег 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_module.html