cisco.dnac.system_health_v1_info 模块 – System Health V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：cisco.dnac.system_health_v1_info。
cisco.dnac 3.1.0 中的新功能
概要
获取所有 System Health V1。
此 API 检索最新的系统事件。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
用于 Cisco DNA Center SDK 启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认: |
|
用于启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认: |
|
域查询参数。使用此域获取系统事件。域的可能值在此处列出 /dna/platform/app/consumer-portal/developer-toolkit/events。 |
|
其他标头。 |
|
限制查询参数。 |
|
偏移量查询参数。 |
|
子域查询参数。使用此子域获取系统事件。子域的可能值在此处列出 /dna/platform/app/consumer-portal/developer-toolkit/events。 |
|
摘要查询参数。获取最新的高严重性事件。 选项
|
|
用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求主体的标志。 选项
|
注释
注意
使用的 SDK 方法为 health_and_performance.HealthAndPerformance.system_health，
使用的路径为 get /dna/intent/api/v1/diagnostics/system/health，
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 关于运行状况和性能 SystemHealthAPIV1 的文档
SystemHealthAPIV1 API 的完整参考。
示例
- name: Get all System Health V1
cisco.dnac.system_health_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}}"
summary: True
domain: string
subdomain: string
limit: 0
offset: 0
register: result
返回值
常见的返回值记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应 已返回: 始终 示例: |