gcp_compute_forwarding_rule_info – Сбор информации о GCP ForwardingRule
Новое в версии 2.7.
Обзор
- Сбор информации о GCP ForwardingRule
- Этот модуль назывался
gcp_compute_forwarding_rule_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: gcp_compute_forwarding_rule_facts
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| 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, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents, используя переменную среды c(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 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 complex | всегда | Список ресурсов | |
| allPorts boolean | успех | Для внутренней балансировки нагрузки TCP/UDP (т.е. схема балансировки нагрузки — INTERNAL, а протокол — TCP/UDP), установите значение в true, чтобы разрешить пересылку пакетов, адресованных любым портам, на бэкенды, настроенные с этим правилом пересылки. Используется с бэкенд-сервисом. Не может быть задано, если заданы порт или диапазон портов. | |
| backendService dictionary | успех | BackendService для приема соответствующего трафика. Используется только для внутренней балансировки нагрузки. | |
| 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-протокол, к которому относится это правило. Допустимые значения — TCP, UDP, ESP, AH, SCTP или ICMP. При схеме балансировки INTERNAL допустимы только TCP и UDP. | |
| ipVersion string | успех | ipVersion — это недопустимое поле для региональных правил пересылки. | |
| loadBalancingScheme string | успех | Это указывает, для чего будет использоваться ForwardingRule и может принимать только следующие значения: INTERNAL, EXTERNAL Значение INTERNAL означает, что это будет использоваться для внутренней балансировки сетевого трафика (TCP, UDP). Значение EXTERNAL означает, что это будет использоваться для внешней балансировки нагрузки (HTTP(S) LB, внешняя балансировка TCP/UDP, SSL-прокси). | |
| name string | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network dictionary | успех | Для внутренней балансировки нагрузки это поле идентифицирует сеть, к которой должен принадлежать IP-адрес, сбалансированный по нагрузке, для данного правила пересылки. Если это поле не указано, будет использоваться сеть по умолчанию. Это поле используется только для внутренней балансировки нагрузки. | |
| networkTier string | успех | Уровень сети, используемый для настройки этого адреса. Это поле может принимать следующие значения: PREMIUM или STANDARD. Если это поле не указано, предполагается, что это PREMIUM. | |
| 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 . | |
| ports list | успех | Это поле используется вместе с полем backend_service для внутренней балансировки нагрузки. При схеме балансировки INTERNAL можно настроить один порт или список портов, разделенных запятыми. Только пакеты, адресованные этим портам, будут пересылаться на бэкенды, настроенные с этим правилом пересылки. Вы можете указать максимальное количество до 5 портов. | |
| region string | успех | Ссылка на регион, где находится региональное правило пересылки. Это поле не применимо к глобальным правилам пересылки. | |
| serviceLabel string | успех | Необязательный префикс имени службы для этого правила пересылки. Если указано, будет первым меткой полностью квалифицированного имени службы. Метка должна быть длиной от 1 до 63 символов и соответствовать RFC1035. Точнее, метка должна быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Это поле используется только для внутренней балансировки нагрузки. | |
| serviceName string | успех | Внутреннее полное квалифицированное имя службы для этого правила пересылки. Это поле используется только для внутренней балансировки нагрузки. | |
| subnetwork dictionary | успех | Подсеть, к которой должен принадлежать IP-адрес, сбалансированный по нагрузке, для данного правила пересылки. Это поле используется только для внутренней балансировки нагрузки. Если указанная сеть находится в режиме автоматической подсети, это поле необязательно. Однако, если сеть находится в режиме пользовательской подсети, подсеть необходимо указать. | |
| target dictionary | успех | Это поле используется только для внешней балансировки нагрузки. Ссылка на ресурс TargetPool для приема соответствующего трафика. Этот целевой объект должен находиться в том же регионе, что и правило пересылки. Пересылаемый трафик должен быть соответствующего типа для целевого объекта. | |
Состояние
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_compute_forwarding_rule_info_module.html
