Модуль cisco.dnac.event_email_config_update – Модуль ресурсов для обновления настроек электронной почты событий

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

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

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: cisco.dnac.event_email_config_update.

Введено в cisco.dnac 6.0.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Управление операцией обновления ресурса обновления конфигурации электронной почты событий.
Обновление получателя электронной почты.

Примечание

Для этого модуля существует соответствующий плагин действия.

Требования

Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. Значение по умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. Значение по умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Информирует SDK о том, какая версия Cisco DNA Center используется. Значение по умолчанию: `"2.3.7.6"`
emailConfigId string	Требуется только для обновления конфигурации электронной почты.
fromEmail string	Адрес отправителя.
primarySMTPConfig dictionary	primarySMTPConfig для обновления конфигурации электронной почты событий.
hostName string	Имя хоста.
password string	Пароль.
port string	Порт.
smtpType string	SmtpType.
userName string	Имя пользователя.
secondarySMTPConfig dictionary	secondarySMTPConfig для обновления конфигурации электронной почты событий.
hostName string	Имя хоста.
password string	Пароль.
port string	Порт.
smtpType string	SmtpType.
userName string	Имя пользователя.
subject string	Тема.
toEmail string	Адрес получателя.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тела запроса на соответствие JSON-схеме. Варианты: `false` `true` ← (default)

Примечания

Примечание

Используемые методы SDK: event_management.EventManagement.update_email_destination,
Используемые пути: put /dna/intent/api/v1/event/email-config,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по обновлению пункта назначения электронной почты в системе управления событиями (UpdateEmailDestination): Полное описание API UpdateEmailDestination.

Примеры

- name: Update all
  cisco.dnac.event_email_config_update:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    emailConfigId: string
    fromEmail: string
    primarySMTPConfig:
      hostName: string
      password: string
      port: string
      smtpType: string
      userName: string
    secondarySMTPConfig:
      hostName: string
      password: string
      port: string
      smtpType: string
      userName: string
    subject: string
    toEmail: string

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"statusUri": "string"}`

Авторы

Rafael Campos (@racampos)

Ссылки на сборку

© 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/cisco/dnac/event_email_config_update_module.html