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

Примечание

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

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

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

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

Новое в 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"`
payload список / элементы=словарь	Данные платного электронного письма о подписке на события.
description строка	Описание.
filter словарь	Фильтр платного электронного письма о подписке на события.
categories список / элементы=строка	Категории.
domainsSubdomains список / элементы=словарь	Домены и поддомены платного электронного письма о подписке на события.
domain строка	Домен.
subDomains список / элементы=строка	Поддомены.
eventIds список / элементы=строка	Идентификаторы событий.
severities список / элементы=целое число	Уровни важности.
siteIds список / элементы=строка	Идентификаторы сайтов.
sources список / элементы=строка	Источники.
types список / элементы=строка	Типы.
name строка	Имя.
subscriptionEndpoints список / элементы=словарь	Конечные точки подписки на электронные письма о событиях.
instanceId строка	(Из Сведения об электронной подписке на события —> выберите InstanceId, если доступно).
subscriptionDetails словарь	Подробности подписки на электронные письма о событиях.
connectorType строка	Тип подключения (должен быть EMAIL).

description string	Описание.
fromEmailAddress string	Адрес электронной почты отправителя.
name string	Имя.
subject string	Тема письма.
toEmailAddresses list / elements=string	Адрес электронной почты получателя (через запятую).
subscriptionId string	Идентификатор подписки (уникальный UUID).
version string	Версия.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, который включает проверку тел запросов по JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center для управления событиями CreateEmailEventSubscription: Полное описание API CreateEmailEventSubscription.
Документация Cisco DNA Center для управления событиями UpdateEmailEventSubscription: Полное описание API UpdateEmailEventSubscription.

Примеры

- name: Create
  cisco.dnac.event_subscription_email:
    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
    payload:
    - description: string
      filter:
        categories:
        - string
        domainsSubdomains:
        - domain: string
          subDomains:
          - string
        eventIds:
        - string
        severities:
        - 0
        siteIds:
        - string
        sources:
        - string
        types:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
          description: string
          fromEmailAddress: string
          name: string
          subject: string
          toEmailAddresses:
          - string
      subscriptionId: string
      version: string

- name: Update all
  cisco.dnac.event_subscription_email:
    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
    payload:
    - description: string
      filter:
        categories:
        - string
        domainsSubdomains:
        - domain: string
          subDomains:
          - string
        eventIds:
        - string
        severities:
        - 0
        siteIds:
        - string
        sources:
        - string
        types:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
          description: string
          fromEmailAddress: string
          name: string
          subject: string
          toEmailAddresses:
          - string
      subscriptionId: string
      version: string

Возвращаемые значения

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

Ключ	Описание
dnac_response dictionary	Словарь или список с ответом, возвращенным 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_subscription_email_module.html