cisco.dnac.health_score_definitions 模块 – 健康评分定义资源模块

注意

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

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

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

要在剧本中使用它,请指定: cisco.dnac.health_score_definitions

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 health_score_definitions_v1 的别名

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

id

字符串

ID 路径参数。健康评分定义 ID。

includeForOverallHealth

布尔值

包含在整体健康中。

选项

  • false

  • true

synchronizeToIssueThreshold

布尔值

同步到问题阈值。

选项

  • false

  • true

thresholdValue

浮点数

阈值。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求体的标志。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 devices.Devices.update_health_score_definition_for_the_given_id_v1,

  • 使用的路径为 put /dna/intent/api/v1/healthScoreDefinitions/{id},

  • 需要注意的是,此模块是 health_score_definitions_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 设备 UpdateHealthScoreDefinitionForTheGivenIdV1 文档

UpdateHealthScoreDefinitionForTheGivenIdV1 API 的完整参考。

示例

- name: Update by id
  cisco.dnac.health_score_definitions:
    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}}"
    state: present
    id: string
    includeForOverallHealth: true
    synchronizeToIssueThreshold: true
    thresholdValue: 0

返回值

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

描述

dnac_response

字典

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

返回: 始终

示例: {"definitionStatus": "string", "description": "string", "deviceFamily": "string", "displayName": "string", "id": "string", "includeForOverallHealth": true, "lastModified": "string", "name": "string", "synchronizeToIssueThreshold": true, "thresholdValue": 0}

作者

  • Rafael Campos (@racampos)