cisco.dnac.applications_health_v1_info 模块 – 应用健康 V1 信息模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.dnac.applications_health_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有应用健康 V1。

  • 意图 API 用于获取特定站点、设备或客户端设备 MAC 地址的应用程序列表。对于特定应用程序与站点和/或设备的组合,API 获取问题/设备/端点的列表。

注意

此模块具有相应的 action 插件

要求

执行此模块的主机需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

applicationHealth

字符串

ApplicationHealth 查询参数。应用健康类别(差、一般或好。可选择仅与 siteId 一起使用)。

applicationName

字符串

ApplicationName 查询参数。要获取信息的应用程序的名称。

deviceId

字符串

DeviceId 查询参数。保证设备 UUID 值(不能与 siteId 和 clientMac 一起提交)。

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 查询参数。时间窗口的结束纪元时间(毫秒)。

headers

字典

附加的报头。

limit

浮点数

Limit 查询参数。返回数据中应用程序条目的最大数量 1, 1000(可选择仅与 siteId 一起使用)。

macAddress

字符串

MacAddress 查询参数。客户端设备的 MAC 地址(不能与 siteId 和 deviceId 一起提交)。

offset

浮点数

Offset 查询参数。返回数据中第一个应用程序的偏移量(可选择仅与 siteId 一起使用)。

siteId

字符串

SiteId 查询参数。保证站点 UUID 值(不能与 deviceId 和 clientMac 一起提交)。

startTime

浮点数

StartTime 查询参数。时间窗口的开始纪元时间(毫秒)。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 架构验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 applications.Applications.applications_v1,

  • 使用的路径是 get /dna/intent/api/v1/application-health,

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 应用 ApplicationsV1 文档

ApplicationsV1 API 的完整参考。

示例

- name: Get all Applications Health V1
  cisco.dnac.applications_health_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}}"
    siteId: string
    deviceId: string
    macAddress: string
    startTime: 0
    endTime: 0
    applicationHealth: string
    offset: 0
    limit: 0
    applicationName: string
  register: result

返回值

常见的返回值已在此处记录 此处,以下是此模块特有的字段

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回:始终

示例: {"response": [{"application": "字符串", "applicationServerLatency": {}, "averageThroughput": 0, "businessRelevance": "字符串", "clientIp": "字符串", "clientMacAddress": "字符串", "clientName": "字符串", "clientNetworkLatency": {}, "deviceType": "字符串", "exporterFamily": "字符串", "exporterIpAddress": "字符串", "exporterName": "字符串", "exporterUUID": "字符串", "health": 0, "issueId": "字符串", "issueName": "字符串", "jitter": {}, "location": "字符串", "name": "字符串", "networkLatency": {}, "occurrences": 0, "operatingSystem": "字符串", "packetLossPercent": {}, "priority": "字符串", "rootCause": "字符串", "serverNetworkLatency": {}, "severity": "字符串", "summary": "字符串", "timestamp": 0, "trafficClass": "字符串", "usageBytes": 0}], "totalCount": 0, "version": "字符串"}

作者

  • Rafael Campos (@racampos)