cisco.dnac.applications_health_v1_info module – Information module for Applications Health V1
Note
This module is part of the cisco.dnac collection (version 6.25.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.applications_health_v1_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Applications Health V1.
Intent API to get a list of applications for a specific site, a device, or a client device’s MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
ApplicationHealth query parameter. Application health category (POOR, FAIR, or GOOD. Optionally use with siteId only). |
|
ApplicationName query parameter. The name of the application to get information on. |
|
DeviceId query parameter. Assurance device UUID value (Cannot be submitted together with siteId and clientMac). |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
EndTime query parameter. Ending epoch time in milliseconds of time window. |
|
Additional headers. |
|
Limit query parameter. The max number of application entries in returned data 1, 1000 (optionally used with siteId only). |
|
MacAddress query parameter. Client device’s MAC address (Cannot be submitted together with siteId and deviceId). |
|
Offset query parameter. The offset of the first application in the returned data (optionally used with siteId only). |
|
SiteId query parameter. Assurance site UUID value (Cannot be submitted together with deviceId and clientMac). |
|
StartTime query parameter. Starting epoch time in milliseconds of time window. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are applications.Applications.applications_v1,
Paths used are get /dna/intent/api/v1/application-health,
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Applications ApplicationsV1
Complete reference of the ApplicationsV1 API.
Examples
- name: Get all Applications Health V1
cisco.dnac.applications_health_v1_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}}"
siteId: string
deviceId: string
macAddress: string
startTime: 0
endTime: 0
applicationHealth: string
offset: 0
limit: 0
applicationName: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |