gcp_compute_global_forwarding_rule_facts – Сбор фактов для GCP GlobalForwardingRule
Новое в версии 2.7.
Описание
- Сбор фактов для GCP GlobalForwardingRule
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться в виде словаря, а строкой, содержащей точное содержимое файла service account json (корректный JSON). | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран как тип. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использованы только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a global forwarding rule facts"
gcp_compute_global_forwarding_rule_facts:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items сложный | всегда | Список элементов | |
| backendService словарь | успешно | Ссылка на BackendService для получения сопоставленного трафика. Используется для внутренней балансировки нагрузки. (не используется для внешней балансировки) . | |
| creationTimestamp строка | успешно | Дата и время создания в формате RFC3339. | |
| description строка | успешно | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| id целое число | успешно | Уникальный идентификатор ресурса. | |
| IPAddress строка | успешно | IP-адрес, по которому эта правила переадресации обслуживает трафик. Адреса ограничены схемой балансировки нагрузки правила переадресации (EXTERNAL или INTERNAL) и областью (глобальная или региональная). Если схема балансировки нагрузки EXTERNAL, для глобальных правил переадресации адрес должен быть глобальным IP-адресом, а для региональных правил переадресации — адресом в том же регионе, что и правило переадресации. Если это поле пустое, будет назначен временный IPv4-адрес из той же области (глобальной или региональной). Региональное правило переадресации поддерживает только IPv4. Глобальное правило переадресации поддерживает IPv4 или IPv6. Если схема балансировки нагрузки INTERNAL, это может быть только IP-адрес RFC 1918, принадлежащий сети/подсети, настроенной для правила переадресации. По умолчанию, если это поле пустое, будет автоматически выделен временный внутренний 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-протокол, к которому применяется это правило. Допустимые значения: TCP, UDP, ESP, AH, SCTP или ICMP. При схеме балансировки нагрузки INTERNAL допустимы только TCP и UDP. | |
| ipVersion строка | успешно | Версия IP, которая будет использоваться этим правилом переадресации. Допустимые значения: IPV4 или IPV6. Это можно указать только для глобального правила переадресации. | |
| loadBalancingScheme строка | успешно | Определяет, для чего используется правило переадресации, и может принимать только следующие значения: INTERNAL, EXTERNAL. Значение INTERNAL означает, что оно используется для внутренней балансировки нагрузки сети (TCP, UDP). Значение EXTERNAL означает, что оно используется для внешней балансировки нагрузки (HTTP(S) LB, внешняя TCP/UDP LB, SSL-прокси) . | |
| name строка | успешно | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно содержать 1–63 символа и соответствовать RFC1035. То есть, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network словарь | успешно | Для внутренней балансировки нагрузки это поле идентифицирует сеть, к которой должен принадлежать IP-адрес, сбалансированный по нагрузке, для этого правила переадресации. Если это поле не указано, используется сеть по умолчанию. Это поле не используется для внешней балансировки нагрузки. | |
| 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 строка | успешно | Ссылка на регион, в котором находится региональное правило переадресации. Это поле не применимо к глобальным правилам переадресации. | |
| subnetwork словарь | успешно | Ссылка на подсеть. Для внутренней балансировки нагрузки это поле идентифицирует подсеть, к которой должен принадлежать IP-адрес, сбалансированный по нагрузке, для этого правила переадресации. Если указанная сеть находится в режиме автоматической подсети, это поле необязательно. Однако, если сеть находится в режиме настраиваемой подсети, подсеть необходимо указать. Это поле не используется для внешней балансировки нагрузки. | |
| target строка | успешно | Эта цель должна быть глобальным ресурсом балансировки нагрузки. Перенаправляемый трафик должен быть соответствующего типа объекту цели. Допустимые типы: HTTP_PROXY, HTTPS_PROXY, SSL_PROXY, TCP_PROXY . | |
Состояние
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/gcp_compute_global_forwarding_rule_facts_module.html
