gcp_compute_forwarding_rule_facts – Сбор фактов о GCP ForwardingRule
Новое в версии 2.7.
Обзор
- Сбор фактов о GCP ForwardingRule
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- 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, который следует использовать. | |
| region - / обязательно | Ссылка на регион, в котором находится региональное правило переадресации. Это поле не применимо к глобальным правилам переадресации. | |
| 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 forwarding rule facts"
gcp_compute_forwarding_rule_facts:
region: us-west1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| items complex | всегда | Список элементов | |
| allPorts boolean | успех | Если схема балансировки нагрузки — ВНУТРЕННЯЯ, а протокол — TCP/UDP, опустите поля `port`/`port_range` и установите это поле в значение `true`, чтобы разрешить передачу пакетов, адресованных любому порту, бэкендам, настроенным с этой правилом переадресации. | |
| backendService словарь | успех | Ссылка на BackendService для получения сопоставленного трафика. Используется для внутренней балансировки нагрузки. (не используется для внешней балансировки). | |
| creationTimestamp строка | успех | Маркер времени создания в формате RFC3339. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| id целое число | успех | Уникальный идентификатор ресурса. | |
| IPAddress строка | успех | IP-адрес, который обслуживает данное правило переадресации. Адреса ограничены схемой балансировки нагрузки правила переадресации (ВНЕШНЯЯ или ВНУТРЕННЯЯ) и областью (глобальная или региональная). Если схема балансировки — ВНЕШНЯЯ, для глобальных правил переадресации адрес должен быть глобальным IP-адресом, а для региональных правил переадресации — в том же регионе, что и правило переадресации. Если это поле пустое, будет назначен временный IPv4-адрес из той же области (глобальной или региональной). Региональное правило переадресации поддерживает только IPv4. Глобальное правило переадресации поддерживает IPv4 или IPv6. Если схема балансировки — ВНУТРЕННЯЯ, это может быть только 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 . | |
| IPProtocol строка | успех | IP-протокол, к которому применяется это правило. Допустимые значения: TCP, UDP, ESP, AH, SCTP или ICMP. Если схема балансировки — ВНУТРЕННЯЯ, допустимы только TCP и UDP. | |
| ipVersion строка | успех | Версия IP, которая будет использоваться этим правилом переадресации. Допустимые значения: IPV4 или IPV6. Это можно указать только для глобального правила переадресации. | |
| loadBalancingScheme строка | успех | Указывает, для чего используется ForwardingRule, и может принимать только следующие значения: ВНУТРЕННЯЯ, ВНЕШНЯЯ. Значение ВНУТРЕННЯЯ означает, что это будет использоваться для внутренней балансировки нагрузки (TCP, UDP). Значение ВНЕШНЯЯ означает, что это будет использоваться для внешней балансировки нагрузки (HTTP(S) LB, внешняя балансировка TCP/UDP, SSL-прокси). | |
| name строка | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| network словарь | успех | Для внутренней балансировки нагрузки это поле идентифицирует сеть, к которой должен принадлежать IP-адрес балансировки нагрузки для данного правила переадресации. Если это поле не указано, используется сеть по умолчанию. Это поле не используется для внешней балансировки нагрузки. | |
| networkTier строка | успех | Уровень сети, используемый для настройки этого адреса. Это поле может принимать следующие значения: PREMIUM или STANDARD. Если это поле не указано, предполагается значение 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 для внутренней балансировки нагрузки. Если схема балансировки — ВНУТРЕННЯЯ, можно настроить отдельный порт или список портов, разделенных запятыми. Только пакеты, адресованные этим портам, будут перенаправлены бэкендам, настроенным с этим правилом переадресации. Вы можете указать не более 5 портов. | |
| region строка | успех | Ссылка на регион, в котором находится региональное правило переадресации. Это поле неприменимо к глобальным правилам переадресации. | |
| serviceLabel строка | успех | Необязательный префикс к имени службы для этого правила переадресации. Если указан, будет первым тегом полному имени сервиса. Тег должен быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, тег должен иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Это поле используется только для внутренней балансировки нагрузки. | |
| serviceName строка | успех | Внутреннее полное имя службы для этого правила переадресации. Это поле используется только для внутренней балансировки нагрузки. | |
| subnetwork словарь | успех | Ссылка на подсеть. Для внутренней балансировки нагрузки это поле идентифицирует подсеть, к которой должен принадлежать IP-адрес балансировки нагрузки для данного правила переадресации. Если указанная сеть находится в режиме автоматической подсети, это поле необязательно. Однако, если сеть находится в режиме настраиваемой подсети, подсеть необходимо указать. Это поле не используется для внешней балансировки нагрузки. | |
| target словарь | успех | Ссылка на ресурс TargetPool для получения сопоставленного трафика. Для региональных правил переадресации этот целевой сервер должен находиться в том же регионе, что и правило переадресации. Для глобальных правил переадресации этот целевой сервер должен быть глобальным ресурсом балансировки нагрузки. Передаваемый трафик должен быть соответствующего типа целевому объекту. Это поле не используется для внутренней балансировки нагрузки. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом 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_forwarding_rule_facts_module.html
