Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/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_count_info
short_description: Information module for System Health Count
description:
- Get all System Health Count.
- This API gives the count of 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
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
requirements:
- dnacentersdk >= 2.4.9
- python >= 3.5
notes:
- SDK Method used are
health_and_performance.HealthAndPerformance.system_health_count,
- Paths used are
get /dna/intent/api/v1/diagnostics/system/health/count,
"""
EXAMPLES = r"""
- name: Get all System Health Count
cisco.dnac.system_health_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:
custom: value
domain: string
subdomain: string
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: >
{
"count": 0
}
"""