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

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только при несовпадении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dlp_profile_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.
match_percentage целое число	Устарело, переименуйте на match_percentage. Процент отпечатков пальцев в базах данных отпечатков пальцев, обозначенных …
name строка	Имя фильтра.
proto список / элементы=строка	Проверка сообщений или файлов по одному или нескольким протоколам. Варианты: `"smtp"` `"pop3"` `"imap"` `"http-post"` `"http-get"` `"ftp"` `"nntp"` `"mapi"` `"ssh"` `"cifs"`
sensitivity любой	(список) Выбор чувствительности шаблона файла DLP для соответствия.
sensor любой	(список) Выбор датчиков DLP.
severity строка	Выбор уровня серьезности или угрозы, соответствующей этому фильтру. Варианты: `"info"` `"low"` `"medium"` `"high"` `"critical"`
type строка	Выберите, нужно ли проверять содержимое сообщений. Варианты: `"file"` `"message"`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с токеном доступа к API forticloud.

profile строка / обязательно	Параметр (profile) в запрошенном URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Выбираемые значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут считаться невыполненными.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут считаться выполненными.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Выбираемые значения: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы с рабочей областью FortiManager; значение может быть global и другие, включая root.
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: Set up DLP rules for this profile.
      fortinet.fortimanager.fmgr_dlp_profile_rule:
        # 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>
        profile: <your own value>
        state: present # <value in [present, absent]>
        dlp_profile_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]>

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

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

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