fortinet.fortimanager.fmgr_ips_baseline_sensor модуль — Настройка сенсора IPS.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.2.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
ips_baseline_sensor словарь	Настройка параметров верхнего уровня.
block_malicious_url строка	Устарело, используйте block_malicious_url. Включение/выключение блокировки вредоносных URL. Варианты: `"disable"` `"enable"`
comment строка	Комментарий.
entries список / элементы=словарь	Элементы.
action строка	Действие, выполняемое с трафиком, в котором обнаружены сигнатуры. Варианты: `"pass"` `"block"` `"reset"` `"default"`
application любой	(список) Приложения, подлежащие защите.
cve любой	(список) Список CVE-идентификаторов сигнатур, которые нужно добавить в датчик
exempt_ip список / элементы=словарь	Исключить IP.
dst_ip строка	Адрес назначения IP и маска сети.
id целое	Идентификатор исключённого IP.
src_ip строка	Адрес источника IP и маска сети.
id целое	Идентификатор правила в базе данных IPS
location любой	(список) Защита трафика клиента или сервера.
log строка	Включить/выключить логирование сигнатур, включенных в фильтр. Варианты: `"disable"` `"enable"`
log_attack_context строка	Включить/выключить логирование контекста атаки Варианты: `"disable"` `"enable"`
log_packet строка	Включить/выключить логирование пакетов. Варианты: `"disable"` `"enable"`
os любой	(список) Операционные системы, подлежащие защите.

protocol any	(list) Протоколы для проверки.
quarantine string	Метод карантина. Варианты: `"none"` `"attacker"` `"both"` `"interface"`
quarantine-expiry string	Устарело, пожалуйста, переименуйте на quarantine_expiry. Длительность карантина.
quarantine-log string	Устарело, пожалуйста, переименуйте на quarantine_log. Включить/выключить протоколирование карантина. Варианты: `"disable"` `"enable"`
rate-count integer	Устарело, пожалуйста, переименуйте на rate_count. Количество.
rate-duration integer	Устарело, пожалуйста, переименуйте на rate_duration. Продолжительность
rate-mode string	Устарело, пожалуйста, переименуйте на rate_mode. Режим ограничения скорости. Варианты: `"periodical"` `"continuous"`
rate-track string	Устарело, пожалуйста, переименуйте на rate_track. Отслеживать поле протокола пакета. Варианты: `"none"` `"src-ip"` `"dest-ip"` `"dhcp-client-mac"` `"dns-domain"`
rule string	Определяет предварительно заданные или пользовательские подписи IPS для добавления в датчик.
severity any	(list) Относительная степень серьезности подписи, от информации до критической.
status string	Статус подписей, включенных в фильтр. Варианты: `"disable"` `"enable"` `"default"`
tags string	Теги.
extended-log string	Устарело, пожалуйста, переименуйте на extended_log. Включить/выключить расширенное протоколирование. Варианты: `"disable"` `"enable"`
filter list / elements=dictionary	Фильтр.
action string	Действие выбранных правил. Варианты: `"pass"` `"block"` `"default"` `"reset"`
application any	(list) Фильтр приложений уязвимостей.
application(real) string	Устарело, пожалуйста, переименуйте на application_real). Приложение
location any	(list) Фильтр местоположения уязвимостей.
location(real) string	Устарело, пожалуйста, переименуйте на location_real). Местоположение
log string	Включить/выключить протоколирование выбранных правил. Варианты: `"disable"` `"enable"` `"default"`
log-packet string	Устарело, пожалуйста, переименуйте на log_packet. Включить/выключить протоколирование пакетов выбранных правил. Варианты: `"disable"` `"enable"` `"default"`

имя строка	Имя фильтра.
os любое	(список) Фильтр уязвимых операционных систем.
os(real) строка	Устарело, пожалуйста, переименуйте на os_real). OS
протокол любое	(список) Фильтр уязвимых протоколов.
протокол(real) строка	Устарело, пожалуйста, переименуйте на protocol_real). Протокол
карантин строка	IP-адрес или интерфейс в карантине. Варианты: `"none"` `"attacker"` `"both"` `"interface"`
карантин-срок_действия целое_число	Устарело, пожалуйста, переименуйте на quarantine_expiry. Длительность карантина в минутах.
карантин-журнал строка	Устарело, пожалуйста, переименуйте на quarantine_log. Включить/выключить протоколирование выбранного карантина. Варианты: `"disable"` `"enable"`
серьёзность любое	(список) Фильтр серьёзности уязвимости.
серьёзность(real) строка	Устарело, пожалуйста, переименуйте на severity_real). Серьёзность
статус строка	Статус выбранных правил. Варианты: `"disable"` `"enable"` `"default"`
журнал строка	Журнал. Варианты: `"disable"` `"enable"`
имя строка / обязательно	Имя датчика.
переопределение список / элементы=словарь	Переопределение.
действие строка	Действие правила переопределения. Варианты: `"pass"` `"block"` `"reset"`
исключение-ip список / элементы=словарь	Устарело, пожалуйста, переименуйте на exempt_ip. Исключение IP.
адрес-назначения-ip строка	Устарело, пожалуйста, переименуйте на dst_ip. Адрес назначения IP и маска сети.
идентификатор целое_число	Идентификатор исключенного IP.
источник-ip строка	Устарело, пожалуйста, переименуйте на src_ip. Адрес источника IP и маска сети.
журнал строка	Включить/выключить протоколирование. Варианты: `"disable"` `"enable"`
журнал-пакет строка	Устарело, пожалуйста, переименуйте на log_packet. Включить/выключить протоколирование пакетов. Варианты: `"disable"` `"enable"`
карантин строка	IP-адрес или интерфейс в карантине. Варианты: `"none"` `"attacker"` `"both"` `"interface"`

quarantine-expiry целое число	Устарело, пожалуйста, переименуйте на quarantine_expiry. Длительность карантина в минутах.
quarantine-log строка	Устарело, пожалуйста, переименуйте на quarantine_log. Включить/выключить протоколирование выбранного карантина. Варианты: `"disable"` `"enable"`
rule-id целое число	Устарело, пожалуйста, переименуйте на rule_id. Идентификатор правила переопределения.
status строка	Включить/выключить состояние правила переопределения. Варианты: `"disable"` `"enable"`
replacemsg-group строка	Устарело, пожалуйста, переименуйте на replacemsg_group. Группа сообщений замены.
scan-botnet-connections строка	Устарело, пожалуйста, переименуйте на scan_botnet_connections. Блокировать или контролировать подключения к серверам ботнета, или отключить Ботнет… Варианты: `"disable"` `"block"` `"monitor"`
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / требуется	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием знака подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Работа в режиме блокировки рабочего пространства поддерживается в данном модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия для отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPS sensor.
      fortinet.fortimanager.fmgr_ips_baseline_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: present # <value in [present, absent]>
        ips_baseline_sensor:
          block_malicious_url: <value in [disable, enable]>
          comment: <string>
          entries:
            -
              action: <value in [pass, block, reset, ...]>
              application: <list or string>
              cve: <list or string>
              exempt_ip:
                -
                  dst_ip: <string>
                  id: <integer>
                  src_ip: <string>
              id: <integer>
              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>
          extended_log: <value in [disable, enable]>
          filter:
            -
              action: <value in [pass, block, default, ...]>
              application: <list or string>
              application_real): <string>
              location: <list or string>
              location_real): <string>
              log: <value in [disable, enable, default]>
              log_packet: <value in [disable, enable, default]>
              name: <string>
              os: <list or string>
              os_real): <string>
              protocol: <list or string>
              protocol_real): <string>
              quarantine: <value in [none, attacker, both, ...]>
              quarantine_expiry: <integer>
              quarantine_log: <value in [disable, enable]>
              severity: <list or string>
              severity_real): <string>
              status: <value in [disable, enable, default]>
          log: <value in [disable, enable]>
          name: <string>
          override:
            -
              action: <value in [pass, block, reset]>
              exempt_ip:
                -
                  dst_ip: <string>
                  id: <integer>
                  src_ip: <string>
              log: <value in [disable, enable]>
              log_packet: <value in [disable, enable]>
              quarantine: <value in [none, attacker, both, ...]>
              quarantine_expiry: <integer>
              quarantine_log: <value in [disable, enable]>
              rule_id: <integer>
              status: <value in [disable, enable]>
          replacemsg_group: <string>
          scan_botnet_connections: <value in [disable, block, monitor]>

Значения возврата

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_ips_baseline_sensor_module.html