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

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

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

Обзор

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация с помощью токена. Токен создаётся в графическом интерфейсе FortiGate.
dlp_label dictionary	Настройка меток, используемых для блокировки DLP.
comment string	Необязательные комментарии.
connector string	Имя коннектора SDN. Источник: system.sdn-connector.name.
entries list / elements=dictionary	Записи меток DLP.
fortidata_label_name string	Имя метки FortiData. Источник: dlp.fdata-label.name.
guid string	GUID метки MPIP.
id integer / обязательный	Идентификатор. См. <a href=’#notes’>Примечания</a>.
mpip_label_name string	Имя метки MPIP. Источник: dlp.mpip-label.name.
mpip_type string	Тип метки MPIP. Варианты: `"remote"` `"local"`
name string / обязательный	Имя таблицы, содержащей метку.
type string	Тип метки. Варианты: `"mpip"` `"fortidata"`
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

Примеры

- name: Configure labels used by DLP blocking.
  fortinet.fortios.fortios_dlp_label:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      dlp_label:
          comment: "Optional comments."
          connector: "<your_own_value> (source system.sdn-connector.name)"
          entries:
              -
                  fortidata_label_name: "<your_own_value> (source dlp.fdata-label.name)"
                  guid: "<your_own_value>"
                  id: "8"
                  mpip_label_name: "<your_own_value> (source dlp.mpip-label.name)"
          mpip_type: "remote"
          name: "default_name_11"
          type: "mpip"

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

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

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