Модуль cisco.dnac.event_series_info – Модуль информации о серии событий

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.event_series_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	Параметр запроса домена.
endTime float	Параметр запроса endTime. Конечное время в миллисекундах.
eventIds string	Параметр запроса eventIds. Необходимо указать зарегистрированный EventId.
headers dictionary	Дополнительные заголовки.
limit float	Параметр запроса limit.
namespace string	Параметр запроса namespace.
offset float	Параметр запроса offset. Начальный сдвиг.
order string	Параметр запроса order. Порядок сортировки: asc/desc (по возрастанию/убыванию).
severity string	Параметр запроса severity.
siteId string	Параметр запроса siteId. Идентификатор сайта.
sortBy string	Параметр запроса sortBy. Столбец для сортировки.
source string	Параметр запроса source.
startTime float	Параметр запроса startTime. Начальное время в миллисекундах.
subDomain string	Параметр запроса subDomain. Поддомен.
tags string	Параметр запроса tags.
type string	Параметр запроса type.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тела запроса на соответствие JSON-схеме. Варианты: `false` `true` ← (default)

Примечания

Примечание

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

См. также

Документация Cisco DNA Center по Event Management GetNotifications: Полное описание API GetNotifications.

Примеры

- name: Get all Event Series
  cisco.dnac.event_series_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
    startTime: 0
    endTime: 0
    category: string
    type: string
    severity: string
    domain: string
    subDomain: string
    source: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
    tags: string
    namespace: string
    siteId: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"eventId\": \"string\",\n \"instanceId\": \"string\",\n \"namespace\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"version\": \"string\",\n \"category\": \"string\",\n \"domain\": \"string\",\n \"subDomain\": \"string\",\n \"type\": \"string\",\n \"severity\": \"string\",\n \"source\": \"string\",\n \"timestamp\": \"string\",\n \"details\": \"string\",\n \"eventHierarchy\": \"string\",\n \"network\": {\n \"siteId\": \"string\",\n \"deviceId\": \"string\"\n }\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"eventId\": \"string\",\n \"instanceId\": \"string\",\n \"namespace\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"version\": \"string\",\n \"category\": \"string\",\n \"domain\": \"string\",\n \"subDomain\": \"string\",\n \"type\": \"string\",\n \"severity\": \"string\",\n \"source\": \"string\",\n \"timestamp\": \"string\",\n \"details\": \"string\",\n \"eventHierarchy\": \"string\",\n \"network\": {\n \"siteId\": \"string\",\n \"deviceId\": \"string\"\n }\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_series_info_module.html