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

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Чтобы использовать его в playbook, укажите: google.cloud.gcp_appengine_firewall_rule.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
action string / обязательно	Действие, которое необходимо выполнить, если это правило соответствует. Некоторые допустимые варианты включают: “UNSPECIFIED_ACTION”, “ALLOW”, “DENY”
auth_kind string / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Необязательное текстовое описание этого правила.
env_type string	Указывает, в какой среде Ansible вы запускаете этот модуль. Это не должно быть установлено, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
priority integer	Положительное целое число, определяющее порядок оценки правил. Правила с самым низким приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всему трафику IPv4 и IPv6, когда ни одно предыдущее правило не соответствует. Только действие этого правила может быть изменено пользователем.
project string	Проект Google Cloud Platform для использования.
scopes list / elements=string	Массив областей, которые будут использоваться
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде представляющей его JSON-строки.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать электронную почту по умолчанию.
service_account_file path	Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
source_range string / обязательно	IP-адрес или диапазон, определенный с помощью нотации CIDR, запросов, к которым применяется это правило.
state string	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник по 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.
Для аутентификации вы можете установить access_token с помощью переменной окружения GCP_ACCESS_TOKEN.
Для аутентификации вы можете установить auth_kind с помощью переменной окружения GCP_AUTH_KIND.
Для аутентификации вы можете установить scopes с помощью переменной окружения GCP_SCOPES.
Значения переменных окружения будут использоваться только в том случае, если значения playbook не установлены.
Параметры 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 целое число	Положительное целое число, определяющее порядок оценки правила. Правила с более низким приоритетом оцениваются первыми. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всему IPv4 и IPv6 трафику, когда никакое предыдущее правило не соответствует. Пользователь может изменить только действие этого правила. Возвращено: success
sourceRange строка	IP-адрес или диапазон, определённый с использованием CIDR-нотации, для запросов, на которые распространяется действие этого правила. Возвращено: success

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_appengine_firewall_rule_module.html