fortinet.fortimanager.fmgr_system_alertevent_alertdestination – Цель оповещения.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_alertevent_alertdestination.
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для данных источников перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| alert-event строка / обязательный | параметр (alert-event) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список rc-кодов, при которых условия будут считаться нарушенными | ||
| rc_succeeded список / элементы=строка | список rc-кодов, при которых условия будут считаться выполненными | ||
| state строка / обязательный |
| направление для создания, обновления или удаления объекта | |
| system_alertevent_alertdestination словарь | параметры верхнего уровня | ||
| from строка | Адрес электронной почты отправителя для использования в электронных письмах об оповещении. | ||
| smtp-name строка | Имя SMTP-сервера. | ||
| snmp-name строка | Имя SNMP-ловушки. | ||
| syslog-name строка | Имя сервера syslog. | ||
| to строка | Адрес электронной почты получателя для использования в электронных письмах об оповещении. | ||
| type строка |
| Тип назначения. mail - Отправка электронного письма об оповещении. snmp - Отправка SNMP-ловушки. syslog - Отправка сообщения syslog. | |
| workspace_locking_adom строка | домен для блокировки в режиме работы с рабочей областью, значение может быть глобальным или другим, включая корень | ||
| 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 destination.
fmgr_system_alertevent_alertdestination:
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, ...]
alert-event: <your own value>
state: <value in [present, absent]>
system_alertevent_alertdestination:
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]>
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_alertdestination_module.html
