cisco.dnac.event_series_info 模块 – 事件系列信息信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.event_series_info

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

此模块具有相应的 操作插件

需求

以下需求在执行此模块的主机上是必需的。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

category

字符串

类别查询参数。

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"

domain

字符串

域名查询参数。

endTime

浮点数

EndTime 查询参数。以毫秒为单位的结束时间。

eventIds

字符串

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

headers

字典

附加标头。

limit

浮点数

Limit 查询参数。

namespace

字符串

命名空间查询参数。

offset

浮点数

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

order

字符串

Order 查询参数。升序/降序 asc/desc。

severity

字符串

严重性查询参数。

siteId

字符串

SiteId 查询参数。站点 ID。

sortBy

字符串

SortBy 查询参数。排序列。

source

字符串

Source 查询参数。

startTime

浮点数

StartTime 查询参数。以毫秒为单位的开始时间。

subDomain

字符串

SubDomain 查询参数。子域名。

tags

字符串

Tags 查询参数。

type

字符串

Type 查询参数。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

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

  • 使用的路径是 get /dna/intent/api/v1/event/event-series,

  • 需要注意的是,此模块是 event_series_v1_info 的别名

  • 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 事件管理 GetNotificationsV1 文档

GetNotificationsV1 API 的完整参考。

示例

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

作者

  • Rafael Campos (@racampos)