fortinet.fortimanager.fmgr_system_autodelete_reportautodeletion – Автоматическая политика удаления отчетов.

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только в случае расхождений между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых выполнение будет прервано
rc_succeeded список / элементы=строка			список кодов rc, при которых выполнение будет успешным
state строка / обязательный		Варианты: present absent	директива для создания, обновления или удаления объекта
system_autodelete_reportautodeletion словарь			параметры верхнего уровня
	retention строка	Варианты: дни ← недели месяцы	Автоматическое удаление данных через дни, недели или месяцы. дни - Автоудаление данных, старше <значение> дней. недели - Автоудаление данных, старше <значение> недель. месяцы - Автоудаление данных, старше <значение> месяцев.
	runat целое число	Значение по умолчанию: 0	Автоматическое удаление в (0 - 23) часов.
	status строка	Варианты: отключить ← включить	Включить/выключить автоматическое удаление. отключить - Отключить автоматическое удаление. включить - Включить автоматическое удаление.
	value целое число	Значение по умолчанию: 0	Автоматическое удаление через x дней, недель или месяцев.
workspace_locking_adom строка			домен, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корневой
workspace_locking_timeout целое число		Значение по умолчанию: 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 reports.
     fmgr_system_autodelete_reportautodeletion:
        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_reportautodeletion:
           retention: <value in [days, weeks, months]>
           runat: <value of integer>
           status: <value in [disable, enable]>
           value: <value of integer>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	статус запроса API
response_message строка	всегда	описательное сообщение ответа 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_reportautodeletion_module.html