cisco.dnac.assurance_events_count_info 模块 – 用于 Assurance Events Count Info 的信息模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.dnac.assurance_events_count_info。

cisco.dnac 6.15.0 中的新增功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

apMac

字符串

ApMac 查询参数。接入点的 MAC 地址。此参数适用于“统一 AP”和“无线客户端”事件。此字段支持基于通配符 (`*`) 字符的搜索。例如 `*50 0F*` 或 `50 0F*` 或 `*50 0F` 示例 `apMac=50 0F 80 0F F7 E0`（请求单个 apMac）`apMac=50 0F 80 0F F7 E0&apMac=18 80 90 AB 7E A0`（请求多个 apMac）。

clientMac

字符串

ClientMac 查询参数。客户端的 MAC 地址。此参数适用于“有线客户端”和“无线客户端”事件。此字段支持基于通配符 (`*`) 字符的搜索。例如 `*66 2B*` 或 `66 2B*` 或 `*66 2B` 示例 `clientMac=66 2B B8 D2 01 56`（请求单个 clientMac）`clientMac=66 2B B8 D2 01 56&clientMac=DC A6 32 F5 5A 89`（请求多个 clientMac）。

deviceFamily

字符串

DeviceFamily 查询参数。设备系列。请注意，不允许跨网络设备类型和客户端类型的多个系列。例如，不支持选择 `路由器` 以及 `无线客户端` 或 `统一 AP`。示例 `deviceFamily=交换机和集线器`（请求单个 deviceFamily）`deviceFamily=交换机和集线器&deviceFamily=路由器`（请求多个 deviceFamily）。

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"

endTime

字符串

EndTime 查询参数。API 查询与资源相关的数据集结束时间。它必须以毫秒为单位的 UNIX 时间戳指定。值是包含的。如果未提供 `endTime`，API 将默认为当前时间。

headers

字典

其他标头。

messageType

字符串

MessageType 查询参数。事件的消息类型。示例 `messageType=Syslog`（请求单个 messageType）`messageType=Trap&messageType=Syslog`（请求多个 messageType）。

networkDeviceId

字符串

NetworkDeviceId 查询参数。网络设备 UUID 的列表。（例如 `6bef213c-19ca-4170-8375-b694e251101c`）示例 `networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c`（请求单个 networkDeviceId）`networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955-8aa2- 79b233318ba0`（请求多个 networkDeviceId）。

networkDeviceName

字符串

NetworkDeviceName 查询参数。网络设备名称。此参数适用于与网络设备相关的系列。此字段支持基于通配符 (`*`) 字符的搜索。例如 `*Branch*` 或 `Branch*` 或 `*Branch` 示例 `networkDeviceName=Branch-3-Gateway`（请求单个 networkDeviceName）`networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch`（请求多个 networkDeviceName）。

severity

字符串

Severity 查询参数。事件的严重性，介于 0 到 6 之间。这仅适用于与网络设备（AP 除外）和“有线客户端”事件相关的事件。| 值 | 严重性 | | —– | ———– | | 0 | 紧急 | | 1 | 警报 | | 2 | 严重 | | 3 | 错误 | | 4 | 警告 | | 5 | 注意 | | 6 | 信息 | 示例 `severity=0`（请求单个严重性）`severity=0&severity=1`（请求多个严重性）。

siteHierarchyId

字符串

SiteHierarchyId 查询参数。站点树的完整层次结构分解，以 id 形式从全局站点 UUID 开始，到特定的站点 UUID 结束。（例如 `globalUuid/areaUuid/buildingUuid/floorUuid`）此字段支持通配符星号 (`*`) 字符搜索支持。例如 `*uuid*, *uuid, uuid*` 示例 `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `（请求单个 siteHierarchyId）`?siteHiera rchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUu id2`（请求多个 siteHierarchyId）。

siteId

字符串

SiteId 查询参数。站点的 UUID。（例如 `flooruuid`）示例 `?siteId=id1`（请求单个 siteId）`?siteId=id1&siteId=id2&siteId=id3`（请求多个 siteId）。

startTime

字符串

StartTime 查询参数。API 查询与资源相关的数据集开始时间。它必须以毫秒为单位的 UNIX 时间戳指定。值是包含的。如果未提供 `startTime`，API 将默认为当前时间减去 24 小时。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

说明

注意

  • 使用的 SDK 方法是 devices.Devices.count_the_number_of_events_v1,

  • 使用的路径为 get /dna/data/api/v1/assuranceEvents/count，

  • 需要注意的是，此模块是 assurance_events_count_v1_info 的别名。

  • 支持 check_mode

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

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

参见

另请参阅

Cisco DNA Center 文档，了解设备计数事件 V1

CountTheNumberOfEventsV1 API 的完整参考。

示例

- name: Get all Assurance Events Count Info
  cisco.dnac.assurance_events_count_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}}"
    deviceFamily: string
    startTime: string
    endTime: string
    messageType: string
    severity: string
    siteId: string
    siteHierarchyId: string
    networkDeviceName: string
    networkDeviceId: string
    apMac: string
    clientMac: string
  register: result

返回值

常见的返回值记录在 这里，以下是此模块独有的字段

键

描述

dnac_response

字典

一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应。

返回： 总是

示例： {"response": {"count": 0}, "version": "string"}

作者

  • Rafael Campos (@racampos)