fortinet.fortimanager.fmgr_waf_profile_constraint – Ограничения протокола HTTP WAF.

Примечание

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_waf_profile_constraint.

Новое в версии 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_constraint словарь				установленные параметры верхнего уровня
	content-length словарь			без описания
		action строка	Варианты: allow block	Действие.
		length целое число		Длина HTTP содержимого в байтах (от 0 до 2147483647).
		log строка	Варианты: disable enable	Включить/выключить ведение журнала.
		severity строка	Варианты: low medium high	Уровень серьезности.
		status строка	Варианты: disable enable	Включить/выключить ограничение.
	exception список / элементы=строка			без описания
		address строка		Адрес хоста.
		content-length строка	Варианты: disable enable	Длина HTTP содержимого в запросе.
		header-length строка	Варианты: disable enable	Длина HTTP заголовка в запросе.
		hostname строка	Варианты: disable enable	Включить/выключить проверку имени хоста.
		id целое число		Идентификатор исключения.
		line-length строка	Варианты: disable enable	Длина HTTP строки в запросе.
		malformed строка	Варианты: disable enable	Включить/выключить проверку некорректного HTTP запроса.
		max-cookie строка	Варианты: disable enable	Максимальное количество файлов cookie в HTTP запросе.
		max-header-line строка	Варианты: disable enable	Максимальное количество строк HTTP заголовка.
		max-range-segment строка	Варианты: disable enable	Максимальное количество сегментов диапазона в строке HTTP диапазона.
		max-url-param строка	Варианты: disable enable	Максимальное количество параметров в URL.
		method строка	Варианты: disable enable	Включить/выключить проверку HTTP метода.
		param-length строка	Варианты: disable enable	Максимальная длина параметра в URL, HTTP POST запросе или HTTP теле.
		pattern строка		Шаблон URL.
		regex строка	Варианты: disable enable	Включить/выключить соответствие шаблону на основе регулярных выражений.
		url-param-length строка	Варианты: disable enable	Максимальная длина параметра в URL.
		version строка	Варианты: disable enable	Включить/выключить проверку HTTP версии.
	header-length словарь			без описания
		action строка	Варианты: allow block	Действие.
		length целое число		Длина HTTP заголовка в байтах (от 0 до 2147483647).
		log строка	Варианты: disable enable	Включить/выключить ведение журнала.
		severity строка	Варианты: low medium high	Уровень серьезности.
		status строка	Варианты: disable enable	Включить/выключить ограничение.
	hostname словарь			без описания
		action строка	Варианты: allow block	Действие.
		log строка	Варианты: disable enable	Включить/выключить ведение журнала.
		severity строка	Варианты: low medium high	Уровень серьезности.
		status строка	Варианты: disable enable	Включить/выключить ограничение.
	line-length словарь			без описания
		action строка	Варианты: allow block	Действие.
		length целое число		Длина HTTP строки в байтах (от 0 до 2147483647).
		log строка	Варианты: disable enable	Включить/выключить ведение журнала.
		severity строка	Варианты: low medium high	Уровень серьезности.

	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
неправильный формат словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
макс-cookie словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	макс-cookie целое число		Максимальное количество cookie в запросе HTTP (0 до 2147483647).
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
макс-строка-заголовка словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	макс-строка-заголовка целое число		Максимальное количество строк HTTP заголовков (0 до 2147483647).
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
макс-сегмент-диапазона словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	макс-сегмент-диапазона целое число		Максимальное количество сегментов диапазона в строке HTTP range (0 до 2147483647).
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
макс-параметр-url словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	макс-параметр-url целое число		Максимальное количество параметров в URL (0 до 2147483647).
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
метод словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
длина-параметра словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	длина целое число		Максимальная длина параметра в URL, HTTP POST запросе или HTTP теле в байтах (0 до 2147483647).
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
длина-параметра-url словарь			нет описания
	действие строка	Варианты: разрешить заблокировать	Действие.
	длина целое число		Максимальная длина параметра URL в байтах (0 до 2147483647).
	журнал строка	Варианты: выключить включить	Включить/выключить ведение журнала.
	серьёзность строка	Варианты: низкая средняя высокая	Серьёзность.
	статус строка	Варианты: выключить включить	Включить/выключить ограничение.
версия словарь			нет описания

	действие строка	Варианты: разрешить заблокировать	Действие.
	журнал строка	Варианты: отключить включить	Включить/отключить ведение журнала.
	уровень_серьёзности строка	Варианты: низкий средний высокий	Уровень серьезности.
	состояние строка	Варианты: отключить включить	Включить/отключить ограничение.
workspace_locking_adom строка			адрес ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным или другим, включая корень
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager; параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей, если возвращен ненулевой код. Вы также можете переопределить условия завершения успехом или неудачей с помощью параметров 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 HTTP protocol restrictions.
     fmgr_waf_profile_constraint:
        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_constraint:
           content-length:
              action: <value in [allow, block]>
              length: <value of integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           exception:
             -
                 address: <value of string>
                 content-length: <value in [disable, enable]>
                 header-length: <value in [disable, enable]>
                 hostname: <value in [disable, enable]>
                 id: <value of integer>
                 line-length: <value in [disable, enable]>
                 malformed: <value in [disable, enable]>
                 max-cookie: <value in [disable, enable]>
                 max-header-line: <value in [disable, enable]>
                 max-range-segment: <value in [disable, enable]>
                 max-url-param: <value in [disable, enable]>
                 method: <value in [disable, enable]>
                 param-length: <value in [disable, enable]>
                 pattern: <value of string>
                 regex: <value in [disable, enable]>
                 url-param-length: <value in [disable, enable]>
                 version: <value in [disable, enable]>
           header-length:
              action: <value in [allow, block]>
              length: <value of integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           hostname:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           line-length:
              action: <value in [allow, block]>
              length: <value of integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           malformed:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           max-cookie:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max-cookie: <value of integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           max-header-line:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max-header-line: <value of integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           max-range-segment:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max-range-segment: <value of integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           max-url-param:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              max-url-param: <value of integer>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           method:
              action: <value in [allow, block]>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           param-length:
              action: <value in [allow, block]>
              length: <value of integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           url-param-length:
              action: <value in [allow, block]>
              length: <value of integer>
              log: <value in [disable, enable]>
              severity: <value in [low, medium, high]>
              status: <value in [disable, enable]>
           version:
              action: <value in [allow, block]>
              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_constraint_module.html