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

Примечание

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

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

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

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

Новинка в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dlp_profile словарь	Параметры верхнего уровня.
comment строка	Комментарий.
dlp-log строка	Устарело, пожалуйста, переименуйте на dlp_log. Включить/выключить ведение журнала DLP. Варианты: `"disable"` `"enable"`
extended-log строка	Устарело, пожалуйста, переименуйте на extended_log. Включить/выключить расширенное ведение журнала для предотвращения утечки данных. Варианты: `"disable"` `"enable"`
feature-set строка	Устарело, пожалуйста, переименуйте на feature_set. Набор функций потока/прокси. Варианты: `"flow"` `"proxy"`
full-archive-proto список / элементы=строка	Устарело, пожалуйста, переименуйте на full_archive_proto. Протоколы для постоянного архивирования содержимого. Варианты: `"smtp"` `"pop3"` `"imap"` `"http-post"` `"http-get"` `"ftp"` `"nntp"` `"mapi"` `"ssh"` `"cifs"`
nac-quar-log строка	Устарело, пожалуйста, переименуйте на nac_quar_log. Включить/выключить ведение журнала карантина NAC. Варианты: `"disable"` `"enable"`
name строка / обязательно	Название профиля DLP.
replacemsg-group строка	Устарело, пожалуйста, переименуйте на replacemsg_group. Группа сообщений замены, используемая этим профилем DLP.
rule список / элементы=словарь	Правило.
action строка	Действие, которое нужно выполнить с содержимым, соответствующим этому профилю DLP. Варианты: `"log-only"` `"block"` `"quarantine-ip"` `"allow"`
archive строка	Включить/выключить архивирование DLP. Варианты: `"disable"` `"enable"`
expiry строка	Длительность карантина в днях, часах, минутах
file-size целое число	Устарело, пожалуйста, переименуйте на file_size. Соответствие файлам такого размера или больше
file-type строка	Устарело, пожалуйста, переименуйте на file_type. Выбор номера таблицы шаблонов файлов DLP для соответствия.
filter-by строка	Устарело, пожалуйста, переименуйте на filter_by. Выбор типа содержимого для соответствия. Варианты: `"fingerprint"` `"sensor"` `"encrypted"` `"none"` `"mip"`
id целое число	Идентификатор.
label строка	Словарь меток MIP.

END_OF_DOCUMENT_MARKER

match-percentage integer	Устаревшее, пожалуйста, переименуйте его в match_percentage. Процент отпечатков пальцев в базах данных отпечатков пальцев, назна…
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 list / elements=string	Устаревшее, пожалуйста, переименуйте его в summary_proto. Протоколы, для которых всегда необходимо регистрировать сводку. Варианты: `"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-кодов, с которыми будут переопределены условия для успеха.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корень.
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 помогают в этом.
Для создания или обновления объекта используйте директиву 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 profiles.
      fortinet.fortimanager.fmgr_dlp_profile:
        # 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_profile:
          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]>
          name: <string>
          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

Значения возврата

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

Ключ	Описание
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_profile_module.html