gcp_compute_forwarding_rule_facts – Сбор фактов о правилах переадресации GCP
Новое в версии 2.7.
Описание
- Сбор фактов о правилах переадресации GCP.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2) | |
| project - | По умолчанию: null | Проект Google Cloud Platform, который нужно использовать. |
| region - / обязательно | Ссылка на регион, в котором находится региональное правило переадресации. Для глобальных правил переадресации этот параметр не применяется. | |
| scopes - | Массив используемых областей. | |
| service_account_email - | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: a forwarding rule facts
gcp_compute_forwarding_rule_facts:
region: us-west1
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items сложный тип | всегда | Список элементов | |
| backend_service словарь | успех | Ссылка на BackendService для получения сопоставленного трафика. Используется для внутренней балансировки нагрузки. (не используется для внешней балансировки). | |
| creation_timestamp строка | успех | Дата и время создания в формате RFC3339. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| id целое число | успех | Уникальный идентификатор ресурса. | |
| ip_address строка | успех | IP-адрес, по которому данное правило переадресации предоставляет услуги. Адреса ограничены схемой балансировки нагрузки (EXTERNAL или INTERNAL) и областью (глобальная или региональная). При схеме балансировки EXTERNAL для глобальных правил переадресации адрес должен быть глобальным IP-адресом, а для региональных правил переадресации — адресом в той же области, что и правило переадресации. Если этот параметр пустой, будет назначен временный IPv4-адрес из той же области (глобальной или региональной). Региональное правило переадресации поддерживает только IPv4. Глобальное правило переадресации поддерживает IPv4 или IPv6. При схеме балансировки INTERNAL это может быть только IP-адрес RFC 1918, принадлежащий сети/подсети, настроенной для правила переадресации. По умолчанию, если этот параметр пустой, будет автоматически выделен временный внутренний IP-адрес из диапазона IP-адресов подсети или сети, настроенной для данного правила переадресации. Адрес может быть указан как буквальный IP-адрес или ссылка на существующий ресурс 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 . | |
| ip_protocol строка | успех | IP-протокол, к которому применяется это правило. Допустимые значения: TCP, UDP, ESP, AH, SCTP или ICMP. При схеме балансировки INTERNAL допустимы только TCP и UDP. | |
| ip_version строка | успех | Версия IP, которая будет использоваться этим правилом переадресации. Допустимые значения: IPV4 или IPV6. Это можно указать только для глобального правила переадресации. | |
| load_balancing_scheme строка | успех | Указывает назначение правила переадресации и может принимать следующие значения: INTERNAL, EXTERNAL. Значение INTERNAL означает, что оно будет использоваться для внутренней балансировки нагрузки (TCP, UDP). Значение EXTERNAL означает, что оно будет использоваться для внешней балансировки нагрузки (HTTP(S) LB, внешняя балансировка TCP/UDP, SSL-прокси). | |
| name строка | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network словарь | успех | Для внутренней балансировки нагрузки этот параметр идентифицирует сеть, к которой должен принадлежать IP-адрес балансировки нагрузки для данного правила переадресации. Если этот параметр не указан, будет использоваться сеть по умолчанию. Этот параметр не используется для внешней балансировки нагрузки. | |
| port_range строка | успех | Этот параметр используется вместе с параметром 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 строка | успех | Ссылка на область, в которой находится региональное правило переадресации. Этот параметр не применим к глобальным правилам переадресации. | |
| subnetwork словарь | успех | Ссылка на подсеть. Для внутренней балансировки нагрузки этот параметр идентифицирует подсеть, к которой должен принадлежать IP-адрес балансировки нагрузки для данного правила переадресации. Если указанная сеть находится в режиме автоматической подсети, этот параметр необязателен. Однако, если сеть находится в режиме настраиваемой подсети, подсеть необходимо указать. Этот параметр не используется для внешней балансировки нагрузки. | |
| target словарь | успех | Ссылка на ресурс 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.7/modules/gcp_compute_forwarding_rule_facts_module.html
