cisco.dnac.event_info 模块 – 用于事件信息的 Information 模块

注意

此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。

如果您使用的是 ansible 包,您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:cisco.dnac.event_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 event_v1_info 的别名

注意

此模块具有对应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

布尔值

Cisco DNA Center SDK 的标志,用于启用调试。

选项

  • false ← (默认)

  • true

dnac_host

string / 必填

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"

eventId

字符串

EventId 查询参数。应提供注册的 EventId。

headers

字典

其他标头。

limit

浮点数

Limit 查询参数。限制结果集中 Registry 数量,默认值为 10。

offset

浮点数

Offset 查询参数。结果集中偏移的 Registry 数量,默认值为 0。

order

字符串

Order 查询参数。

sortBy

字符串

SortBy 查询参数。SortBy 字段名称。

tags

字符串

Tags 查询参数。应提供注册的 Tags。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

注释

注意

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

  • 使用的路径是 get /dna/intent/api/v1/events,

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

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

GetEventsV1 API 的完整参考。

示例

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

list / elements=dictionary

一个字典或列表,包含 Cisco DNAC Python SDK 返回的响应

返回:始终

示例: "[\n  {\n    \"eventId\": \"字符串\",\n    \"nameSpace\": \"字符串\",\n    \"name\": \"字符串\",\n    \"description\": \"字符串\",\n    \"version\": \"字符串\",\n    \"category\": \"字符串\",\n    \"domain\": \"字符串\",\n    \"subDomain\": \"字符串\",\n    \"type\": \"字符串\",\n    \"tags\": [\n      \"字符串\"\n    ],\n    \"severity\": 0,\n    \"details\": {},\n    \"subscriptionTypes\": [\n      \"字符串\"\n    ]\n  }\n]\n"

作者

  • Rafael Campos (@racampos)