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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливать в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для сбоя.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
system_autodelete словарь	Настройка параметров верхнего уровня.
dlp_files_auto_deletion словарь	Устарело, пожалуйста, переименуйте на dlp_files_auto_deletion. Автоматическое удаление файлов DLP.
retention строка	Автоматическое удаление данных через дни, недели или месяцы. дни - Автоудаление данных, старше чем недели - Автоудаление данных, старше чем месяцы - Автоудаление данных, старше чем Варианты: `"days"` `"weeks"` `"months"`
runat целое число	Время выполнения автоматического удаления
status строка	Включить/выключить автоматическое удаление. disable - Выключить автоматическое удаление. enable - Включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value целое число	Автоматическое удаление через x дней, недель или месяцев.
log_auto_deletion словарь	Устарело, пожалуйста, переименуйте на log_auto_deletion. Автоматическое удаление журналов.
retention строка	Автоматическое удаление данных через дни, недели или месяцы. дни - Автоудаление данных, старше чем недели - Автоудаление данных, старше чем месяцы - Автоудаление данных, старше чем Варианты: `"days"` `"weeks"` `"months"`
runat целое число	Время выполнения автоматического удаления
status строка	Включить/выключить автоматическое удаление. disable - Выключить автоматическое удаление. enable - Включить автоматическое удаление. Варианты: `"disable"` `"enable"`
value целое число	Автоматическое удаление через x дней, недель или месяцев.
quarantine_files_auto_deletion словарь	Устарело, пожалуйста, переименуйте на quarantine_files_auto_deletion. Автоматическое удаление файлов карантина.
retention строка	Автоматическое удаление данных через дни, недели или месяцы. дни - Автоудаление данных, старше чем недели - Автоудаление данных, старше чем месяцы - Автоудаление данных, старше чем Варианты: `"days"` `"weeks"` `"months"`

runat целое число	Время запуска автоматического удаления
status строка	Включение/выключение автоматического удаления. disable - Отключить автоматическое удаление. enable - Включить автоматическое удаление. Выбоpы: `"disable"` `"enable"`
value целое число	Автоматическое удаление через x дней, недель или месяцев.
report-auto-deletion словарь	Устаревшее, пожалуйста, переименуйте на report_auto_deletion. Автоматическое удаление отчетов.
retention строка	Автоматическое удаление через дни, недели или месяцы. days - Автоудаление данных старше weeks - Автоудаление данных старше months - Автоудаление данных старше Выбоpы: `"days"` `"weeks"` `"months"`
runat целое число	Время запуска автоматического удаления
status строка	Включение/выключение автоматического удаления. disable - Отключить автоматическое удаление. enable - Включить автоматическое удаление. Выбоpы: `"disable"` `"enable"`
value целое число	Автоматическое удаление через x дней, недель или месяцев.
status-fake целое число	Устаревшее, пожалуйста, переименуйте на status_fake. Фиктивное значение для работы меню.
workspace_locking_adom строка	Область управления (ADOM) для блокировки при работе в режиме рабочей области FortiManager. Значение может быть глобальным и другими, включая корневой.
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 помогают в этой работе.
Обычно, выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код (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: Automatic deletion policy for logs, reports, archived, and quarantined files.
      fortinet.fortimanager.fmgr_system_autodelete:
        # 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, ...]
        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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге сценариев, не поддерживаются текущей версией 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_system_autodelete_module.html