Модуль fortinet.fortimanager.fmgr_ips_sensor_entries – Фильтр датчиков IPS.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить логирование для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
ips_sensor_entries словарь | Установленные параметры верхнего уровня. |
|
action строка |
Действие, выполняемое с трафиком, в котором обнаружены подписи. Варианты:
|
|
application любой |
(список) Приложения, подлежащие защите. |
|
cve любой |
(список) Список идентификаторов CVE подписей, которые нужно добавить в датчик |
|
default_action строка |
Устарело, пожалуйста, переименуйте на default_action. Фильтр по умолчанию действия подписи. Варианты:
|
|
default_status строка |
Устарело, пожалуйста, переименуйте на default_status. Фильтр по умолчанию статуса подписи. Варианты:
|
|
exempt_ip список / элементы=словарь |
Устарело, пожалуйста, переименуйте на exempt_ip. Исключённые IP-адреса. |
|
dst_ip строка |
Устарело, пожалуйста, переименуйте на dst_ip. Адрес назначения IP и маска подсети. |
|
id целое число |
Идентификатор исключённого IP-адреса. |
|
src_ip строка |
Устарело, пожалуйста, переименуйте на src_ip. Адрес источника IP и маска подсети. |
|
id целое число / обязательно |
Идентификатор правила в базе данных IPS |
|
last_modified любой |
(список или str) Устарело, пожалуйста, переименуйте на last_modified. Фильтр по дате последнего изменения подписи. |
|
location любой |
(список) Защита трафика клиента или сервера. |
|
log строка |
Включить/выключить логирование подписей, включенных в фильтр. Варианты:
|
|
log_attack_context строка |
Устарело, пожалуйста, переименуйте на log_attack_context. Включить/выключить логирование контекста атаки Варианты:
|
|
log_packet строка |
Устарело, пожалуйста, переименуйте на log_packet. Включить/выключить логирование пакетов. Варианты:
|
|
os any |
(list) Операционные системы, которые необходимо защитить. |
|
protocol any |
(list) Протоколы, которые необходимо проверить. |
|
quarantine string |
Метод карантина. Варианты:
|
|
quarantine-expiry string |
Устарело, переименуйте в quarantine_expiry. Продолжительность карантина. |
|
quarantine-log string |
Устарело, переименуйте в quarantine_log. Включить/выключить логирование карантина. Варианты:
|
|
rate-count integer |
Устарело, переименуйте в rate_count. Количество скорости. |
|
rate-duration integer |
Устарело, переименуйте в rate_duration. Продолжительность |
|
rate-mode string |
Устарело, переименуйте в rate_mode. Режим ограничения скорости. Варианты:
|
|
rate-track string |
Устарело, переименуйте в rate_track. Отслеживать поле протокола пакета. Варианты:
|
|
rule any |
(list or str) Идентифицирует предопределенные или пользовательские сигнатуры IPS, которые нужно добавить к сенсору. |
|
severity any |
(list) Относительная серьезность сигнатуры, от info до critical. |
|
status string |
Статус сигнатур, включенных в фильтр. Варианты:
|
|
tags string |
Назначьте пользовательский фильтр тегов для сенсора IPS. |
|
vuln-type any |
(list) Устарело, переименуйте в vuln_type. Список типов уязвимостей сигнатур для фильтрации. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, с помощью которых будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, с помощью которых будут переопределены условия успеха. |
sensor string / required | Параметр (сенсор) в запрошенном URL. |
state string / required | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM для блокировки для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: 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 запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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_entries_module.html
