Модуль fortinet.fortimanager.fmgr_ips_baseline_sensor_entries — фильтр датчика IPS.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.2.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.
ips_baseline_sensor_entries dictionary	Набор параметров верхнего уровня.
action string	Действие, выполняемое с трафиком, в котором обнаружены сигнатуры. Варианты: `"pass"` `"block"` `"reset"` `"default"`
application any	(список) Приложения, которые необходимо защитить.
cve any	(список) Список идентификаторов CVE сигнатур, добавляемых в датчик
exempt_ip псевдонимы: exempt-ip list / элементы=dictionary	Исключение IP-адреса.
dst_ip псевдонимы: dst-ip string	IP-адрес и маска подсети назначения.
id integer	Идентификатор исключенного IP-адреса.
src_ip псевдонимы: src-ip string	IP-адрес и маска подсети источника.
id integer / обязательный	Идентификатор правила в базе данных IPS
location any	(список) Защита трафика клиента или сервера.
log string	Включить/отключить ведение журнала сигнатур, включенных в фильтр. Варианты: `"disable"` `"enable"`
log_attack_context псевдонимы: log-attack-context string	Включить/отключить ведение журнала контекста атаки Варианты: `"disable"` `"enable"`
log_packet псевдонимы: log-packet string	Включить/отключить ведение журнала пакетов. Варианты: `"disable"` `"enable"`
os any	(список) Операционные системы, которые необходимо защитить.
protocol any	(список) Протоколы для проверки.
quarantine string	Метод помещения в карантин. Варианты: `"none"` `"attacker"` `"both"` `"interface"`
quarantine_expiry псевдонимы: quarantine-expiry string	Продолжительность карантина.
quarantine_log псевдонимы: quarantine-log string	Включить/отключить ведение журнала карантина. Варианты: `"disable"` `"enable"`
rate_count псевдонимы: rate-count integer	Количество событий в пределах интервала.
rate_duration псевдонимы: rate-duration integer	Продолжительность
rate_mode псевдонимы: rate-mode string	Режим ограничения частоты. Варианты: `"periodical"` `"continuous"`
rate_track псевдонимы: rate-track string	Отслеживание поля протокола пакета. Варианты: `"none"` `"src-ip"` `"dest-ip"` `"dhcp-client-mac"` `"dns-domain"`
rule string	Определяет предустановленные или пользовательские сигнатуры IPS, добавляемые в датчик.
severity any	(список) Относительная степень серьезности сигнатуры: от информационной до критической.
status string	Статус сигнатур, включенных в фильтр. Варианты: `"disable"` `"enable"` `"default"`
tags string	Теги.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, для которых переопределяются условия успеха.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
sensor string / обязательный	Параметр (sensor) в запрашиваемом URL.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
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: IPS sensor filter.
      fortinet.fortimanager.fmgr_ips_baseline_sensor_entries:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        sensor: <your own value>
        state: present # <value in [present, absent]>
        ips_baseline_sensor_entries:
          id: 0 # Required variable, integer
          # action: <value in [pass, block, reset, ...]>
          # application: <list or string>
          # cve: <list or string>
          # exempt_ip:
          #   - dst_ip: <string>
          #     id: <integer>
          #     src_ip: <string>
          # location: <list or string>
          # log: <value in [disable, enable]>
          # log_attack_context: <value in [disable, enable]>
          # log_packet: <value in [disable, enable]>
          # os: <list or string>
          # protocol: <list or string>
          # quarantine: <value in [none, attacker, both, ...]>
          # quarantine_expiry: <string>
          # quarantine_log: <value in [disable, enable]>
          # rate_count: <integer>
          # rate_duration: <integer>
          # rate_mode: <value in [periodical, continuous]>
          # rate_track: <value in [none, src-ip, dest-ip, ...]>
          # rule: <string>
          # severity: <list or string>
          # status: <value in [disable, enable, default]>
          # tags: <string>

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

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

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