Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_global_forwarding_rule_info – Сбор информации о GCP GlobalForwardingRule

Примечание

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

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

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

Для использования в книге задач укажите: google.cloud.gcp_compute_global_forwarding_rule_info.

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

Описание

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

Требования

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

  • 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 для использования.

scopes

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

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

service_account_contents

jsonarg

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

service_account_email

строка

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

service_account_file

путь

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

Примечания

Примечание

  • для аутентификации можно установить 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 a global forwarding rule
  gcp_compute_global_forwarding_rule_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ

Описание

resources

complex

Список ресурсов

Возвращается: всегда

creationTimestamp

string

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

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

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

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

id

integer

Уникальный идентификатор ресурса.

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

IPAddress

string

IP-адрес, который это правило переадресации обслуживает от имени.

Адреса ограничены в зависимости от схемы балансировки нагрузки правила переадресации (EXTERNAL или INTERNAL) и области действия (глобальная или региональная).

Когда схема балансировки нагрузки EXTERNAL, для глобальных правил переадресации адрес должен быть глобальным IP-адресом, а для региональных правил переадресации адрес должен находиться в том же регионе, что и правило переадресации. Если это поле пустое, будет назначен эфемерный IPv4-адрес из той же области (глобальная или региональная). Региональное правило переадресации поддерживает только IPv4. Глобальное правило переадресации поддерживает IPv4 или IPv6.

Когда схема балансировки нагрузки INTERNAL, это может быть только IP-адрес RFC 1918, принадлежащий сети/подсети, настроенной для правила переадресации. По умолчанию, если это поле пустое, эфемерный внутренний IP-адрес будет автоматически выделен из диапазона IP-адресов подсети или сети, настроенной для этого правила переадресации.

Адрес может быть указан либо с помощью литерального IP-адреса, либо с помощью URL-ссылки на существующий ресурс Address. Следующие примеры действительны: * 100.1.2.3 * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address .

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

IPProtocol

string

IP-протокол, к которому применяется это правило. Когда схема балансировки нагрузки INTERNAL_SELF_MANAGED, допустим только TCP. Это поле не должно быть установлено, если глобальный адрес настроен как цель PRIVATE_SERVICE_CONNECT и addressType INTERNAL.

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

ipVersion

string

Версия IP, которая будет использоваться этим глобальным правилом переадресации.

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

loadBalancingScheme

string

Это указывает, для чего будет использоваться GlobalForwardingRule.

Значение INTERNAL_SELF_MANAGED означает, что оно будет использоваться для внутреннего глобального HTTP(S) LB. Значение EXTERNAL означает, что оно будет использоваться для внешней глобальной балансировки нагрузки (HTTP(S) LB, внешняя TCP/UDP LB, прокси SSL) ([Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) только) Примечание: это поле должно быть установлено в пустое значение, если глобальный адрес настроен как цель PRIVATE_SERVICE_CONNECT и addressType INTERNAL.

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

metadataFilters

complex

Непрозрачные критерии фильтрации, используемые Loadbalancer для ограничения конфигурации маршрутизации до ограниченного набора совместимых с xDS клиентов. В своих запросах xDS к Loadbalancer клиенты xDS представляют метаданные узла. Если происходит совпадение, соответствующая конфигурация маршрутизации предоставляется этим прокси.

Для каждого metadataFilter в этом списке, если его filterMatchCriteria установлен в MATCH_ANY, по крайней мере один из filterLabels должен соответствовать соответствующей метке, указанной в метаданных. Если его filterMatchCriteria установлен в MATCH_ALL, то все его filterLabels должны соответствовать соответствующим меткам в предоставленных метаданных.

metadataFilters, указанные здесь, могут быть переопределены теми, которые указаны в UrlMap, на который ссылается это ForwardingRule.

metadataFilters применяется только к Loadbalancer, у которых loadBalancingScheme установлен в INTERNAL_SELF_MANAGED.

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

filterLabels

complex

Список пар значений меток, которые должны соответствовать меткам в предоставленных метаданных на основе filterMatchCriteria. Этот список не должен быть пустым и может содержать максимум 64 записи.

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

name

string

Имя метки метаданных. Длина должна быть от 1 до 1024 символов включительно.

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

value

string

Значение, которому должна соответствовать метка. Значение имеет максимальную длину 1024 символа.

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

filterMatchCriteria

string

Указывает, как отдельные совпадения filterLabel в списке filterLabels вносят вклад в общее совпадение metadataFilter.

MATCH_ANY - По крайней мере одна из filterLabels должна иметь совпадающую метку в предоставленных метаданных.

MATCH_ALL - Все filterLabels должны иметь совпадающие метки в предоставленных метаданных.

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

name

string

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

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

network

dictionary

Это поле не используется для внешнего балансирования нагрузки.

Для балансирования нагрузки INTERNAL_SELF_MANAGED это поле идентифицирует сеть, к которой должен принадлежать IP-адрес балансируемой нагрузки для этой глобальной правила маршрутизации. Если это поле не указано, будет использована сеть по умолчанию.

Возвращаемое значение: success

portRange

string

Это поле используется вместе с полем target для TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.

Применимо только в случае IPProtocol TCP, UDP или SCTP, только пакеты, адресованные портам в указанном диапазоне, будут перенаправлены целевому устройству.

Правила перенаправления с одинаковой парой [IPAddress, IPProtocol] должны иметь непересекающиеся диапазоны портов.

Некоторые типы целевых устройств имеют ограничения на допустимые порты: * TargetHttpProxy: 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: 500, 4500 .

Возвращаемое значение: success

target

string

URL целевого ресурса для получения соответствующего трафика.

Перенаправляемый трафик должен соответствовать типу целевого объекта.

Для балансирования нагрузки INTERNAL_SELF_MANAGED допустимы только целевые объекты HTTP и HTTPS.

([Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) только) Для глобального адреса с назначением PRIVATE_SERVICE_CONNECT и типом адреса INTERNAL допустимы только «all-apis» и «vpc-sc».

Возвращаемое значение: success

Авторы

  • 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_global_forwarding_rule_info_module.html

Spec-Zone.ru

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