fortinet.fortimanager.fmgr_waf_profile_signature модуль — Подписи WAF.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
profile строка / обязательно	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для сбоя.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия для успеха.
waf_profile_signature словарь	Установленные параметры верхнего уровня.
credit_card_detection_threshold целое число	Устарело, пожалуйста, переименуйте на credit_card_detection_threshold. Минимальное количество кредитных карт для обнаружения нарушения.
custom_signature список / элементы=словарь	Устарело, пожалуйста, переименуйте на custom_signature. Пользовательская подпись.
action строка	Действие. Варианты: `"allow"` `"block"` `"erase"`
case_sensitivity строка	Устарело, пожалуйста, переименуйте на case_sensitivity. Чувствительность к регистру в шаблоне. Варианты: `"disable"` `"enable"`
direction строка	Направление трафика. Варианты: `"request"` `"response"`
log строка	Включить/отключить ведение журнала. Варианты: `"disable"` `"enable"`
name строка	Имя подписи.
pattern строка	Шаблон совпадения.
severity строка	Уровень серьезности. Варианты: `"low"` `"medium"` `"high"`
status строка	Статус. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

target список / элементы=строка	Сопоставление целевого 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. Отключенные подписи
disabled-sub-class любой	(список или строка) Устаревшее, пожалуйста, переименуйте на disabled_sub_class. Отключенные подклассы сигнатур.
main-class словарь	Устаревшее, пожалуйста, переименуйте на main_class. Основной класс.
action строка	Действие. Варианты: `"allow"` `"block"` `"erase"`
id целое число	Идентификатор основного класса подписи.
log строка	Включить/выключить ведение журнала. Варианты: `"disable"` `"enable"`
severity строка	Уровень серьезности. Варианты: `"low"` `"medium"` `"high"`
status строка	Статус. Варианты: `"disable"` `"enable"`
workspace_locking_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневое.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: WAF signatures.
      fortinet.fortimanager.fmgr_waf_profile_signature:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_waf_profile_signature_module.html