Модуль fortinet.fortimanager.fmgr_system_log_settings – Настройки журналирования.

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

• false ← (по умолчанию)
• true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

• false ← (по умолчанию)
• true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

• "update"
• "set"
• "add"

rc_failed

list / elements=integer

Список кодов rc, для которых будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых будут переопределены условия успешного выполнения.

system_log_settings

dictionary

Набор параметров верхнего уровня.

browse_max_logfiles

псевдонимы: browse-max-logfiles

integer

Максимальное количество файлов журнала при каждой попытке просмотра журналов для каждого ADOM.

client_cert_auth

псевдонимы: client-cert-auth

dictionary

Аутентификация по сертификату клиента.

mode

string

Режим.

Варианты:

• "basic"
• "strict"

tls_port

псевдонимы: tls-port

string

Порт TLS.

Варианты:

• "both"
• "514"
• "6514"

trusted_client

псевдонимы: trusted-client

list / elements=dictionary

Доверенный клиент.

certificate

any

(список) Сертификат.

description

string

Описание.

domain

string

Домен.

id

integer

Идентификатор.

type

string

Тип.

Варианты:

• "certificate"
• "domain"

device_auto_detect

псевдонимы: device-auto-detect

string

Включить или отключить поиск идентификатора устройства в полученных без шифрования сообщениях syslog.

disable — отключить поиск идентификатора устройства в полученных без шифрования сообщениях syslog.

enable — включить поиск идентификатора устройства в полученных без шифрования сообщениях syslog.

Варианты:

• "disable"
• "enable"

dns_resolve_dstip

псевдонимы: dns-resolve-dstip

string

Включить или отключить разрешение IP-адреса назначения с помощью DNS.

disable — отключить разрешение IP-адреса назначения с помощью DNS.

enable — включить разрешение IP-адреса назначения с помощью DNS.

Варианты:

• "disable"
• "enable"

download_max_logs

псевдонимы: download-max-logs

integer

Максимальное количество записей журнала при каждой попытке их загрузки.

FAC_custom_field1

псевдонимы: FAC-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FAZ_custom_field1

псевдонимы: FAZ-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FCH_custom_field1

псевдонимы: FCH-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FCT_custom_field1

псевдонимы: FCT-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FDD_custom_field1

псевдонимы: FDD-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FFW_custom_field1

псевдонимы: FFW-custom-field1

string

Настраиваемое поле FFW 1.

FGT_custom_field1

псевдонимы: FGT-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FMG_custom_field1

псевдонимы: FMG-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FML_custom_field1

псевдонимы: FML-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FPX_custom_field1

псевдонимы: FPX-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FSA_custom_field1

псевдонимы: FSA-custom-field1

string

Имя настраиваемого поля журнала для индексации.

FWB_custom_field1

псевдонимы: FWB-custom-field1

string

Имя настраиваемого поля журнала для индексации.

ha_auto_migrate

псевдонимы: ha-auto-migrate

string

Включить или отключить автоматическое объединение журналов участников HA-кластера.

disable — отключить автоматическое объединение журналов участников HA-кластера.

enable — включить автоматическое объединение журналов участников HA-кластера.

Варианты:

• "disable"
• "enable"

import_max_logfiles

псевдонимы: import-max-logfiles

integer

Максимальное количество файлов журнала при каждой попытке импорта журналов.

keep_dev_logs

псевдонимы: keep-dev-logs

string

Включить или отключить сохранение журналов устройства после его удаления.

disable — отключить сохранение журналов устройства после его удаления.

enable — включить сохранение журналов устройства после его удаления.

Варианты:

• "disable"
• "enable"

legacy_auth_mode

псевдонимы: legacy-auth-mode

string

Включить или отключить устаревший режим аутентификации устройства с помощью имени пользователя и пароля.

disable — отключить поддержку устаревшего режима аутентификации.

enable — включить поддержку устаревшего режима аутентификации.

Варианты:

• "disable"
• "enable"

log_file_archive_name

псевдонимы: log-file-archive-name

string

Формат имени файла журнала для архивирования, например при резервном копировании, отправке или загрузке.

basic — базовый формат имени файла архива журнала, например

extended — расширенный формат имени файла архива журнала, например

Варианты:

• "basic"
• "extended"

log_interval_dev_no_logging

псевдонимы: log-interval-dev-no-logging

integer

Интервал в минутах, в течение которого устройство не получает журналы, прежде чем будет считаться недоступным.

log_process_fast_mode

псевдонимы: log-process-fast-mode

string

Включить или отключить быстрый режим обработки журналов.

disable — отключить быстрый режим обработки журналов.

enable — включить быстрый режим обработки журналов.

Варианты:

• "disable"
• "enable"

log_upload_interval_dev_no_logging

псевдонимы: log-upload-interval-dev-no-logging

integer

Интервал в минутах, в течение которого устройство не отправляет журналы, прежде чем будет считаться недоступным.

rolling_analyzer

псевдонимы: rolling-analyzer

dictionary

Циклическая обработка анализатора.

days

list / elements=string

Расписание циклической обработки файлов журнала

sun — воскресенье.

mon — понедельник.

tue — вторник.

wed — среда.

thu — четверг.

fri — пятница.

sat — суббота.

Варианты:

• "sun"
• "mon"
• "tue"
• "wed"
• "thu"
• "fri"
• "sat"

del_files

псевдонимы: del-files

string

Включить или отключить удаление файлов журнала после отправки.

disable — отключить удаление файлов журнала.

enable — включить удаление файлов журнала.

Варианты:

• "disable"
• "enable"

directory

string

Каталог на сервере для отправки; для сервера Unix используйте абсолютный путь

file_size

псевдонимы: file-size

integer

Циклически переключать файлы журнала при достижении этого размера

gzip_format

псевдонимы: gzip-format

string

Включить или отключить сжатие отправляемых файлов журнала.

disable — отключить сжатие.

enable — включить сжатие.

Варианты:

• "disable"
• "enable"

hour

integer

Расписание циклической обработки файлов журнала

ip

string

IP-адрес сервера для отправки.

ip2

string

IP-адрес 2 сервера для отправки.

ip3

string

IP-адрес 3 сервера для отправки.

log_format

aliases: log-format

string

Формат загружаемых файлов журнала.

native — Собственный формат

text — Текстовый формат

csv — CSV

Варианты:

• "native"
• "text"
• "csv"

min

integer

Расписание ротации файлов журнала

password

any

(список) Пароль для входа на сервер загрузки.

password2

any

(список) Пароль password2 для входа на сервер загрузки.

password3

any

(список) Пароль password3 для входа на сервер загрузки.

port

integer

Номер порта IP-адреса 1 сервера загрузки.

port2

integer

Номер порта IP-адреса 2 сервера загрузки.

port3

integer

Номер порта IP-адреса 3 сервера загрузки.

rolling_upgrade_status

aliases: rolling-upgrade-status

integer

Состояние поэтапного обновления

server

string

FQDN/IP-адрес сервера загрузки.

server2

string

FQDN/IP-адрес сервера загрузки 2.

server3

string

FQDN/IP-адрес сервера загрузки 3.

server_type

aliases: server-type

string

Тип сервера загрузки.

ftp — Загрузка через FTP.

sftp — Загрузка через SFTP.

scp — Загрузка через SCP.

Варианты:

• "ftp"
• "sftp"
• "scp"

upload

string

Включить или отключить загрузку файлов журнала.

disable — Отключить загрузку файлов журнала.

enable — Включить загрузку файлов журнала.

Варианты:

• "disable"
• "enable"

upload_hour

aliases: upload-hour

integer

Расписание загрузки файлов журнала

upload_mode

aliases: upload-mode

string

Режим загрузки при использовании нескольких серверов.

backup — При сбое подключения выполняется попытка подключения к следующему серверу.

mirror — Выполняется попытка подключения ко всем настроенным серверам, и они используются.

Варианты:

• "backup"
• "mirror"

upload_trigger

aliases: upload-trigger

string

Событие, запускающее загрузку файлов журнала.

on-roll — Загружать файлы журнала после их ротации.

on-schedule — Загружать файлы журнала ежедневно.

Варианты:

• "on-roll"
• "on-schedule"

username

string

Имя пользователя для входа на сервер загрузки.

username2

string

Имя пользователя username2 для входа на сервер загрузки.

username3

string

Имя пользователя username3 для входа на сервер загрузки.

when

string

Периодически выполнять ротацию файлов журнала.

none — Не выполнять периодическую ротацию файлов журнала.

daily — Выполнять ротацию файлов журнала ежедневно.

weekly — Выполнять ротацию файлов журнала в определенные дни недели.

Варианты:

• "none"
• "daily"
• "weekly"

rolling_local

aliases: rolling-local

dictionary

Локальная ротация.

days

list / elements=string

Расписание ротации файлов журнала

sun — Воскресенье.

mon — Понедельник.

tue — Вторник.

wed — Среда.

thu — Четверг.

fri — Пятница.

sat — Суббота.

Варианты:

• "sun"
• "mon"
• "tue"
• "wed"
• "thu"
• "fri"
• "sat"

del_files

aliases: del-files

string

Включить или отключить удаление файлов журнала после загрузки.

disable — Отключить удаление файлов журнала.

enable — Включить удаление файлов журнала.

Варианты:

• "disable"
• "enable"

directory

string

Каталог на сервере загрузки; для Unix-сервера укажите абсолютный путь

file_size

aliases: file-size

integer

Выполнять ротацию файлов журнала при достижении этого размера

gzip_format

aliases: gzip-format

string

Включить или отключить сжатие загружаемых файлов журнала.

disable — Отключить сжатие.

enable — Включить сжатие.

Варианты:

• "disable"
• "enable"

hour

integer

Расписание ротации файлов журнала

ip

string

IP-адрес сервера загрузки.

ip2

string

IP-адрес сервера загрузки 2.

ip3

string

IP-адрес сервера загрузки 3.

log_format

aliases: log-format

string

Формат загружаемых файлов журнала.

native — Собственный формат

text — Текстовый формат

csv — CSV

Варианты:

• "native"
• "text"
• "csv"

min

integer

Расписание ротации файлов журнала

password

any

(список) Пароль для входа на сервер загрузки.

password2

any

(список) Пароль password2 для входа на сервер загрузки.

password3

any

(список) Пароль password3 для входа на сервер загрузки.

port

integer

Номер порта IP-адреса 1 сервера загрузки.

port2

integer

Номер порта IP-адреса 2 сервера загрузки.

port3

integer

Номер порта IP-адреса 3 сервера загрузки.

rolling_upgrade_status

aliases: rolling-upgrade-status

integer

Состояние поэтапного обновления

server

string

FQDN/IP-адрес сервера загрузки.

server2

string

FQDN/IP-адрес сервера загрузки 2.

server3

string

FQDN/IP-адрес сервера загрузки 3.

server_type

aliases: server-type

string

Тип сервера загрузки.

ftp — Загрузка через FTP.

sftp — Загрузка через SFTP.

scp — Загрузка через SCP.

Варианты:

• "ftp"
• "sftp"
• "scp"

upload

string

Включить или отключить загрузку файлов журнала.

disable — Отключить загрузку файлов журнала.

enable — Включить загрузку файлов журнала.

Варианты:

• "disable"
• "enable"

upload_hour

aliases: upload-hour

integer

Расписание загрузки файлов журнала

upload_mode

aliases: upload-mode

string

Режим загрузки при использовании нескольких серверов.

backup — При сбое подключения выполняется попытка подключения к следующему серверу.

mirror — Выполняется попытка подключения ко всем настроенным серверам, и они используются.

Варианты:

• "backup"
• "mirror"

upload_trigger

aliases: upload-trigger

string

Событие, запускающее загрузку файлов журнала.

on-roll — Загружать файлы журнала после их ротации.

on-schedule — Загружать файлы журнала ежедневно.

Варианты:

• "on-roll"
• "on-schedule"

username

string

Имя пользователя для входа на сервер загрузки.

username2

string

Имя пользователя username2 для входа на сервер загрузки.

username3

string

Имя пользователя username3 для входа на сервер загрузки.

when

string

Периодически выполнять ротацию файлов журнала.

none — Не выполнять периодическую ротацию файлов журнала.

daily — Выполнять ротацию файлов журнала ежедневно.

weekly — Выполнять ротацию файлов журнала в определенные дни недели.

Варианты:

• "none"
• "daily"
• "weekly"

rolling_regular

aliases: rolling-regular

dictionary

Обычная ротация.

days

list / elements=string

Расписание ротации файлов журнала

sun — Воскресенье.

mon — Понедельник.

tue — Вторник.

wed — Среда.

thu — Четверг.

fri — Пятница.

sat — Суббота.

Варианты:

• "sun"
• "mon"
• "tue"
• "wed"
• "thu"
• "fri"
• "sat"

del_files

aliases: del-files

string

Включить или отключить удаление файлов журналов после загрузки.

disable — отключить удаление файлов журналов.

enable — включить удаление файлов журналов.

Варианты:

• "disable"
• "enable"

directory

string

Каталог на сервере для загрузки; для сервера Unix используйте абсолютный путь

file_size

aliases: file-size

integer

Начинать новый файл журнала при достижении этого размера

gzip_format

aliases: gzip-format

string

Включить или отключить сжатие загружаемых файлов журналов.

disable — отключить сжатие.

enable — включить сжатие.

Варианты:

• "disable"
• "enable"

hour

integer

Расписание создания новых файлов журналов

ip

string

IP-адрес сервера для загрузки.

ip2

string

IP-адрес 2 сервера для загрузки.

ip3

string

IP-адрес 3 сервера для загрузки.

log_format

aliases: log-format

string

Формат загружаемых файлов журналов.

native — исходный формат

text — текстовый формат

csv — CSV

Варианты:

• "native"
• "text"
• "csv"

min

integer

Расписание создания новых файлов журналов

password

any

(список) Пароль для входа на сервер загрузки.

password2

any

(список) Пароль password2 для входа на сервер загрузки.

password3

any

(список) Пароль password3 для входа на сервер загрузки.

port

integer

Номер порта IP1 сервера для загрузки.

port2

integer

Номер порта IP2 сервера для загрузки.

port3

integer

Номер порта IP3 сервера для загрузки.

rolling_upgrade_status

aliases: rolling-upgrade-status

integer

Состояние поэтапного обновления

server

string

FQDN/IP-адрес сервера для загрузки.

server2

string

FQDN/IP-адрес сервера 2 для загрузки.

server3

string

FQDN/IP-адрес сервера 3 для загрузки.

server_type

aliases: server-type

string

Тип сервера для загрузки.

ftp — загрузка по FTP.

sftp — загрузка по SFTP.

scp — загрузка по SCP.

Варианты:

• "ftp"
• "sftp"
• "scp"

upload

string

Включить или отключить загрузку файлов журналов.

disable — отключить загрузку файлов журналов.

enable — включить загрузку файлов журналов.

Варианты:

• "disable"
• "enable"

upload_hour

aliases: upload-hour

integer

Расписание загрузки файлов журналов

upload_mode

aliases: upload-mode

string

Режим загрузки при наличии нескольких серверов.

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

mirror — выполняется попытка подключения ко всем настроенным серверам и используются все серверы.

Варианты:

• "backup"
• "mirror"

upload_trigger

aliases: upload-trigger

string

Событие, запускающее загрузку файлов журналов.

on-roll — загружать файлы журналов после создания новых файлов.

on-schedule — загружать файлы журналов ежедневно.

Варианты:

• "on-roll"
• "on-schedule"

username

string

Имя пользователя для входа на сервер загрузки.

username2

string

Имя пользователя username2 для входа на сервер загрузки.

username3

string

Имя пользователя username3 для входа на сервер загрузки.

when

string

Периодически создавать новые файлы журналов.

none — не создавать новые файлы журналов периодически.

daily — создавать новые файлы журналов ежедневно.

weekly — создавать новые файлы журналов в определённые дни недели.

Варианты:

• "none"
• "daily"
• "weekly"

sync_search_timeout

aliases: sync-search-timeout

integer

Максимальное количество секунд для выполнения сеанса поиска по журналам в синхронном режиме.

syslog_over_tls_port

aliases: syslog-over-tls-port

string

Порт Syslog поверх TLS.

Варианты:

• "514"
• "6514"

unencrypted_logging

aliases: unencrypted-logging

string

Включить или отключить получение Syslog через UDP

disable — отключить получение Syslog через UDP

enable — включить получение Syslog через UDP

Варианты:

• "disable"
• "enable"

unencrypted_logging_tcp

aliases: unencrypted-logging-tcp

string

Незашифрованное ведение журналов через TCP.

Варианты:

• "disable"
• "enable"

unencrypted_logging_udp

aliases: unencrypted-logging-udp

string

Незашифрованное ведение журналов через UDP.

Варианты:

• "disable"
• "enable"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области.

По умолчанию: 300

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Состояние запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Состояние запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

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

Возвращается: при сложных условиях