fortinet.fortimanager.fmgr_ips_sensor – Настройка сенсора IPS.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_ips_sensor.

Введено в версии 2.10: модуля fortinet.fortimanager

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль способен настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать согласно источникам данных перед использованием.

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation логическое значение				Варианты: нет ← да	устанавливать в True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров
ips_sensor словарь					параметры верхнего уровня
	block-malicious-url строка			Варианты: выключить включить	Включить/выключить блокировку вредоносных URL.
	comment строка				Комментарий.
	entries список / элементы=строка				нет описания
		action строка		Варианты: пропустить заблокировать сбросить по умолчанию	Действие, выполняемое с трафиком, в котором обнаружены подписи.
		application строка			нет описания
		exempt-ip список / элементы=строка			нет описания
			dst-ip строка		IP-адрес и маска сети назначения.
			id целое число		Идентификатор исключённого IP.
			src-ip строка		IP-адрес и маска сети источника.
		id целое число			Идентификатор правила в базе данных IPS (0 - 4294967295).
		location строка			нет описания
		log строка		Варианты: выключить включить	Включить/выключить протоколирование подписей, включённых в фильтр.
		log-attack-context строка		Варианты: выключить включить	Включить/выключить протоколирование контекста атаки: буфер URL, буфер заголовков, буфер тела, буфер пакета.
		log-packet строка		Варианты: выключить включить	Включить/выключить протоколирование пакетов. Включить, чтобы сохранить пакет, вызвавший срабатывание фильтра. Вы можете загрузить пакеты в pca...
		os строка			нет описания
		protocol строка			нет описания
		quarantine строка		Варианты: нет атакующий оба интерфейс	Метод карантина.
		quarantine-expiry строка			Продолжительность карантина. (Формат ###d##h##m, минимум 1м, максимум 364d23h59m, по умолчанию = 5м). Требуется карантин, установленный на ...
		quarantine-log строка		Варианты: выключить включить	Включить/выключить протоколирование карантина.
		rate-count целое число			Количество ограничений.
		rate-duration целое число			Продолжительность (сек) ограничения.
		rate-mode строка		Варианты: периодический непрерывный	Режим ограничения скорости.
		rate-track строка		Варианты: нет src-ip dest-ip dhcp-client-mac dns-domain	Отслеживать поле протокола пакета.
		rule строка			Идентифицирует предопределённые или пользовательские подписи IPS для добавления в датчик.
		severity строка			нет описания
		status строка		Варианты: выключить включить по умолчанию	Статус подписей, включённых в фильтр. По умолчанию фильтр включён и используются только фильтры со статусом по умолчанию...
	extended-log строка			Варианты: выключить включить	Включить/выключить расширенное протоколирование.
	filter список / элементы=строка				нет описания
		action строка		Варианты: пропустить заблокировать по умолчанию сбросить	Действие выбранных правил.
		application строка			нет описания
		location строка			нет описания
		log строка		Варианты: выключить включить по умолчанию	Включить/выключить протоколирование выбранных правил.
		log-packet строка		Варианты: выключить включить по умолчанию	Включить/выключить протоколирование пакетов выбранных правил.
		name строка			Имя фильтра.
		os строка			нет описания
		protocol строка			нет описания
		quarantine строка		Варианты: нет атакующий оба интерфейс	Карантин IP-адреса или интерфейса.
		quarantine-expiry целое число			Продолжительность карантина в минутах.
		quarantine-log строка		Варианты: выключить включить	Включить/выключить протоколирование выбранного карантина.
		severity строка			нет описания
		status строка		Варианты: выключить включить по умолчанию	Статус выбранных правил.
	name строка				Имя датчика.
	override список / элементы=строка				нет описания
		action строка		Варианты: пропустить заблокировать сбросить	Действие правила переопределения.

		exempt-ip list / elements=string			нет описания
			dst-ip string		IP-адрес назначения и маска сети.
			id integer		Идентификатор исключённого IP.
			src-ip string		IP-адрес источника и маска сети.
		log string		Варианты: disable enable	Включить/выключить ведение журнала.
		log-packet string		Варианты: disable enable	Включить/выключить протоколирование пакетов.
		quarantine string		Варианты: none attacker both interface	Карантин IP-адреса или интерфейса.
		quarantine-expiry integer			Срок карантина в минутах.
		quarantine-log string		Варианты: disable enable	Включить/выключить протоколирование выбранного карантина.
		rule-id integer			Переопределить ID правила.
		status string		Варианты: disable enable	Включить/выключить состояние правила переопределения.
	replacemsg-group string				Группа заменяющих сообщений.
rc_failed list / elements=string					Список кодов rc, при которых условия будут нарушены.
rc_succeeded list / elements=string					Список кодов rc, при которых условия будут выполнены.
state string / required				Варианты: present absent	Директива для создания, обновления или удаления объекта.
workspace_locking_adom string					ADOM для блокировки при работе в режиме рабочего пространства FortiManager, значение может быть глобальным или другим, включая root.
workspace_locking_timeout integer				По умолчанию: 300	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой rc. Вы также можете переопределить условия для ошибок или успешного завершения с помощью параметров rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPS sensor.
     fmgr_ips_sensor:
        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>
        state: <value in [present, absent]>
        ips_sensor:
           block-malicious-url: <value in [disable, enable]>
           comment: <value of string>
           entries:
             -
                 action: <value in [pass, block, reset, ...]>
                 application: <value of string>
                 exempt-ip:
                   -
                       dst-ip: <value of string>
                       id: <value of integer>
                       src-ip: <value of string>
                 id: <value of integer>
                 location: <value of string>
                 log: <value in [disable, enable]>
                 log-attack-context: <value in [disable, enable]>
                 log-packet: <value in [disable, enable]>
                 os: <value of string>
                 protocol: <value of string>
                 quarantine: <value in [none, attacker, both, ...]>
                 quarantine-expiry: <value of string>
                 quarantine-log: <value in [disable, enable]>
                 rate-count: <value of integer>
                 rate-duration: <value of integer>
                 rate-mode: <value in [periodical, continuous]>
                 rate-track: <value in [none, src-ip, dest-ip, ...]>
                 rule: <value of string>
                 severity: <value of string>
                 status: <value in [disable, enable, default]>
           extended-log: <value in [disable, enable]>
           filter:
             -
                 action: <value in [pass, block, default, ...]>
                 application: <value of string>
                 location: <value of string>
                 log: <value in [disable, enable, default]>
                 log-packet: <value in [disable, enable, default]>
                 name: <value of string>
                 os: <value of string>
                 protocol: <value of string>
                 quarantine: <value in [none, attacker, both, ...]>
                 quarantine-expiry: <value of integer>
                 quarantine-log: <value in [disable, enable]>
                 severity: <value of string>
                 status: <value in [disable, enable, default]>
           name: <value of string>
           override:
             -
                 action: <value in [pass, block, reset]>
                 exempt-ip:
                   -
                       dst-ip: <value of string>
                       id: <value of integer>
                       src-ip: <value of string>
                 log: <value in [disable, enable]>
                 log-packet: <value in [disable, enable]>
                 quarantine: <value in [none, attacker, both, ...]>
                 quarantine-expiry: <value of integer>
                 quarantine-log: <value in [disable, enable]>
                 rule-id: <value of integer>
                 status: <value in [disable, enable]>
           replacemsg-group: <value of string>

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

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

Ключ	Возвращаемое	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Описание ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_ips_sensor_module.html