Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

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 / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

waf_profile_constraint

dictionary

Набор параметров верхнего уровня.

content_length

aliases: content-length

dictionary

Длина содержимого.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

length

integer

Длина содержимого HTTP в байтах

log

string

Включить/отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Степень серьёзности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить/отключить ограничение.

Варианты:

  • "disable"
  • "enable"

exception

list / elements=dictionary

Исключение.

address

string

Адрес узла.

content_length

aliases: content-length

string

Длина содержимого HTTP в запросе.

Варианты:

  • "disable"
  • "enable"

header_length

aliases: header-length

string

Длина заголовка HTTP в запросе.

Варианты:

  • "disable"
  • "enable"

hostname

string

Включить/отключить проверку имени узла.

Варианты:

  • "disable"
  • "enable"

id

integer

Идентификатор исключения.

line_length

aliases: line-length

string

Длина строки HTTP в запросе.

Варианты:

  • "disable"
  • "enable"

malformed

string

Включить/отключить проверку корректности запроса HTTP.

Варианты:

  • "disable"
  • "enable"

max_cookie

aliases: max-cookie

string

Максимальное количество файлов cookie в запросе HTTP.

Варианты:

  • "disable"
  • "enable"

max_header_line

aliases: max-header-line

string

Максимальное количество строк заголовка HTTP.

Варианты:

  • "disable"
  • "enable"

max_range_segment

aliases: max-range-segment

string

Максимальное количество сегментов диапазона в строке диапазона HTTP.

Варианты:

  • "disable"
  • "enable"

max_url_param

aliases: max-url-param

string

Максимальное количество параметров в URL.

Варианты:

  • "disable"
  • "enable"

method

string

Включить/отключить проверку метода HTTP.

Варианты:

  • "disable"
  • "enable"

param_length

aliases: param-length

string

Максимальная длина параметра в URL, запросе HTTP POST или теле HTTP.

Варианты:

  • "disable"
  • "enable"

pattern

string

Шаблон URL.

regex

string

Включить/отключить сопоставление с шаблоном на основе регулярного выражения.

Варианты:

  • "disable"
  • "enable"

url_param_length

aliases: url-param-length

string

Максимальная длина параметра в URL.

Варианты:

  • "disable"
  • "enable"

version

string

Включить/отключить проверку версии HTTP.

Варианты:

  • "disable"
  • "enable"

header_length

aliases: header-length

dictionary

Длина заголовка.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

length

integer

Длина заголовка HTTP в байтах

log

string

Включить/отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Степень серьёзности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить/отключить ограничение.

Варианты:

  • "disable"
  • "enable"

hostname

dictionary

Имя узла.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить/отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Степень серьёзности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить/отключить ограничение.

Варианты:

  • "disable"
  • "enable"

line_length

aliases: line-length

dictionary

Длина строки.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

length

integer

Длина строки HTTP в байтах

log

string

Включить/отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Степень серьёзности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить/отключить ограничение.

Варианты:

  • "disable"
  • "enable"

malformed

dictionary

Некорректный формат.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

max_cookie

псевдонимы: max-cookie

dictionary

Максимальное количество файлов cookie.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

max_cookie

псевдонимы: max-cookie

integer

Максимальное количество файлов cookie в HTTP-запросе

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

max_header_line

псевдонимы: max-header-line

dictionary

Максимальное количество строк заголовка.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

max_header_line

псевдонимы: max-header-line

integer

Максимальное количество строк HTTP-заголовка

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

max_range_segment

псевдонимы: max-range-segment

dictionary

Максимальное количество сегментов диапазона.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

max_range_segment

псевдонимы: max-range-segment

integer

Максимальное количество сегментов диапазона в строке HTTP Range

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

max_url_param

псевдонимы: max-url-param

dictionary

Максимальное количество параметров URL.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

max_url_param

псевдонимы: max-url-param

integer

Максимальное количество параметров в URL

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

method

dictionary

Метод.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

param_length

псевдонимы: param-length

dictionary

Длина параметра.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

length

integer

Максимальная длина параметра в URL, HTTP POST-запросе или теле HTTP-запроса в байтах

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

url_param_length

псевдонимы: url-param-length

dictionary

Длина параметра URL.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

length

integer

Максимальная длина параметра URL в байтах

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

version

dictionary

Версия.

action

string

Действие.

Варианты:

  • "allow"
  • "block"

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

severity

string

Уровень серьезности.

Варианты:

  • "low"
  • "medium"
  • "high"

status

string

Включить или отключить ограничение.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM, блокируемый для FortiManager, работающего в режиме workspace; в качестве значения можно указать 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 HTTP protocol restrictions.
      fortinet.fortimanager.fmgr_waf_profile_constraint:
        # workspace_locking_adom: <global or your adom name>
        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

список / элементы=строка

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API