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

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.event_info.

Новый в cisco.dnac 3.1.0

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

Описание

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

… (rest of the table translated similarly)

Параметр	Комментарии
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"`
eventId строка	Параметр запроса eventId. Должен быть предоставлен зарегистрированный eventId.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Event
  cisco.dnac.event_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}}"
    eventId: string
    tags: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: `"[\n {\n \"eventId\": \"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 \"tags\": [\n \"string\"\n ],\n \"severity\": 0,\n \"details\": {},\n \"subscriptionTypes\": [\n \"string\"\n ]\n }\n]\n"`

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"eventId\": \"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 \"tags\": [\n \"string\"\n ],\n \"severity\": 0,\n \"details\": {},\n \"subscriptionTypes\": [\n \"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_info_module.html