Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_ips_custom — настройка пользовательской сигнатуры IPS в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_ips_custom.

Добавлено в fortinet.fortios 2.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции IPS и пользовательской категории. В примерах приведены все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием. Проверено с FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

ips_custom

dictionary

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

action

string

Действие по умолчанию (разрешить или блокировать) для этой сигнатуры.

Варианты:

  • "pass"
  • "block"

application

list / elements=string

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

comment

string

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

location

list / elements=string

Защита трафика клиента или сервера.

log

string

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

Варианты:

  • "disable"
  • "enable"

log_packet

string

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

Варианты:

  • "disable"
  • "enable"

os

list / elements=string

Операционные системы, которые защищает сигнатура. Оставьте пустым, чтобы выбрать все операционные системы.

protocol

string

Протоколы, трафик которых проверяет сигнатура. Оставьте пустым, чтобы выбрать все протоколы.

rule_id

integer

Идентификатор сигнатуры.

severity

string

Относительная степень серьезности сигнатуры: от информационной до критической. Сообщения журнала, созданные сигнатурой, содержат сведения о степени серьезности.

sig_name

string

Имя сигнатуры.

signature

string

Пользовательская сигнатура в одинарных кавычках.

status

string

Включить/отключить эту сигнатуру.

Варианты:

  • "disable"
  • "enable"

tag

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

Метка сигнатуры.

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с указанием member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure IPS custom signature.
  fortinet.fortios.fortios_ips_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ips_custom:
          action: "pass"
          application: "<your_own_value>"
          comment: "Comment."
          location: "<your_own_value>"
          log: "disable"
          log_packet: "disable"
          os: "<your_own_value>"
          protocol: "<your_own_value>"
          rule_id: "0"
          severity: "<your_own_value>"
          sig_name: "<your_own_value>"
          signature: "<your_own_value>"
          status: "disable"
          tag: "<your_own_value>"

Возвращаемые значения

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate после выполнения последней операции

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

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер редакции

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

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

Пример: "success"

vdom

string

Использованный виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_ips_custom_module.html

Spec-Zone.ru

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