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

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
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_constraint словарь	Набор параметров верхнего уровня.
content-length словарь	Устарело, пожалуйста, переименуйте на content_length. Длина содержимого.
action строка	Действие. Варианты: `"allow"` `"block"`
length целое	Длина HTTP содержимого в байтах
log строка	Включить/выключить ведение журнала. Варианты: `"disable"` `"enable"`
severity строка	Уровень серьезности. Варианты: `"low"` `"medium"` `"high"`
status строка	Включить/выключить ограничение. Варианты: `"disable"` `"enable"`
exception список / элементы=словарь	Исключение.
address строка	Адрес хоста.
content-length строка	Устарело, пожалуйста, переименуйте на content_length. Длина содержимого HTTP запроса. Варианты: `"disable"` `"enable"`
header-length строка	Устарело, пожалуйста, переименуйте на header_length. Длина HTTP заголовков запроса. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

hostname string	Включить/выключить проверку имени хоста. Choices: `"disable"` `"enable"`
id integer	Идентификатор исключения.
line-length string	Устарело, переименуйте в line_length. Длина строки HTTP в запросе. Choices: `"disable"` `"enable"`
malformed string	Включить/выключить проверку некорректного HTTP-запроса. Choices: `"disable"` `"enable"`
max-cookie string	Устарело, переименуйте в max_cookie. Максимальное количество файлов cookie в HTTP-запросе. Choices: `"disable"` `"enable"`
max-header-line string	Устарело, переименуйте в max_header_line. Максимальное количество строк HTTP-заголовка. Choices: `"disable"` `"enable"`
max-range-segment string	Устарело, переименуйте в max_range_segment. Максимальное количество сегментов диапазона в строке диапазона HTTP. Choices: `"disable"` `"enable"`
max-url-param string	Устарело, переименуйте в max_url_param. Максимальное количество параметров в URL. Choices: `"disable"` `"enable"`
method string	Включить/выключить проверку метода HTTP. Choices: `"disable"` `"enable"`
param-length string	Устарело, переименуйте в param_length. Максимальная длина параметра в URL, HTTP POST-запросе или теле HTTP. Choices: `"disable"` `"enable"`
pattern string	Шаблон URL.
regex string	Включить/выключить сопоставление шаблонов на основе регулярных выражений. Choices: `"disable"` `"enable"`
url-param-length string	Устарело, переименуйте в url_param_length. Максимальная длина параметра в URL. Choices: `"disable"` `"enable"`
version string	Включить/выключить проверку версии HTTP. Choices: `"disable"` `"enable"`
header-length dictionary	Устарело, переименуйте в header_length. Длина заголовка.
action string	Действие. Choices: `"allow"` `"block"`
length integer	Длина HTTP-заголовка в байтах
log string	Включить/выключить ведение журнала. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`

status string	Включить/выключить ограничение. Choices: `"disable"` `"enable"`
hostname dictionary	Имя хоста.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/выключить ведение журнала. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/выключить ограничение. Choices: `"disable"` `"enable"`
line-length dictionary	Устарело, пожалуйста, переименуйте его в line_length. Длина строки.
action string	Действие. Choices: `"allow"` `"block"`
length integer	Длина строки HTTP в байтах
log string	Включить/выключить ведение журнала. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/выключить ограничение. Choices: `"disable"` `"enable"`
malformed dictionary	Неправильный формат.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/выключить ведение журнала. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/выключить ограничение. Choices: `"disable"` `"enable"`
max-cookie dictionary	Устарело, пожалуйста, переименуйте его в max_cookie. Максимальное количество файлов cookie.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/выключить ведение журнала. Choices: `"disable"` `"enable"`

max-cookie integer	Устарело, переименуйте в max_cookie. Максимальное количество файлов cookie в HTTP-запросе
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
max-header-line dictionary	Устарело, переименуйте в max_header_line. Максимальная длина строки заголовка.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/отключить ведение журнала. Choices: `"disable"` `"enable"`
max-header-line integer	Устарело, переименуйте в max_header_line. Максимальное количество строк заголовка HTTP
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
max-range-segment dictionary	Устарело, переименуйте в max_range_segment. Максимальный сегмент диапазона.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/отключить ведение журнала. Choices: `"disable"` `"enable"`
max-range-segment integer	Устарело, переименуйте в max_range_segment. Максимальное количество сегментов диапазона в строке диапазона HTTP
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
max-url-param dictionary	Устарело, переименуйте в max_url_param. Максимальный параметр URL.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/отключить ведение журнала. Choices: `"disable"` `"enable"`
max-url-param integer	Устарело, переименуйте в max_url_param. Максимальное количество параметров в URL
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`

status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
method dictionary	Метод.
action string	Действие. Choices: `"allow"` `"block"`
log string	Включить/отключить логирование. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
param-length dictionary	Устарело, пожалуйста, переименуйте его в param_length. Длина параметра.
action string	Действие. Choices: `"allow"` `"block"`
length integer	Максимальная длина параметра в URL, запросе HTTP POST или теле HTTP в байтах
log string	Включить/отключить логирование. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
url-param-length dictionary	Устарело, пожалуйста, переименуйте его в url_param_length. Длина параметра URL.
action string	Действие. Choices: `"allow"` `"block"`
length integer	Максимальная длина параметра URL в байтах
log string	Включить/отключить логирование. Choices: `"disable"` `"enable"`
severity string	Серьезность. Choices: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Choices: `"disable"` `"enable"`
version dictionary	Версия.
action string	Действие. Choices: `"allow"` `"block"`

log string	Включить/отключить ведение журнала. Выбори: `"disable"` `"enable"`
severity string	Уровень важности. Выбори: `"low"` `"medium"` `"high"`
status string	Включить/отключить ограничение. Выбори: `"disable"` `"enable"`
workspace_locking_adom string	ADOM для блокировки рабочего пространства в режиме работы FortiManager в рабочем пространстве, значение может быть глобальным и другими, включая корневой.
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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: WAF HTTP protocol restrictions.
      fortinet.fortimanager.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: <integer>
            log: <value in [disable, enable]>
            severity: <value in [low, medium, high]>
            status: <value in [disable, enable]>
          exception:
            -
              address: <string>
              content_length: <value in [disable, enable]>
              header_length: <value in [disable, enable]>
              hostname: <value in [disable, enable]>
              id: <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: <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: <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: <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: <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: <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: <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: <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: <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: <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]>

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_constraint_module.html