fortinet.fortimanager.fmgr_waf_profile_signature – Подписи WAF.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_waf_profile_signature.

Добавлено в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation логическое			Варианты: нет ← да	устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
profile строка / обязательно				параметр (profile) в запрошенном URL
rc_failed список / элементы=строка				список кодов rc, при которых условия будут считаться ошибками
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут считаться успешными
state строка / обязательно			Варианты: present absent	направление создания, обновления или удаления объекта
waf_profile_signature словарь				параметры верхнего уровня
	credit-card-detection-threshold целое число			Минимальное количество кредитных карт для обнаружения нарушения.
	custom-signature список / элементы=строка			нет описания
		action строка	Варианты: разрешить заблокировать стереть	Действие.
		case-sensitivity строка	Варианты: выключить включить	Чувствительность к регистру в шаблоне.
		direction строка	Варианты: запрос ответ	Направление трафика.
		log строка	Варианты: выключить включить	Включить/выключить ведение журнала.
		name строка		Имя подписи.
		pattern строка		Шаблон соответствия.
		severity строка	Варианты: низкий средний высокий	Уровень серьезности.
		status строка	Варианты: выключить включить	Статус.
		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 строка			Выключенные подписи
	disabled-sub-class строка			Выключенные подклассы подписей.
	main-class словарь			нет описания
		action строка	Варианты: разрешить заблокировать стереть	Действие.
		id целое число		Идентификатор основного класса подписи.
		log строка	Варианты: выключить включить	Включить/выключить ведение журнала.
		severity строка	Варианты: низкий средний высокий	Уровень серьезности.
		status строка	Варианты: выключить включить	Статус.
workspace_locking_adom строка				область, которая должна быть заблокирована для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число			По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область

Примечания

Примечание

Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого кода rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: WAF signatures.
     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: <value of 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: <value of string>
                 pattern: <value of 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: <value of string>
           disabled-sub-class: <value of string>
           main-class:
              action: <value in [allow, block, erase]>
              id: <value of integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_waf_profile_signature_module.html