fortinet.fortimanager.fmgr_system_log_settings_rollinglocal – Политика ротации логов для локальных журналов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_log_settings_rollinglocal.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только при различии схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список rc-кодов, при которых условия будут игнорироваться | ||
| rc_succeeded список / элементы=строка | список rc-кодов, при которых условия будут игнорироваться | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| system_log_settings_rollinglocal словарь | параметры верхнего уровня | ||
| 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 - CSV (разделенные запятыми) формат. | |
| min целое число | Значение по умолчанию: 0 | Расписание сжатия файлов логов (минуты). | |
| password строка | нет описания | ||
| password2 строка | нет описания | ||
| password3 строка | нет описания | ||
| server-type строка |
| Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. | |
| upload строка |
| Включить/выключить загрузку файлов логов. выключить - Выключить загрузку файлов логов. включить - Включить загрузку файлов логов. | |
| upload-hour целое число | Значение по умолчанию: 0 | Расписание загрузки файлов логов (час). | |
| upload-mode string |
| Режим загрузки с несколькими серверами. backup - Серверы пытаются подключиться и используются по очереди при невозможности подключения. mirror - Все настроенные серверы пытаются подключиться и используются. | |
| upload-trigger string |
| Событие, запускающее загрузку лог-файлов. on-roll - Загрузка лог-файлов после их архивирования. on-schedule - Ежедневная загрузка лог-файлов. | |
| username string | Имя пользователя для входа на сервер загрузки. | ||
| username2 string | Имя пользователя для входа на сервер загрузки (2). | ||
| username3 string | Имя пользователя для входа на сервер загрузки (3). | ||
| when string |
| Периодическое архивирование лог-файлов. none - Не производить периодическое архивирование лог-файлов. daily - Ежедневное архивирование лог-файлов. weekly - Архивирование лог-файлов по определенным дням недели. | |
| workspace_locking_adom string | ADOM для блокировки при работе 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: Log rolling policy for local logs.
fmgr_system_log_settings_rollinglocal:
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_rollinglocal:
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 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_log_settings_rollinglocal_module.html
