Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_forwarding_rule_info — Сбор информации о GCP ForwardingRule

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_forwarding_rule_info.

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

Обзор

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

Требования

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

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

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

project

строка

Проект Google Cloud Platform, который нужно использовать.

region

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

Ссылка на регион, в котором находится региональная правила переадресации.

Это поле неприменимо к глобальным правилам переадресации.

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 forwarding rule
  gcp_compute_forwarding_rule_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Значения возврата

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

Ключ

Описание

resources

сложный

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

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

allowGlobalAccess

логическое

Если true, клиенты могут получить доступ к ILB из всех регионов.

В противном случае доступ разрешен только из локального региона, в котором находится ILB.

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

allPorts

логическое

Для внутренней балансировки TCP/UDP (т.е. схема балансировки INTERNAL, протокол TCP/UDP), установите значение true, чтобы разрешить перенаправление пакетов, адресованных любым портам, на бэкенды, настроенные с этой правилом переадресации. Используется с бэкенд-сервисом. Не может быть установлено, если заданы порт или диапазон портов.

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

backendService

словарь

BackendService для получения соответствующего трафика. Используется только для внутренней балансировки.

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

creationTimestamp

строка

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

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

description

строка

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

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

id

целое число

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

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

IPAddress

строка

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

строка

Протокол IP, к которому применяется это правило.

При INTERNAL-схеме балансировки допустимы только TCP и UDP.

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

isMirroringCollector

логическое

Указывает, может ли этот балансировщик использоваться в качестве коллектора для зеркалирования пакетов. Чтобы предотвратить петли зеркалирования, экземпляры за этим балансировщиком не будут зеркалировать свой трафик, даже если к ним применяется правило PacketMirroring. Это свойство может быть установлено только для балансировщиков с loadBalancingScheme, установленным в INTERNAL.

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

loadBalancingScheme

строка

Указывает назначение правила переадресации: EXTERNAL, INTERNAL или INTERNAL_MANAGED. EXTERNAL используется для шлюзов Classic Cloud VPN, переадресации протоколов на ВМ с внешнего IP-адреса, и HTTP(S), SSL Proxy, TCP Proxy и сетевых TCP/UDP балансировщиков.

INTERNAL используется для переадресации протоколов на ВМ с внутреннего IP-адреса и внутренних TCP/UDP балансировщиков.

INTERNAL_MANAGED используется для внутренних HTTP(S) балансировщиков.

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

name

строка

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

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

network

словарь

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

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

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

networkTier

строка

Сеть-уровень, используемый для настройки этого адреса. Если это поле не указано, предполагается PREMIUM.

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

Диапазон портов (portRange)

строка

Это поле используется совместно с полем 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

Порты (ports)

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

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

При схеме балансировки INTERNAL можно настроить один порт или список портов, разделенных запятыми. Только пакеты, адресованные этим портам, будут перенаправлены на бэкенды, настроенные с этим правилом переадресации.

Вы можете указать не более 5 портов.

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

Регион (region)

строка

Ссылка на регион, в котором находится региональное правило переадресации.

Это поле не применимо к глобальным правилам переадресации.

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

Метка сервиса (serviceLabel)

строка

Необязательный префикс к имени сервиса для этого правила переадресации.

Если указан, будет первой меткой полностью квалифицированного имени сервиса.

Метка должна иметь длину от 1 до 63 символов и соответствовать RFC1035.

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

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

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

Имя сервиса (serviceName)

строка

Внутреннее полностью квалифицированное имя сервиса для этого правила переадресации.

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

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

Подсеть (subnetwork)

словарь

Подсеть, к которой должна принадлежать IP-адрес, сбалансированный по нагрузке, для этого правила переадресации. Это поле используется только для внутреннего балансирования нагрузки.

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

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

Целевой ресурс (target)

строка

URL целевого ресурса, который должен получать соответствующий трафик.

Целевой ресурс должен находиться в том же регионе, что и правило переадресации.

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

Возвращаемое значение: 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_forwarding_rule_info_module.html

Spec-Zone.ru

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