Модуль fortinet.fortios.fortios_dlp_fp_doc_source — создание базы данных отпечатков DLP, предоставляя FortiGate доступ к файловому серверу с файлами, из которых создаются отпечатки в 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_fp_doc_source.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
dlp_fp_doc_source dictionary	Создает базу данных отпечатков DLP, предоставляя FortiGate доступ к файловому серверу с файлами, из которых создаются отпечатки.
date integer	День месяца, в который следует сканировать сервер (1–31).
file_path string	Путь к файлам отпечатков на сервере (не более 119 символов).
file_pattern string	Для файлов на сервере, соответствующих этому шаблону, создаются отпечатки. При необходимости используйте подстановочные знаки * и ?.
keep_modified string	Включите, чтобы при изменении файла на сервере FortiGate сохранял старый отпечаток и добавлял в базу данных новый. Варианты: `"enable"` `"disable"`
name string / обязательный	Имя базы данных отпечатков DLP.
password string	Пароль для входа на файловый сервер.
period string	Частота проверки FortiGate наличия новых или измененных файлов на сервере. Варианты: `"none"` `"daily"` `"weekly"` `"monthly"`
remove_deleted string	Включите, чтобы база данных отпечатков обновлялась при удалении файла с сервера. Варианты: `"enable"` `"disable"`
scan_on_creation string	Запустить немедленное обновление базы данных отпечатков после создания этой записи fp-doc-source. Варианты: `"enable"` `"disable"`
scan_subdirectories string	Включить или отключить сканирование подкаталогов для поиска файлов, по которым создаются отпечатки. Варианты: `"enable"` `"disable"`
sensitivity string	Выберите уровень чувствительности или угрозы для совпадений в этой базе данных отпечатков. Добавляйте уровни чувствительности с помощью sensitivity. Источник: dlp .sensitivity.name.
server string	IPv4- или IPv6-адрес сервера.
server_type string	Протокол взаимодействия с файловым сервером. В настоящее время поддерживаются только серверы Samba (SMB). Варианты: `"samba"`
tod_hour integer	Час суток, в который следует сканировать сервер (0–23).
tod_min integer	Минута часа, в которую следует сканировать сервер (0–59).
username string	Имя пользователя для входа на файловый сервер.
vdom string	Выберите VDOM, который может взаимодействовать с файловым сервером. Варианты: `"mgmt"` `"current"`
weekday string	День недели, в который следует сканировать сервер. Варианты: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
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: Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints.
  fortinet.fortios.fortios_dlp_fp_doc_source:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_fp_doc_source:
          date: "1"
          file_path: "<your_own_value>"
          file_pattern: "<your_own_value>"
          keep_modified: "enable"
          name: "default_name_7"
          password: "<your_own_value>"
          period: "none"
          remove_deleted: "enable"
          scan_on_creation: "enable"
          scan_subdirectories: "enable"
          sensitivity: "<your_own_value> (source dlp.sensitivity.name)"
          server: "192.168.100.40"
          server_type: "samba"
          tod_hour: "1"
          tod_min: "0"
          username: "<your_own_value>"
          vdom: "mgmt"
          weekday: "sunday"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: success Пример: `"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_dlp_fp_doc_source_module.html