Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_waf_profile_constraint_exception – исключение ограничения HTTP.

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_waf_profile_constraint_exception.

Добавлено в 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 / элементы=integer

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

rc_succeeded

list / элементы=integer

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

revision_note

string

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

state

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

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

waf_profile_constraint_exception

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"

workspace_locking_adom

string

ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства; значением может быть global или другой ADOM, включая 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: HTTP constraint exception.
      fortinet.fortimanager.fmgr_waf_profile_constraint_exception:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        state: present # <value in [present, absent]>
        waf_profile_constraint_exception:
          id: 0 # Required variable, integer
          # address: <string>
          # content_length: <value in [disable, enable]>
          # header_length: <value in [disable, enable]>
          # hostname: <value in [disable, enable]>
          # 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]>

Возвращаемые значения

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус API-запроса.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=string

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

Spec-Zone.ru

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