Модуль google.cloud.gcp_compute_global_forwarding_rule_info — сбор сведений о GCP GlobalForwardingRule
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это влияет только на строку User Agent для любых запросов к API. |
filters list / elements=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / elements=string | Массив используемых областей действия |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы — в виде словаря или строки JSON, представляющей его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file path | Путь к 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). Значение EXTERNAL означает, что правило будет использоваться для внешней глобальной балансировки нагрузки (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) (только [бета-версия](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-адрес балансировки нагрузки для этого глобального правила пересылки. Если поле не задано, будет использоваться сеть по умолчанию. Возвращается: при успехе |
|
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 . Возвращается: при успехе |
|
target string |
URL целевого ресурса, которому будут переданы совпавшие данные. Тип пересылаемого трафика должен соответствовать целевому объекту. При балансировке нагрузки INTERNAL_SELF_MANAGED допустимы только цели HTTP и HTTPS. (Только [бета-версия](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Для глобального адреса с назначением PRIVATE_SERVICE_CONNECT и addressType со значением INTERNAL допустимы только «all-apis» и «vpc-sc». Возвращается: при успехе |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_compute_global_forwarding_rule_info_module.html