Модуль google.cloud.gcp_appengine_firewall_rule — создание FirewallRule в GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте команду: ansible-galaxy collection install google.cloud. Для работы с этим модулем требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: 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 / обязательный | Тип используемых учетных данных. Варианты:
|
description string | Необязательное текстовое описание этого правила. |
env_type string | Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте это значение, если не уверены в своих действиях. Изменяется только строка User Agent для всех запросов к API. |
priority integer | Положительное целое число, определяющее порядок проверки правил. Сначала проверяются правила с наименьшим приоритетом. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всему трафику IPv4 и IPv6, если ни одно из предыдущих правил не подошло. Пользователь может изменять только действие этого правила. |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=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 Варианты:
|
Примечания
Примечание
- Справочник 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. - Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
- Параметры 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 string | Действие, которое следует выполнить, если запрос соответствует этому правилу. Возвращается: при успешном выполнении |
description string | Необязательное текстовое описание этого правила. Возвращается: при успешном выполнении |
priority integer | Положительное целое число, определяющее порядок проверки правил. Сначала проверяются правила с наименьшим приоритетом. Правило по умолчанию с приоритетом Int32.MaxValue соответствует всему трафику IPv4 и IPv6, если ни одно из предыдущих правил не подошло. Пользователь может изменять только действие этого правила. Возвращается: при успешном выполнении |
sourceRange string | IP-адрес или диапазон в нотации CIDR для запросов, к которым применяется это правило. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_appengine_firewall_rule_module.html
