Spec-Zone.ru › Ansible

google.cloud.gcp_compute_interconnect_attachment_info модуль – Сбор информации о GCP InterconnectAttachment

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Сбор информации о GCP InterconnectAttachment

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

env_type

строка

Указывает, в какой среде Ansible выполняется этот модуль.

Это поле следует заполнять только в случае необходимости.

Изменяет только строку User Agent для всех запросов к API.

filters

список / элементы=строка

Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2).

project

строка

Проект Google Cloud Platform для использования.

region

строка / обязательно

Регион, в котором находится региональное соединение Interconnect.

scopes

список / элементы=строка

Массив используемых областей

service_account_contents

jsonarg

Содержание файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, его представляющая.

service_account_email

строка

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

service_account_file

путь

Путь к файлу JSON учетной записи службы, если тип service account выбран.

Примечания

Примечание

  • для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
  • для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
  • для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
  • Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
  • Параметры 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, изменяемый для PARTNER_PROVIDER и DEDICATED, по умолчанию BPS_10G.

Возвращается: успех

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.

Возвращается: успех

cloudRouterIpAddress

string

IPv4-адрес + длина префикса, который будет настроен на интерфейсе Cloud Router для этого подключения к интерконнекту.

Возвращается: успех

creationTimestamp

string

Метка времени создания в текстовом формате RFC3339.

Возвращается: успех

customerRouterIpAddress

string

IPv4-адрес + длина префикса, который будет настроен на под-интерфейсе маршрутизатора клиента для этого подключения к интерконнекту.

Возвращается: успех

description

string

Необязательное описание этого ресурса.

Возвращается: успех

edgeAvailabilityDomain

string

Требуемый домен доступности для подключения. Доступно только для типа PARTNER, при создании. Для повышения надежности клиенты должны настроить пару подключений, по одному на каждый домен доступности. Выбранный домен доступности будет предоставлен партнеру через ключ сопряжения, чтобы проложенный контур находился в указанном домене. Если не указано, значение будет установлено по умолчанию в AVAILABILITY_DOMAIN_ANY.

Возвращается: успех

encryption

string

Указывает предоставленный пользователем вариант шифрования этого подключения к интерконнекту: NONE — значение по умолчанию, означающее, что подключение передает незашифрованный трафик. Виртуальные машины могут отправлять трафик на это подключение или получать трафик от него.

IPSEC указывает, что подключение передает только трафик, зашифрованный устройством IPsec, например, шлюзом HA VPN. Виртуальные машины не могут напрямую отправлять трафик на такое подключение или получать трафик от него. Чтобы использовать шифрование IPsec Cloud Interconnect, создайте подключение с использованием этого параметра.

В настоящее время не доступно публично.

Возвращается: успех

googleReferenceId

string

Идентификатор ссылки Google, который следует использовать при создании запросов в службу поддержки Google или для отладки проблем с подключением на стороне сервера.

Возвращается: успех

id

string

Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.

Возвращается: успех

interconnect

string

URL базового объекта Interconnect, через который будет проходить трафик этого подключения. Требуется, если тип DEDICATED, не должен быть установлен, если тип PARTNER.

Возвращается: успех

ipsecInternalAddresses

list / elements=string

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.

Возвращается: успех

имя

строка

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

Возвращается: успех

pairingKey

строка

[Только для типа PARTNER. Отсутствует для DEDICATED]. Непрозрачный идентификатор подключения PARTNER, используемый для инициирования подготовки с выбранным партнером. Формат: “XXXXX/region/domain”.

Возвращается: успех

partnerAsn

строка

[Только для типа PARTNER. Отсутствует для DEDICATED]. Необязательный ASN BGP для маршрутизатора, который должен быть предоставлен партнером по 3-му уровню, если он настраивал BGP от имени клиента.

Возвращается: успех

privateInterconnectInfo

сложное

Информация, специфичная для InterconnectAttachment. Это свойство заполняется, если соединение, к которому он подключен, имеет тип DEDICATED.

Возвращается: успех

tag8021q

целое число

Тег инкапсуляции 802.1q, используемый для трафика между Google и клиентом, входящего и исходящего из этой сети и региона.

Возвращается: успех

регион

строка

Регион, в котором находится региональное подключение к межсоединению.

Возвращается: успех

маршрутизатор

словарь

URL облачного маршрутизатора, используемого для динамической маршрутизации. Этот маршрутизатор должен находиться в том же регионе, что и это подключение межсоединения. Подключение межсоединения автоматически подключит межсоединение к сети и региону, в которых настроен облачный маршрутизатор.

Возвращается: успех

состояние

строка

[Только для вывода] Текущее состояние функциональности этого подключения.

Возвращается: успех

тип

строка

Тип InterconnectAttachment, который вы хотите создать. По умолчанию DEDICATED.

Возвращается: успех

vlanTag8021q

целое число

Тег VLAN IEEE 802.1Q для этого подключения в диапазоне 2-4094. При использовании типа PARTNER это будет управляться по потоку.

Возвращается: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходные тексты)

© 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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API