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

注意

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

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

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

要在 playbook 中使用它,请指定: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

浮点数

限制查询参数。

namespace

字符串

命名空间查询参数。

offset

浮点数

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

order

字符串

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

severity

字符串

严重性查询参数。

siteId

字符串

SiteId 查询参数。站点 ID。

sortBy

字符串

SortBy 查询参数。按列排序。

source

字符串

源查询参数。

startTime

浮点数

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

subDomain

字符串

子域查询参数。子域。

tags

字符串

标记查询参数。

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\": \"字符串\",\n    \"instanceId\": \"字符串\",\n    \"namespace\": \"字符串\",\n    \"name\": \"字符串\",\n    \"description\": \"字符串\",\n    \"version\": \"字符串\",\n    \"category\": \"字符串\",\n    \"domain\": \"字符串\",\n    \"subDomain\": \"字符串\",\n    \"type\": \"字符串\",\n    \"severity\": \"字符串\",\n    \"source\": \"字符串\",\n    \"timestamp\": \"字符串\",\n    \"details\": \"字符串\",\n    \"eventHierarchy\": \"字符串\",\n    \"network\": {\n      \"siteId\": \"字符串\",\n      \"deviceId\": \"字符串\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)