fortinet.fortimanager.fmgr_system_log_settings – Настройки логов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_system_log_settings.
Новое в версии 2.10: плагина fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| bypass_validation boolean |
| устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для завершения с ошибкой | |||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успешного завершения | |||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | ||
| system_log_settings словарь | установленные параметры верхнего уровня | |||
| browse-max-logfiles целое число | Значение по умолчанию: 10000 | Максимальное количество файлов журналов для каждого запроса просмотра журналов для каждого объекта Adom. | ||
| dns-resolve-dstip строка |
| Включение/выключение разрешения IP-адреса назначения по DNS. выключено - Выключение разрешения IP-адреса назначения по DNS. включено - Включение разрешения IP-адреса назначения по DNS. | ||
| download-max-logs целое число | Значение по умолчанию: 500000 | Максимальное количество журналов для каждого запроса скачивания журналов. | ||
| FAC-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FAZ-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FCH-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FCT-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FDD-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FGT-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FMG-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FML-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FPX-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FSA-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| FWB-custom-field1 строка | Имя пользовательского поля журнала для индексации. | |||
| ha-auto-migrate строка |
| Включение/выключение автоматической агрегации журналов членов HA в кластер HA. выключено - Отключение автоматической агрегации журналов членов HA в кластер HA. включено - Включение автоматической агрегации журналов членов HA в кластер HA. | ||
| import-max-logfiles целое число | Значение по умолчанию: 10000 | Максимальное количество файлов журналов для каждого запроса импорта журналов. | ||
| log-file-archive-name строка |
| Формат имени файла журнала для архивации, например, резервного копирования, загрузки или скачивания. основной - Основной формат имени файла архива журнала, например, FGT20C0000000001.tlog.1417797247.log. расширенный - Расширенный формат имени файла архива журнала, например, FGT20C0000000001.2014-12-05-08:34:58.tlog.1417797247.log. | ||
| rolling-analyzer словарь | нет описания | |||
| 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 строка |
| Формат загружаемых файлов журналов. родной - Родной формат (текст или компактный). текст - Текстовый формат (преобразовать при необходимости). csv - Формат CSV (разделенный запятыми). | ||
| min целое число | Значение по умолчанию: 0 | График ротации файлов журналов (минуты). | ||
| password строка | нет описания | |||
| password2 строка | нет описания | |||
| password3 строка | нет описания | |||
| server-type строка |
| Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. | ||
| upload строка |
| Включение/выключение загрузки файлов журналов. выключено - Отключение загрузки файлов журналов. включено - Включение загрузки файлов журналов. | ||
| upload-hour целое число | Значение по умолчанию: 0 | График загрузки файлов журналов (час). | ||
| upload-mode строка |
| Режим загрузки с несколькими серверами. резервное копирование - Сервера пытаются подключиться один за другим в случае неудачи. зеркальное отображение - Все настроенные сервера пытаются подключиться. | ||
| upload-trigger строка |
| Событие, запускающее загрузку файлов журналов. при ротации - Загрузка файлов журналов после их ротации. по расписанию - Ежедневная загрузка файлов журналов. | ||
| логин_пользователя строка | Имя пользователя для входа на сервер загрузки. | |||
| логин_пользователя2 строка | Имя пользователя для входа на сервер загрузки2. | |||
| логин_пользователя3 строка | Имя пользователя для входа на сервер загрузки3. | |||
| когда строка |
| Периодическое создание резервных копий лог-файлов. нет - Не создавать резервные копии лог-файлов периодически. ежедневно - Создавать резервные копии лог-файлов ежедневно. еженедельно - Создавать резервные копии лог-файлов по определенным дням недели. | ||
| архивация_локально словарь | нет описания | |||
| дни список / элементы=строка |
| нет описания | ||
| удалить_файлы строка |
| Включить/отключить удаление лог-файлов после загрузки. отключить - Отключить удаление лог-файлов. включить - Включить удаление лог-файлов. | ||
| каталог строка | Каталог на сервере загрузки, для серверов Unix использовать абсолютный | |||
| размер_файла целое_число | По умолчанию: 200 | Создавать резервные копии лог-файлов, когда они достигают этого размера (МБ). | ||
| формат_gzip строка |
| Включить/отключить сжатие загруженных лог-файлов. отключить - Отключить сжатие. включить - Включить сжатие. | ||
| час целое_число | По умолчанию: 0 | Расписание создания резервных копий лог-файлов (час). | ||
| ip строка | По умолчанию: "0.0.0.0" | IP-адрес сервера загрузки. | ||
| ip2 строка | По умолчанию: "0.0.0.0" | IP-адрес сервера загрузки2. | ||
| ip3 строка | По умолчанию: "0.0.0.0" | IP-адрес сервера загрузки3. | ||
| формат_лога строка |
| Формат загружаемых лог-файлов. родной - Родной формат (текст или компактный). текст - Текстовый формат (преобразовать при необходимости). csv - CSV (разделенный запятыми) формат. | ||
| мин целое_число | По умолчанию: 0 | Расписание создания резервных копий лог-файлов (минуты). | ||
| пароль строка | нет описания | |||
| пароль2 строка | нет описания | |||
| пароль3 строка | нет описания | |||
| тип_сервера строка |
| Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. | ||
| загрузка строка |
| Включить/отключить загрузку лог-файлов. отключить - Отключить загрузку лог-файлов. включить - Включить загрузку лог-файлов. | ||
| час_загрузки целое_число | По умолчанию: 0 | Расписание загрузки лог-файлов (час). | ||
| режим_загрузки строка |
| Режим загрузки с несколькими серверами. резервная_копия - Серверы пробуются последовательно, один за другим в случае неудачи подключения. зеркало - Все настроенные серверы пробуются и используются. | ||
| триггер_загрузки строка |
| Событие, запускающее загрузку лог-файлов. при_архивации - Загрузить лог-файлы после архивации. по_расписанию - Загрузить лог-файлы ежедневно. | ||
| логин_пользователя строка | Имя пользователя для входа на сервер загрузки. | |||
| логин_пользователя2 строка | Имя пользователя для входа на сервер загрузки2. | |||
| логин_пользователя3 строка | Имя пользователя для входа на сервер загрузки3. | |||
| когда строка |
| Периодическое создание резервных копий лог-файлов. нет - Не создавать резервные копии лог-файлов периодически. ежедневно - Создавать резервные копии лог-файлов ежедневно. еженедельно - Создавать резервные копии лог-файлов по определенным дням недели. | ||
| архивация_регулярно словарь | нет описания | |||
| дни список / элементы=строка |
| нет описания | ||
| удалить_файлы строка |
| Включить/отключить удаление лог-файлов после загрузки. отключить - Отключить удаление лог-файлов. включить - Включить удаление лог-файлов. | ||
| каталог строка | Каталог на сервере загрузки, для серверов Unix использовать абсолютный | |||
| размер_файла целое_число | По умолчанию: 200 | Создавать резервные копии лог-файлов, когда они достигают этого размера (МБ). | ||
| формат_gzip строка |
| Включить/отключить сжатие загруженных лог-файлов. отключить - Отключить сжатие. включить - Включить сжатие. | ||
| час целое_число | По умолчанию: 0 | Расписание создания резервных копий лог-файлов (час). | ||
| ip строка | По умолчанию: "0.0.0.0" | IP-адрес сервера загрузки. | ||
| ip2 строка | По умолчанию: "0.0.0.0" | IP-адрес сервера загрузки2. | ||
| ip3 строка | По умолчанию: "0.0.0.0" | IP-адрес сервера загрузки3. | ||
| формат_лога строка |
| Формат загружаемых лог-файлов. родной - Родной формат (текст или компактный). текст - Текстовый формат (преобразовать при необходимости). csv - CSV (разделенный запятыми) формат. | ||
| min integer | Значение по умолчанию: 0 | Расписание вращения лог-файлов (минуты). | ||
| password string | нет описания | |||
| password2 string | нет описания | |||
| password3 string | нет описания | |||
| server-type string |
| Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. | ||
| upload string |
| Включить/выключить загрузку лог-файлов. disable - Отключить загрузку лог-файлов. enable - Включить загрузку лог-файлов. | ||
| upload-hour integer | Значение по умолчанию: 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 - Вращать лог-файлы в определенные дни недели. | ||
| sync-search-timeout integer | Значение по умолчанию: 60 | Максимальное время в секундах для выполнения сеанса поиска логов в синхронном режиме. | ||
| workspace_locking_adom string | домен для блокировки рабочей области в режиме FortiManager, значение может быть глобальным или другим, включая корневой | |||
| workspace_locking_timeout integer | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем | ||
Примечания
Примечание
- Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код. Вы также можете переопределить условия для ошибки или успеха параметрами 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 settings.
fmgr_system_log_settings:
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:
FAC-custom-field1: <value of string>
FAZ-custom-field1: <value of string>
FCH-custom-field1: <value of string>
FCT-custom-field1: <value of string>
FDD-custom-field1: <value of string>
FGT-custom-field1: <value of string>
FMG-custom-field1: <value of string>
FML-custom-field1: <value of string>
FPX-custom-field1: <value of string>
FSA-custom-field1: <value of string>
FWB-custom-field1: <value of string>
browse-max-logfiles: <value of integer>
dns-resolve-dstip: <value in [disable, enable]>
download-max-logs: <value of integer>
ha-auto-migrate: <value in [disable, enable]>
import-max-logfiles: <value of integer>
log-file-archive-name: <value in [basic, extended]>
rolling-analyzer:
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]>
rolling-local:
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]>
rolling-regular:
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]>
sync-search-timeout: <value of integer>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_module.html