fortinet.fortios.fortios_dlp_dictionary module – Настройка словарей, используемых для блокировки 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_dictionary.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
dlp_dictionary dictionary	Настройка словарей, используемых для блокировки DLP.
comment string	Необязательные комментарии.
entries list / elements=dictionary	Записи словаря DLP.
comment string	Необязательные комментарии.
id integer / обязательный	Идентификатор. см. <a href=’#notes’>Примечания</a>.
ignore_case string	Включить/отключить игнорирование регистра. Варианты: `"enable"` `"disable"`
pattern string	Шаблон для сопоставления.
repeat string	Включить/отключить повторное сопоставление. Варианты: `"enable"` `"disable"`
status string	Включить/отключить этот шаблон. Варианты: `"enable"` `"disable"`
type string	Тип шаблона для сопоставления. Источник: dlp.data-type.name.
match_around string	Включить/отключить поддержку поиска в окружающем контексте. Варианты: `"enable"` `"disable"`
match_type string	Логическая связь между записями. Варианты: `"match-all"` `"match-any"`
name string / обязательный	Имя таблицы, содержащей словарь.
uuid string	Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную).
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 dictionaries used by DLP blocking.
  fortinet.fortios.fortios_dlp_dictionary:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_dictionary:
          comment: "Optional comments."
          entries:
              -
                  comment: "Optional comments."
                  id: "6"
                  ignore_case: "enable"
                  pattern: "<your_own_value>"
                  repeat: "enable"
                  status: "enable"
                  type: "<your_own_value> (source dlp.data-type.name)"
          match_around: "enable"
          match_type: "match-all"
          name: "default_name_14"
          uuid: "<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_dlp_dictionary_module.html