Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_dlp_sensor — настройка датчиков DLP.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Варианты:

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

dlp_sensor

dictionary

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

comment

string

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

dlp_log

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

string

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

Варианты:

  • "disable"
  • "enable"

entries

list / элементы=dictionary

Записи.

count

integer

Количество совпадений со словарём, необходимое для срабатывания записи датчика

dictionary

string

Выберите словарь DLP.

id

integer

Идентификатор.

status

string

Включить или отключить эту запись.

Варианты:

  • "disable"
  • "enable"

eval

string

Вычисляемое выражение.

extended_log

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

string

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

Варианты:

  • "disable"
  • "enable"

feature_set

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

string

Набор функций для режимов потока и прокси.

Варианты:

  • "proxy"
  • "flow"

fgd_id

псевдонимы: fgd-id

integer

Идентификатор объекта в базе данных FortiGuard.

filter

list / элементы=dictionary

Фильтр.

action

string

Действие с содержимым, соответствующим условиям этого датчика DLP.

Варианты:

  • "log-only"
  • "block"
  • "exempt"
  • "ban"
  • "ban-sender"
  • "quarantine-ip"
  • "quarantine-port"
  • "none"
  • "allow"

archive

string

Включить или отключить архивирование DLP.

Варианты:

  • "disable"
  • "enable"
  • "summary-only"

company_identifier

псевдонимы: company-identifier

string

Введите идентификатор компании для сопоставления с водяным знаком.

expiry

string

Срок карантина в формате «дни, часы, минуты»

file_size

псевдонимы: file-size

integer

Сопоставлять файлы указанного размера или больше

file_type

псевдонимы: file-type

string

Выберите номер таблицы шаблонов файлов DLP для сопоставления.

filter_by

псевдонимы: filter-by

string

Выберите тип содержимого для сопоставления.

Варианты:

  • "credit-card"
  • "ssn"
  • "regexp"
  • "file-type"
  • "file-size"
  • "fingerprint"
  • "watermark"
  • "encrypted"
  • "file-type-and-size"

fp_sensitivity

псевдонимы: fp-sensitivity

any

(список или строка) Выберите уровень чувствительности шаблона файлов DLP для сопоставления.

id

integer

Идентификатор.

match_percentage

псевдонимы: match-percentage

integer

Процент совпадений отпечатков в базах отпечатков, соответствующих выбранному значению fp-sensitivity.

name

string

Имя фильтра.

proto

list / элементы=string

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

Варианты:

  • "imap"
  • "smtp"
  • "pop3"
  • "ftp"
  • "nntp"
  • "mm1"
  • "mm3"
  • "mm4"
  • "mm7"
  • "mapi"
  • "aim"
  • "icq"
  • "msn"
  • "yahoo"
  • "http-get"
  • "http-post"
  • "ssh"
  • "cifs"

regexp

string

Введите регулярное выражение для сопоставления

sensitivity

any

(список или строка) Выберите уровень чувствительности шаблона файлов DLP для сопоставления.

severity

string

Выберите степень серьёзности или уровень угрозы, соответствующий этому фильтру.

Варианты:

  • "info"
  • "low"
  • "medium"
  • "high"
  • "critical"

type

string

Выберите, проверять ли содержимое сообщений

Варианты:

  • "file"
  • "message"

flow_based

псевдонимы: flow-based

string

Включить или отключить потоковую обработку DLP.

Варианты:

  • "disable"
  • "enable"

full_archive_proto

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

list / элементы=string

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

Варианты:

  • "imap"
  • "smtp"
  • "pop3"
  • "ftp"
  • "nntp"
  • "mm1"
  • "mm3"
  • "mm4"
  • "mm7"
  • "mapi"
  • "aim"
  • "icq"
  • "msn"
  • "yahoo"
  • "http-get"
  • "http-post"
  • "ssh"
  • "cifs"

match_type

псевдонимы: match-type

string

Логическая связь между записями

Варианты:

  • "match-all"
  • "match-any"
  • "match-eval"

nac_quar_log

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

string

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

Варианты:

  • "disable"
  • "enable"

name

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

Имя датчика DLP.

options

string

Настройка параметров DLP.

Варианты:

  • "strict-file"

replacemsg_group

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

string

Группа сообщений для замены, используемая этим датчиком DLP.

summary_proto

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

list / элементы=string

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

Варианты:

  • "imap"
  • "smtp"
  • "pop3"
  • "ftp"
  • "nntp"
  • "mm1"
  • "mm3"
  • "mm4"
  • "mm7"
  • "mapi"
  • "aim"
  • "icq"
  • "msn"
  • "yahoo"
  • "http-get"
  • "http-post"
  • "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 / элементы=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: Configure DLP sensors.
      fortinet.fortimanager.fmgr_dlp_sensor:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        dlp_sensor:
          name: "your value" # Required variable, string
          # comment: <string>
          # dlp_log: <value in [disable, enable]>
          # extended_log: <value in [disable, enable]>
          # filter:
          #   - action: <value in [log-only, block, exempt, ...]>
          #     archive: <value in [disable, enable, summary-only]>
          #     company_identifier: <string>
          #     expiry: <string>
          #     file_size: <integer>
          #     file_type: <string>
          #     filter_by: <value in [credit-card, ssn, regexp, ...]>
          #     fp_sensitivity: <list or string>
          #     id: <integer>
          #     match_percentage: <integer>
          #     name: <string>
          #     proto: ["imap", "smtp", "pop3", "ftp", "nntp", "mm1", "mm3", "mm4", "mm7", "mapi",
          #             "aim", "icq", "msn", "yahoo", "http-get", "http-post", "ssh", "cifs"]
          #     regexp: <string>
          #     severity: <value in [info, low, medium, ...]>
          #     type: <value in [file, message]>
          #     sensitivity: <list or string>
          # flow_based: <value in [disable, enable]>
          # full_archive_proto: ["imap", "smtp", "pop3", "ftp", "nntp", "mm1", "mm3", "mm4",
          #                      "mm7", "mapi", "aim", "icq", "msn", "yahoo", "http-get",
          #                      "http-post", "ssh", "cifs"]
          # nac_quar_log: <value in [disable, enable]>
          # options: <value in [strict-file]>
          # replacemsg_group: <string>
          # summary_proto: ["imap", "smtp", "pop3", "ftp", "nntp", "mm1", "mm3", "mm4", "mm7",
          #                 "mapi", "aim", "icq", "msn", "yahoo", "http-get", "http-post", "ssh",
          #                 "cifs"]
          # feature_set: <value in [proxy, flow]>
          # entries:
          #   - count: <integer>
          #     dictionary: <string>
          #     id: <integer>
          #     status: <value in [disable, enable]>
          # eval: <string>
          # match_type: <value in [match-all, match-any, match-eval]>
          # fgd_id: <integer>

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

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

Ключ

Описание

meta

словарь

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

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

request_url

строка

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

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

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

response_code

целое число

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

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

Пример: 0

response_data

список / элементы=строка

Ответ API.

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

response_message

строка

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

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

Пример: "OK."

system_information

словарь

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

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

rc

целое число

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

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

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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_sensor_module.html

Spec-Zone.ru

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