Spec-Zone.ru › Ansible

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

Примечание

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

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_baseline_sensor

dictionary

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

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 сигнатур, добавляемых в датчик

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

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

string

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

severity

any

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

status

string

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

Варианты:

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

tags

string

Теги.

extended_log

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

string

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

Варианты:

  • "disable"
  • "enable"

filter

list / elements=dictionary

Фильтр.

action

string

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

Варианты:

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

application

any

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

application_real

псевдонимы: application(real)

string

Приложение

location

any

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

location_real

псевдонимы: location(real)

string

Местоположение

log

string

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

Варианты:

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

log_packet

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

string

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

Варианты:

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

name

string

Имя фильтра.

os

any

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

os_real

псевдонимы: os(real)

string

Операционная система

protocol

any

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

protocol_real

псевдонимы: protocol(real)

string

Протокол

quarantine

string

IP-адрес или интерфейс для помещения в карантин.

Варианты:

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

quarantine_expiry

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

integer

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

quarantine_log

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

string

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

Варианты:

  • "disable"
  • "enable"

severity

any

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

severity_real

псевдонимы: severity(real)

string

Степень серьезности

status

string

Состояние выбранных правил.

Варианты:

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

log

string

Журнал.

Варианты:

  • "disable"
  • "enable"

name

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

Имя датчика.

override

list / elements=dictionary

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

action

string

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

Варианты:

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

exempt_ip

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

list / elements=dictionary

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

dst_ip

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

string

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

id

integer

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

src_ip

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

string

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

log

string

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

Варианты:

  • "disable"
  • "enable"

log_packet

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

string

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

Варианты:

  • "disable"
  • "enable"

quarantine

string

Карантин для IP-адреса или интерфейса.

Варианты:

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

quarantine_expiry

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

integer

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

quarantine_log

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

string

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

Варианты:

  • "disable"
  • "enable"

rule_id

псевдонимы: rule-id

integer

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

status

string

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

Варианты:

  • "disable"
  • "enable"

replacemsg_group

псевдонимы: replacemsg-group

string

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

scan_botnet_connections

псевдонимы: 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure IPS sensor.
      fortinet.fortimanager.fmgr_ips_baseline_sensor:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        ips_baseline_sensor:
          name: "your value" # Required variable, string
          # 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]>
          # 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

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_baseline_sensor_module.html

Spec-Zone.ru

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