Модуль cisco.dnac.events_and_notifications_workflow_manager – Настройка различных типов назначений для доставки уведомлений об событиях из платформы Cisco Catalyst Center.

config

list / elements=dictionary / required

Список, содержащий конфигурацию подписки на события, уведомления на сайте через один или несколько каналов.

email_destination

dictionary

Настройка параметров для отправки электронных писем из Cisco Catalyst Center. Также мы можем создать или настроить пункт назначения электронной почты в Cisco Catalyst Center только один раз, а затем позже мы можем просто изменить его. Этот параметр используется только для настройки первичного и вторичного SMTP-сервера при настройке пункта назначения электронной почты. Он не связан с уведомлением о подписке на события по электронной почте.

primary_smtp_config

dictionary

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

password

string

Пароль для аутентификации основного SMTP-сервера.

port

string

Номер порта, используемый для настройки основного SMTP-сервера. Также существует сопоставление smtype и порта: если snmp_type имеет значение DEFAULT, то порт равен 25, а для smtp_type TLS или SSL можно выбрать 465 или 587 в качестве номера порта.

server_address

string / required

Имя хоста или IP-адрес основного SMTP-сервера. Поддерживаются IPv4 и IPv6.

smtp_type

string / required

Тип соединения, используемый для SMTP-сервера, с вариантами DEFAULT, TLS или SSL. По умолчанию установлено значение DEFAULT. DEFAULT — выбирает стандартное SMTP-соединение без шифрования. Если он выбран, то порт будет только 25. TLS — инициирует незашифрованное SMTP-соединение и обновляется до шифрования TLS, если это возможно. Если он выбран, то порт будет 465 или 587. SSL — начинается с зашифрованного SMTP-соединения с использованием SSL с самого начала. Если он выбран, то порт будет 465 или 587.

username

string

Имя пользователя для аутентификации основного SMTP-сервера.

recipient_email

string / required

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

secondary_smtp_config

dictionary

Включите дополнительную вторичную конфигурацию SMTP при создании или обновлении пункта назначения электронной почты.

password

string

Пароль для аутентификации вторичного SMTP-сервера.

port

string

Номер порта, используемый для настройки вторичного SMTP-сервера. Также существует сопоставление smtype и порта: если snmp_type имеет значение DEFAULT, то порт равен 25, а для smtp_type TLS или SSL можно выбрать 465 или 587 в качестве номера порта.

server_address

string

Имя хоста или IP-адрес вторичного SMTP-сервера. Поддерживаются IPv4 и IPv6.

smtp_type

string

Тип соединения, используемый для SMTP-сервера, с вариантами DEFAULT, TLS или SSL. По умолчанию установлено значение DEFAULT. DEFAULT — выбирает стандартное SMTP-соединение без шифрования. Если он выбран, то порт будет только 25. TLS — инициирует незашифрованное SMTP-соединение и обновляется до шифрования TLS, если это возможно. Если он выбран, то порт будет 465 или 587. SSL — начинается с зашифрованного SMTP-соединения с использованием SSL с самого начала. Если он выбран, то порт будет 465 или 587.

username

string

Имя пользователя для аутентификации вторичного SMTP-сервера.

sender_email

string / required

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

subject

string / required

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

email_event_notification

dictionary

Конфигурация для настройки или изменения подписки на уведомления о событиях по электронной почте в Cisco Catalyst Center. Это включает параметры для самого уведомления по электронной почте, а также сведения о связанном экземпляре электронной почты.

description

string / required

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

domain

string

Основная категория или область, к которой относятся события (например, «Знайте свою сеть», «Подключение» и т. д.).

event_categories

list / elements=string

Список категорий событий, которые должны быть включены в подписку на уведомления (например, WARN, INFO, ERROR, ALERT, TASK_COMPLETE, TASK_FAILURE).

event_severities

list / elements=string

Список уровней серьезности событий, которые должны быть включены в подписку на уведомления (например, [“1”, “2”, “3”]).

event_sources

list / elements=string

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

event_types

list / elements=string

Типы событий, которые активируют уведомления, определяющие природу события (например, [“APP”, “NETWORK”]).

events

list / elements=string / required

Список имен событий, на которые необходимо подписаться для конфигурации уведомлений (например, [“AP Flap”, “AP Reboot Crash”]).

instance

string / required

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

instance_description

string / required

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

name

string / required

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

recipient_emails

list / elements=string / required

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

sender_email

string / required

Исходный адрес электронной почты для отправки уведомлений.

sites

list / elements=string

Список имен сайтов, где события включены в подписку на уведомления (например, [“Global/India”, “Global/USA”]).

subdomains

list / elements=string

Более конкретные категории в пределах основного домена для дальнейшей классификации событий (например, [“Wireless”, “Applications”]).

subject

string / required

Тема уведомления по электронной почте, кратко указывающая на содержание уведомления.

version

string

Метка версии для подписки на событие, помогающая отслеживать обновления или изменения.

itsm_setting

dictionary

Словарь, содержащий подробные сведения о конфигурации для настройки параметров ServiceNow/BMCRemedy для автоматического создания инцидентов/проблем/RFC из Cisco Catalyst Center.

connection_settings

dictionary

Словарь параметров, необходимых для установления соединения с системой ITSM.

password

string / required

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

url

string / required

URL конечной точки API системы ITSM. Это базовый URL, используемый для запросов службы ITSM.

username

string / required

Имя пользователя, используемое для аутентификации в системе ITSM. Это необходимо для доступа к API.

description

string

Краткое описание настроек ITSM, описывающее их назначение или использование в организации.

instance_name

string / required

Имя конфигурации ITSM. Это помогает идентифицировать интеграцию в системе. Также при удалении настройки ITSM Intergration из Cisco Catalyst Center.

snmp_destination

dictionary

Словарь, содержащий сведения для настройки/обновления сервера SNMP Trap для получения журналов аудита и событий от Cisco Catalyst Center.

auth_password

string

Пароль, используемый для аутентификации SNMP.

auth_type

string

Тип протокола аутентификации SNMP, например MD5 или SHA. SHA - обозначает Алгоритм безопасного хеширования (Secure Hash Algorithm), набор криптографических хэш-функций, разработанных Агентством национальной безопасности (АНБ), обеспечивающий повышенную безопасность. MD5 - обозначает Алгоритм дайджеста сообщений 5 (Message Digest Algorithm 5), хорошо зарекомендовавшая себя криптографическая хэш-функция, генерирующая 128-битное хэш-значение, используемое в SNMPv3 для проверки подлинности и целостности сообщений.

community

string

Строка сообщества SNMP, используемая для аутентификации, необходима только при установке snmp_version в V2C.

description

string / required

Описание места назначения SNMP.

mode

string

Режим безопасности для связи SNMP (опции - AUTH_PRIVACY, AUTH_NO_PRIVACY, NO_AUTH_NO_PRIVACY). Обязательно для snmp_version V3 и не должно быть установлено в NONE. AUTH_PRIVACY - Наиболее безопасный режим, обеспечивающий как проверку источника сообщения с помощью аутентификации, так и защиту содержимого сообщения с помощью шифрования. Если выбран этот параметр, необходимо указать параметры auth_type, auth_password, privacy_type, privacy_password в playbook. AUTH_NO_PRIVACY - Этот режим обеспечивает подлинность сообщений SNMP с помощью строки сообщества для проверки, но не шифрует данные, оставляя их уязвимыми для перехвата. Если выбран этот параметр, необходимо указать параметры auth_type, auth_password в playbook. NO_AUTH_NO_PRIVACY - В этом режиме сообщения SNMP не аутентифицируются и не шифруются, что делает его наименее безопасным, поскольку не требует учетных данных или защиты данных. Если выбран этот параметр, не нужно указывать параметры auth_type, auth_password, privacy_type, privacy_password в playbook.

name

string / required

Имя места назначения SNMP.

port

string / required

Номер порта, на котором прослушивает сервер SNMP.

privacy_password

string

Пароль, используемый для шифрования в конфиденциальности SNMP.

privacy_type

string

Алгоритм шифрования, используемый для конфиденциальности SNMP, например AES128.

server_address

string / required

IP-адрес сервера SNMP.

snmp_version

string

Используемая версия протокола SNMP для управления сетью и мониторинга, выбираемая между SNMPv2c и SNMPv3. V2C - использует строки сообщества для аутентификации между менеджером SNMP (например, Cisco Catalyst) и управляемыми сетевыми устройствами (маршрутизаторы, коммутаторы, точки доступа) без шифрования, поскольку строки отправляются в открытом тексте. V3 - предлагает расширенные функции безопасности по сравнению с V2C, включая аутентификацию, целостность и шифрование, используя имена пользователей, пароли и ключи шифрования для безопасной связи.

username

string

Имя пользователя, необходимое для аутентификации SNMP, применимо исключительно при настройке snmp_version на V3.

syslog_destination

dictionary

Словарь, содержащий сведения для настройки/обновления сервера Syslog для сбора журналов аудита и событий от Cisco Catalyst Center.

description

string / required

Краткое пояснение, описывающее назначение места назначения syslog.

name

string / required

Имя места назначения syslog.

port

integer / required

Номер порта, на котором прослушивает сервер syslog. Он должен быть в диапазоне от 1 до 65535. Если порт не указан, будет использоваться порт 514 по умолчанию.

protocol

string / required

Протокол, используемый для отправки сообщений syslog (например, UDP, TCP). Transmission Control Protocol (TCP) - это ориентированный на соединение протокол, используемый для надежной и упорядоченной связи между устройствами в сети. Он обеспечивает проверку ошибок, повторную передачу потерянных пакетов и гарантирует, что данные будут доставлены в правильном порядке. User Datagram Protocol (UDP) - это бессоединительный протокол, используемый для отправки дейтаграмм между устройствами в сети. Он обеспечивает легковесный механизм доставки «без гарантий» без гарантии доставки или упорядочения пакетов. UDP обычно используется для приложений реального времени, таких как потоковое мультимедиа, онлайн-игры и VoIP.

server_address

string / required

Имя хоста или IP-адрес сервера Syslog.

syslog_event_notification

dictionary

Конфигурация для установления или изменения подписки на события Syslog в Cisco Catalyst Center. Это позволяет указать параметры уведомления о событиях Syslog и параметры назначения.

description

string / required

Краткое пояснение, описывающее назначение уведомления о подписке на события syslog.

destination

string / required

Имя места назначения для отправки уведомлений о событиях через syslog.

domain

string

Основная категория или домен, к которому относятся события (например, «Знайте свою сеть», «Подключение» и т. д.).

event_categories

list / elements=string

Список категорий событий, которые должны быть включены в подписку на уведомления (например, WARN, INFO, ERROR, ALERT, TASK_COMPLETE, TASK_FAILURE).

event_severities

list / elements=string

Список степеней серьезности событий, которые должны быть включены в подписку на уведомления (например, [“1”, “2”, “3”]).

event_sources

list / elements=string

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

event_types

list / elements=string

Типы событий, которые запускают уведомления, определяющие природу события (например, [“APP”, “NETWORK”]).

events

list / elements=string / required

Список имен событий, на которые необходимо подписаться для конфигурации уведомлений (например, [“AP Flap”, “AP Reboot Crash”]).

name

string / required

Имя уведомления о подписке на события Syslog.

sites

list / elements=string

Список имен сайтов, где события включены в подписку на уведомления (например, [“Global/India”, “Global/USA”]).

subdomains

list / elements=string

Более конкретные категории в рамках основного домена для дальнейшей классификации событий (например, [“Wireless”, “Applications”]).

version

string

Метка версии для подписки на события, помогающая отслеживать обновления или изменения.

webhook_destination

dictionary

Словарь, содержащий сведения о настройке/обновлении конечной точки REST для получения журналов аудита и событий с платформы Cisco Catalyst Center.

description

string

Краткое объяснение того, для чего используется место назначения webhook.

headers

list / elements=dictionary

Список HTTP-заголовков, которые должны быть включены в запрос webhook. Каждый заголовок представлен в виде словаря. При указании сведений о заголовках мы можем классифицировать их как - «Основные, Токен и Без авторизации». Основная аутентификация - используется для обеспечения того, чтобы принимающий сервер мог проверить личность запрашивающего сервера, проверяя учетные данные в своем хранилище. Этот метод прост, но менее безопасен по сравнению с другими, поскольку учетные данные отправляются в закодированном, но не зашифрованном виде. Токенная аутентификация - включает в себя токены безопасности, которые обычно генерируются сервером. Клиент должен отправить этот токен в HTTP-заголовке для доступа к ресурсам. Он более безопасен, чем основная аутентификация, поскольку позволяет серверу выдавать токены, которые могут иметь ограниченный срок действия, быть отозваны и иметь определенные разрешения без раскрытия учетных данных пользователя. Без авторизации - означает, что для доступа к месту назначения webhook не требуется метод аутентификации. Эта настройка может использоваться в средах, где безопасность обеспечивается другими средствами (например, изоляцией сети) или где передаваемые данные не являются конфиденциальными.

default_value

string

Значение по умолчанию для HTTP-заголовка, которое может использоваться, если не указано конкретное значение.

encrypt

boolean

Указывает, следует ли шифровать значение заголовка. Полезно для конфиденциальных данных.

Choices:

• false
• true

name

string

Имя HTTP-заголовка.

value

string

Значение, присвоенное HTTP-заголовку.

is_proxy_route

boolean

Логическое значение, указывающее, следует ли использовать прокси-сервер для запроса. Оно будет установлено в true для маршрутизации через прокси и в false для прямого соединения. По умолчанию оно установлено в True.

Choices:

• false
• true

method

string

HTTP-метод, используемый веб-хуком при отправке запросов (например, POST, PUT). POST - Обычно используется для создания нового целевого объекта веб-хука. При настройке нового веб-хука в Cisco Catalyst Center вы будете использовать метод POST для отправки необходимых сведений о конфигурации (таких как URL, заголовки, формат полезной нагрузки и т. д.) на сервер. PUT - Используется для обновления существующего целевого объекта веб-хука. Если целевой объект веб-хука уже настроен и вам необходимо изменить какие-либо его параметры, например изменить URL, настроить заголовки или изменить формат полезной нагрузки.

name

string / required

Имя целевого объекта веб-хука. Уникальный идентификатор для целевого объекта веб-хука в системе.

trust_cert

boolean

Логическое значение, указывающее, следует ли проверять сертификат SSL/TLS URL-адреса; установка этого значения в true приведет к обходу проверки сертификата. По умолчанию установлено значение false.

Choices:

• false
• true

url

string / required

Полностью квалифицированный URL, на который веб-хук будет отправлять запросы (например, “https://ciscocatalyst.com”).

webhook_event_notification

dictionary

Словарь, содержащий сведения для создания/обновления уведомления о подписке на событие веб-хука в Cisco Catalyst Center.

description

string / required

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

destination

string / required

Имя места назначения для отправки уведомлений о событиях через веб-хук.

domain

string

Основная категория или область, к которой относятся события (например, «Знайте свою сеть», «Подключение» и т. д.).

event_categories

list / elements=string

Список категорий событий, которые должны быть включены в подписку на уведомления (например, WARN, INFO, ERROR, ALERT, TASK_COMPLETE, TASK_FAILURE).

event_severities

list / elements=string

Список степеней серьезности событий, которые должны быть включены в подписку на уведомления (например, [“1”, “2”, “3”]).

event_sources

list / elements=string

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

event_types

list / elements=string

Типы событий, которые запускают уведомления, определяющие характер события (например, [“APP”, “NETWORK”]).

events

list / elements=string / required

Список имен событий, на которые необходимо подписаться для конфигурации уведомлений (например, [“AP Flap”, “AP Reboot Crash”]).

name

string / required

Имя уведомления о подписке на событие веб-хука.

sites

list / elements=string

Список имен сайтов, события которых включены в подписку на уведомления (например, [“Global/India”, “Global/USA”]).

subdomains

list / elements=string

Более конкретные категории в пределах основного домена для дальнейшей классификации событий (например, [“Wireless”, “Applications”]).

version

string

Метка версии для подписки на события, помогающая отслеживать обновления или изменения.

config_verify

boolean

Установите в True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook.

Варианты:

• false ← (default)
• true

dnac_api_task_timeout

integer

Определяет время ожидания в секундах для вызовов API для получения сведений о задаче. Если сведения о задаче не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о времени ожидания.

По умолчанию: 1200

dnac_debug

boolean

Указывает, включена ли отладка в Cisco Catalyst Center SDK.

Варианты:

• false ← (default)
• true

dnac_host

string / required

Имя хоста Cisco Catalyst Center.

dnac_log

boolean

Флаг для включения/отключения ведения журнала выполнения playbook.

Если true и указан dnac_log_file_path, - Создайте файл журнала в местоположении выполнения с указанным именем.

Если true и dnac_log_file_path не указан, - Создайте файл журнала в местоположении выполнения с именем ‘dnac.log’.

Если false, - Ведение журнала отключено.

Если файла журнала не существует, - он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”.

Если файл журнала существует, - он перезаписывается или к нему добавляется информация в зависимости от флага “dnac_log_append”.

Варианты:

• false ← (default)
• true

dnac_log_append

boolean

Определяет режим файла. Установите в True для режима ‘добавления’. Установите в False для режима ‘записи’.

Варианты:

• false
• true ← (default)

dnac_log_file_path

string

Управляет ведением журнала. Журналы записываются, если dnac_log имеет значение True.

Если путь не указан, - Когда ‘dnac_log_append’ имеет значение True, ‘dnac.log’ создается в текущем каталоге Ansible; журналы добавляются. - Когда ‘dnac_log_append’ имеет значение False, ‘dnac.log’ создается; журналы перезаписываются.

Если путь указан, - Когда ‘dnac_log_append’ имеет значение True, файл открывается в режиме добавления. - Когда ‘dnac_log_append’ имеет значение False, файл открывается в режиме записи (w). - В сценариях с общим файлом без режима добавления содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите добавление в False для первого модуля (для перезаписи); для последующих модулей установите добавление в True.

По умолчанию: "dnac.log"

dnac_log_level

string

Устанавливает порог для уровня журнала. Сообщения с уровнем, равным или выше этого, будут регистрироваться. Уровни перечислены в порядке серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG].

CRITICAL указывает на серьезные ошибки, приостанавливающие работу программы. Отображает только сообщения CRITICAL.

ERROR указывает на проблемы, препятствующие выполнению функции. Отображает сообщения ERROR и CRITICAL.

WARNING указывает на потенциальные будущие проблемы. Отображает сообщения WARNING, ERROR, CRITICAL.

INFO отслеживает нормальную работу. Отображает сообщения INFO, WARNING, ERROR, CRITICAL.

DEBUG предоставляет подробную диагностическую информацию. Отображает все сообщения журнала.

По умолчанию: "WARNING"

dnac_password

string

Пароль для аутентификации в Cisco Catalyst Center.

dnac_port

string

Указывает номер порта, связанного с Cisco Catalyst Center.

По умолчанию: "443"

dnac_task_poll_interval

integer

Указывает интервал в секундах между последовательными вызовами API для получения сведений о задаче.

По умолчанию: 2

dnac_username

aliases: user

string

Имя пользователя для аутентификации в Cisco Catalyst Center.

По умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

• false
• true ← (default)

dnac_version

string

Указывает версию Cisco Catalyst Center, которую должен использовать SDK.

По умолчанию: "2.2.3.3"

state

string

Состояние Cisco Catalyst Center после завершения модуля.

Возможные значения:

• "merged" ← (по умолчанию)
• "deleted"

validate_response_schema

boolean

Флаг для Cisco Catalyst Center SDK, чтобы включить валидацию тел запросов по схеме JSON.

Возможные значения:

• false
• true ← (по умолчанию)