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

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_autodelete_logautodeletion.

Введено в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых условия выполнения будут переопределены
rc_succeeded список / элементы=строка			список кодов rc, при которых условия выполнения будут переопределены
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
system_autodelete_logautodeletion словарь			устанавливаемые параметры верхнего уровня
	retention строка	Варианты: дни ← недели месяцы	Автоматическое удаление в днях, неделях или месяцах. дни - Автоматическое удаление данных, старше <значение> дней. недели - Автоматическое удаление данных, старше <значение> недель. месяцы - Автоматическое удаление данных, старше <значение> месяцев.
	runat целое число	По умолчанию: 0	Автоматическое удаление выполняется в (0 - 23) часов.
	status строка	Варианты: отключить ← включить	Включение/отключение автоматического удаления. отключить - Отключить автоматическое удаление. включить - Включить автоматическое удаление.
	value целое число	По умолчанию: 0	Автоматическое удаление в x дней, недель или месяцев.
workspace_locking_adom строка			ADOM для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая root.
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 device logs.
     fmgr_system_autodelete_logautodeletion:
        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_logautodeletion:
           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_logautodeletion_module.html