Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_dlp – Настройка профилей DLP.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_dlp_profile.

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

dlp_profile

dictionary

Набор параметров верхнего уровня.

comment

string

Комментарий.

dlp_log

псевдонимы: dlp-log

string

Включение/отключение ведения журналов DLP.

Варианты:

  • "disable"
  • "enable"

extended_log

псевдонимы: extended-log

string

Включение/отключение расширенного ведения журналов для предотвращения утечки данных.

Варианты:

  • "disable"
  • "enable"

feature_set

псевдонимы: feature-set

string

Набор функций потокового/прокси-режима.

Варианты:

  • "flow"
  • "proxy"

fortidata_error_action

псевдонимы: fortidata-error-action

string

Действие при сбое запроса FortiData.

Варианты:

  • "block"
  • "log-only"
  • "ignore"

full_archive_proto

псевдонимы: full-archive-proto

list / elements=string

Протоколы, содержимое которых всегда архивируется полностью.

Варианты:

  • "smtp"
  • "pop3"
  • "imap"
  • "http-post"
  • "http-get"
  • "ftp"
  • "nntp"
  • "mapi"
  • "ssh"
  • "cifs"

nac_quar_log

псевдонимы: nac-quar-log

string

Включение/отключение ведения журналов карантина NAC.

Варианты:

  • "disable"
  • "enable"

name

string / обязательный

Имя профиля DLP.

replacemsg_group

псевдонимы: replacemsg-group

string

Группа замещающих сообщений, используемая этим профилем DLP.

rule

list / elements=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 / elements=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"

summary_proto

псевдонимы: summary-proto

list / elements=string

Протоколы, для которых всегда ведется сводный журнал.

Варианты:

  • "smtp"
  • "pop3"
  • "imap"
  • "http-post"
  • "http-get"
  • "ftp"
  • "nntp"
  • "mapi"
  • "ssh"
  • "cifs"

enable_log

boolean

Включение/отключение ведения журналов для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Метод, переопределяющий базовый запрос Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия неудачного выполнения.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие области, включая 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: Configure DLP profiles.
      fortinet.fortimanager.fmgr_dlp_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        dlp_profile:
          name: "your value" # Required variable, string
          # comment: <string>
          # dlp_log: <value in [disable, enable]>
          # extended_log: <value in [disable, enable]>
          # feature_set: <value in [flow, proxy]>
          # full_archive_proto: ["smtp", "pop3", "imap", "http-post", "http-get", "ftp", "nntp",
          #                      "mapi", "ssh", "cifs"]
          # nac_quar_log: <value in [disable, enable]>
          # replacemsg_group: <string>
          # rule:
          #   - 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, ...]>
          #     id: <integer>
          #     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]>
          # summary_proto: ["smtp", "pop3", "imap", "http-post", "http-get", "ftp", "nntp",
          #                 "mapi", "ssh", "cifs"]
          # fortidata_error_action: <value in [block, log-only, ignore]>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API