Модуль fortinet.fortimanager.fmgr_ips_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_sensor_entries.

Добавлено в 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.
ips_sensor_entries dictionary	Набор параметров верхнего уровня.
action string	Действие, выполняемое с трафиком, в котором обнаружены сигнатуры. Варианты: `"pass"` `"block"` `"reset"` `"default"`
application any	(список) Приложения, которые необходимо защитить.
cve any	(список) Список идентификаторов CVE сигнатур, которые нужно добавить в датчик.
default_action псевдонимы: default-action string	Фильтр действия по умолчанию для сигнатуры. Варианты: `"block"` `"pass"` `"all"` `"drop"`
default_status псевдонимы: default-status string	Фильтр статуса сигнатуры по умолчанию. Варианты: `"disable"` `"enable"` `"all"`
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.
last_modified псевдонимы: last-modified any	(список или строка) Фильтр по дате последнего изменения сигнатуры.
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 any	(список или строка) Определяет предопределённые или пользовательские сигнатуры IPS, которые нужно добавить в датчик.
severity any	(список) Относительная степень серьёзности сигнатуры: от информационной до критической.
status string	Статус сигнатур, включённых в фильтр. Варианты: `"disable"` `"enable"` `"default"`
tags string
vuln_type псевдонимы: vuln-type any	(список) Список типов уязвимостей сигнатур для фильтрации.
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 и другие значения, включая 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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: IPS sensor filter.
      fortinet.fortimanager.fmgr_ips_sensor_entries:
        bypass_validation: false
        adom: ansible
        sensor: "ansible-test-ipssensor" # name
        state: present
        ips_sensor_entries:
          action: block # <value in [pass, block, reset, ...]>
          id: 1

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the filters of IPS sensor
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "ips_sensor_entries"
          params:
            adom: "ansible"
            sensor: "ansible-test-ipssensor" # name
            entries: "your_value"

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

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

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