google.cloud.gcp_compute_global_forwarding_rule_info – Сбор информации о GCP GlobalForwardingRule

Примечание

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

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

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

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

Обзор

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

Требования

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

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. Каждый дополнительный фильтр в списке будет добавлен как условие 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
для аутентификации можно задать auth_kind используя переменную среды GCP_AUTH_KIND
для аутентификации можно задать scopes используя переменную среды GCP_SCOPES
значения переменных среды будут использоваться только в случае, если значения в playbook не заданы.
параметры 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 является допустимым.
	ipVersion string			успех	Версия IP, которая будет использоваться этим глобальным правилом переадресации.
	loadBalancingScheme string			успех	Указывает, для чего используется GlobalForwardingRule. Значение INTERNAL_SELF_MANAGED означает, что это используется для внутреннего глобального HTTP(S) LB. Значение EXTERNAL означает, что это используется для внешнего глобального балансирования нагрузки (HTTP(S) LB, внешний балансировщик TCP/UDP, SSL-прокси) ПРИМЕЧАНИЕ: В настоящее время глобальные правила переадресации не могут использоваться для внутренней балансировки нагрузки.
	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.

Авторы

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