модуль fortinet.fortios.fortios_dlp_sensor — настройка датчиков, используемых для блокировки DLP в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

Обзор

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.
dlp_sensor dictionary	Настройка датчиков, используемых для блокировки DLP.
comment string	Необязательные комментарии.
dlp_log string	Включение/отключение ведения журнала DLP. Варианты: `"enable"` `"disable"`
entries list / элементы=dictionary	Записи датчика DLP.
count integer	Количество совпадений со словарём, необходимое для срабатывания записи датчика (в зависимости от параметра «repeat» словарь может срабатывать не более одного раза; 1–255).
dictionary string	Выберите словарь DLP или точное совпадение данных. Источник: dlp.dictionary.name dlp.exact-data-match.name.
id integer / обязательный	Идентификатор. См. <a href=’#notes’>Примечания</a>.
status string	Включение/отключение этой записи. Варианты: `"enable"` `"disable"`
eval string	Вычисляемое выражение.
extended_log string	Включение/отключение расширенного ведения журнала для предотвращения утечки данных. Варианты: `"enable"` `"disable"`
feature_set string	Набор функций потокового режима или режима прокси. Варианты: `"flow"` `"proxy"`
filter list / элементы=dictionary	Настройка фильтров DLP для этого датчика.
action string	Действие с содержимым, обнаруженным этим датчиком DLP. Варианты: `"allow"` `"log-only"` `"block"` `"quarantine-ip"`
archive string	Включение/отключение архивирования DLP. Варианты: `"disable"` `"enable"`
company_identifier string	Укажите идентификатор компании в водяном знаке для поиска. Будут найдены только водяные знаки, добавленные вашей компанией в файлы.
expiry string	Срок карантина в днях, часах и минутах (формат = dddhhmm).
file_size integer	Поиск файлов указанного размера или больше (0–4294967295 Кбайт).
file_type integer	Выберите номер таблицы шаблонов файлов DLP для поиска. Источник: dlp.filepattern.id.
filter_by string	Выберите тип содержимого для поиска. Варианты: `"credit-card"` `"ssn"` `"regexp"` `"file-type"` `"file-size"` `"fingerprint"` `"watermark"` `"encrypted"`
fp_sensitivity list / элементы=dictionary	Выберите уровень чувствительности шаблона файла DLP для поиска.
name string / обязательный	Выберите уровень чувствительности DLP. Источник: dlp.fp-sensitivity.name.
id integer / обязательный	Идентификатор. См. <a href=’#notes’>Примечания</a>.
match_percentage integer	Процент отпечатков в базах данных отпечатков, помеченных выбранным уровнем чувствительности, который должен совпасть.
name string	Имя фильтра.
proto list / элементы=string	Проверять сообщения или файлы по одному или нескольким из этих протоколов. Варианты: `"smtp"` `"pop3"` `"imap"` `"http-get"` `"http-post"` `"ftp"` `"nntp"` `"mapi"` `"ssh"` `"cifs"` `"mm1"` `"mm3"` `"mm4"` `"mm7"`
regexp string	Введите регулярное выражение для поиска (макс. 255 символов).
sensitivity list / элементы=dictionary	Выберите уровень чувствительности шаблона файла DLP для поиска.
name string / обязательный	Выберите уровень чувствительности DLP. Источник: dlp.sensitivity.name.
severity string	Выберите степень серьёзности или уровень угрозы, соответствующий этому фильтру. Варианты: `"info"` `"low"` `"medium"` `"high"` `"critical"`
type string	Выберите, проверять ли содержимое сообщений (например, электронного письма) или файлов (загруженных файлов или вложений электронной почты). Варианты: `"file"` `"fos_message"`
flow_based string	Включение/отключение потоковой обработки DLP. Варианты: `"enable"` `"disable"`
full_archive_proto list / элементы=string	Протоколы, содержимое которых всегда архивируется полностью. Варианты: `"smtp"` `"pop3"` `"imap"` `"http-get"` `"http-post"` `"ftp"` `"nntp"` `"mapi"` `"ssh"` `"cifs"` `"mm1"` `"mm3"` `"mm4"` `"mm7"`
match_type string	Логическая связь между записями. Варианты: `"match-all"` `"match-any"` `"match-eval"`
nac_quar_log string	Включение/отключение ведения журнала карантина NAC. Варианты: `"enable"` `"disable"`
name string / обязательный	Имя таблицы, содержащей датчик.
options string	Настройка параметров DLP.
replacemsg_group string	Группа сообщений-заменителей, используемая этим датчиком DLP. Источник: system.replacemsg-group.name.
summary_proto list / элементы=string	Протоколы, для которых всегда записывается сводка. Варианты: `"smtp"` `"pop3"` `"imap"` `"http-get"` `"http-post"` `"ftp"` `"nntp"` `"mapi"` `"ssh"` `"cifs"` `"mm1"` `"mm3"` `"mm4"` `"mm7"`
enable_log boolean	Включение/отключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
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 sensors used by DLP blocking.
  fortinet.fortios.fortios_dlp_sensor:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_sensor:
          comment: "Optional comments."
          dlp_log: "enable"
          entries:
              -
                  count: "1"
                  dictionary: "<your_own_value> (source dlp.dictionary.name dlp.exact-data-match.name)"
                  id: "8"
                  status: "enable"
          eval: "<your_own_value>"
          extended_log: "enable"
          feature_set: "flow"
          filter:
              -
                  action: "allow"
                  archive: "disable"
                  company_identifier: "myId_16"
                  expiry: "<your_own_value>"
                  file_size: "10"
                  file_type: "0"
                  filter_by: "credit-card"
                  fp_sensitivity:
                      -
                          name: "default_name_22 (source dlp.fp-sensitivity.name)"
                  id: "23"
                  match_percentage: "10"
                  name: "default_name_25"
                  proto: "smtp"
                  regexp: "<your_own_value>"
                  sensitivity:
                      -
                          name: "default_name_29 (source dlp.sensitivity.name)"
                  severity: "info"
                  type: "file"
          flow_based: "enable"
          full_archive_proto: "smtp"
          match_type: "match-all"
          nac_quar_log: "enable"
          name: "default_name_36"
          options: "<your_own_value>"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          summary_proto: "smtp"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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_dlp_sensor_module.html