/ home / racampos / racampos.dnac / 0.0.1 / module / network_health

racampos.dnac.network_health (0.0.1) — module

Manage NetworkHealth objects of Topology

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

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

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

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

Inputs

    
timestamp:
    description:
    - Epoch time(in milliseconds) when the Network health data is required.
    type: int

Outputs

get_overall_network_health:
  contains: null
  description: Returns Overall Network Health information by Device category (Access,
    Distribution, Core, Router, Wireless) for any given point of time.
  healthDistirubution:
    contains:
      badCount:
        description: It is the network health's badCount.
        returned: always
        sample: 0
        type: int
      badPercentage:
        description: It is the network health's badPercentage.
        returned: always
        sample: 0
        type: int
      category:
        description: It is the network health's category.
        returned: always
        sample: <category>
        type: str
      fairCount:
        description: It is the network health's fairCount.
        returned: always
        sample: 0
        type: int
      fairPercentage:
        description: It is the network health's fairPercentage.
        returned: always
        sample: 0
        type: int
      goodCount:
        description: It is the network health's goodCount.
        returned: always
        sample: 0
        type: int
      goodPercentage:
        description: It is the network health's goodPercentage.
        returned: always
        sample: 0
        type: int
      healthScore:
        description: It is the network health's healthScore.
        returned: always
        sample: 0
        type: int
      kpiMetrics:
        description: It is the network health's kpiMetrics.
        returned: always
        type: list
      totalCount:
        description: It is the network health's totalCount.
        returned: always
        sample: 0
        type: int
      unmonCount:
        description: It is the network health's unmonCount.
        returned: always
        sample: 0
        type: int
      unmonPercentage:
        description: It is the network health's unmonPercentage.
        returned: always
        sample: 0
        type: int
    description: Health Distirubution, property of the response body (list of objects).
    returned: always
    type: list
  latestHealthScore:
    description: LatestHealthScore, property of the response body.
    returned: always
    sample: 0
    type: int
  latestMeasuredByEntity:
    description: Latest Measured By Entity, property of the response body.
    returned: always
    type: dict
  measuredBy:
    description: Measured By, property of the response body.
    returned: always
    sample: <measuredby>
    type: str
  monitoredDevices:
    description: MonitoredDevices, property of the response body.
    returned: always
    sample: 0
    type: int
  monitoredHealthyDevices:
    description: MonitoredHealthyDevices, property of the response body.
    returned: always
    sample: 0
    type: int
  monitoredUnHealthyDevices:
    description: MonitoredUnHealthyDevices, property of the response body.
    returned: always
    sample: 0
    type: int
  response:
    contains:
      badCount:
        description: It is the network health's badCount.
        returned: always
        sample: 0
        type: int
      entity:
        description: It is the network health's entity.
        returned: always
        type: dict
      fairCount:
        description: It is the network health's fairCount.
        returned: always
        sample: 0
        type: int
      goodCount:
        description: It is the network health's goodCount.
        returned: always
        sample: 0
        type: int
      healthScore:
        description: It is the network health's healthScore.
        returned: always
        sample: 0
        type: int
      time:
        description: It is the network health's time.
        returned: always
        sample: <time>
        type: str
      timeinMillis:
        description: It is the network health's timeinMillis.
        returned: always
        sample: 0
        type: int
      totalCount:
        description: It is the network health's totalCount.
        returned: always
        sample: 0
        type: int
      unmonCount:
        description: It is the network health's unmonCount.
        returned: always
        sample: 0
        type: int
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  unMonitoredDevices:
    description: UnMonitoredDevices, property of the response body.
    returned: always
    sample: 0
    type: int
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str