Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_ips_sensor — настройка датчика IPS в Fortinet FortiOS и FortiGate.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_ips_sensor.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции IPS и категории датчика. В примерах приведены все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием. Проверено на FOS v6.0.0

Требования

На хосте, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate.

enable_log

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

ips_sensor

dictionary

Настройка датчика IPS.

block_malicious_url

string

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

Варианты:

  • "disable"
  • "enable"

comment

string

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

entries

list / elements=dictionary

Фильтр датчика IPS.

action

string

Действие, выполняемое с трафиком, в котором обнаружены сигнатуры.

Варианты:

  • "pass"
  • "block"
  • "reset"
  • "default"

application

list / elements=string

Операционные системы, которые необходимо защищать. Используйте all для всех приложений и other для приложений, отсутствующих в списке.

cve

list / elements=dictionary

Список идентификаторов CVE сигнатур, которые нужно добавить в датчик.

cve_entry

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

Идентификаторы CVE или шаблоны CVE.

default_action

string

Фильтр действия по умолчанию для сигнатуры.

Варианты:

  • "all"
  • "pass"
  • "block"

default_status

string

Фильтр статуса сигнатуры по умолчанию.

Варианты:

  • "all"
  • "enable"
  • "disable"

exempt_ip

list / elements=dictionary

Трафик с выбранных исходных или целевых IP-адресов освобождается от проверки этой сигнатурой.

dst_ip

string

IP-адрес назначения и маска подсети (применяются к пакету, соответствующему сигнатуре).

id

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

Идентификатор исключённого IP-адреса. См. <a href=’#notes’>примечания</a>.

src_ip

string

IP-адрес источника и маска подсети (применяются к пакету, соответствующему сигнатуре).

id

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

Идентификатор правила в базе данных IPS (0–4294967295). См. <a href=’#notes’>примечания</a>.

last_modified

string

Фильтр по дате последнего изменения сигнатуры. Форматы: before <date>, after <date>, between <start-date> <end-date>.

location

list / elements=string

Защита трафика клиента или сервера.

log

string

Включить/отключить ведение журнала сигнатур, включённых в фильтр.

Варианты:

  • "disable"
  • "enable"

log_attack_context

string

Включить/отключить ведение журнала контекста атаки: буфера URL, буфера заголовка, буфера тела и буфера пакета.

Варианты:

  • "disable"
  • "enable"

log_packet

string

Включить/отключить ведение журнала пакетов. Включите этот параметр, чтобы сохранять пакет, вызвавший срабатывание фильтра. Для диагностики можно скачать пакеты в формате pcap.

Варианты:

  • "disable"
  • "enable"

os

list / elements=string

Операционные системы, которые необходимо защищать. Используйте all для всех операционных систем и other для операционных систем, отсутствующих в списке.

protocol

list / elements=string

Протоколы для проверки. Используйте all для всех протоколов и other для протоколов, отсутствующих в списке.

quarantine

string

Метод помещения в карантин.

Варианты:

  • "none"
  • "attacker"

quarantine_expiry

string

Продолжительность карантина. (Формат

quarantine_log

string

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

Варианты:

  • "disable"
  • "enable"

rate_count

integer

Количество событий для ограничения частоты.

rate_duration

integer

Длительность интервала ограничения частоты (с).

rate_mode

string

Режим ограничения частоты.

Варианты:

  • "periodical"
  • "continuous"

rate_track

string

Отслеживаемое поле протокола пакета.

Варианты:

  • "none"
  • "src-ip"
  • "dest-ip"
  • "dhcp-client-mac"
  • "dns-domain"

rule

list / elements=dictionary

Определяет предопределённые или пользовательские сигнатуры IPS, которые нужно добавить в датчик.

id

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

Правило IPS. См. <a href=’#notes’>примечания</a>.

severity

list / elements=string

Относительная степень серьёзности сигнатуры — от информационной до критической. Степень серьёзности указывается в сообщениях журнала, созданных сигнатурой.

status

string

Статус сигнатур, включённых в фильтр. Используются только фильтры со статусом enable.

Варианты:

  • "disable"
  • "enable"
  • "default"

vuln_type

list / elements=dictionary

Список типов уязвимостей сигнатур для фильтрации.

id

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

Идентификатор типа уязвимости. См. <a href=’#notes’>примечания</a>.

extended_log

string

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

Варианты:

  • "enable"
  • "disable"

filter

list / elements=dictionary

Фильтр датчика IPS.

action

string

Действие для выбранных правил.

Варианты:

  • "pass"
  • "block"
  • "reset"
  • "default"

application

string

Фильтр уязвимых приложений.

location

string

Фильтр по местоположению уязвимости.

log

string

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

Варианты:

  • "disable"
  • "enable"

log_packet

string

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

Варианты:

  • "disable"
  • "enable"

name

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

Имя фильтра.

os

string

Фильтр уязвимых операционных систем.

protocol

string

Фильтр уязвимых протоколов.

quarantine

string

Поместить IP-адрес или интерфейс в карантин.

Варианты:

  • "none"
  • "attacker"

quarantine_expiry

integer

Продолжительность карантина в минутах.

quarantine_log

string

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

Варианты:

  • "disable"
  • "enable"

severity

string

Фильтр по степени серьёзности уязвимости.

status

string

Статус выбранных правил.

Варианты:

  • "disable"
  • "enable"
  • "default"

name

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

Имя датчика.

override

list / elements=dictionary

Правило переопределения IPS.

action

string

Действие для правила переопределения.

Варианты:

  • "pass"
  • "block"
  • "reset"

exempt_ip

list / elements=dictionary

Исключённый IP-адрес.

dst_ip

string

IP-адрес назначения и маска подсети.

id

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

Идентификатор исключённого IP-адреса. См. <a href=’#notes’>примечания</a>.

src_ip

string

IP-адрес источника и маска подсети.

log

string

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

Варианты:

  • "disable"
  • "enable"

log_packet

string

Включить или отключить регистрацию пакетов.

Варианты:

  • "disable"
  • "enable"

quarantine

string

Карантин IP-адреса или интерфейса.

Варианты:

  • "none"
  • "attacker"

quarantine_expiry

integer

Длительность карантина в минутах.

quarantine_log

string

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

Варианты:

  • "disable"
  • "enable"

rule_id

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

Идентификатор переопределяемого правила. См. <a href=’#notes’>примечания</a>.

status

string

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

Варианты:

  • "disable"
  • "enable"

replacemsg_group

string

Группа сообщений для замены. Источник: system.replacemsg-group.name.

scan_botnet_connections

string

Блокировать или отслеживать подключения к серверам ботнетов либо отключить сканирование ботнетов.

Варианты:

  • "disable"
  • "block"
  • "monitor"

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр member_path предназначен для выполнения операций с элементами.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; предпочтительный способ запуска плейбуков — httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure IPS sensor.
  fortinet.fortios.fortios_ips_sensor:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ips_sensor:
          block_malicious_url: "disable"
          comment: "Comment."
          entries:
              -
                  action: "pass"
                  application: "<your_own_value>"
                  cve:
                      -
                          cve_entry: "<your_own_value>"
                  default_action: "all"
                  default_status: "all"
                  exempt_ip:
                      -
                          dst_ip: "<your_own_value>"
                          id: "14"
                          src_ip: "<your_own_value>"
                  id: "16"
                  last_modified: "<your_own_value>"
                  location: "<your_own_value>"
                  log: "disable"
                  log_attack_context: "disable"
                  log_packet: "disable"
                  os: "<your_own_value>"
                  protocol: "<your_own_value>"
                  quarantine: "none"
                  quarantine_expiry: "<your_own_value>"
                  quarantine_log: "disable"
                  rate_count: "0"
                  rate_duration: "60"
                  rate_mode: "periodical"
                  rate_track: "none"
                  rule:
                      -
                          id: "32"
                  severity: "<your_own_value>"
                  status: "disable"
                  vuln_type:
                      -
                          id: "36"
          extended_log: "enable"
          filter:
              -
                  action: "pass"
                  application: "<your_own_value>"
                  location: "<your_own_value>"
                  log: "disable"
                  log_packet: "disable"
                  name: "default_name_44"
                  os: "<your_own_value>"
                  protocol: "<your_own_value>"
                  quarantine: "none"
                  quarantine_expiry: "1073741823"
                  quarantine_log: "disable"
                  severity: "<your_own_value>"
                  status: "disable"
          name: "default_name_52"
          override:
              -
                  action: "pass"
                  exempt_ip:
                      -
                          dst_ip: "<your_own_value>"
                          id: "57"
                          src_ip: "<your_own_value>"
                  log: "disable"
                  log_packet: "disable"
                  quarantine: "none"
                  quarantine_expiry: "1073741823"
                  quarantine_log: "disable"
                  rule_id: "<you_own_value>"
                  status: "disable"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          scan_botnet_connections: "disable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи конфигурации на FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate после выполнения последней операции

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

Пример: "200"

mkey

string

Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер редакции

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

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

Пример: "success"

vdom

string

Используемый виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_ips_sensor_module.html

Spec-Zone.ru

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