fortinet.fortimanager.fmgr_system_locallog_disk_setting – Настройки локального журнала на диске.

Примечание

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

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

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

Новый в версии 2.10: коллекции fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: no ← yes	устанавливается в True только когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполняться без проверки параметров
rc_failed list / elements=string			список кодов rc, при которых условия будут нарушены
rc_succeeded list / elements=string			список кодов rc, при которых условия будут выполнены
state string / required		Варианты: present absent	направление на создание, обновление или удаление объекта
system_locallog_disk_setting dictionary			установка параметров верхнего уровня
	diskfull string	Варианты: overwrite ← nolog	Политика, применяемая при заполнении диска. overwrite - Перезапись старейшего лога при заполнении диска. nolog - Остановка регистрации при заполнении диска.
	log-disk-full-percentage integer	Значение по умолчанию: 80	Диск логов считается полным при этом значении заполнения.
	max-log-file-size integer	Значение по умолчанию: 100	Максимальный размер файла логов перед ротацией.
	roll-day list / elements=string	Варианты: воскресенье понедельник вторник среда четверг пятница суббота	отсутствует описание
	roll-schedule string	Варианты: none ← daily weekly	Частота проверки файла логов на ротацию. none - Отсутствует расписание. daily - Ежедневно. weekly - Еженедельно.
	roll-time string		отсутствует описание
	server-type string	Варианты: FTP ← SFTP SCP	Тип сервера. FTP - Загрузка через FTP. SFTP - Загрузка через SFTP. SCP - Загрузка через SCP.
	severity string	Варианты: emergency alert critical error warning notification information ← debug	Минимальный уровень серьезности для регистрации. emergency - Уровень чрезвычайной ситуации. alert - Уровень тревоги. critical - Критический уровень. error - Уровень ошибки. warning - Уровень предупреждения. notification - Уровень уведомления. information - Уровень информации. debug - Уровень отладки.
	status string	Варианты: disable enable ←	Включить/отключить локальный журнал на диске. disable - Не регистрировать на локальном диске. enable - Регистрировать на локальном диске.
	upload string	Варианты: disable ← enable	Загрузка файла лога при ротации. disable - Отключить загрузку при ротации файла лога. enable - Включить загрузку при ротации файла лога.
	upload-delete-files string	Варианты: disable enable ←	Удалять файлы логов после загрузки (по умолчанию = enable). disable - Не удалять файлы логов после загрузки. enable - Удалять файлы логов после загрузки.
	upload-time string		отсутствует описание
	uploaddir string		Дистантерный каталог для загрузки файла лога.
	uploadip string	Значение по умолчанию: "0.0.0.0"	IP-адрес сервера загрузки логов.
	uploadpass string		отсутствует описание
	uploadport integer	Значение по умолчанию: 0	Порт сервера (0 = порт по умолчанию для протокола).
	uploadsched string	Варианты: disable ← enable	Планируемая загрузка (disable = загрузка при ротации). disable - Загрузка при ротации. enable - Планируемая загрузка.
	uploadtype list / elements=string	Варианты: event	отсутствует описание
	uploaduser string		Пользовательская учетная запись на сервере загрузки.
	uploadzip string	Варианты: disable ← enable	Сжимать загружаемые логи. disable - Загружать файлы логов в виде простого текста. enable - Загружать файлы логов в сжатом виде.
workspace_locking_adom string			adom для блокировки при работе в режиме рабочей области FortiManager; значение может быть глобальным и другими, включая root
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: Settings for local disk logging.
     fmgr_system_locallog_disk_setting:
        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_locallog_disk_setting:
           diskfull: <value in [overwrite, nolog]>
           log-disk-full-percentage: <value of integer>
           max-log-file-size: <value of integer>
           roll-day:
             - sunday
             - monday
             - tuesday
             - wednesday
             - thursday
             - friday
             - saturday
           roll-schedule: <value in [none, daily, weekly]>
           roll-time: <value of string>
           server-type: <value in [FTP, SFTP, SCP]>
           severity: <value in [emergency, alert, critical, ...]>
           status: <value in [disable, enable]>
           upload: <value in [disable, enable]>
           upload-delete-files: <value in [disable, enable]>
           upload-time: <value of string>
           uploaddir: <value of string>
           uploadip: <value of string>
           uploadpass: <value of string>
           uploadport: <value of integer>
           uploadsched: <value in [disable, enable]>
           uploadtype:
             - event
           uploaduser: <value of string>
           uploadzip: <value in [disable, enable]>

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

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

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