Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_waf_profile — настройка межсетевого экрана веб-приложений.

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: fortinet.fortimanager.fmgr_waf_profile.

Добавлено в fortinet.fortimanager 1.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.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых будут переопределены условия успешного выполнения.

revision_note

string

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

state

string / обязательный

Указание создать, обновить или удалить объект.

Варианты:

  • "present"
  • "absent"

waf_profile

dictionary

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

address_list

псевдонимы: address-list

dictionary

Список адресов.

blocked_address

псевдонимы: blocked-address

any

(список или строка) Заблокированный адрес.

blocked_log

псевдонимы: blocked-log

string

Включить/отключить ведение журнала для заблокированных адресов.

Варианты:

  • "disable"
  • "enable"

severity

string

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

Варианты:

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

status

string

Состояние.

Варианты:

  • "disable"
  • "enable"

trusted_address

псевдонимы: trusted-address

any

(список или строка) Доверенный адрес.

comment

string

Комментарий.

constraint

dictionary

Ограничение.

content_length

псевдонимы: 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

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

string

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

Варианты:

  • "disable"
  • "enable"

header_length

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

string

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

Варианты:

  • "disable"
  • "enable"

hostname

string

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

Варианты:

  • "disable"
  • "enable"

id

integer

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

line_length

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

string

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

Варианты:

  • "disable"
  • "enable"

malformed

string

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

Варианты:

  • "disable"
  • "enable"

max_cookie

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

string

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

Варианты:

  • "disable"
  • "enable"

max_header_line

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

string

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

Варианты:

  • "disable"
  • "enable"

max_range_segment

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

string

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

Варианты:

  • "disable"
  • "enable"

max_url_param

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

string

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

Варианты:

  • "disable"
  • "enable"

method

string

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

Варианты:

  • "disable"
  • "enable"

param_length

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

string

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

Варианты:

  • "disable"
  • "enable"

pattern

string

Шаблон URL.

regex

string

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

Варианты:

  • "disable"
  • "enable"

url_param_length

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

string

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

Варианты:

  • "disable"
  • "enable"

version

string

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

Варианты:

  • "disable"
  • "enable"

header_length

псевдонимы: 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

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

length

целое число

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

log

строка

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

Варианты:

  • "disable"
  • "enable"

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

malformed

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

строка

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

Варианты:

  • "disable"
  • "enable"

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

max_cookie

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

строка

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

Варианты:

  • "disable"
  • "enable"

max_cookie

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

целое число

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

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

max_header_line

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

строка

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

Варианты:

  • "disable"
  • "enable"

max_header_line

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

целое число

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

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

max_range_segment

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

строка

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

Варианты:

  • "disable"
  • "enable"

max_range_segment

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

целое число

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

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

max_url_param

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

строка

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

Варианты:

  • "disable"
  • "enable"

max_url_param

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

целое число

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

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

method

словарь

Метод.

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

строка

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

Варианты:

  • "disable"
  • "enable"

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

param_length

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

length

целое число

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

log

строка

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

Варианты:

  • "disable"
  • "enable"

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

url_param_length

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

словарь

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

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

length

целое число

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

log

строка

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

Варианты:

  • "disable"
  • "enable"

severity

строка

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

Варианты:

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

version

словарь

Версия.

action

строка

Действие.

Варианты:

  • "allow"
  • "block"

log

string

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

Варианты:

  • "disable"
  • "enable"

severity

string

Важность.

Варианты:

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

status

string

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

Варианты:

  • "disable"
  • "enable"

extended_log

aliases: extended-log

string

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

Варианты:

  • "disable"
  • "enable"

external

string

Отключить или включить внешнюю проверку HTTP-трафика.

Варианты:

  • "disable"
  • "enable"

method

dictionary

Метод.

default_allowed_methods

aliases: default-allowed-methods

list / elements=string

Методы.

Варианты:

  • "delete"
  • "get"
  • "head"
  • "options"
  • "post"
  • "put"
  • "trace"
  • "others"
  • "connect"

log

string

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

Варианты:

  • "disable"
  • "enable"

method_policy

aliases: method-policy

list / elements=dictionary

Политика методов.

address

string

Адрес узла.

allowed_methods

aliases: allowed-methods

list / elements=string

Разрешённые методы.

Варианты:

  • "delete"
  • "get"
  • "head"
  • "options"
  • "post"
  • "put"
  • "trace"
  • "others"
  • "connect"

id

integer

Идентификатор политики методов HTTP.

pattern

string

Шаблон URL-адреса.

regex

string

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

Варианты:

  • "disable"
  • "enable"

severity

string

Важность.

Варианты:

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

status

string

Статус.

Варианты:

  • "disable"
  • "enable"

name

string / обязательный

Имя профиля WAF.

signature

dictionary

Сигнатура.

credit_card_detection_threshold

aliases: credit-card-detection-threshold

integer

Минимальное количество обнаруживаемых кредитных карт, необходимое для фиксации нарушения.

custom_signature

aliases: custom-signature

list / elements=dictionary

Пользовательская сигнатура.

action

string

Действие.

Варианты:

  • "allow"
  • "block"
  • "erase"

case_sensitivity

aliases: case-sensitivity

string

Учет регистра в шаблоне.

Варианты:

  • "disable"
  • "enable"

direction

string

Направление трафика.

Варианты:

  • "request"
  • "response"

log

string

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

Варианты:

  • "disable"
  • "enable"

name

string

Имя сигнатуры.

pattern

string

Шаблон для сопоставления.

severity

string

Важность.

Варианты:

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

status

string

Статус.

Варианты:

  • "disable"
  • "enable"

target

list / elements=string

Сопоставить цель 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

aliases: disabled-signature

any

(список или строка) Отключенные сигнатуры

disabled_sub_class

aliases: disabled-sub-class

any

(список или строка) Отключенные подклассы сигнатур.

main_class

aliases: main-class

dictionary

Основной класс.

action

string

Действие.

Варианты:

  • "allow"
  • "block"
  • "erase"

id

integer

Идентификатор основного класса сигнатур.

log

string

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

Варианты:

  • "disable"
  • "enable"

severity

string

Важность.

Варианты:

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

status

string

Статус.

Варианты:

  • "disable"
  • "enable"

url_access

aliases: url-access

list / elements=dictionary

Доступ к URL-адресам.

access_pattern

aliases: access-pattern

list / elements=dictionary

Шаблон доступа.

id

integer

Идентификатор шаблона доступа к URL-адресу.

negate

string

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

Варианты:

  • "disable"
  • "enable"

pattern

string

Шаблон URL-адреса.

regex

string

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

Варианты:

  • "disable"
  • "enable"

srcaddr

string

Адрес источника.

action

string

Действие.

Варианты:

  • "bypass"
  • "permit"
  • "block"

address

string

Адрес узла.

id

integer

Идентификатор доступа к URL-адресу.

log

string

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

Варианты:

  • "disable"
  • "enable"

severity

string

Важность.

Варианты:

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

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть 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.
  • Чтобы создать или обновить объект, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Web application firewall configuration.
      fortinet.fortimanager.fmgr_waf_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        waf_profile:
          name: "your value" # Required variable, string
          # comment: <string>
          # extended_log: <value in [disable, enable]>
          # external: <value in [disable, enable]>
          # url_access:
          #   - access_pattern:
          #       - id: <integer>
          #         negate: <value in [disable, enable]>
          #         pattern: <string>
          #         regex: <value in [disable, enable]>
          #         srcaddr: <string>
          #     action: <value in [bypass, permit, block]>
          #     address: <string>
          #     id: <integer>
          #     log: <value in [disable, enable]>
          #     severity: <value in [low, medium, high]>
          # address_list:
          #   blocked_address: <list or string>
          #   blocked_log: <value in [disable, enable]>
          #   severity: <value in [low, medium, high]>
          #   status: <value in [disable, enable]>
          #   trusted_address: <list or string>
          # 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]>
          # method:
          #   default_allowed_methods: ["delete", "get", "head", "options", "post", "put",
          #                             "trace", "others", "connect"]
          #   log: <value in [disable, enable]>
          #   method_policy:
          #     - address: <string>
          #       allowed_methods: ["delete", "get", "head", "options", "post", "put", "trace",
          #                         "others", "connect"]
          #       id: <integer>
          #       pattern: <string>
          #       regex: <value in [disable, enable]>
          #   severity: <value in [low, medium, high]>
          #   status: <value in [disable, enable]>
          # 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–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_module.html

Spec-Zone.ru

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