Модуль fortinet.fortimanager.fmgr_dlp_dictionary — настройка словарей, используемых для блокировки DLP.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dlp_dictionary dictionary	Набор параметров верхнего уровня.
comment string	Необязательные комментарии.
entries list / elements=dictionary	Записи.
comment string	Необязательные комментарии.
id integer	Идентификатор.
ignore_case псевдонимы: ignore-case string	Включить или отключить игнорирование регистра. Варианты: `"disable"` `"enable"`
pattern string	Шаблон для сопоставления.
repeat string	Включить или отключить повторное сопоставление. Варианты: `"disable"` `"enable"`
status string	Включить или отключить этот шаблон. Варианты: `"disable"` `"enable"`
type string	Тип шаблона для сопоставления.
fgd_id псевдонимы: fgd-id integer	Идентификатор объекта в базе данных FortiGuard.
match_around псевдонимы: match-around string	Включить или отключить поддержку match-around. Варианты: `"disable"` `"enable"`
match_type псевдонимы: match-type string	Логическая связь между записями Варианты: `"match-all"` `"match-any"`
name string / обязательный	Имя таблицы, содержащей словарь.
uuid string	Универсальный уникальный идентификатор
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, переопределяющий условия, при которых выполнение считается успешным.
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 dictionaries used by DLP blocking.
      fortinet.fortimanager.fmgr_dlp_dictionary:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        dlp_dictionary:
          name: "your value" # Required variable, string
          # comment: <string>
          # entries:
          #   - comment: <string>
          #     id: <integer>
          #     ignore_case: <value in [disable, enable]>
          #     pattern: <string>
          #     repeat: <value in [disable, enable]>
          #     status: <value in [disable, enable]>
          #     type: <string>
          # match_type: <value in [match-all, match-any]>
          # uuid: <string>
          # match_around: <value in [disable, enable]>
          # fgd_id: <integer>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_dictionary_module.html