cisco.dnac.assurance_events_v1_info 模块 – Assurance Events V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您正在使用 ansible 包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定： cisco.dnac.assurance_events_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有 Assurance Events V1。
按 ID 获取 Assurance Events V1。
使用事件 `id` 获取担保事件详细信息的 API。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml。
返回 Catalyst Center 发现的事件列表，由复杂的过滤器确定。请参阅“API 支持文档”部分以了解支持哪些字段。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ApMac 查询参数。接入点的 MAC 地址。此参数适用于 `Unified AP` 和 `Wireless Client` 事件。此字段支持基于通配符（`*`）的搜索。例如 `*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）。 |
|
Attribute 查询参数。需要包含在响应中的属性列表。如果未提供此参数，则基本属性（`id`、`name`、`timestamp`、`details`、`messageType`、`siteHierarchyId`、`siteHierarchy`、`deviceFamily`、`networkDeviceId`、`networkDeviceName`、`managementIpAddress`）将成为响应的一部分。示例 `attribute=name`（请求单个属性） `attribute=name&attribute=networkDeviceName`（请求多个属性）。 |
|
ClientMac 查询参数。客户端的 MAC 地址。此参数适用于 `Wired Client` 和 `Wireless Client` 事件。此字段支持基于通配符（`*`）的搜索。例如 `*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 查询参数。设备系列。请注意，不允许跨网络设备类型和客户端类型使用多个系列。例如，选择 `Routers` 和 `Wireless Client` 或 `Unified AP` 不受支持。示例 `deviceFamily=Switches and Hubs`（请求单个 deviceFamily） `deviceFamily=Switches and Hubs&deviceFamily=Routers`（请求多个 deviceFamily）。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
EndTime 查询参数。API 查询与资源相关的 DataSet 的结束时间。必须以毫秒为单位的 UNIX epochtime 指定值。值包含在内。如果未提供 `endTime`，API 将默认为当前时间。 |
|
附加头。 |
|
Id 路径参数。事件的唯一标识符。 |
|
Limit 查询参数。要返回的最大记录数。 |
|
MessageType 查询参数。事件的消息类型。例如 `messageType=Syslog`（请求单个 messageType） `messageType=Trap&messageType=Syslog`（请求多个 messageType）。 |
|
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 查询参数。网络设备名称。此参数适用于与网络设备相关的系列。此字段支持基于通配符（`*`）字符的搜索。例如 `*Branch*` 或 `Branch*` 或 `*Branch` 例如 `networkDeviceName=Branch-3-Gateway`（请求单个 networkDeviceName） `networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch`（请求多个 networkDeviceName）。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序，升序或降序。 |
|
Severity 查询参数。事件的严重性级别，介于 0 和 6 之间。这仅适用于与网络设备（AP 除外）和 `Wired Client` 事件相关的事件。| 值 | 严重性 | | —– | ———– | | 0 | 紧急 | | 1 | 警报 | | 2 | 严重 | | 3 | 错误 | | 4 | 警告 | | 5 | 通知 | | 6 | 信息 | 例如 `severity=0`（请求单个严重性） `severity=0&severity=1`（请求多个严重性）。 |
|
SiteHierarchyId 查询参数。站点树的完整层级细分，以 ID 形式表示，从全局站点 UUID 开始，到特定站点 UUID 结束。（例如 `globalUuid/areaUuid/buildingUuid/floorUuid`）此字段支持通配符星号（`*`）字符搜索。例如 `*uuid*, *uuid, uuid*` 例如 `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `（请求单个 siteHierarchyId） `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2`（请求多个 siteHierarchyId）。 |
|
SiteId 查询参数。站点的 UUID。（例如 `flooruuid`）例如 `?siteId=id1`（请求单个 siteId） `?siteId=id1&siteId=id2&siteId=id3`（请求多个 siteId）。 |
|
SortBy 查询参数。响应中要排序的字段。 |
|
StartTime 查询参数。API 从中查询与资源相关的数据集的起始时间。必须以毫秒为单位的 UNIX 纪元时间指定。值为包含值。如果未提供 `startTime`，API 将默认为当前时间减去 24 小时。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
|
View 查询参数。事件视图列表。请参阅 `EventViews` 以了解受支持的列表 例如 `view=network`（请求单个视图） `view=network&view=ap`（请求多个视图）。 |
备注
注意
使用的 SDK 方法为 devices.Devices.get_details_of_a_single_assurance_event_v1、devices.Devices.query_assurance_events_v1，
使用的路径为 get /dna/data/api/v1/assuranceEvents、get /dna/data/api/v1/assuranceEvents/{id}，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 文档，关于 Devices GetDetailsOfASingleAssuranceEventV1
GetDetailsOfASingleAssuranceEventV1 API 的完整参考。
- Cisco DNA Center 文档，关于 Devices QueryAssuranceEventsV1
QueryAssuranceEventsV1 API 的完整参考。
示例
- name: Get all Assurance Events V1
cisco.dnac.assurance_events_v1_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: 0
endTime: 0
messageType: string
severity: 0
siteId: string
siteHierarchyId: string
networkDeviceName: string
networkDeviceId: string
apMac: string
clientMac: string
attribute: string
view: string
offset: 0
limit: 0
sortBy: string
order: string
register: result
- name: Get Assurance Events V1 by id
cisco.dnac.assurance_events_v1_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}}"
attribute: string
view: string
id: string
register: result
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值：始终 示例： |