.. Document meta
:orphan:
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. Anchors
.. _ansible_collections.cisco.dnac.site_health_info_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.site_health_info -- Information module for Site Health
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.1.7).
To install it use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.site_health_info`.
.. version_added
.. versionadded:: 1.0.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Get all Site Health.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-headers"></div>
<b>headers</b>
<a class="ansibleOptionLink" href="#parameter-headers" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Additional headers.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-timestamp"></div>
<b>timestamp</b>
<a class="ansibleOptionLink" href="#parameter-timestamp" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required.</div>
</td>
</tr>
</table>
<br/>
.. Attributes
.. Notes
.. Seealso
See Also
--------
.. seealso::
`Site Health reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Site Health object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Get all Site Health
cisco.dnac.site_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:
custom: value
timestamp: string
register: result
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=dictionary</span> </div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">[
{
"siteName": "string",
"siteId": "string",
"parentSiteId": "string",
"parentSiteName": "string",
"siteType": "string",
"latitude": 0,
"longitude": 0,
"healthyNetworkDevicePercentage": {},
"healthyClientsPercentage": {},
"clientHealthWired": {},
"clientHealthWireless": {},
"numberOfClients": {},
"numberOfNetworkDevice": {},
"networkHealthAverage": {},
"networkHealthAccess": {},
"networkHealthCore": {},
"networkHealthDistribution": {},
"networkHealthRouter": {},
"networkHealthWireless": {},
"networkHealthOthers": {},
"numberOfWiredClients": {},
"numberOfWirelessClients": {},
"totalNumberOfConnectedWiredClients": {},
"totalNumberOfActiveWirelessClients": {},
"wiredGoodClients": {},
"wirelessGoodClients": {},
"overallGoodDevices": {},
"accessGoodCount": {},
"accessTotalCount": {},
"coreGoodCount": {},
"coreTotalCount": {},
"distributionGoodCount": {},
"distributionTotalCount": {},
"routerGoodCount": {},
"routerTotalCount": {},
"wirelessDeviceGoodCount": {},
"wirelessDeviceTotalCount": {},
"applicationHealth": {},
"applicationGoodCount": {},
"applicationTotalCount": {},
"applicationBytesTotalCount": {},
"dnacInfo": {},
"applicationHealthStats": {
"appTotalCount": 0,
"businessRelevantAppCount": {
"poor": 0,
"fair": 0,
"good": 0
},
"businessIrrelevantAppCount": {
"poor": 0,
"fair": 0,
"good": 0
},
"defaultHealthAppCount": {
"poor": 0,
"fair": 0,
"good": 0
}
}
}
]</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors