cisco.dnac.system_health_count_v1_info 模块 – System Health Count V1 的信息模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.dnac.system_health_count_v1_info。

cisco.dnac 3.1.0 中的新功能

概要

  • 获取所有 System Health Count V1。

  • 此 API 提供最新的系统事件计数。

注意

此模块具有对应的 操作插件。

要求

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

  • 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"

domain

字符串

域查询参数。使用此域获取系统事件。 域的可能值在此处列出 /dna/platform/app/consumer-portal/developer-toolkit/events。

headers

字典

其他标头。

subdomain

字符串

子域查询参数。使用此子域获取系统事件。 子域的可能值在此处列出 /dna/platform/app/consumer-portal/developer-toolkit/events。

validate_response_schema

布尔值

Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式的请求正文验证。

选项

  • false

  • true ←（默认）

说明

注意

  • 使用的 SDK 方法是 health_and_performance.HealthAndPerformance.system_health_count，

  • 使用的路径是 get /dna/intent/api/v1/diagnostics/system/health/count，

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，了解 Health and Performance SystemHealthCountAPIV1

SystemHealthCountAPIV1 API 的完整参考。

示例

- name: Get all System Health Count V1
  cisco.dnac.system_health_count_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}}"
    domain: string
    subdomain: string
  register: result

返回值

常见的返回值记录在此处，以下是此模块独有的字段

键

描述

dnac_response

字典

一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应

已返回: 总是

示例: {"count": 0}

作者

  • Rafael Campos (@racampos)