1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: system_health_info
short_description: Information module for System Health
description:
- Get all System Health.
- This API retrieves the latest system events.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
summary:
description:
- Summary query parameter. Fetch the latest high severity event.
type: bool
domain:
description:
- >
Domain query parameter. Fetch system events with this domain. Possible values of domain are listed here
/dna/platform/app/consumer-portal/developer-toolkit/events.
type: str
subdomain:
description:
- >
Subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed
here /dna/platform/app/consumer-portal/developer-toolkit/events.
type: str
limit:
description:
- Limit query parameter.
type: float
offset:
description:
- Offset query parameter.
type: float
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Health and Performance SystemHealthAPI
description: Complete reference of the SystemHealthAPI API.
link: https://developer.cisco.com/docs/dna-center/#!system-health-api
notes:
- SDK Method used are
health_and_performance.HealthAndPerformance.system_health,
- Paths used are
get /dna/intent/api/v1/diagnostics/system/health,
"""
EXAMPLES = r"""
- name: Get all System Health
cisco.dnac.system_health_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
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"healthEvents": [
{
"severity": "string",
"hostname": "string",
"instance": "string",
"subDomain": "string",
"domain": "string",
"description": "string",
"state": "string",
"timestamp": "string",
"status": "string"
}
],
"version": "string",
"hostName": "string",
"cimcaddress": [
"string"
]
}
"""
|
