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

Примечание

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

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

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

Для использования в playbook, укажите: cisco.dnac.event_artifact_info.

Новое в cisco.dnac 3.1.0

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

Краткое описание

Получить все Event Artifact.
Получает список артефактов на основе заданных смещения и ограничения.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug логическое	Флаг для 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 логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
eventIds строка	Параметр запроса eventIds. Список eventIds.
headers словарь	Дополнительные заголовки.
limit число с плавающей точкой	Параметр запроса limit.
offset число с плавающей точкой	Параметр запроса offset. Смещение начала записи.
order строка	Параметр запроса order. Порядок сортировки (asc/desc).
search строка	Параметр запроса search. Поиск совпадений в имени, описании, eventId, type, category.
sortBy строка	Параметр запроса sortBy. Сортировка по полю.
tags строка	Параметр запроса tags. Заданные теги.
validate_response_schema логическое	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Event Artifact
  cisco.dnac.event_artifact_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
    tags: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
    search: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"version\": \"string\",\n \"artifactId\": \"string\",\n \"namespace\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"domain\": \"string\",\n \"subDomain\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"isTemplateEnabled\": true,\n \"ciscoDNAEventLink\": \"string\",\n \"note\": \"string\",\n \"isPrivate\": true,\n \"eventPayload\": {\n \"eventId\": \"string\",\n \"version\": \"string\",\n \"category\": \"string\",\n \"type\": \"string\",\n \"source\": \"string\",\n \"severity\": \"string\",\n \"details\": {\n \"device_ip\": \"string\",\n \"message\": \"string\"\n },\n \"additionalDetails\": {}\n },\n \"eventTemplates\": [\n {}\n ],\n \"isTenantAware\": true,\n \"supportedConnectorTypes\": [\n \"string\"\n ],\n \"configs\": {\n \"isAlert\": true,\n \"isACKnowledgeable\": true\n },\n \"tenantId\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"version\": \"string\",\n \"artifactId\": \"string\",\n \"namespace\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"domain\": \"string\",\n \"subDomain\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"isTemplateEnabled\": true,\n \"ciscoDNAEventLink\": \"string\",\n \"note\": \"string\",\n \"isPrivate\": true,\n \"eventPayload\": {\n \"eventId\": \"string\",\n \"version\": \"string\",\n \"category\": \"string\",\n \"type\": \"string\",\n \"source\": \"string\",\n \"severity\": \"string\",\n \"details\": {\n \"device_ip\": \"string\",\n \"message\": \"string\"\n },\n \"additionalDetails\": {}\n },\n \"eventTemplates\": [\n {}\n ],\n \"isTenantAware\": true,\n \"supportedConnectorTypes\": [\n \"string\"\n ],\n \"configs\": {\n \"isAlert\": true,\n \"isACKnowledgeable\": true\n },\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_artifact_info_module.html