cisco.dnac.health_score_definitions_info 模块 – 健康评分定义信息信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.dnac.health_score_definitions_info。
cisco.dnac 6.15.0 中的新增功能
概要
此模块表示模块 health_score_definitions_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
以下要求是在执行此模块的主机上所需的。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
属性查询参数。这些是健康评分定义响应中支持的属性。默认情况下，所有属性都包含在响应中。 |
|
DeviceType 查询参数。这些是健康评分定义支持的设备系列。如果未输入设备系列，则考虑所有设备系列。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
附加的标头。 |
|
Id 查询参数。定义标识符。例如 id=015d9cba-4f53-4087-8317-7e49e5ffef46（单个实体 ID 请求） id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47（查询参数中的多个 ID）。 |
|
IncludeForOverallHealth 查询参数。问题定义的包含状态，为 true 或 false。True 表示特定健康指标包含在整体健康计算中，否则为 false。默认设置为 true。 选项
|
|
Limit 查询参数。要返回的最大记录数。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是基于 1 的偏移量。起始值为 1。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
备注
注意
使用的 SDK 方法是 devices.Devices.get_all_health_score_definitions_for_given_filters_v1、devices.Devices.get_health_score_definition_for_the_given_id_v1，
使用的路径是 get /dna/intent/api/v1/healthScoreDefinitions、get /dna/intent/api/v1/healthScoreDefinitions/{id}，
需要注意的是，此模块是 health_score_definitions_v1_info 的别名
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 设备 GetAllHealthScoreDefinitionsForGivenFiltersV1 文档
GetAllHealthScoreDefinitionsForGivenFiltersV1 API 的完整参考。
- Cisco DNA Center 设备 GetHealthScoreDefinitionForTheGivenIdV1 文档
GetHealthScoreDefinitionForTheGivenIdV1 API 的完整参考。
示例
- name: Get all Health Score Definitions Info
cisco.dnac.health_score_definitions_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}}"
deviceType: string
id: string
includeForOverallHealth: True
attribute: string
offset: 0
limit: 0
register: result
- name: Get Health Score Definitions Info by id
cisco.dnac.health_score_definitions_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}}"
id: string
register: result
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 已返回：始终 示例： |