модуль fortinet.fortimanager.fmgr_waf_profile_signature – сигнатуры WAF.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_waf_profile_signature.

Добавлено в fortinet.fortimanager 2.0.0

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

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

Этот модуль позволяет настроить устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile string / обязательный	Параметр (profile) в запрашиваемом URL.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, для которых переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
waf_profile_signature dictionary	Набор параметров верхнего уровня.
credit_card_detection_threshold псевдонимы: credit-card-detection-threshold integer	Минимальное количество кредитных карт, необходимое для обнаружения нарушения.
custom_signature псевдонимы: custom-signature list / элементы=dictionary	Пользовательская сигнатура.
action string	Действие. Варианты: `"allow"` `"block"` `"erase"`
case_sensitivity псевдонимы: case-sensitivity string	Учитывать регистр в шаблоне. Варианты: `"disable"` `"enable"`
direction string	Направление трафика. Варианты: `"request"` `"response"`
log string	Включить или отключить ведение журнала. Варианты: `"disable"` `"enable"`
name string	Имя сигнатуры.
pattern string	Шаблон для сопоставления.
severity string	Степень серьёзности. Варианты: `"low"` `"medium"` `"high"`
status string	Статус. Варианты: `"disable"` `"enable"`
target list / элементы=string	Сопоставление с целевым объектом HTTP. Варианты: `"arg"` `"arg-name"` `"req-body"` `"req-cookie"` `"req-cookie-name"` `"req-filename"` `"req-header"` `"req-header-name"` `"req-raw-uri"` `"req-uri"` `"resp-body"` `"resp-hdr"` `"resp-status"`
disabled_signature псевдонимы: disabled-signature any	(список или строка) Отключённые сигнатуры
disabled_sub_class псевдонимы: disabled-sub-class any	(список или строка) Отключённые подклассы сигнатур.
main_class псевдонимы: main-class dictionary	Основной класс.
action string	Действие. Варианты: `"allow"` `"block"` `"erase"`
id integer	Идентификатор основного класса сигнатур.
log string	Включить или отключить ведение журнала. Варианты: `"disable"` `"enable"`
severity string	Степень серьёзности. Варианты: `"low"` `"medium"` `"high"`
status string	Статус. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие значения, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Измените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается с ошибкой, если возвращён ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: WAF signatures.
      fortinet.fortimanager.fmgr_waf_profile_signature:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        waf_profile_signature:
          # credit_card_detection_threshold: <integer>
          # custom_signature:
          #   - action: <value in [allow, block, erase]>
          #     case_sensitivity: <value in [disable, enable]>
          #     direction: <value in [request, response]>
          #     log: <value in [disable, enable]>
          #     name: <string>
          #     pattern: <string>
          #     severity: <value in [low, medium, high]>
          #     status: <value in [disable, enable]>
          #     target: ["arg", "arg-name", "req-body", "req-cookie", "req-cookie-name",
          #              "req-filename", "req-header", "req-header-name", "req-raw-uri",
          #              "req-uri", "resp-body", "resp-hdr", "resp-status"]
          # disabled_signature: <list or string>
          # disabled_sub_class: <list or string>
          # main_class:
          #   action: <value in [allow, block, erase]>
          #   id: <integer>
          #   log: <value in [disable, enable]>
          #   severity: <value in [low, medium, high]>
          #   status: <value in [disable, enable]>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_waf_profile_signature_module.html