cisco.dnac.health_score_definitions_count_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_count_info。

cisco.dnac 6.15.0 新增功能

概要

  • 此模块代表模块 health_score_definitions_count_v1_info 的别名。

注意

此模块具有相应的 action 插件。

需求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceType

字符串

DeviceType 查询参数。这些是支持健康评分定义的设备系列。如果未输入设备系列，则考虑所有设备系列。

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"

headers

字典

附加头。

id

字符串

Id 查询参数。定义标识符。示例 id=015d9cba-4f53-4087-8317-7e49e5ffef46 (单个实体 ID 请求) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (查询参数中的多个 ID)。

includeForOverallHealth

布尔值

IncludeForOverallHealth 查询参数。问题定义的包含状态，为 true 或 false。True 表示特定健康指标包含在整体健康计算中，否则为 false。默认情况下设置为 true。

选项

  • false

  • true

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 devices.Devices.get_the_count_of_health_score_definitions_based_on_provided_filters_v1，

  • 使用的路径是 get /intent/api/v1/healthScoreDefinitions/count，

  • 需要注意的是，此模块是 health_score_definitions_count_v1_info 的别名。

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，了解 Devices GetTheCountOfHealthScoreDefinitionsBasedOnProvidedFiltersV1。

GetTheCountOfHealthScoreDefinitionsBasedOnProvidedFiltersV1 API 的完整参考。

示例

- name: Get all Health Score Definitions Count Info
  cisco.dnac.health_score_definitions_count_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
  register: result

返回值

公共返回值已记录在 此处，以下是此模块独有的字段。

键

描述

dnac_response

字典

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

返回值：始终返回

示例： {"response": {"count": 0}, "version": "string"}

作者

  • Rafael Campos (@racampos)