/ home / cisco / cisco.dnac / 6.13.3 / module / topology_network_health_info

cisco.dnac.topology_network_health_info (6.13.3) — module

Information module for Topology Network Health

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Topology Network Health.

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

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Topology Network Health
  cisco.dnac.topology_network_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}}"
    timestamp: string
  register: result

Inputs

    
headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

timestamp:
    description:
    - Timestamp query parameter. Epoch time(in milliseconds) when the Network health data
      is required.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"version\": \"string\",\n  \"response\": [\n    {\n      \"time\"\
    : \"string\",\n      \"healthScore\": 0,\n      \"totalCount\": 0,\n      \"goodCount\"\
    : 0,\n      \"unmonCount\": 0,\n      \"fairCount\": 0,\n      \"badCount\": 0,\n\
    \      \"entity\": {},\n      \"timeinMillis\": 0\n    }\n  ],\n  \"measuredBy\"\
    : \"string\",\n  \"latestMeasuredByEntity\": {},\n  \"latestHealthScore\": 0,\n\
    \  \"monitoredDevices\": 0,\n  \"monitoredHealthyDevices\": 0,\n  \"monitoredUnHealthyDevices\"\
    : 0,\n  \"unMonitoredDevices\": 0,\n  \"healthDistirubution\": [\n    {\n    \
    \  \"category\": \"string\",\n      \"totalCount\": 0,\n      \"healthScore\"\
    : 0,\n      \"goodPercentage\": 0,\n      \"badPercentage\": 0,\n      \"fairPercentage\"\
    : 0,\n      \"unmonPercentage\": 0,\n      \"goodCount\": 0,\n      \"badCount\"\
    : 0,\n      \"fairCount\": 0,\n      \"unmonCount\": 0,\n      \"kpiMetrics\"\
    : [\n        {}\n      ]\n    }\n  ]\n}\n"
  type: dict