fortinet.fortimanager.fmgr_system_log_settings модуль — Настройки логов.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Добавлен в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

END_OF_DOCUMENT_MARKER

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; в этом случае модуль продолжает выполняться без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиент Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия сбоя.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия успеха.
system_log_settings словарь	Установленные параметры верхнего уровня.
browse_max_logfiles целое число	Устарело, пожалуйста, переименуйте на browse_max_logfiles. Максимальное количество файлов журналов для каждой попытки просмотра журналов для каждого домена Adom.
device_auto_detect строка	Устарело, пожалуйста, переименуйте на device_auto_detect. Включить/выключить поиск идентификатора устройства в полученном syslog без шифрования. disable - Выключить поиск идентификатора устройства в полученном syslog без шифрования. enable - Включить поиск идентификатора устройства в полученном syslog без шифрования. Варианты: `"disable"` `"enable"`
dns_resolve_dstip строка	Устарело, пожалуйста, переименуйте на dns_resolve_dstip. Включить/выключить разрешение IP-адреса назначения по DNS. disable - Выключить разрешение IP-адреса назначения по DNS. enable - Включить разрешение IP-адреса назначения по DNS. Варианты: `"disable"` `"enable"`
download_max_logs целое число	Устарело, пожалуйста, переименуйте на download_max_logs. Максимальное количество журналов для каждой попытки скачивания журналов.
FAC_custom_field1 строка	Устарело, пожалуйста, переименуйте на FAC_custom_field1. Имя пользовательского поля журнала для индексации.
FAZ_custom_field1 строка	Устарело, пожалуйста, переименуйте на FAZ_custom_field1. Имя пользовательского поля журнала для индексации.
FCH_custom_field1 строка	Устарело, пожалуйста, переименуйте на FCH_custom_field1. Имя пользовательского поля журнала для индексации.
FCT_custom_field1 строка	Устарело, пожалуйста, переименуйте на FCT_custom_field1. Имя пользовательского поля журнала для индексации.
FDD_custom_field1 строка	Устарело, пожалуйста, переименуйте на FDD_custom_field1. Имя пользовательского поля журнала для индексации.
FGT_custom_field1 строка	Устарело, пожалуйста, переименуйте на FGT_custom_field1. Имя пользовательского поля журнала для индексации.
FMG_custom_field1 строка	Устарело, пожалуйста, переименуйте на FMG_custom_field1. Имя пользовательского поля журнала для индексации.
FML_custom_field1 строка	Устарело, пожалуйста, переименуйте на FML_custom_field1. Имя пользовательского поля журнала для индексации.
FPX_custom_field1 строка	Устарело, пожалуйста, переименуйте на FPX_custom_field1. Имя пользовательского поля журнала для индексации.

END_OF_DOCUMENT_MARKER

FSA-custom-field1 string	Устарело, переименуйте в FSA_custom_field1. Имя настраиваемого поля журнала для индексации.
FWB-custom-field1 string	Устарело, переименуйте в FWB_custom_field1. Имя настраиваемого поля журнала для индексации.
ha-auto-migrate string	Устарело, переименуйте в ha_auto_migrate. Включить/Выключить автоматическое объединение журналов участников HA в кластер HA. disable - Отключить автоматическое объединение журналов участников HA в кластер HA. enable - Включить автоматическое объединение журналов участников HA в кластер HA. Choices: `"disable"` `"enable"`
import-max-logfiles integer	Устарело, переименуйте в import_max_logfiles. Максимальное количество файлов журналов для каждой попытки импорта журнала.
keep-dev-logs string	Устарело, переименуйте в keep_dev_logs. Включить/Выключить сохранение журналов устройств после удаления устройства. disable - Отключить сохранение журналов устройств после удаления устройства. enable - Включить сохранение журналов устройств после удаления устройства. Choices: `"disable"` `"enable"`
log-file-archive-name string	Устарело, переименуйте в log_file_archive_name. Формат имени файла журнала для архивирования, например, резервное копирование, загрузка или скачивание. basic - Базовый формат имени файла архива журнала, например. extended - Расширенный формат имени файла архива журнала, например. Choices: `"basic"` `"extended"`
log-interval-dev-no-logging integer	Устарело, переименуйте в log_interval_dev_no_logging. Интервал в минутах отсутствия журнала, полученного от устройства при…
log-upload-interval-dev-no-logging integer	Устарело, переименуйте в log_upload_interval_dev_no_logging. Интервал в минутах отсутствия загруженного журнала от устройства при…
rolling-analyzer dictionary	Устарело, переименуйте в rolling_analyzer. Ролирующий анализатор.
days list / elements=string	Расписание циклического обновления файлов журналов sun - Воскресенье. mon - Понедельник. tue - Вторник. wed - Среда. thu - Четверг. fri - Пятница. sat - Суббота. Choices: `"sun"` `"mon"` `"tue"` `"wed"` `"thu"` `"fri"` `"sat"`
del-files string	Устарело, переименуйте в del_files. Включить/Выключить удаление файлов журналов после загрузки. disable - Отключить удаление файлов журналов. enable - Включить удаление файлов журналов. Choices: `"disable"` `"enable"`
directory string	Каталог сервера загрузки, для Unix-сервера используйте абсолютный путь
file-size integer	Устарело, переименуйте в file_size. Циклическое обновление файлов журналов при достижении этого размера
gzip-format string	Устарело, переименуйте в gzip_format. Включить/Выключить сжатие загруженных файлов журналов. disable - Отключить сжатие. enable - Включить сжатие. Choices: `"disable"` `"enable"`
hour integer	Расписание циклического обновления файлов журналов
ip string	IP-адрес сервера загрузки.
ip2 string	IP2-адрес сервера загрузки.
ip3 string	IP3-адрес сервера загрузки.
log-format string	Устарело, переименуйте в log_format. Формат загруженных файлов журналов. native - Собственный формат text - Текстовый формат csv - CSV Choices: `"native"` `"text"` `"csv"`

min integer	Расписание вращения файлов журналов
password any	(list) Пароль для входа на сервер загрузки.
password2 any	(list) Пароль для входа на сервер загрузки2.
password3 any	(list) Пароль для входа на сервер загрузки3.
port integer	Номер порта сервера загрузки IP1.
port2 integer	Номер порта сервера загрузки IP2.
port3 integer	Номер порта сервера загрузки IP3.
rolling-upgrade-status integer	Устарело, переименуйте в rolling_upgrade_status. Статус обновления с заменой.
server string	FQDN/IP сервера загрузки.
server-type string	Устарело, переименуйте в server_type. Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. Варианты: `"ftp"` `"sftp"` `"scp"`
server2 string	FQDN/IP сервера загрузки2.
server3 string	FQDN/IP сервера загрузки3.
upload string	Включить/выключить загрузку файлов журналов. disable - Отключить загрузку файлов журналов. enable - Включить загрузку файлов журналов. Варианты: `"disable"` `"enable"`
upload-hour integer	Устарело, переименуйте в upload_hour. Расписание загрузки файлов журналов
upload-mode string	Устарело, переименуйте в upload_mode. Режим загрузки с несколькими серверами. backup - Серверы пытаются и используются один за другим после сбоя соединения. mirror - Все настроенные серверы пытаются и используются. Варианты: `"backup"` `"mirror"`
upload-trigger string	Устарело, переименуйте в upload_trigger. Событие, запускающее загрузку файлов журналов. on-roll - Загрузка файлов журналов после их вращения. on-schedule - Загрузка файлов журналов ежедневно. Варианты: `"on-roll"` `"on-schedule"`
username string	Имя пользователя для входа на сервер загрузки.
username2 string	Имя пользователя для входа на сервер загрузки2.
username3 string	Имя пользователя для входа на сервер загрузки3.
when string	Регулярное вращение файлов журналов. none - Не вращать файлы журналов периодически. daily - Вращать файлы журналов ежедневно. weekly - Вращать файлы журналов в определенные дни недели. Варианты: `"none"` `"daily"` `"weekly"`
rolling-local dictionary	Устарело, переименуйте в rolling_local. Вращение локально.

days list / elements=string	Расписание вращения файлов журнала sun - Воскресенье. mon - Понедельник. tue - Вторник. wed - Среда. thu - Четверг. fri - Пятница. sat - Суббота. Варианты: `"sun"` `"mon"` `"tue"` `"wed"` `"thu"` `"fri"` `"sat"`
del-files string	Устарело, переименуйте в del_files. Включить/выключить удаление файлов журнала после загрузки. disable - Отключить удаление файлов журнала. enable - Включить удаление файлов журнала. Варианты: `"disable"` `"enable"`
directory string	Каталог сервера загрузки, для Unix-сервера используйте абсолютный путь
file-size integer	Устарело, переименуйте в file_size. Вращать файлы журнала, когда они достигают этого размера
gzip-format string	Устарело, переименуйте в gzip_format. Включить/выключить сжатие загруженных файлов журнала. disable - Отключить сжатие. enable - Включить сжатие. Варианты: `"disable"` `"enable"`
hour integer	Расписание вращения файлов журнала
ip string	IP-адрес сервера загрузки.
ip2 string	IP2-адрес сервера загрузки.
ip3 string	IP3-адрес сервера загрузки.
log-format string	Устарело, переименуйте в log_format. Формат загружаемых файлов журнала. native - Нативный формат text - Текстовый формат csv - CSV Варианты: `"native"` `"text"` `"csv"`
min integer	Расписание вращения файлов журнала
password any	(list) Пароль для входа на сервер загрузки.
password2 any	(list) Пароль2 для входа на сервер загрузки.
password3 any	(list) Пароль3 для входа на сервер загрузки.
port integer	Номер порта IP1 сервера загрузки.
port2 integer	Номер порта IP2 сервера загрузки.
port3 integer	Номер порта IP3 сервера загрузки.
rolling-upgrade-status integer	Устарело, переименуйте в rolling_upgrade_status. Статус обновления с вращением
server string	FQDN/IP сервера загрузки.
server-type string	Устарело, переименуйте в server_type. Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. Варианты: `"ftp"` `"sftp"` `"scp"`
server2 string	FQDN/IP сервера загрузки2.
server3 string	FQDN/IP сервера загрузки3.

upload string	Включить/отключить загрузку файлов журналов. disable - Отключить загрузку файлов журналов. enable - Включить загрузку файлов журналов. Choices: `"disable"` `"enable"`
upload-hour integer	Устарело, переименуйте в upload_hour. Расписание загрузки файлов журналов
upload-mode string	Устарело, переименуйте в upload_mode. Режим загрузки с несколькими серверами. backup - Серверы проверяются и используются один за другим после сбоя подключения. mirror - Все настроенные серверы проверяются и используются. Choices: `"backup"` `"mirror"`
upload-trigger string	Устарело, переименуйте в upload_trigger. Событие, запускающее загрузку файлов журналов. on-roll - Загрузить файлы журналов после их переписывания. on-schedule - Загружать файлы журналов ежедневно. Choices: `"on-roll"` `"on-schedule"`
username string	Имя пользователя для входа на сервер загрузки.
username2 string	Имя пользователя для входа на сервер загрузки2.
username3 string	Имя пользователя для входа на сервер загрузки3.
when string	Периодически переписывать файлы журналов. none - Не переписывать файлы журналов периодически. daily - Переписывать файлы журналов ежедневно. weekly - Переписывать файлы журналов в определенные дни недели. Choices: `"none"` `"daily"` `"weekly"`
rolling-regular dictionary	Устарело, переименуйте в rolling_regular. Регулярное переписывание.
days list / elements=string	Расписание переписывания файлов журналов sun - Воскресенье. mon - Понедельник. tue - Вторник. wed - Среда. thu - Четверг. fri - Пятница. sat - Суббота. Choices: `"sun"` `"mon"` `"tue"` `"wed"` `"thu"` `"fri"` `"sat"`
del-files string	Устарело, переименуйте в del_files. Включить/отключить удаление файлов журналов после загрузки. disable - Отключить удаление файлов журналов. enable - Включить удаление файлов журналов. Choices: `"disable"` `"enable"`
directory string	Каталог сервера загрузки, для Unix-сервера используйте абсолютный путь
file-size integer	Устарело, переименуйте в file_size. Переписывать файлы журналов, когда они достигают этого размера
gzip-format string	Устарело, переименуйте в gzip_format. Включить/отключить сжатие загружаемых файлов журналов. disable - Отключить сжатие. enable - Включить сжатие. Choices: `"disable"` `"enable"`
hour integer	Расписание переписывания файлов журналов
ip string	IP-адрес сервера загрузки.
ip2 string	IP-адрес сервера загрузки2.
ip3 string	IP-адрес сервера загрузки3.
log-format string	Устарело, переименуйте в log_format. Формат загружаемых файлов журналов. native - Нативный формат text - Текстовый формат csv - CSV Choices: `"native"` `"text"` `"csv"`

min integer	Расписание вращения файлов журналов
password any	(list) Пароль для входа на сервер загрузки.
password2 any	(list) Пароль для входа на сервер загрузки2.
password3 any	(list) Пароль для входа на сервер загрузки3.
port integer	Номер порта сервера загрузки IP1.
port2 integer	Номер порта сервера загрузки IP2.
port3 integer	Номер порта сервера загрузки IP3.
rolling-upgrade-status integer	Устарело, пожалуйста, переименуйте в rolling_upgrade_status. Статус обновления с вращением
server string	FQDN/IP сервера загрузки.
server-type string	Устарело, пожалуйста, переименуйте в server_type. Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. Варианты: `"ftp"` `"sftp"` `"scp"`
server2 string	FQDN/IP сервера загрузки2.
server3 string	FQDN/IP сервера загрузки3.
upload string	Включить/отключить загрузку файлов журналов. disable - Отключить загрузку файлов журналов. enable - Включить загрузку файлов журналов. Варианты: `"disable"` `"enable"`
upload-hour integer	Устарело, пожалуйста, переименуйте в upload_hour. Расписание загрузки файлов журналов
upload-mode string	Устарело, пожалуйста, переименуйте в upload_mode. Режим загрузки с несколькими серверами. backup - Серверы пытаются использоваться один за другим после сбоя соединения. mirror - Все настроенные серверы пытаются использоваться. Варианты: `"backup"` `"mirror"`
upload-trigger string	Устарело, пожалуйста, переименуйте в upload_trigger. Событие, запускающее загрузку файлов журналов. on-roll - Загрузка файлов журналов после их вращения. on-schedule - Ежедневная загрузка файлов журналов. Варианты: `"on-roll"` `"on-schedule"`
username string	Имя пользователя для входа на сервер загрузки.
username2 string	Имя пользователя для входа на сервер загрузки2.
username3 string	Имя пользователя для входа на сервер загрузки3.
when string	Периодическое вращение файлов журналов. none - Не вращать файлы журналов периодически. daily - Ежедневное вращение файлов журналов. weekly - Вращение файлов журналов в определенные дни недели. Варианты: `"none"` `"daily"` `"weekly"`
sync-search-timeout integer	Устарело, пожалуйста, переименуйте в sync_search_timeout. Максимальное количество секунд для выполнения сеанса поиска журналов в синхро…

unencrypted-logging string	Устарело, пожалуйста, переименуйте его в unencrypted_logging. Включить/выключить получение syslog через UDP disable - Отключить получение syslog через UDP enable - Включить получение syslog через UDP Варианты: `"disable"` `"enable"`
workspace_locking_adom string	Область (ADOM) для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневое.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name” на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочего пространства реализована в данном модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия завершения успехом или неудачей с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Log settings.
      fortinet.fortimanager.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: <string>
          FAZ_custom_field1: <string>
          FCH_custom_field1: <string>
          FCT_custom_field1: <string>
          FDD_custom_field1: <string>
          FGT_custom_field1: <string>
          FMG_custom_field1: <string>
          FML_custom_field1: <string>
          FPX_custom_field1: <string>
          FSA_custom_field1: <string>
          FWB_custom_field1: <string>
          browse_max_logfiles: <integer>
          dns_resolve_dstip: <value in [disable, enable]>
          download_max_logs: <integer>
          ha_auto_migrate: <value in [disable, enable]>
          import_max_logfiles: <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: <string>
            file_size: <integer>
            gzip_format: <value in [disable, enable]>
            hour: <integer>
            ip: <string>
            ip2: <string>
            ip3: <string>
            log_format: <value in [native, text, csv]>
            min: <integer>
            password: <list or string>
            password2: <list or string>
            password3: <list or string>
            server_type: <value in [ftp, sftp, scp]>
            upload: <value in [disable, enable]>
            upload_hour: <integer>
            upload_mode: <value in [backup, mirror]>
            upload_trigger: <value in [on-roll, on-schedule]>
            username: <string>
            username2: <string>
            username3: <string>
            when: <value in [none, daily, weekly]>
            port: <integer>
            port2: <integer>
            port3: <integer>
            rolling_upgrade_status: <integer>
            server: <string>
            server2: <string>
            server3: <string>
          rolling_local:
            days:
              - sun
              - mon
              - tue
              - wed
              - thu
              - fri
              - sat
            del_files: <value in [disable, enable]>
            directory: <string>
            file_size: <integer>
            gzip_format: <value in [disable, enable]>
            hour: <integer>
            ip: <string>
            ip2: <string>
            ip3: <string>
            log_format: <value in [native, text, csv]>
            min: <integer>
            password: <list or string>
            password2: <list or string>
            password3: <list or string>
            server_type: <value in [ftp, sftp, scp]>
            upload: <value in [disable, enable]>
            upload_hour: <integer>
            upload_mode: <value in [backup, mirror]>
            upload_trigger: <value in [on-roll, on-schedule]>
            username: <string>
            username2: <string>
            username3: <string>
            when: <value in [none, daily, weekly]>
            port: <integer>
            port2: <integer>
            port3: <integer>
            rolling_upgrade_status: <integer>
            server: <string>
            server2: <string>
            server3: <string>
          rolling_regular:
            days:
              - sun
              - mon
              - tue
              - wed
              - thu
              - fri
              - sat
            del_files: <value in [disable, enable]>
            directory: <string>
            file_size: <integer>
            gzip_format: <value in [disable, enable]>
            hour: <integer>
            ip: <string>
            ip2: <string>
            ip3: <string>
            log_format: <value in [native, text, csv]>
            min: <integer>
            password: <list or string>
            password2: <list or string>
            password3: <list or string>
            server_type: <value in [ftp, sftp, scp]>
            upload: <value in [disable, enable]>
            upload_hour: <integer>
            upload_mode: <value in [backup, mirror]>
            upload_trigger: <value in [on-roll, on-schedule]>
            username: <string>
            username2: <string>
            username3: <string>
            when: <value in [none, daily, weekly]>
            port: <integer>
            port2: <integer>
            port3: <integer>
            rolling_upgrade_status: <integer>
            server: <string>
            server2: <string>
            server3: <string>
          sync_search_timeout: <integer>
          keep_dev_logs: <value in [disable, enable]>
          device_auto_detect: <value in [disable, enable]>
          unencrypted_logging: <value in [disable, enable]>
          log_interval_dev_no_logging: <integer>
          log_upload_interval_dev_no_logging: <integer>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_log_settings_module.html