gcp_appengine_firewall_rule – Создаёт правило брандмауэра GCP
Новая версия 2.9.
Обзор
- Единожды правило брандмауэра, которое оценивается по отношению к входящему трафику и предоставляет действие, которое нужно предпринять для соответствующих запросов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action строка / обязательно | Действие, которое нужно выполнить, если правило соответствует запросу. Некоторые допустимые варианты: "UNSPECIFIED_ACTION", "ALLOW", "DENY" | |
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| description строка | Необязательное текстовое описание правила. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливать, если не знаете, что делаете. Изменяет только строку User Agent для всех запросов к API. | |
| priority целое число | Положительное целое число, определяющее порядок оценки правил. Правила с меньшим приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всем трафику IPv4 и IPv6, когда предыдущие правила не соответствуют. Только действие этого правила может быть изменено пользователем. | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список | Массив используемых областей. | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, его представляющая. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбрана учетная запись службы. | |
| source_range строка / обязательно | IP-адрес или диапазон, определённый с использованием CIDR-нотации, для запросов, к которым применяется это правило. | |
| state строка |
| Указывает, должен ли указанный объект существовать в GCP |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.firewall.ingressRules
- Официальная документация: https://cloud.google.com/appengine/docs/standard/python/creating-firewalls#creating_firewall_rules
- для аутентификации можно установить 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: create a firewall rule
gcp_appengine_firewall_rule:
priority: 1000
source_range: 10.0.0.0
action: ALLOW
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| action строка | успех | Действие, которое нужно выполнить, если правило соответствует запросу. |
| description строка | успех | Необязательное текстовое описание правила. |
| priority целое число | успех | Положительное целое число, определяющее порядок оценки правил. Правила с меньшим приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всем трафику IPv4 и IPv6, когда предыдущие правила не соответствуют. Только действие этого правила может быть изменено пользователем. |
| sourceRange строка | успех | IP-адрес или диапазон, определённый с использованием CIDR-нотации, для запросов, к которым применяется это правило. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [бета-версия]
- Этот модуль поддерживается сообществом 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_appengine_firewall_rule_module.html