fortinet.fortimanager.fmgr_ips_sensor модуль — Настройка датчика IPS.

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_ips_sensor.

Новый в fortinet.fortimanager 1.0.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_sensor словарь	Параметры верхнего уровня.
_baseline строка	Базовая линия.
block_malicious_url строка	Устаревшее, пожалуйста, переименуйте на block_malicious_url. Включить/выключить блокировку вредоносных URL-адресов. Варианты: `"disable"` `"enable"`
comment строка	Комментарий.
entries список / элементы=словарь	Элементы.
action строка	Действие, выполняемое с трафиком, в котором обнаружены подписи. Варианты: `"pass"` `"block"` `"reset"` `"default"`
application любой	(список) Приложения, подлежащие защите.
cve любой	(список) Список CVE-идентификаторов подписей, которые нужно добавить в сенсор
default_action строка	Устаревшее, пожалуйста, переименуйте на default_action. Фильтр по действию по умолчанию подписи. Варианты: `"block"` `"pass"` `"all"` `"drop"`
default_status строка	Устаревшее, пожалуйста, переименуйте на default_status. Фильтр по статусу по умолчанию подписи. Варианты: `"disable"` `"enable"` `"all"`
exempt_ip список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на exempt_ip. Исключение IP.
dst_ip строка	Устаревшее, пожалуйста, переименуйте на dst_ip. Адрес назначения IP и маска сети.
id целое число	Идентификатор исключенного IP.
src_ip строка	Устаревшее, пожалуйста, переименуйте на src_ip. Адрес источника IP и маска сети.
id целое число	Идентификатор правила в базе данных IPS
last_modified любой	(список или строка) Устаревшее, пожалуйста, переименуйте на last_modified. Фильтр по дате последнего изменения подписи.
location любой	(список) Защита трафика клиента или сервера.

END_OF_DOCUMENT_MARKER

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

location any	(list) Фильтр местоположения уязвимости.
log string	Включить/отключить ведение журнала выбранных правил. Choices: `"disable"` `"enable"` `"default"`
log-packet string	Устарело, пожалуйста, переименуйте в log_packet. Включить/отключить ведение журнала пакетов выбранных правил. Choices: `"disable"` `"enable"` `"default"`
name string	Имя фильтра.
os any	(list) Фильтр уязвимой ОС.
protocol any	(list) Фильтр уязвимого протокола.
quarantine string	Карантин IP или интерфейса. Choices: `"none"` `"attacker"` `"both"` `"interface"`
quarantine-expiry integer	Устарело, пожалуйста, переименуйте в quarantine_expiry. Продолжительность карантина в минутах.
quarantine-log string	Устарело, пожалуйста, переименуйте в quarantine_log. Включить/отключить ведение журнала выбранного карантина. Choices: `"disable"` `"enable"`
severity any	(list) Фильтр серьезности уязвимости.
status string	Статус выбранных правил. Choices: `"disable"` `"enable"` `"default"`
name string / required	Имя сенсора.
override list / elements=dictionary	Переопределение.
action string	Действие правила переопределения. Choices: `"pass"` `"block"` `"reset"`
exempt-ip list / elements=dictionary	Устарело, пожалуйста, переименуйте в exempt_ip. Исключение IP.
dst-ip string	Устарело, пожалуйста, переименуйте в dst_ip. IP-адрес назначения и маска сети.
id integer	ID исключенного IP.
src-ip string	Устарело, пожалуйста, переименуйте в src_ip. Исходный IP-адрес и маска сети.
log string	Включить/отключить ведение журнала. Choices: `"disable"` `"enable"`
log-packet string	Устарело, пожалуйста, переименуйте в log_packet. Включить/отключить ведение журнала пакетов. Choices: `"disable"` `"enable"`
quarantine string	Карантин IP или интерфейса. Choices: `"none"` `"attacker"` `"both"` `"interface"`
quarantine-expiry integer	Устарело, пожалуйста, переименуйте в quarantine_expiry. Продолжительность карантина в минутах.

quarantine-log string	Устарело, пожалуйста, переименуйте на quarantine_log. Включить/выключить протоколирование выбранной карантинной информации. Варианты: `"disable"` `"enable"`
rule-id integer	Устарело, пожалуйста, переименуйте на rule_id. Переопределённый идентификатор правила.
status string	Включить/выключить статус переопределённого правила. Варианты: `"disable"` `"enable"`
replacemsg-group string	Устарело, пожалуйста, переименуйте на replacemsg_group. Группа сообщений замены.
scan-botnet-connections string	Устарело, пожалуйста, переименуйте на scan_botnet_connections. Блокировать или отслеживать подключения к серверам ботнета или отключить ботнет… Варианты: `"disable"` `"block"` `"monitor"`
proposed_method string	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, при которых условия будут игнорироваться.
rc_succeeded list / elements=integer	Список rc-кодов, при которых условия будут выполнены.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе модуля FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая корень.
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
  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_sensor:
        bypass_validation: false
        adom: ansible
        state: present
        ips_sensor:
          block-malicious-url: disable
          comment: "ansible-comment"
          name: "ansible-test-ipssensor"

- 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 IPS sensors
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "ips_sensor"
          params:
            adom: "ansible"
            sensor: "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 список / элементы=строка	Предупреждение, если параметры, используемые в 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_sensor_module.html