Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_autodelete

Новое в версии 2.10: модуля fortinet.fortimanager

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bypass_validation
boolean
    Варианты:
  • нет ←
  • да
устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed
list / elements=string
список кодов rc, при которых условия будут игнорироваться
rc_succeeded
list / elements=string
список кодов rc, при которых условия будут выполняться
state
string / required
    Варианты:
  • present
  • absent
направление создания, обновления или удаления объекта
system_autodelete
dictionary
настройка параметров верхнего уровня
dlp-files-auto-deletion
dictionary
нет описания
retention
string
    Варианты:
  • дни ←
  • недели
  • месяцы
Автоматическое удаление через дни, недели или месяцы.
дни - Автоматически удалять данные, которым больше <значение> дней.
недели - Автоматически удалять данные, которым больше <значение> недель.
месяцы - Автоматически удалять данные, которым больше <значение> месяцев.
runat
integer
Значение по умолчанию:
0
Автоматическое удаление выполняется в (0 - 23) часов.
status
string
    Варианты:
  • отключить ←
  • включить
Включить/отключить автоматическое удаление.
отключить - Отключить автоматическое удаление.
включить - Включить автоматическое удаление.
value
integer
Значение по умолчанию:
0
Автоматическое удаление через x дней, недель или месяцев.
log-auto-deletion
dictionary
нет описания
retention
string
    Варианты:
  • дни ←
  • недели
  • месяцы
Автоматическое удаление через дни, недели или месяцы.
дни - Автоматически удалять данные, которым больше <значение> дней.
недели - Автоматически удалять данные, которым больше <значение> недель.
месяцы - Автоматически удалять данные, которым больше <значение> месяцев.
runat
integer
Значение по умолчанию:
0
Автоматическое удаление выполняется в (0 - 23) часов.
status
string
    Варианты:
  • отключить ←
  • включить
Включить/отключить автоматическое удаление.
отключить - Отключить автоматическое удаление.
включить - Включить автоматическое удаление.
value
integer
Значение по умолчанию:
0
Автоматическое удаление через x дней, недель или месяцев.
quarantine-files-auto-deletion
dictionary
нет описания
retention
string
    Варианты:
  • дни ←
  • недели
  • месяцы
Автоматическое удаление через дни, недели или месяцы.
дни - Автоматически удалять данные, которым больше <значение> дней.
недели - Автоматически удалять данные, которым больше <значение> недель.
месяцы - Автоматически удалять данные, которым больше <значение> месяцев.
runat
integer
Значение по умолчанию:
0
Автоматическое удаление выполняется в (0 - 23) часов.
status
string
    Варианты:
  • отключить ←
  • включить
Включить/отключить автоматическое удаление.
отключить - Отключить автоматическое удаление.
включить - Включить автоматическое удаление.
value
integer
Значение по умолчанию:
0
Автоматическое удаление через x дней, недель или месяцев.
report-auto-deletion
dictionary
нет описания
retention
string
    Варианты:
  • дни ←
  • недели
  • месяцы
Автоматическое удаление через дни, недели или месяцы.
дни - Автоматически удалять данные, которым больше <значение> дней.
недели - Автоматически удалять данные, которым больше <значение> недель.
месяцы - Автоматически удалять данные, которым больше <значение> месяцев.
runat
integer
Значение по умолчанию:
0
Автоматическое удаление выполняется в (0 - 23) часов.
status
string
    Варианты:
  • отключить ←
  • включить
Включить/отключить автоматическое удаление.
отключить - Отключить автоматическое удаление.
включить - Включить автоматическое удаление.
value
integer
Значение по умолчанию:
0
Автоматическое удаление через x дней, недель или месяцев.
status-fake
integer
Двойное значение для работы меню.
workspace_locking_adom
string
область, которая блокируется при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout
integer
Значение по умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство.

Примечания

Примечание

  • Поддерживается запуск в режиме блокировки рабочего пространства в данном модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно, запуск одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  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.
     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: <value of integer>
              status: <value in [disable, enable]>
              value: <value of integer>
           log-auto-deletion:
              retention: <value in [days, weeks, months]>
              runat: <value of integer>
              status: <value in [disable, enable]>
              value: <value of integer>
           quarantine-files-auto-deletion:
              retention: <value in [days, weeks, months]>
              runat: <value of integer>
              status: <value in [disable, enable]>
              value: <value of integer>
           report-auto-deletion:
              retention: <value in [days, weeks, months]>
              runat: <value of integer>
              status: <value in [disable, enable]>
              value: <value of integer>
           status-fake: <value of integer>

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

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

Ключ Возвращаемое значение Описание
request_url
string
всегда
полный запрашиваемый URL

Пример:
/sys/login/user
response_code
integer
всегда
статус запроса API
response_message
string
всегда
описательное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_autodelete_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API