fortinet.fortimanager.fmgr_ips_baseline_sensor_entries модуль – Фильтр датчиков IPS.

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortimanager.fmgr_ips_baseline_sensor_entries.

Впервые в 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_entries словарь	Настройка параметров верхнего уровня.
action строка	Действие, выполняемое с трафиком, в котором обнаружены подписи. Варианты: `"pass"` `"block"` `"reset"` `"default"`
application любой	(список) Приложения, которые необходимо защищать.
cve любой	(список) Список идентификаторов CVE подписей, которые необходимо добавить в датчик
exempt_ip список / элементы=словарь	Устарело, пожалуйста, переименуйте на exempt_ip. Исключить IP.
dst_ip строка	Устарело, пожалуйста, переименуйте на dst_ip. Адрес назначения IP и маска подсети.
id целое число	ID IP адреса исключения.
src_ip строка	Устарело, пожалуйста, переименуйте на src_ip. Адрес источника IP и маска подсети.
id целое число / обязательно	ID правила в базе данных IPS.
location любой	(список) Защитить трафик клиента или сервера.
log строка	Включить/выключить ведение журнала подписей, включенных в фильтр. Варианты: `"disable"` `"enable"`
log_attack_context строка	Устарело, пожалуйста, переименуйте на log_attack_context. Включить/выключить ведение журнала контекста атаки. Варианты: `"disable"` `"enable"`
log_packet строка	Устарело, пожалуйста, переименуйте на log_packet. Включить/выключить ведение журнала пакетов. Варианты: `"disable"` `"enable"`
os любой	(список) Операционные системы, которые необходимо защищать.
protocol любой	(список) Протоколы, которые необходимо проверить.
quarantine строка	Метод карантина. Варианты: `"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	(список) Относительная степень серьезности подписи, от информации до критической.
status string	Статус подписей, включенных в фильтр. Варианты: `"disable"` `"enable"` `"default"`
tags string	Теги.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, при которых условия будут считаться проваленными.
rc_succeeded list / elements=integer	Список rc-кодов, при которых условия будут считаться выполненными.
sensor string / обязательно	Параметр (sensor) в запрошенном URL.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе с FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву 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: IPS sensor filter.
      fortinet.fortimanager.fmgr_ips_baseline_sensor_entries:
        # 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>
        sensor: <your own value>
        state: present # <value in [present, absent]>
        ips_baseline_sensor_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>

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_entries_module.html