fortinet.fortimanager.fmgr_dlp_sensor модуль – Настройка сенсоров DLP.

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dlp_sensor словарь	Устанавливаются параметры верхнего уровня.
comment строка	Комментарий.
dlp-log строка	Устарело, пожалуйста, переименуйте на dlp_log. Включить/выключить ведение журнала DLP. Варианты: `"disable"` `"enable"`
entries список / элементы=словарь	Элементы.
count целое число	Количество совпадений словаря для срабатывания совпадения записи датчика.
dictionary строка	Выберите словарь DLP.
id целое число	Идентификатор.
status строка	Включить/выключить эту запись. Варианты: `"disable"` `"enable"`
eval строка	Выражение для вычисления.
extended-log строка	Устарело, пожалуйста, переименуйте на extended_log. Включить/выключить расширенное ведение журнала для предотвращения утечки данных. Варианты: `"disable"` `"enable"`
feature-set строка	Устарело, пожалуйста, переименуйте на feature_set. Набор функций потока/прокси. Варианты: `"proxy"` `"flow"`
fgd-id целое число	Устарело, пожалуйста, переименуйте на fgd_id. Идентификатор объекта в базе данных FortiGuard.
filter список / элементы=словарь	Фильтр.
action строка	Действие, которое необходимо выполнить с содержимым, соответствующим этому датчику DLP. Варианты: `"log-only"` `"block"` `"exempt"` `"ban"` `"ban-sender"` `"quarantine-ip"` `"quarantine-port"` `"none"` `"allow"`
archive строка	Включить/выключить архивацию DLP. Варианты: `"disable"` `"enable"` `"summary-only"`
company-identifier строка	Устарело, пожалуйста, переименуйте на company_identifier. Введите идентификатор компании, для соответствия.
expiry строка	Срок хранения в формате дни, часы, минуты
file-size целое число	Устарело, пожалуйста, переименуйте на file_size. Сопоставлять файлы такого размера или большего.
file-type строка	Устарело, пожалуйста, переименуйте на file_type. Выберите номер таблицы шаблонов файлов DLP для соответствия.

END_OF_DOCUMENT_MARKER

filter-by string	Устарело, переименуйте в filter_by. Выберите тип контента для сопоставления. Choices: `"credit-card"` `"ssn"` `"regexp"` `"file-type"` `"file-size"` `"fingerprint"` `"watermark"` `"encrypted"` `"file-type-and-size"`
fp-sensitivity any	(list or str) Устарело, переименуйте в fp_sensitivity. Выберите чувствительность шаблона файла DLP для сопоставления.
id integer	Идентификатор.
match-percentage integer	Устарело, переименуйте в match_percentage. Процент отпечатков пальцев в базах данных отпечатков пальцев, обозначенных…
name string	Имя фильтра.
proto list / elements=string	Проверять сообщения или файлы по одному или нескольким из этих протоколов. Choices: `"imap"` `"smtp"` `"pop3"` `"ftp"` `"nntp"` `"mm1"` `"mm3"` `"mm4"` `"mm7"` `"mapi"` `"aim"` `"icq"` `"msn"` `"yahoo"` `"http-get"` `"http-post"` `"ssh"` `"cifs"`
regexp string	Введите регулярное выражение для сопоставления
sensitivity any	(list or str) Выберите чувствительность шаблона файла DLP для сопоставления.
severity string	Выберите уровень серьезности или угрозы, который соответствует этому фильтру. Choices: `"info"` `"low"` `"medium"` `"high"` `"critical"`
type string	Выберите, следует ли проверять содержимое сообщений Choices: `"file"` `"message"`
flow-based string	Устарело, переименуйте в flow_based. Включить/отключить DLP на основе потока. Choices: `"disable"` `"enable"`
full-archive-proto list / elements=string	Устарело, переименуйте в full_archive_proto. Протоколы, для которых всегда выполняется архивация контента. Choices: `"imap"` `"smtp"` `"pop3"` `"ftp"` `"nntp"` `"mm1"` `"mm3"` `"mm4"` `"mm7"` `"mapi"` `"aim"` `"icq"` `"msn"` `"yahoo"` `"http-get"` `"http-post"` `"ssh"` `"cifs"`
match-type string	Устарело, переименуйте в match_type. Логическое отношение между записями Choices: `"match-all"` `"match-any"` `"match-eval"`
nac-quar-log string	Устарело, переименуйте в nac_quar_log. Включить/отключить ведение журнала карантина NAC. Choices: `"disable"` `"enable"`
name string / required	Имя сенсора DLP.
options string	Настройка параметров DLP. Choices: `"strict-file"`
replacemsg-group string	Устарело, переименуйте в replacemsg_group. Группа сообщений для замены, используемая этим сенсором DLP.

summary_proto список / элементы=строка	Устаревший параметр, пожалуйста, переименуйте его в summary_proto. Протоколы для всегда регистрации сводки. Варианты: `"imap"` `"smtp"` `"pop3"` `"ftp"` `"nntp"` `"mm1"` `"mm3"` `"mm4"` `"mm7"` `"mapi"` `"aim"` `"icq"` `"msn"` `"yahoo"` `"http-get"` `"http-post"` `"ssh"` `"cifs"`
enable_log логический	Включить/отключить протоколирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с токеном доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на ошибку.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на успешность.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	Область ADOM, блокируемая для FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DLP sensors.
      fortinet.fortimanager.fmgr_dlp_sensor:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        dlp_sensor:
          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]>
          name: <string>
          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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_dlp_sensor_module.html