cisco.catalystcenter.topology_network_health_info module -- Information module for Topology Network Health

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.topology_network_health_info.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Topology Network Health. - > 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.

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

timestamp

float

Timestamp query parameter. UTC timestamp of network health data in milliseconds.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are topology.Topology.get_overall_network_health,

  • Paths used are get /dna/intent/api/v1/network-health,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Topology GetOverallNetworkHealth

Complete reference of the GetOverallNetworkHealth API.

Examples

---
- name: Get all Topology Network Health
  cisco.catalystcenter.topology_network_health_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    timestamp: 0
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"healthContributingDevices": 0, "healthDistirubution": [{"badCount": 0, "badPercentage": 0, "category": "string", "fairCount": 0, "fairPercentage": 0, "goodCount": 0, "goodPercentage": 0, "healthScore": 0, "kpiMetrics": [{"key": "string", "value": "string"}], "noHealthCount": 0, "noHealthPercentage": 0, "thirdPartyDeviceCount": 0, "totalCount": 0, "unmonCount": 0, "unmonPercentage": 0}], "latestHealthScore": 0, "latestMeasuredByEntity": "string", "measuredBy": "string", "monitoredDevices": 0, "monitoredFairHealthDevices": 0, "monitoredHealthyDevices": 0, "monitoredPoorHealthDevices": 0, "monitoredUnHealthyDevices": 0, "noHealthDevices": 0, "response": [{"badCount": 0, "entity": "string", "fairCount": 0, "goodCount": 0, "healthScore": 0, "maintenanceModeCount": 0, "noHealthCount": 0, "time": "string", "timeinMillis": 0, "totalCount": 0, "unmonCount": 0}], "totalDevices": 0, "unMonitoredDevices": 0, "version": "string"}`

Authors

  • Rafael Campos (@racampos)