Spec-Zone.ru › Ansible

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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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.15

Параметры

Параметр

Комментарии

access_token

строка

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

enable_log

логический

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

Выбор:

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

ips_sensor

словарь

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

block_malicious_url

строка

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

Выбор:

  • "disable"
  • "enable"

comment

строка

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

entries

список / элементы=словарь

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

action

строка

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

Выбор:

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

application

список / элементы=строка

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

cve

список / элементы=словарь

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

cve_entry

строка / обязательно

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

default_action

строка

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

Выбор:

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

default_status

строка

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

Выбор:

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

exempt_ip

список / элементы=словарь

Трафик с указанных исходных или целевых IP-адресов исключен из этой подписи.

dst_ip

строка

Целевой IP-адрес и маска сети (применимо к пакетам, соответствующим подписи).

id

целое число / обязательно

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

src_ip

строка

Исходный IP-адрес и маска сети (применимо к пакетам, соответствующим подписи).

id

целое число / обязательно

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

last_modified

строка

Фильтр по дате последнего изменения подписи. Форматы: до <дата>, после <дата>, между <дата начала> <дата окончания>.

location

список / элементы=строка

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

log

строка

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

Выбор:

  • "disable"
  • "enable"

log_attack_context

строка

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

Выбор:

  • "disable"
  • "enable"

log_packet

string

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

Choices:

  • "disable"
  • "enable"

os

list / elements=string

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

protocol

list / elements=string

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

quarantine

string

Метод карантина.

Choices:

  • "none"
  • "attacker"

quarantine_expiry

string

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

quarantine_log

string

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

Choices:

  • "disable"
  • "enable"

rate_count

integer

Количество скорости.

rate_duration

integer

Продолжительность (сек) скорости.

rate_mode

string

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

Choices:

  • "periodical"
  • "continuous"

rate_track

string

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

Choices:

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

rule

list / elements=dictionary

Идентифицирует предопределенные или пользовательские сигнатуры IPS, которые необходимо добавить к сенсору.

id

integer / required

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

severity

list / elements=string

Относительная серьезность сигнатуры, от info до critical. Сообщения журнала, генерируемые сигнатурой, включают серьезность.

status

string

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

Choices:

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

vuln_type

list / elements=dictionary

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

id

integer / required

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

extended_log

string

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

Choices:

  • "enable"
  • "disable"

filter

list / elements=dictionary

Фильтр сенсора IPS.

action

string

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

Choices:

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

application

string

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

location

string

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

log

string

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

Choices:

  • "disable"
  • "enable"

log_packet

string

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

Choices:

  • "disable"
  • "enable"

name

string / required

Имя фильтра.

os

string

Фильтр уязвимых ОС.

protocol

string

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

quarantine

string

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

Choices:

  • "none"
  • "attacker"

quarantine_expiry

integer

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

quarantine_log

string

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

Choices:

  • "disable"
  • "enable"

severity

string

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

status

string

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

Choices:

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

name

string / required

Имя сенсора.

override

list / elements=dictionary

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

action

string

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

Choices:

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

exempt_ip

list / elements=dictionary

Исключенный IP.

dst_ip

string

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

id

integer / required

ID исключенного IP. см. <a href=’#notes’>Примечания</a>.

src_ip

string

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

log

string

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

Choices:

  • "disable"
  • "enable"

log_packet

string

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

Choices:

  • "disable"
  • "enable"

quarantine

string

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

Choices:

  • "none"
  • "attacker"

quarantine_expiry

integer

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

quarantine_log

string

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

Choices:

  • "disable"
  • "enable"

rule_id

целое число / обязательно

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

replacemsg_group

строка

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

scan_botnet_connections

строка

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

Варианты:

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

member_path

строка

Путь к атрибуту члена для обработки.

Разделяется символом слеша, если атрибутов несколько.

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

member_state

строка

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

Когда member_state указан, опция state игнорируется.

Варианты:

  • "present"
  • "absent"

state

строка / обязательно

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

Варианты:

  • "present"
  • "absent"

vdom

строка

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

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

Примечания

Примечание

  • Модуль fortiosapi устарел, httpapi предпочтительнее для выполнения playbooks.
  • Модуль поддерживает режим 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

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

Главный ключ (id), используемый в последнем вызове FortiGate

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

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

Внутренний номер версии

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_ips_sensor_module.html

Spec-Zone.ru

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