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

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к 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-кодов, с которыми будут переопределены условия для успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
waf_profile_constraint_exception словарь	Набор параметров верхнего уровня.
address строка	Адрес хоста.
content-length строка	Устарело, пожалуйста, переименуйте его в content_length. Длина HTTP-контента в запросе. Варианты: `"disable"` `"enable"`
header-length строка	Устарело, пожалуйста, переименуйте его в header_length. Длина HTTP-заголовка в запросе. Варианты: `"disable"` `"enable"`
hostname строка	Включить/выключить проверку имени хоста. Варианты: `"disable"` `"enable"`
id целое число / обязательно	Идентификатор исключения.
line-length строка	Устарело, пожалуйста, переименуйте его в line_length. Длина строки HTTP-запроса. Варианты: `"disable"` `"enable"`
malformed строка	Включить/выключить проверку некорректных HTTP-запросов. Варианты: `"disable"` `"enable"`
max-cookie строка	Устарело, пожалуйста, переименуйте его в max_cookie. Максимальное количество файлов cookie в HTTP-запросе. Варианты: `"disable"` `"enable"`

max-header-line string	Устаревшее, пожалуйста, переименуйте на max_header_line. Максимальное количество строк HTTP-заголовка. Варианты: `"disable"` `"enable"`
max-range-segment string	Устаревшее, пожалуйста, переименуйте на max_range_segment. Максимальное количество сегментов диапазона в строке HTTP range. Варианты: `"disable"` `"enable"`
max-url-param string	Устаревшее, пожалуйста, переименуйте на max_url_param. Максимальное количество параметров в URL. Варианты: `"disable"` `"enable"`
method string	Включить/отключить проверку HTTP-метода. Варианты: `"disable"` `"enable"`
param-length string	Устаревшее, пожалуйста, переименуйте на param_length. Максимальная длина параметра в URL, HTTP-запросе POST или HTTP-теле. Варианты: `"disable"` `"enable"`
pattern string	Шаблон URL.
regex string	Включить/отключить сопоставление шаблона на основе регулярного выражения. Варианты: `"disable"` `"enable"`
url-param-length string	Устаревшее, пожалуйста, переименуйте на url_param_length. Максимальная длина параметра в URL. Варианты: `"disable"` `"enable"`
version string	Включить/отключить проверку HTTP-версии. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно запуск одного модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия завершения ошибкой или успехом с помощью параметров 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: HTTP constraint exception.
      fortinet.fortimanager.fmgr_waf_profile_constraint_exception:
        # 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>
        state: present # <value in [present, absent]>
        waf_profile_constraint_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]>

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

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

Ключ	Описание
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–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_exception_module.html