модуль fortinet.fortimanager.fmgr_system_autodelete — политика автоматического удаления журналов, отчетов, архивных файлов и файлов в карантине.

Примечание

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

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

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

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

Добавлено в 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 dictionary	Набор параметров верхнего уровня.
dlp_files_auto_deletion псевдонимы: dlp-files-auto-deletion dictionary	Автоматическое удаление файлов DLP.
retention string	Автоматическое удаление за период в днях, неделях или месяцах. days — автоматически удалять данные старше указанного срока weeks — автоматически удалять данные старше указанного срока months — автоматически удалять данные старше указанного срока Варианты: `"days"` `"weeks"` `"months"`
runat integer	Время запуска автоматического удаления
status string	Включить или отключить автоматическое удаление. disable — отключить автоматическое удаление. enable — включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value integer	Автоматическое удаление через x дней, недель или месяцев.
log_auto_deletion псевдонимы: log-auto-deletion dictionary	Автоматическое удаление журналов.
retention string	Автоматическое удаление за период в днях, неделях или месяцах. days — автоматически удалять данные старше указанного срока weeks — автоматически удалять данные старше указанного срока months — автоматически удалять данные старше указанного срока Варианты: `"days"` `"weeks"` `"months"`
runat integer	Время запуска автоматического удаления
status string	Включить или отключить автоматическое удаление. disable — отключить автоматическое удаление. enable — включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value integer	Автоматическое удаление через x дней, недель или месяцев.
quarantine_files_auto_deletion псевдонимы: quarantine-files-auto-deletion dictionary	Автоматическое удаление файлов в карантине.
retention string	Автоматическое удаление за период в днях, неделях или месяцах. days — автоматически удалять данные старше указанного срока weeks — автоматически удалять данные старше указанного срока months — автоматически удалять данные старше указанного срока Варианты: `"days"` `"weeks"` `"months"`
runat integer	Время запуска автоматического удаления
status string	Включить или отключить автоматическое удаление. disable — отключить автоматическое удаление. enable — включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value integer	Автоматическое удаление через x дней, недель или месяцев.
report_auto_deletion псевдонимы: report-auto-deletion dictionary	Автоматическое удаление отчетов.
retention string	Автоматическое удаление за период в днях, неделях или месяцах. days — автоматически удалять данные старше указанного срока weeks — автоматически удалять данные старше указанного срока months — автоматически удалять данные старше указанного срока Варианты: `"days"` `"weeks"` `"months"`
runat integer	Время запуска автоматического удаления
status string	Включить или отключить автоматическое удаление. disable — отключить автоматическое удаление. enable — включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value integer	Автоматическое удаление через x дней, недель или месяцев.
status_fake псевдонимы: status-fake integer	Фиктивное значение для работы меню.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, в том числе 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 logs, reports, archived, and quarantined files.
      fortinet.fortimanager.fmgr_system_autodelete:
        # workspace_locking_adom: <global or your adom name>
        system_autodelete:
          # dlp_files_auto_deletion:
          #   retention: <value in [days, weeks, months]>
          #   runat: <integer>
          #   status: <value in [disable, enable]>
          #   value: <integer>
          # log_auto_deletion:
          #   retention: <value in [days, weeks, months]>
          #   runat: <integer>
          #   status: <value in [disable, enable]>
          #   value: <integer>
          # quarantine_files_auto_deletion:
          #   retention: <value in [days, weeks, months]>
          #   runat: <integer>
          #   status: <value in [disable, enable]>
          #   value: <integer>
          # report_auto_deletion:
          #   retention: <value in [days, weeks, months]>
          #   runat: <integer>
          #   status: <value in [disable, enable]>
          #   value: <integer>
          # status_fake: <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_system_autodelete_module.html