cisco.dnac.event_artifact_info 模块 – 事件工件信息的信息模块

注意

此模块是 cisco.dnac 集合(版本 6.25.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_v1_info 的别名

注意

此模块具有相应的 action 插件

要求

执行此模块的主机需要满足以下要求。

  • dnacentersdk >= 2.4.9

  • 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 查询参数。事件 ID 列表。

headers

字典

其他标头。

limit

浮点数

Limit 查询参数。

offset

浮点数

Offset 查询参数。记录起始偏移量。

order

字符串

Order 查询参数。排序顺序(asc/desc)。

字符串

Search 查询参数。在名称、描述、eventId、类型、类别中查找匹配项。

sortBy

字符串

SortBy 查询参数。按字段排序。

tags

字符串

Tags 查询参数。已定义的标签。

validate_response_schema

布尔值

用于启用针对 JSON 架构验证请求正文的 Cisco DNA Center SDK 的标志。

选项

  • false

  • true ←(默认)

注释

注意

  • 使用的 SDK 方法是 event_management.EventManagement.get_eventartifacts,

  • 使用的路径是 get /dna/system/api/v1/event/artifact,

  • 应该注意的是,此模块是 event_artifact_v1_info 的别名

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关事件管理 GetEventArtifactsV1 的 Cisco DNA Center 文档

GetEventArtifactsV1 API 的完整参考。

示例

- name: Get all Event Artifact Info
  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

列表 / elements=字典

包含 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    \"deprecationMessage\": \"string\",\n    \"deprecated\": true,\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    \"tenantId\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)