google.cloud.gcp_compute_forwarding_rule_info – Сбор информации о правиле переадресации GCP

Примечание

Этот плагин является частью коллекции google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud.

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

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

Описание

Сбор информации о правиле переадресации GCP

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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.
для аутентификации можно установить 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 относится к ним. Это может быть установлено только в true для балансировщиков, у которых loadBalancingScheme установлено в INTERNAL.
	loadBalancingScheme строка	успех	Это означает, для чего будет использоваться ForwardingRule, и может быть EXTERNAL, INTERNAL или INTERNAL_MANAGED. EXTERNAL используется для шлюзов Classic Cloud VPN, перенаправления протоколов на виртуальные машины из внешнего IP-адреса и HTTP(S), SSL Proxy, TCP Proxy и Network 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.
	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 .
	ports список / элементы=строка	успех	Это поле используется вместе с полем backend_service для внутреннего балансирования нагрузки. При схеме балансирования нагрузки INTERNAL можно настроить один порт или список портов, разделенных запятыми. Только пакеты, адресованные этим портам, будут пересылаться бэкендам, настроенным с этим правилом перенаправления. Можно указать не более 5 портов.
	region строка	успех	Ссылка на регион, в котором находится региональное правило перенаправления. Это поле не относится к глобальным правилам перенаправления.
	serviceLabel строка	успех	Необязательное префиксное имя сервиса для этого правила перенаправления. Если указано, будет первым меткой полного имени сервиса. Метка должна быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, метка должна быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Это поле используется только для внутреннего балансирования нагрузки.
	serviceName строка	успех	Полное внутреннее имя сервиса для этого правила перенаправления. Это поле используется только для внутреннего балансирования нагрузки.
	subnetwork словарь	успех	Подсеть, к которой должен принадлежать IP-адрес, сбалансированный по нагрузке, для этого правила перенаправления. Это поле используется только для внутреннего балансирования нагрузки. Если указанная сеть находится в режиме автоматической подсети, это поле необязательно. Однако, если сеть находится в режиме пользовательской подсети, подсеть необходимо указать.
	target строка	успех	URL целевого ресурса для получения соответствующего трафика. Целевой ресурс должен находиться в том же регионе, что и правило перенаправления. Перенаправляемый трафик должен быть соответствующего типа для целевого объекта.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_forwarding_rule_info_module.html