fortinet.fortimanager.fmgr_system_locallog_fortianalyzer_setting – Настройки локального лога для FortiAnalyzer.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только в случае расхождений схемы модуля со структурой API FortiManager, модуль продолжает выполнятся без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых будут игнорироваться условия ошибки
rc_succeeded список / элементы=строка			список кодов rc, при которых будут игнорироваться условия успеха
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
system_locallog_fortianalyzer_setting словарь			настройки верхнего уровня
	reliable строка	Варианты: отключить ← включить	Включить/отключить надежное протоколирование в реальном времени. отключить - Отключить надежное протоколирование в реальном времени. включить - Включить надежное протоколирование в реальном времени.
	secure-connection строка	Варианты: отключить ← включить	Включить/отключить соединение, защищенное TLS/SSL. отключить - Отключить SSL-соединение. включить - Включить SSL-соединение.
	server-ip строка	По умолчанию: "0.0.0.0"	IP-адрес удаленного сервера FortiAnalyzer.
	severity строка	Варианты: emergency alert critical error warning notification ← information debug	Минимальный уровень серьезности для протоколирования. emergency - Уровень чрезвычайной ситуации. alert - Уровень тревоги. critical - Критический уровень. error - Уровень ошибки. warning - Уровень предупреждения. notification - Уровень уведомления. information - Уровень информации. debug - Уровень отладки.
	status строка	Варианты: отключить ← realtime upload	Статус протоколирования в FortiAnalyzer. отключить - Протоколирование в FortiAnalyzer отключено. realtime - Протоколирование в FortiAnalyzer в реальном времени. upload - Протоколирование в FortiAnalyzer в запланированное время.
	upload-time строка		нет описания
workspace_locking_adom строка			область, которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневое
workspace_locking_timeout целое число		По умолчанию: 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 locallog to fortianalyzer.
     fmgr_system_locallog_fortianalyzer_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_fortianalyzer_setting:
           reliable: <value in [disable, enable]>
           secure-connection: <value in [disable, enable]>
           server-ip: <value of string>
           severity: <value in [emergency, alert, critical, ...]>
           status: <value in [disable, realtime, upload]>
           upload-time: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа 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_fortianalyzer_setting_module.html