google.cloud.gcp_appengine_firewall_rule – Создаёт правило брандмауэра GCP

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.1).

Для установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_appengine_firewall_rule.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Одно правило брандмауэра, которое проверяется на входящий трафик и определяет действие для обработанных запросов.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
action строка / обязательно		Действие, которое должно быть выполнено, если правило совпадает. Некоторые допустимые значения: "UNSPECIFIED_ACTION", "ALLOW", "DENY"
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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 учетной записи службы, если в качестве типа выбран serviceaccount.
source_range строка / обязательно		IP-адрес или диапазон, определённый с помощью CIDR-нотации, для запросов, к которым применяется это правило.
state строка	Варианты: present ← absent	Существование объекта в 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 с помощью переменной среды gcp_service_account_file.
для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры service_account_email и service_account_file взаимоисключают друг друга.

Примеры

- name: create a firewall rule
  google.cloud.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 строка	success	Действие, которое должно быть выполнено, если правило совпадает.
description строка	success	Необязательное текстовое описание этого правила.
priority целое число	success	Положительное целое число, определяющее порядок проверки правил. Правила с меньшим приоритетом проверяются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всем IPv4 и IPv6 трафику, когда предыдущие правила не соответствуют. Только действие этого правила может быть изменено пользователем.
sourceRange строка	success	IP-адрес или диапазон, определённый с помощью CIDR-нотации, для запросов, к которым применяется это правило.

Авторы

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.10/collections/google/cloud/gcp_appengine_firewall_rule_module.html