fortinet.fortimanager.fmgr_system_locallog_fortianalyzer2_setting – Настройки для локального протокола регистрации событий для FortiAnalyzer.

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_locallog_fortianalyzer2_setting.

В версии 2.10: из fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых будут игнорироваться условия для завершения с ошибкой
rc_succeeded список / элементы=строка			список кодов rc, при которых будут игнорироваться условия для успешного завершения
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
system_locallog_fortianalyzer2_setting словарь			параметры верхнего уровня
	reliable строка	Варианты: выключено ← включено	Включение/выключение надежной регистрации событий в реальном времени. выключено - Отключить надежную регистрацию событий в реальном времени. включено - Включить надежную регистрацию событий в реальном времени.
	secure-connection строка	Варианты: выключено ← включено	Включение/выключение подключения, защищенного TLS/SSL. выключено - Отключить SSL-соединение. включено - Включить SSL-соединение.
	server-ip строка	Значение по умолчанию: "0.0.0.0"	IP-адрес удаленного сервера FortiAnalyzer.
	severity строка	Варианты: критический опасный критический ошибка предупреждение уведомление ← информация отладка	Наименьший уровень серьезности для регистрации. критический - Критический уровень. опасный - Опасный уровень. критический - Критический уровень. ошибка - Уровень ошибки. предупреждение - Уровень предупреждения. уведомление - Уровень уведомления. информация - Уровень информации. отладка - Уровень отладки.
	status строка	Варианты: выключено ← реальное время загрузка	Статус регистрации в FortiAnalyzer. выключено - Регистрация в FortiAnalyzer отключена. реальное время - Регистрация в FortiAnalyzer в реальном времени. загрузка - Регистрация в 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_fortianalyzer2_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_fortianalyzer2_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_fortianalyzer2_setting_module.html