cisco.dnac.assurance_issues_info 模块 – Assurance 问题信息的信息模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在剧本中使用它,请指定:cisco.dnac.assurance_issues_info
。
cisco.dnac 6.15.0 中的新增功能
概要
此模块表示模块 assurance_issues_v1_info 的别名
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
AiDriven 查询参数。标志问题是否为 AI 驱动的问题。 选项
|
|
属性查询参数。与问题相关的属性列表。如果提供了这些属性,则只有这些属性将与默认属性一起作为响应的一部分。请参考 `IssuesResponseAttribute` 模型以获取支持的属性。示例 `attribute=deviceType`(请求单个属性)`attribute=deviceType&attribute=updatedBy`(请求多个属性)。 |
|
类别查询参数。问题的类别。支持单个类别和多个类别。示例 category=availability (请求单个状态) category=availability&category=onboarding (请求多个类别)。 |
|
DeviceType 查询参数。此问题所属设备的设备类型。支持单个设备类型和多个设备类型。示例 deviceType=wireless controller(请求单个设备类型)deviceType=wireless controller&deviceType=core(请求多个设备类型)。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于验证的 Cisco DNA Center 用户名。 默认值: |
|
用于启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用哪个版本的 Cisco DNA Center。 默认值: |
|
EndTime 查询参数。API 查询与资源相关的数据集的结束时间。它必须以毫秒为单位的 UNIX 时间戳指定。值是包含的。 |
|
EntityId 查询参数。此问题所属实体的 ID。例如,它可以是 AP 的 MAC 地址或传感器的 UUID,示例 68 ca e4 79 3f 20 4de02167-901b-43cf-8822-cffd3caa286f 示例 entityId=68 ca e4 79 3f 20 (请求单个实体 ID) entityId=68 ca e4 79 3f 20&entityId=864d0421-02c0-43a6-9c52-81cad45f66d8 (请求多个实体 ID)。 |
|
EntityType 查询参数。问题的实体类型。支持单个实体类型和多个实体类型。示例 entityType=networkDevice(请求单个实体类型)entityType=network device&entityType=client(请求多个实体类型)。 |
|
FabricDriven 查询参数。标志问题是否与 Fabric 站点、虚拟网络或传输有关。 选项
|
|
FabricSiteDriven 查询参数。标志问题是否为 Fabric 站点驱动的问题。 选项
|
|
FabricSiteId 查询参数。Fabric 站点的 UUID。(例如,“flooruuid”)示例 fabricSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26(请求单个 ID)fabricSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26,864d0421-02c0-43a6-9c52-81cad45f66d8(请求多个 ID)。 |
|
FabricTransitDriven 查询参数。标志问题是否为 Fabric 传输驱动的问题。 选项
|
|
FabricTransitSiteId 查询参数。Fabric 传输站点的 UUID。(例如,“flooruuid”)示例 fabricTransitSiteId=e52aecfe-b142-4287-a587-11a16ba6dd26(请求单个 ID)fabricTransitSiteId=e52aecfe- b142-4287-a587-11a16ba6dd26&fabricTransitSiteId=864d0421-02c0-43a6-9c52-81cad45f66d8(请求多个 ID)。 |
|
FabricVnDriven 查询参数。标志问题是否为 Fabric 虚拟网络驱动的问题。 选项
|
|
FabricVnName 查询参数。Fabric 虚拟网络的名称 示例 fabricVnName=name1(请求单个 Fabric 虚拟网络名称)fabricVnName=name1&fabricVnName=name2&fabricVnName=name3(请求多个 Fabric 虚拟网络名称)。 |
|
其他标头。 |
|
Id 路径参数。问题的 UUID。 |
|
IsGlobal 查询参数。全局问题是指那些影响多个设备、站点的问题。它们也显示在 Catalyst Center UI 中的问题仪表板上。非全局问题仅显示在客户端 360 或设备 360 页面上。如果此标志为“true”,则只返回全局问题。如果为“false”,则返回所有问题。 选项
|
|
IssueId 查询参数。问题的 UUID 示例 issueId=e52aecfe-b142-4287-a587-11a16ba6dd26(请求单个问题 ID)issueId=e52aecfe-b142-4287-a587-11a16ba6dd26&issueId=864d0421-02c0-43a6-9c52-81cad45f66d8(请求多个问题 ID)。 |
|
Limit 查询参数。要返回的最大问题数。 |
|
MacAddress 查询参数。网络设备或客户端的 macAddress。此字段支持基于通配符 (`*`) 的搜索。例如 `*AB AB AB*` 或 `AB AB AB*` 或 `*AB AB AB`。示例:`macAddress=AB AB AB CD CD CD`(请求单个 macAddress) `macAddress=AB AB AB CD CD DC&macAddress=AB AB AB CD CD FE`(请求多个 macAddress)。 |
|
名称查询参数。问题的名称。示例:name=ap_down(请求单个问题名称)name=ap_down&name=wlc_monitor(请求多个问题名称)。可以使用 API `/data/api/v1/assuranceIssueConfigurations` 检索问题名称。 |
|
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`(使用 & 分隔符请求多个 networkDeviceIds)。 |
|
NetworkDeviceIpAddress 查询参数。网络设备管理 IP 地址列表。(例如:`121.1.1.10`)此字段支持基于通配符 (`*`) 的搜索。例如 `*1.1*` 或 `1.1*` 或 `*1.1`。示例: `networkDeviceIpAddress=121.1.1.10` `networkDeviceIpAddress=121.1.1.10&networkDeviceIpAddress=172.20.1.10&networkDeviceIpAddress=10.10.20.10`(使用 & 分隔符请求多个网络设备 IP 地址)。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是一个基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序,升序或降序。 |
|
Priority 查询参数。问题的优先级。支持单个优先级和多个优先级。示例:priority=P1(请求单个优先级)priority=P1&priority=P2&priority=P3(请求多个优先级)。 |
|
Severity 查询参数。问题的严重性。支持单个严重性和多个严重性。示例:severity=high(请求单个严重性)severity=high&severity=medium(请求多个严重性)。 |
|
SiteHierarchy 查询参数。站点树的完整层级分解,从全局站点名称开始,到特定站点名称结束。根站点名为 “Global”(例如:`Global/AreaName/BuildingName/FloorName`)。此字段支持通配符星号 (*) 字符搜索。例如 */San*、*/San、/San*。示例: `?siteHierarchy=Global/AreaName/BuildingName/FloorName`(请求单个 siteHierarchy) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaNam e2/BuildingName2/FloorName2`(请求多个 siteHierarchies)。 |
|
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`(请求多个 siteHierarchyIds)。 |
|
SiteId 查询参数。站点的 UUID。(例如:`flooruuid`)此字段支持通配符星号 (*) 字符搜索。例如 `*flooruuid*`、`*flooruuid`、`flooruuid*`。示例: `?siteId=id1`(请求单个 id) `?siteId=id1&siteId=id2&siteId=id3`(请求多个 ids)。 |
|
SiteName 查询参数。站点的名称。(例如:`FloorName`)此字段支持通配符星号 (*) 字符搜索。例如 `*San*`、`*San`、`San*`。示例: `?siteName=building1`(请求单个 siteName)`?siteName=building1&siteName=building2&siteName=building3`(请求多个 siteNames)。 |
|
SortBy 查询参数。 |
|
StartTime 查询参数。API 查询与资源相关的数据集的起始时间。它必须以 UNIX 纪元时间(毫秒)指定。值是包含的。如果未提供 `startTime`,API 将默认为当前时间。 |
|
Status 查询参数。问题的状态。支持单个状态和多个状态。示例:status=active(请求单个状态)status=active&status=resolved(请求多个状态)。 |
|
UpdatedBy 查询参数。最后更新此问题的用户。示例:updatedBy=admin(请求单个 updatedBy)updatedBy=admin&updatedBy=john(请求多个 updatedBy)。 |
|
Cisco DNA Center SDK 的标志,用于启用针对 JSON 模式验证请求正文。 选项
|
|
View 查询参数。视图的名称。每个视图代表一个特定的数据集。请参考 `IssuesView` 模型了解支持的视图。视图是 API 支持的预定义属性集。只有与给定视图相关的属性以及默认属性才会包含在 API 响应中。如果提供了多个视图,则响应将包含来自所有这些视图的属性。如果未指定任何视图,则将返回所有属性。| 视图名称 | 包含的属性 | | — | — | | `update` | updatedTime, updatedBy | | `site` | siteName, siteHierarchy, siteId, siteHierarchyId | 示例:`view=update`(请求单个视图)`view=update&view=site`(请求多个视图)。 |
备注
注意
使用的 SDK 方法是 issues.Issues.get_all_the_details_and_suggested_actions_of_an_issue_for_the_given_issue_id_v1,issues.Issues.get_the_details_of_issues_for_given_set_of_filters_know_your_network_v1,
使用的路径是 get /dna/data/api/v1/assuranceIssues, get /dna/data/api/v1/assuranceIssues/{id},
应注意,此模块是 assurance_issues_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档,了解 Issues GetAllTheDetailsAndSuggestedActionsOfAnIssueForTheGivenIssueIdV1
GetAllTheDetailsAndSuggestedActionsOfAnIssueForTheGivenIssueIdV1 API 的完整参考。
- Cisco DNA Center 文档,了解 Issues GetTheDetailsOfIssuesForGivenSetOfFiltersKnowYourNetworkV1
GetTheDetailsOfIssuesForGivenSetOfFiltersKnowYourNetworkV1 API 的完整参考。
示例
- name: Get all Assurance Issues Info
cisco.dnac.assurance_issues_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}}"
startTime: 0
endTime: 0
limit: 0
offset: 0
sortBy: string
order: string
isGlobal: True
priority: string
severity: string
status: string
entityType: string
category: string
deviceType: string
name: string
issueId: string
entityId: string
updatedBy: string
siteHierarchy: string
siteHierarchyId: string
siteName: string
siteId: string
fabricSiteId: string
fabricVnName: string
fabricTransitSiteId: string
networkDeviceId: string
networkDeviceIpAddress: string
macAddress: string
view: string
attribute: string
aiDriven: True
fabricDriven: True
fabricSiteDriven: True
fabricVnDriven: True
fabricTransitDriven: True
register: result
- name: Get Assurance Issues Info by id
cisco.dnac.assurance_issues_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}}"
view: string
attribute: string
id: string
register: result
返回值
常见的返回值记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典或列表,包含 Cisco DNAC Python SDK 返回的响应 返回: 始终 示例: |