Модуль fortinet.fortimanager.fmgr_dlp_profile_rule — настройка правил DLP для этого профиля.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_dlp_profile_rule.

Добавлено в fortinet.fortimanager 2.1.0

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dlp_profile_rule dictionary	Параметры верхнего уровня.
action string	Действие, выполняемое с содержимым, соответствующим этому профилю DLP. Варианты: `"log-only"` `"block"` `"quarantine-ip"` `"allow"`
archive string	Включить или отключить архивирование DLP. Варианты: `"disable"` `"enable"`
expiry string	Длительность помещения в карантин в днях, часах и минутах
file_size псевдонимы: file-size integer	Соответствие файлам указанного или большего размера
file_type псевдонимы: file-type string	Выберите номер таблицы шаблонов файлов DLP для сопоставления.
filter_by псевдонимы: filter-by string	Выберите тип содержимого для сопоставления. Варианты: `"fingerprint"` `"sensor"` `"encrypted"` `"none"` `"mip"` `"label"`
id integer / обязательный	Идентификатор.
label string	Словарь меток MIP.
match_percentage псевдонимы: match-percentage integer	Процент отпечатков в базах данных отпечатков, помеченных выбранным уровнем конфиденциальности, которые должны совпасть.
name string	Имя фильтра.
proto list / элементы=string	Проверять сообщения или файлы, передаваемые по одному или нескольким из этих протоколов. Варианты: `"smtp"` `"pop3"` `"imap"` `"http-post"` `"http-get"` `"ftp"` `"nntp"` `"mapi"` `"ssh"` `"cifs"`
sensitivity any	(список) Выберите уровень конфиденциальности шаблона файла DLP для сопоставления.
sensor any	(список) Выберите датчики DLP.
severity string	Выберите уровень серьезности или угрозы, соответствующий этому фильтру. Варианты: `"info"` `"low"` `"medium"` `"high"` `"critical"`
type string	Выберите, следует ли проверять содержимое сообщений Варианты: `"file"` `"message"`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
profile string / обязательный	Параметр (profile) в запрашиваемом URL.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 для всех входных аргументов используется соглашение об именовании с подчеркиванием (snake_case). Замените аргументы, например, “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, но для них будут выводиться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия ошибки или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Set up DLP rules for this profile.
      fortinet.fortimanager.fmgr_dlp_profile_rule:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        state: present # <value in [present, absent]>
        dlp_profile_rule:
          id: 0 # Required variable, integer
          # action: <value in [log-only, block, quarantine-ip, ...]>
          # archive: <value in [disable, enable]>
          # expiry: <string>
          # file_size: <integer>
          # file_type: <string>
          # filter_by: <value in [fingerprint, sensor, encrypted, ...]>
          # label: <string>
          # match_percentage: <integer>
          # name: <string>
          # proto: ["smtp", "pop3", "imap", "http-post", "http-get", "ftp", "nntp", "mapi", "ssh",
          #         "cifs"]
          # sensitivity: <list or string>
          # sensor: <list or string>
          # severity: <value in [info, low, medium, ...]>
          # type: <value in [file, message]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_dlp_profile_rule_module.html