cisco.dnac.network_health – Manage NetworkHealth objects of Topology

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time.

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
timestamp
integer
Epoch time(in milliseconds) when the Network health data is required.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_health

The official documentation on the cisco.dnac.plugins.module_utils.definitions.network_health module.

NetworkHealth reference

Complete reference of the NetworkHealth object model.

NetworkHealth reference

SDK reference.

Examples

- name: get_overall_network_health
  cisco.dnac.network_health:
    state: query  # required
    timestamp: 1  #  integer
  register: nm_get_overall_network_health

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 with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
topology.get_overall_network_health


Authors

  • Rafael Campos (@racampos)