Модуль fortinet.fortimanager.fmgr_dlp_filepattern — настройка шаблонов файлов, используемых для блокировки DLP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_dlp_filepattern.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логический | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Допустимые значения:
|
dlp_filepattern словарь | Набор параметров верхнего уровня. |
|
comment строка |
Необязательный комментарий. |
|
entries список / элементы=словарь |
Записи. |
|
file_type псевдонимы: file-type строка |
Выберите тип файла. Допустимые значения:
|
|
filter_type псевдонимы: filter-type строка |
Фильтрация по шаблону имени файла или по типу файла. Допустимые значения:
|
|
pattern строка |
Добавьте шаблон имени файла. |
|
id целое число / обязательный |
Идентификатор. |
|
name строка |
Имя таблицы, содержащей список шаблонов файлов. |
enable_log логический | Включить/отключить ведение журнала для задачи. Допустимые значения:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Допустимые значения:
|
rc_failed список / элементы=целое число | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded список / элементы=целое число | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Указание на создание, обновление или удаление объекта. Допустимые значения:
|
workspace_locking_adom строка | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global или другие ADOM, включая root. |
workspace_locking_timeout целое число | Максимальное время ожидания освобождения блокировки рабочего пространства другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 file patterns used by DLP blocking.
fortinet.fortimanager.fmgr_dlp_filepattern:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
dlp_filepattern:
id: 0 # Required variable, integer
# comment: <string>
# entries:
# - file_type: <value in [unknown, ignored, exe, ...]>
# filter_type: <value in [pattern, type]>
# pattern: <string>
# name: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, характерные только для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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_filepattern_module.html
