cisco.dnac.applications_health_info – Information module for Applications Health

Note

This plugin is part of the cisco.dnac collection (version 3.2.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.applications_health_info.

New in version 3.1.0: of cisco.dnac

Synopsis

• Get all Applications Health.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.3.1

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
applicationHealth string		ApplicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only).
deviceId string		DeviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac).
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.2.3"	Informs the SDK which version of Cisco DNA Center to use.
endTime integer		EndTime query parameter. Ending epoch time in milliseconds of time window.
headers dictionary		Additional headers.
limit integer		Limit query parameter. The max number of application entries in returned data 1, 1000 (optionally used with siteId only).
macAddress string		MacAddress query parameter. Client device's MAC address (Cannot be submitted together with siteId and deviceId).
offset integer		Offset query parameter. The offset of the first application in the returned data (optionally used with siteId only).
siteId string		SiteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac).
startTime integer		StartTime query parameter. Starting epoch time in milliseconds of time window.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• Supports check_mode

See Also

See also

Applications Health reference

Complete reference of the Applications Health object model.

Examples

- name: Get all Applications Health
  cisco.dnac.applications_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
    siteId: string
    deviceId: string
    macAddress: string
    startTime: 0
    endTime: 0
    applicationHealth: string
    offset: 0
    limit: 0
  register: result

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "version": "string", "totalCount": 0, "response": [ { "name": "string", "health": {}, "businessRelevance": "string", "trafficClass": "string", "usageBytes": 0, "averageThroughput": 0, "packetLossPercent": {}, "networkLatency": {}, "jitter": {}, "applicationServerLatency": {}, "clientNetworkLatency": {}, "serverNetworkLatency": {} } ] }

Authors

• Rafael Campos (@racampos)