cisco.dnac.device_health_info 模块 – 设备健康信息的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.dnac.device_health_info。
cisco.dnac 3.1.0 中的新增功能
概要
此模块表示模块 device_health_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
DeviceRole 查询参数。CORE、ACCESS、DISTRIBUTION、ROUTER、WLC 或 AP（不区分大小写）。 |
|
用于启用调试的 Cisco DNA Center SDK 的标志。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
用于启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用哪个版本的 Cisco DNA Center。 默认值： |
|
EndTime 查询参数。UTC epoch 时间，以毫秒为单位。 |
|
其他标头。 |
|
Health 查询参数。DNAC 健康类别 POOR、FAIR 或 GOOD（不区分大小写）。 |
|
Limit 查询参数。响应中设备条目的最大数量（默认为 50。最大为 500）。 |
|
Offset 查询参数。返回数据中第一个设备的偏移量（“limit” + 1 的倍数）。 |
|
SiteId 查询参数。DNAC 站点 UUID。 |
|
StartTime 查询参数。UTC epoch 时间，以毫秒为单位。 |
|
用于启用针对 JSON 模式验证请求正文的 Cisco DNA Center SDK 的标志。 选择
|
注意
注意
使用的 SDK 方法是 devices.Devices.devices_v1，
使用的路径是 get /dna/intent/api/v1/device-health，
应注意，此模块是 device_health_v1_info 的别名
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 设备 DevicesV1 的文档
DevicesV1 API 的完整参考。
示例
- name: Get all Device Health Info
cisco.dnac.device_health_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}}"
deviceRole: string
siteId: string
health: string
startTime: 0
endTime: 0
limit: 0
offset: 0
register: result
返回值
常见的返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
由 Cisco DNAC Python SDK 返回的响应的字典或列表 返回：始终 示例： |