cisco.dnac.system_health_info – Information module for System Health

Note

This plugin is part of the cisco.dnac collection (version 3.1.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.system_health_info.

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all System Health.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
domain string		Domain query parameter. Fetch system events with this domain. Possible values of domain are listed here /dna/platform/app/consumer-portal/developer-toolkit/events.
limit integer		Limit query parameter.
offset integer		Offset query parameter.
subdomain string		Subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here /dna/platform/app/consumer-portal/developer-toolkit/events.
summary boolean	Choices: no yes	Summary query parameter. Fetch the latest high severity event.

See Also

See also

System Health reference

Complete reference of the System Health object model.

Examples

- 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}}"
    summary: True
    domain: string
    subdomain: string
    limit: 0
    offset: 0
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "healthEvents": [ { "severity": "string", "hostname": "string", "instance": "string", "subDomain": "string", "domain": "string", "description": "string", "state": "string", "timestamp": "string", "status": "string" } ], "version": "string", "hostName": "string" }

Authors

• Rafael Campos (@racampos)