Модуль cisco.dnac.event_email_config – Модуль ресурсов для конфигурации электронных писем событий

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

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

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.dnac.event_email_config:
    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}}"
    state: present
    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

- name: Create
  cisco.dnac.event_email_config:
    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}}"
    state: present
    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_module.html