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

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.event_subscription_email_info.

Добавлена в cisco.dnac 3.1.0

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

Обзор

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
category string	Параметр запроса категории. Список подписок на электронную почту, связанных с соответствующей категорией.
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"`
domain string	Параметр запроса домена. Список подписок на электронную почту, связанных с соответствующим доменом.
eventIds string	Параметр запроса EventIds. Список подписок на электронную почту, связанных с соответствующими eventIds (идентификаторы событий, разделенные запятыми).
headers dictionary	Дополнительные заголовки.
limit float	Параметр запроса limit. Количество подписок, которые необходимо ограничить в результирующем наборе, значение по умолчанию 10.
name string	Параметр запроса name. Список подписок на электронную почту, связанных с соответствующим именем.
offset float	Параметр запроса offset. Количество подписок, которые необходимо сместить в результирующем наборе, значение по умолчанию 0.
order string	Параметр запроса order.
sortBy string	Параметр запроса sortBy. Имя поля для сортировки.
subDomain string	Параметр запроса subDomain. Список подписок на электронную почту, связанных с соответствующим поддоменом.
type string	Параметр запроса type. Список подписок на электронную почту, связанных с соответствующим типом.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки текстов запросов на соответствие схеме JSON. Варианты: `false` `true` ← (default)

Примечания

Примечание

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

См. также

Cisco DNA Center documentation for Event Management GetEmailEventSubscriptions: Полная справка по API GetEmailEventSubscriptions.

Примеры

- name: Get all Event Subscription Email
  cisco.dnac.event_subscription_email_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    eventIds: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
    domain: string
    subDomain: string
    category: string
    type: string
    name: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список со значением, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"version\": \"string\",\n \"subscriptionId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"subscriptionEndpoints\": [\n {\n \"instanceId\": \"string\",\n \"subscriptionDetails\": {\n \"connectorType\": \"string\",\n \"instanceId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"fromEmailAddress\": \"string\",\n \"toEmailAddresses\": [\n \"string\"\n ],\n \"subject\": \"string\"\n },\n \"connectorType\": \"string\"\n }\n ],\n \"filter\": {\n \"eventIds\": [\n \"string\"\n ],\n \"others\": [\n \"string\"\n ],\n \"domainsSubdomains\": [\n {\n \"domain\": \"string\",\n \"subDomains\": [\n \"string\"\n ]\n }\n ],\n \"types\": [\n \"string\"\n ],\n \"categories\": [\n \"string\"\n ],\n \"severities\": [\n \"string\"\n ],\n \"sources\": [\n \"string\"\n ],\n \"siteIds\": [\n \"string\"\n ]\n },\n \"isPrivate\": true,\n \"tenantId\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

список / элементы=словарь

Словарь или список со значением, возвращённым Cisco DNAC Python SDK

Возвращается: всегда

Пример: "[\n {\n \"version\": \"string\",\n \"subscriptionId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"subscriptionEndpoints\": [\n {\n \"instanceId\": \"string\",\n \"subscriptionDetails\": {\n \"connectorType\": \"string\",\n \"instanceId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"fromEmailAddress\": \"string\",\n \"toEmailAddresses\": [\n \"string\"\n ],\n \"subject\": \"string\"\n },\n \"connectorType\": \"string\"\n }\n ],\n \"filter\": {\n \"eventIds\": [\n \"string\"\n ],\n \"others\": [\n \"string\"\n ],\n \"domainsSubdomains\": [\n {\n \"domain\": \"string\",\n \"subDomains\": [\n \"string\"\n ]\n }\n ],\n \"types\": [\n \"string\"\n ],\n \"categories\": [\n \"string\"\n ],\n \"severities\": [\n \"string\"\n ],\n \"sources\": [\n \"string\"\n ],\n \"siteIds\": [\n \"string\"\n ]\n },\n \"isPrivate\": true,\n \"tenantId\": \"string\"\n }\n]\n"

Авторы

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_info_module.html