fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer – Политика архивирования логов для логов анализатора сети.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых условия будут считаться выполненными с ошибкой
rc_succeeded список / элементы=строка			список кодов rc, при которых условия будут считаться выполненными успешно
state строка / обязательный		Варианты: present absent	направление создания, обновления или удаления объекта
system_log_settings_rollinganalyzer словарь			установленные параметры верхнего уровня
	days список / элементы=строка	Варианты: вс пн вт ср чт пт сб	нет описания
	del-files строка	Варианты: выкл ← вкл	Включает/выключает удаление файлов логов после загрузки. выкл - Отключение удаления файлов логов. вкл - Включение удаления файлов логов.
	directory строка		Директория сервера загрузки, для Unix сервера, используйте абсолютный путь
	file-size целое число	Значение по умолчанию: 200	Архивировать файлы логов, когда они достигнут этого размера (МБ).
	gzip-format строка	Варианты: выкл ← вкл	Включает/выключает сжатие загружаемых файлов логов. выкл - Отключение сжатия. вкл - Включение сжатия.
	hour целое число	Значение по умолчанию: 0	График архивации файлов логов (час).
	ip строка	Значение по умолчанию: "0.0.0.0"	IP-адрес сервера загрузки.
	ip2 строка	Значение по умолчанию: "0.0.0.0"	IP-адрес сервера загрузки 2.
	ip3 строка	Значение по умолчанию: "0.0.0.0"	IP-адрес сервера загрузки 3.
	log-format строка	Варианты: native ← text csv	Формат загружаемых файлов логов. native - Нативный формат (текст или компактный). text - Текстовый формат (преобразовать, если необходимо). csv - CSV (comma-separated value) формат.
	min целое число	Значение по умолчанию: 0	График архивации файлов логов (минуты).
	password строка		нет описания
	password2 строка		нет описания
	password3 строка		нет описания
	server-type строка	Варианты: ftp ← sftp scp	Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP.
	upload строка	Варианты: выкл ← вкл	Включает/выключает загрузку файлов логов. выкл - Отключение загрузки файлов логов. вкл - Включение загрузки файлов логов.
	upload-hour целое число	Значение по умолчанию: 0	График загрузки файлов логов (час).
	upload-mode строка	Варианты: бэкап ← зеркало	Режим загрузки с несколькими серверами. бэкап - Серверы пытаются подключиться и используются по очереди при возникновении ошибки подключения. зеркало - Все настроенные серверы пытаются подключиться и используются.
	upload-trigger строка	Варианты: при_архивации ← по_расписанию	Событие, которое запускает загрузку файлов логов. при_архивации - Загрузка файлов логов после их архивации. по_расписанию - Ежедневная загрузка файлов логов.
	username строка		Имя пользователя для входа на сервер загрузки.
	username2 строка		Имя пользователя 2 для входа на сервер загрузки.
	username3 строка		Имя пользователя 3 для входа на сервер загрузки.
	when строка	Варианты: нет ← ежедневно еженедельно	Архивация файлов логов периодически. нет - Не производить периодическую архивацию файлов логов. ежедневно - Архивация файлов логов ежедневно. еженедельно - Архивация файлов логов по определенным дням недели.
workspace_locking_adom строка			область (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: Log rolling policy for Network Analyzer logs.
     fmgr_system_log_settings_rollinganalyzer:
        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_log_settings_rollinganalyzer:
           days:
             - sun
             - mon
             - tue
             - wed
             - thu
             - fri
             - sat
           del-files: <value in [disable, enable]>
           directory: <value of string>
           file-size: <value of integer>
           gzip-format: <value in [disable, enable]>
           hour: <value of integer>
           ip: <value of string>
           ip2: <value of string>
           ip3: <value of string>
           log-format: <value in [native, text, csv]>
           min: <value of integer>
           password: <value of string>
           password2: <value of string>
           password3: <value of string>
           server-type: <value in [ftp, sftp, scp]>
           upload: <value in [disable, enable]>
           upload-hour: <value of integer>
           upload-mode: <value in [backup, mirror]>
           upload-trigger: <value in [on-roll, on-schedule]>
           username: <value of string>
           username2: <value of string>
           username3: <value of string>
           when: <value in [none, daily, weekly]>

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

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

Ключ	Возвращаемое значение	Описание
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_log_settings_rollinganalyzer_module.html