Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook укажите: cisco.dnac.event_email_config_create.

Впервые появился в cisco.dnac 6.0.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

словарь

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

hostName

строка

Имя хоста.

password

строка

Пароль.

port

строка

Порт.

smtpType

строка

Тип SMTP.

userName

строка

Имя пользователя.

secondarySMTPConfig

словарь

Дополнительный параметр SMTPConfig модуля создания конфигурации электронной почты событий.

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,
  • Используемые пути: post /dna/intent/api/v1/event/email-config,
  • Не поддерживает check_mode
  • Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco DNA Center по Event Management CreateEmailDestination

Полное описание API CreateEmailDestination.

Примеры

- name: Create
  cisco.dnac.event_email_config_create:
    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_create_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API