Модуль fortinet.fortimanager.fmgr_system_autodelete_dlpfilesautodeletion – Политика автоматического удаления архивов DLP.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
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, переопределяющий условия успешного выполнения.
system_autodelete_dlpfilesautodeletion dictionary	Набор параметров верхнего уровня.
retention string	Автоматическое удаление через заданное число дней, недель или месяцев. days — автоматически удалять данные старше указанного срока weeks — автоматически удалять данные старше указанного срока months — автоматически удалять данные старше указанного срока Варианты: `"days"` `"weeks"` `"months"`
runat integer	Время запуска автоматического удаления
status string	Включить или отключить автоматическое удаление. disable — отключить автоматическое удаление. enable — включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value integer	Автоматическое удаление через x дней, недель или месяцев.
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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Automatic deletion policy for DLP archives.
      fortinet.fortimanager.fmgr_system_autodelete_dlpfilesautodeletion:
        # workspace_locking_adom: <global or your adom name>
        system_autodelete_dlpfilesautodeletion:
          # retention: <value in [days, weeks, months]>
          # runat: <integer>
          # status: <value in [disable, enable]>
          # value: <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	Предупреждение, если используемые в 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_autodelete_dlpfilesautodeletion_module.html