fortinet.fortimanager.fmgr_system_alertevent_alertdestination модуль — Назначение получателя оповещений.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_system_alertevent_alertdestination.

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
alert-event строка	Устаревшее, используйте «alert_event»
alert_event строка	Параметр (alert-event) в запрошенном URL.
bypass_validation булево	Устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентифицировать Ansible-клиент с помощью токена доступа к forticloud API.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, при которых будут переопределены условия для отказа.
rc_succeeded список / элементы=целое	Список rc-кодов, при которых будут переопределены условия для успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
system_alertevent_alertdestination словарь	Настройка параметров верхнего уровня.
from строка	Адрес электронной почты отправителя для использования в электронных письмах об оповещениях.
smtp_name строка	Устаревшее, переименуйте на smtp_name. Имя SMTP-сервера.
snmp_name строка	Устаревшее, переименуйте на snmp_name. Имя SNMP-ловушки.
syslog_name строка	Устаревшее, переименуйте на syslog_name. Имя сервера syslog.
to строка	Адрес электронной почты получателя для использования в электронных письмах об оповещениях.
type строка	Тип назначения. mail - Отправка оповещения по электронной почте. snmp - Отправка SNMP-ловушки. syslog - Отправка сообщения syslog. Варианты: `"mail"` `"snmp"` `"syslog"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название в стиле нижнего подчеркивания (snake_case). Пожалуйста, замените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддерживается работа в режиме блокировки рабочего пространства в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Также можно переопределить условия для отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Alert destination.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        system_alertevent_alertdestination:
          from: <string>
          smtp_name: <string>
          snmp_name: <string>
          syslog_name: <string>
          to: <string>
          type: <value in [mail, snmp, syslog]>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_alertevent_alertdestination_module.html