racampos.dnac.site_health (0.0.1) — module

Manage SiteHealth objects of Sites

| "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 Health information for all sites.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_site_health
  cisco.dnac.site_health:
    state: query  # required
    timestamp: 1  #  integer
  register: query_result

Inputs

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

Outputs

get_site_health:
  contains: null
  description: Returns Overall Health information for all sites.
  response:
    contains:
      accessGoodCount:
        description: It is the site health's accessGoodCount.
        returned: always
        sample: <accessgoodcount>
        type: str
      accessTotalCount:
        description: It is the site health's accessTotalCount.
        returned: always
        sample: <accesstotalcount>
        type: str
      applicationBytesTotalCount:
        description: It is the site health's applicationBytesTotalCount.
        returned: always
        type: dict
      applicationGoodCount:
        description: It is the site health's applicationGoodCount.
        returned: always
        type: dict
      applicationHealth:
        description: It is the site health's applicationHealth.
        returned: always
        type: dict
      applicationTotalCount:
        description: It is the site health's applicationTotalCount.
        returned: always
        type: dict
      clientHealthWired:
        description: It is the site health's clientHealthWired.
        returned: always
        sample: <clienthealthwired>
        type: str
      clientHealthWireless:
        description: It is the site health's clientHealthWireless.
        returned: always
        type: dict
      clientIssueCount:
        description: It is the site health's clientIssueCount.
        returned: always
        type: dict
      clientNumberOfIssues:
        description: It is the site health's clientNumberOfIssues.
        returned: always
        type: dict
      coreGoodCount:
        description: It is the site health's coreGoodCount.
        returned: always
        sample: <coregoodcount>
        type: str
      coreTotalCount:
        description: It is the site health's coreTotalCount.
        returned: always
        sample: <coretotalcount>
        type: str
      distributionGoodCount:
        description: It is the site health's distributionGoodCount.
        returned: always
        sample: <distributiongoodcount>
        type: str
      distributionTotalCount:
        description: It is the site health's distributionTotalCount.
        returned: always
        sample: <distributiontotalcount>
        type: str
      healthyClientsPercentage:
        description: It is the site health's healthyClientsPercentage.
        returned: always
        sample: <healthyclientspercentage>
        type: str
      healthyNetworkDevicePercentage:
        description: It is the site health's healthyNetworkDevicePercentage.
        returned: always
        sample: <healthynetworkdevicepercentage>
        type: str
      latitude:
        description: It is the site health's latitude.
        returned: always
        type: dict
      longitude:
        description: It is the site health's longitude.
        returned: always
        type: dict
      networkHealthAccess:
        description: It is the site health's networkHealthAccess.
        returned: always
        sample: <networkhealthaccess>
        type: str
      networkHealthAverage:
        description: It is the site health's networkHealthAverage.
        returned: always
        type: dict
      networkHealthCore:
        description: It is the site health's networkHealthCore.
        returned: always
        sample: <networkhealthcore>
        type: str
      networkHealthDistribution:
        description: It is the site health's networkHealthDistribution.
        returned: always
        sample: <networkhealthdistribution>
        type: str
      networkHealthOthers:
        description: It is the site health's networkHealthOthers.
        returned: always
        type: dict
      networkHealthRouter:
        description: It is the site health's networkHealthRouter.
        returned: always
        sample: <networkhealthrouter>
        type: str
      networkHealthWireless:
        description: It is the site health's networkHealthWireless.
        returned: always
        type: dict
      networkNumberOfIssues:
        description: It is the site health's networkNumberOfIssues.
        returned: always
        type: dict
      numberOfClients:
        description: It is the site health's numberOfClients.
        returned: always
        sample: <numberofclients>
        type: str
      numberOfNetworkDevice:
        description: It is the site health's numberOfNetworkDevice.
        returned: always
        sample: <numberofnetworkdevice>
        type: str
      numberOfWiredClients:
        description: It is the site health's numberOfWiredClients.
        returned: always
        sample: <numberofwiredclients>
        type: str
      numberOfWirelessClients:
        description: It is the site health's numberOfWirelessClients.
        returned: always
        type: dict
      overallGoodDevices:
        description: It is the site health's overallGoodDevices.
        returned: always
        sample: <overallgooddevices>
        type: str
      parentSiteId:
        description: It is the site health's parentSiteId.
        returned: always
        sample: <parentsiteid>
        type: str
      parentSiteName:
        description: It is the site health's parentSiteName.
        returned: always
        sample: <parentsitename>
        type: str
      routerGoodCount:
        description: It is the site health's routerGoodCount.
        returned: always
        sample: <routergoodcount>
        type: str
      routerTotalCount:
        description: It is the site health's routerTotalCount.
        returned: always
        sample: <routertotalcount>
        type: str
      siteId:
        description: It is the site health's siteId.
        returned: always
        sample: <siteid>
        type: str
      siteName:
        description: It is the site health's siteName.
        returned: always
        sample: <sitename>
        type: str
      siteType:
        description: It is the site health's siteType.
        returned: always
        sample: <sitetype>
        type: str
      wiredGoodClients:
        description: It is the site health's wiredGoodClients.
        returned: always
        sample: <wiredgoodclients>
        type: str
      wirelessDeviceGoodCount:
        description: It is the site health's wirelessDeviceGoodCount.
        returned: always
        sample: <wirelessdevicegoodcount>
        type: str
      wirelessDeviceTotalCount:
        description: It is the site health's wirelessDeviceTotalCount.
        returned: always
        sample: <wirelessdevicetotalcount>
        type: str
      wirelessGoodClients:
        description: It is the site health's wirelessGoodClients.
        returned: always
        type: dict
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict

See also