fortinet.fortimanager.fmgr_system_alertconsole – Консоль оповещений.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых будут выполняться условия для возврата ошибки
rc_succeeded список / элементы=строка			список кодов rc, при которых будут выполняться условия для успешного завершения
state строка / обязательно		Варианты: present absent	директива для создания, обновления или удаления объекта
system_alertconsole словарь			настройка верхнего уровня
	period строка	Варианты: 1 2 3 4 5 6 7 ←	Консоль оповещений хранит оповещения за указанный период. 1 - 1 день. 2 - 2 дня. 3 - 3 дня. 4 - 4 дня. 5 - 5 дней. 6 - 6 дней. 7 - 7 дней.
	severity-level список / элементы=строка	Варианты: debug information notify warning error critical alert emergency	нет описания
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: Alert console.
     fmgr_system_alertconsole:
        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_alertconsole:
           period: <value in [1, 2, 3, ...]>
           severity-level:
             - debug
             - 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_alertconsole_module.html