Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

ips_sensor

dictionary

Набор параметров верхнего уровня.

_baseline

string

Базовый уровень.

block_malicious_url

псевдонимы: block-malicious-url

string

Включить или отключить блокировку вредоносных URL-адресов.

Варианты:

  • "disable"
  • "enable"

comment

string

Комментарий.

entries

list / elements=dictionary

Записи.

action

string

Действие, выполняемое с трафиком, в котором обнаружены сигнатуры.

Варианты:

  • "pass"
  • "block"
  • "reset"
  • "default"

application

any

(список) Приложения, которые необходимо защитить.

cve

any

(список) Список идентификаторов CVE сигнатур, добавляемых в сенсор.

default_action

псевдонимы: default-action

string

Фильтр действий по умолчанию для сигнатуры.

Варианты:

  • "block"
  • "pass"
  • "all"
  • "drop"

default_status

псевдонимы: default-status

string

Фильтр статуса сигнатуры по умолчанию.

Варианты:

  • "disable"
  • "enable"
  • "all"

exempt_ip

псевдонимы: exempt-ip

list / elements=dictionary

Исключенный IP-адрес.

dst_ip

псевдонимы: dst-ip

string

IP-адрес назначения и маска сети.

id

integer

Идентификатор исключенного IP-адреса.

src_ip

псевдонимы: src-ip

string

IP-адрес источника и маска сети.

id

integer

Идентификатор правила в базе данных IPS.

last_modified

псевдонимы: last-modified

any

(список или строка) Фильтр по дате последнего изменения сигнатуры.

location

any

(список) Защищать трафик клиента или сервера.

log

string

Включить или отключить ведение журнала сигнатур, включенных в фильтр.

Варианты:

  • "disable"
  • "enable"

log_attack_context

псевдонимы: log-attack-context

string

Включить или отключить ведение журнала контекста атаки.

Варианты:

  • "disable"
  • "enable"

log_packet

псевдонимы: log-packet

string

Включить или отключить ведение журнала пакетов.

Варианты:

  • "disable"
  • "enable"

os

any

(список) Операционные системы, которые необходимо защитить.

protocol

any

(список) Протоколы, подлежащие проверке.

quarantine

string

Способ помещения в карантин.

Варианты:

  • "none"
  • "attacker"
  • "both"
  • "interface"

quarantine_expiry

псевдонимы: quarantine-expiry

string

Продолжительность карантина.

quarantine_log

псевдонимы: quarantine-log

string

Включить или отключить ведение журнала карантина.

Варианты:

  • "disable"
  • "enable"

rate_count

псевдонимы: rate-count

integer

Количество событий за интервал.

rate_duration

псевдонимы: rate-duration

integer

Длительность.

rate_mode

псевдонимы: rate-mode

string

Режим ограничения частоты.

Варианты:

  • "periodical"
  • "continuous"

rate_track

псевдонимы: rate-track

string

Отслеживать поле протокола пакета.

Варианты:

  • "none"
  • "src-ip"
  • "dest-ip"
  • "dhcp-client-mac"
  • "dns-domain"

rule

any

(список или строка) Определяет предопределенные или пользовательские сигнатуры IPS, добавляемые в сенсор.

severity

any

(список) Относительная степень серьезности сигнатуры — от информационной до критической.

status

string

Статус сигнатур, включенных в фильтр.

Варианты:

  • "disable"
  • "enable"
  • "default"

tags

string

Назначить сенсору IPS пользовательский фильтр по тегам.

vuln_type

псевдонимы: vuln-type

any

(список) Список типов уязвимостей сигнатур для фильтрации.

extended_log

псевдонимы: extended-log

string

Включить или отключить расширенное ведение журнала.

Варианты:

  • "disable"
  • "enable"

filter

list / elements=dictionary

Фильтр.

action

string

Действие для выбранных правил.

Варианты:

  • "pass"
  • "block"
  • "default"
  • "reset"

application

any

(список) Фильтр уязвимых приложений.

location

any

(список) Фильтр расположения уязвимостей.

log

string

Включить или отключить ведение журнала выбранных правил.

Варианты:

  • "disable"
  • "enable"
  • "default"

log_packet

псевдонимы: log-packet

string

Включить или отключить ведение журнала пакетов для выбранных правил.

Варианты:

  • "disable"
  • "enable"
  • "default"

name

string

Имя фильтра.

os

any

(список) Фильтр уязвимых операционных систем.

protocol

any

(список) Фильтр уязвимых протоколов.

quarantine

string

Поместить IP-адрес или интерфейс в карантин.

Варианты:

  • "none"
  • "attacker"
  • "both"
  • "interface"

quarantine_expiry

псевдонимы: quarantine-expiry

integer

Продолжительность карантина в минутах.

quarantine_log

псевдонимы: quarantine-log

string

Включить или отключить ведение журнала выбранных событий помещения в карантин.

Варианты:

  • "disable"
  • "enable"

severity

any

(список) Фильтр степени серьезности уязвимости.

status

string

Статус выбранных правил.

Варианты:

  • "disable"
  • "enable"
  • "default"

name

string / обязательный

Имя сенсора.

override

list / elements=dictionary

Переопределение.

action

string

Действие для правила переопределения.

Варианты:

  • "pass"
  • "block"
  • "reset"

exempt_ip

aliases: exempt-ip

list / elements=dictionary

Исключаемый IP-адрес.

dst_ip

aliases: dst-ip

string

IP-адрес назначения и маска подсети.

id

integer

Идентификатор исключаемого IP-адреса.

src_ip

aliases: src-ip

string

IP-адрес источника и маска подсети.

log

string

Включить или отключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

log_packet

aliases: log-packet

string

Включить или отключить ведение журнала пакетов.

Варианты:

  • "disable"
  • "enable"

quarantine

string

Поместить IP-адрес или интерфейс в карантин.

Варианты:

  • "none"
  • "attacker"
  • "both"
  • "interface"

quarantine_expiry

aliases: quarantine-expiry

integer

Продолжительность карантина в минутах.

quarantine_log

aliases: quarantine-log

string

Включить или отключить ведение журнала выбранного карантина.

Варианты:

  • "disable"
  • "enable"

rule_id

aliases: rule-id

integer

Идентификатор переопределяемого правила.

status

string

Включить или отключить переопределяемое правило.

Варианты:

  • "disable"
  • "enable"

replacemsg_group

aliases: replacemsg-group

string

Группа сообщений для замены.

scan_botnet_connections

aliases: scan-botnet-connections

string

Блокировать или отслеживать подключения к серверам ботнетов либо отключить сканирование ботнетов.

Варианты:

  • "disable"
  • "block"
  • "monitor"

proposed_method

string

Переопределяемый метод для соответствующего запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, для которых будут переопределены условия неудачного выполнения.

rc_succeeded

list / elements=integer

Список кодов rc, для которых будут переопределены условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая 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.
  • Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Чтобы создать или обновить объект, используйте директиву state present.
  • Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL-адрес запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_ips_sensor_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API