Модуль google.cloud.gcp_compute_interconnect_attachment – Создаёт соединение GCP InterconnectAttachment
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Вам, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для подробностей.
Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_interconnect_attachment.
Описание
- Представляет ресурс InterconnectAttachment (присоединение VLAN). Для получения дополнительной информации см. Создание присоединений VLAN.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
admin_enabled boolean | Включено или отключено подключение VLAN. При использовании типа PARTNER это предварительно активирует подключение к сети. Варианты:
|
auth_kind string / required | Тип используемых учетных данных. Варианты:
|
bandwidth string | Обеспеченная пропускная способность для подключения к сети. Для подключений типа 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, во время создания. Для повышения надежности клиенты должны настроить пару подключений, по одному в каждом домене доступности. Выбранный домен доступности будет предоставлен партнеру через ключ сопряжения, чтобы проложенный канал находился в указанном домене. Если не указано, значение будет установлено по умолчанию в AVAILABILITY_DOMAIN_ANY. |
encryption string | Указывает предоставленный пользователем вариант шифрования этого подключения к сети: NONE — это значение по умолчанию, что означает, что подключение передает незашифрованный трафик. Виртуальные машины могут отправлять трафик на это подключение или получать трафик от него. IPSEC указывает, что подключение передает только трафик, зашифрованный устройством IPsec, таким как шлюз HA VPN. Виртуальные машины не могут напрямую отправлять трафик на такое подключение или получать трафик от него. Чтобы использовать Cloud Interconnect с шифрованием IPsec, создайте подключение, используя этот параметр. В настоящее время не доступно публично. Некоторые допустимые варианты включают: «NONE», «IPSEC» По умолчанию: |
env_type string | Указывает, в какой среде Ansible вы запускаете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API. |
interconnect string | URL базового объекта Interconnect, через который будет проходить трафик этого подключения. Обязательно, если тип DEDICATED, не должно быть установлено, если тип PARTNER. |
ipsec_internal_addresses list / elements=dictionary | URL адресов, зарезервированных для подключения к сети. Используется только для подключения к сети, имеющего параметр шифрования IPSEC. Адреса должны быть диапазонами IP-адресов RFC 1918. При создании шлюза HA VPN через подключение к сети, если подключение настроено на использование IP-адреса RFC 1918, то IP-адрес шлюза VPN будет выделен из диапазона IP-адресов, указанного здесь. Например, если интерфейс 0 шлюза HA VPN сопряжен с этим подключением к сети, то IP-адрес RFC 1918 для интерфейса 0 шлюза VPN будет выделен из диапазона IP-адресов, указанного для этого подключения к сети. Если это поле не указано для подключения к сети, имеющего параметр шифрования IPSEC, позже при создании шлюза HA VPN на этом подключении к сети IP-адрес шлюза HA VPN будет выделен из регионального пула внешних IP-адресов. |
mtu string | Максимальный размер передаваемого блока (MTU) в байтах пакетов, проходящих через это подключение к сети. В настоящее время разрешены только 1440 и 1500. Если не указано, значение будет установлено по умолчанию в 1440. |
name string / required | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. |
project string | Проект Google Cloud Platform для использования. |
region string / required | Регион, где находится региональное подключение к сети. |
маршрутизатор словарь / обязательный | URL облачного маршрутизатора, используемого для динамической маршрутизации. Этот маршрутизатор должен находиться в той же зоне, что и этот InterconnectAttachment. InterconnectAttachment автоматически подключит Interconnect к сети и региону, в котором настроен облачный маршрутизатор. Это поле представляет ссылку на ресурс маршрутизатора в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя_ресурса` к задаче gcp_compute_router, а затем установить это поле маршрутизатора на «{{ имя_ресурса }}» |
области список / элементы=строка | Массив областей, которые будут использоваться |
содержимое_учета_службы jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо как строка JSON, его представляющая. |
эл_адрес_учета_службы строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
файл_учета_службы путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран. |
состояние строка | Нужно ли создать указанный объект в GCP Варианты:
|
тип строка | Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED. Некоторые допустимые значения включают: «DEDICATED», «PARTNER», «PARTNER_PROVIDER» |
тег_vlan_8021q целое число | Тег 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 | Включено или отключено подключение VLAN. При использовании типа PARTNER это предварительно активирует подключение к сети Interconnect. Возвращено: success |
bandwidth string | Запрошенная пропускная способность для подключения к сети Interconnect. Для подключений типа DEDICATED пользователь может установить пропускную способность. Для подключений типа PARTNER Google Partner, который управляет соединением, должен установить пропускную способность. Вывод только для типа PARTNER, изменяемый для PARTNER_PROVIDER и DEDICATED, по умолчанию BPS_10G. Возвращено: success |
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. Возвращено: success |
cloudRouterIpAddress string | IPv4-адрес + длина префикса, который будет настроен на интерфейсе Cloud Router для этого подключения к сети Interconnect. Возвращено: success |
creationTimestamp string | Метка времени создания в текстовом формате RFC3339. Возвращено: success |
customerRouterIpAddress string | IPv4-адрес + длина префикса, который будет настроен на под-интерфейсе маршрутизатора клиента для этого подключения к сети Interconnect. Возвращено: success |
description string | Необязательное описание этого ресурса. Возвращено: success |
edgeAvailabilityDomain string | Требуемый домен доступности для подключения. Доступно только для типа PARTNER, во время создания. Для повышения надежности клиенты должны настроить пару подключений, по одному в каждом домене доступности. Выбранный домен доступности будет предоставлен партнеру через ключ сопряжения, чтобы подготовленная цепь находилась в указанном домене. Если не указано, значение будет установлено по умолчанию в AVAILABILITY_DOMAIN_ANY. Возвращено: success |
encryption string | Указывает предоставленный пользователем параметр шифрования этого подключения к сети Interconnect: NONE — значение по умолчанию, что означает, что подключение передает незашифрованный трафик. Виртуальные машины могут отправлять трафик на это подключение или получать от него трафик. IPSEC указывает, что подключение передает только трафик, зашифрованный устройством IPsec, таким как шлюз HA VPN. Виртуальные машины не могут напрямую отправлять трафик на такое подключение или получать от него трафик. Чтобы использовать шифрование IPsec Cloud Interconnect, создайте подключение с помощью этого параметра. В настоящее время не доступно публично. Возвращено: success |
googleReferenceId string | Идентификатор ссылки Google, который следует использовать при создании запросов в службу поддержки Google или для отладки проблем с подключением к серверной части. Возвращено: success |
id string | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. Возвращено: success |
interconnect string | URL базового объекта Interconnect, через который будет проходить трафик этого подключения. Требуется, если тип DEDICATED, не должен быть установлен, если тип PARTNER. Возвращено: success |
ipsecInternalAddresses list / elements=string | URL адресов, которые были зарезервированы для подключения к сети Interconnect, используется только для подключения к сети Interconnect, которое имеет параметр шифрования IPSEC. Адреса должны быть диапазонами IP-адресов RFC 1918. При создании шлюза HA VPN через подключение к сети Interconnect, если подключение настроено на использование IP-адреса RFC 1918, то IP-адрес шлюза VPN будет выделен из указанного здесь диапазона IP-адресов. Например, если интерфейс 0 шлюза HA VPN сопоставлен с этим подключением к сети Interconnect, то IP-адрес RFC 1918 для интерфейса 0 шлюза VPN будет выделен из указанного для этого подключения к сети Interconnect IP-адреса. Если это поле не указано для подключения к сети Interconnect, имеющего параметр шифрования IPSEC, позже при создании шлюза HA VPN на этом подключении к сети Interconnect IP-адрес шлюза HA VPN будет выделен из регионального пула внешних IP-адресов. Возвращено: success |
mtu string | Максимальная единица передачи (MTU) в байтах пакетов, проходящих через это подключение к сети Interconnect. В настоящее время разрешены только 1440 и 1500. Если не указано, значение будет установлено по умолчанию в 1440. Возвращено: success |
name string | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов, и оно должно соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращено: success |
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 облачного маршрутизатора, используемого для динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение межсоединения. Подключение межсоединения автоматически подключит межсоединение к сети и региону, в котором настроен облачный маршрутизатор. Возвращается: успех |
state string | [Только для вывода] Текущее состояние функциональности этого подключения. Возвращается: успех |
type string | Тип InterconnectAttachment, который требуется создать. По умолчанию DEDICATED. Возвращается: успех |
vlanTag8021q integer | Тег VLAN IEEE 802.1Q для этого подключения в диапазоне 2-4094. При использовании типа PARTNER он будет управляться по потоку. Возвращается: успех |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_interconnect_attachment_module.html