fortinet.fortimanager.fmgr_system_alertevent – События оповещений.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка				список кодов rc, при которых условия для завершения работы с ошибкой будут переопределены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия для успешного выполнения будут переопределены
state строка / обязательный			Варианты: present absent	направление для создания, обновления или удаления объекта
system_alertevent словарь				настройка параметров верхнего уровня
	alert-destination список / элементы=строка			нет описания
		from строка		Адрес электронной почты отправителя для использования в электронных письмах об оповещении.
		smtp-name строка		Имя SMTP-сервера.
		snmp-name строка		Имя SNMP-ловушки.
		syslog-name строка		Имя сервера syslog.
		to строка		Адрес электронной почты получателя для использования в электронных письмах об оповещении.
		type строка	Варианты: mail ← snmp syslog	Тип назначения. mail - Отправка оповещения по электронной почте. snmp - Отправка SNMP-ловушки. syslog - Отправка сообщения syslog.
	enable-generic-text список / элементы=строка		Варианты: включить выключить	нет описания
	enable-severity-filter список / элементы=строка		Варианты: включить выключить	нет описания
	event-time-period строка		Варианты: 0,5 ← 1 3 6 12 24 72 168	Период времени (в часах). 0,5 - 30 минут. 1 - 1 час. 3 - 3 часа. 6 - 6 часов. 12 - 12 часов. 24 - 1 день. 72 - 3 дня. 168 - 1 неделя.
	generic-text строка			Текст, который должен присутствовать в журнале, чтобы сработал оповещение.
	name строка			Имя оповещения.
	num-events строка		Варианты: 1 ← 5 10 50 100	Минимальное количество событий, необходимых в течение заданного периода. 1 - 1 событие. 5 - 5 событий. 10 - 10 событий. 50 - 50 событий. 100 - 100 событий.
	severity-filter строка		Варианты: высокий ← средне-высокий средний средне-низкий низкий	Требуемый уровень серьезности журнала для срабатывания оповещения. высокий - Сигнализация высокого уровня. средне-высокий - Оповещение средне-высокого уровня. средний - Оповещение среднего уровня. средне-низкий - Оповещение средне-низкого уровня. низкий - Оповещение низкого уровня.
	severity-level-comp список / элементы=строка		Варианты: строка >= строка = строка <=	нет описания
	severity-level-logs список / элементы=строка		Варианты: без проверки информация уведомление предупреждение ошибка критично сигнализация экстренно	нет описания
workspace_locking_adom строка				область управления (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: Alert events.
     fmgr_system_alertevent:
        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, ...]
        state: <value in [present, absent]>
        system_alertevent:
           alert-destination:
             -
                 from: <value of string>
                 smtp-name: <value of string>
                 snmp-name: <value of string>
                 syslog-name: <value of string>
                 to: <value of string>
                 type: <value in [mail, snmp, syslog]>
           enable-generic-text:
             - enable
             - disable
           enable-severity-filter:
             - enable
             - disable
           event-time-period: <value in [0.5, 1, 3, ...]>
           generic-text: <value of string>
           name: <value of string>
           num-events: <value in [1, 5, 10, ...]>
           severity-filter: <value in [high, medium-high, medium, ...]>
           severity-level-comp:
             - string of >=
             - string of =
             - string of <=
           severity-level-logs:
             - no-check
             - information
             - notify
             - warning
             - error
             - critical
             - alert
             - emergency

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

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

Ключ	Возвращаемое значение	Описание
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_alertevent_module.html