/ home / cisco / cisco.dnac / 6.13.3 / module / applications_health_info

cisco.dnac.applications_health_info (6.13.3) — module

Information module for Applications Health

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Applications Health.

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.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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: "{{my_headers | from_json}}"
    siteId: string
    deviceId: string
    macAddress: string
    startTime: 0
    endTime: 0
    applicationHealth: string
    offset: 0
    limit: 0
    applicationName: string
  register: result

Inputs

limit:
description:
- 'Limit query parameter. The max number of application entries in returned data 1,
1000 (optionally used with siteId only).

'
type: int

offset:
description:
- 'Offset query parameter. The offset of the first application in the returned data
(optionally used with siteId only).

'
type: int

siteId:
description:
- SiteId query parameter. Assurance site UUID value (Cannot be submitted together
with deviceId and clientMac).
type: str

endTime:
description:
- EndTime query parameter. Ending epoch time in milliseconds of time window.
type: int

headers:
description: Additional headers.
type: dict

deviceId:
description:
- DeviceId query parameter. Assurance device UUID value (Cannot be submitted together
with siteId and clientMac).
type: str

dnac_host:
description:
- The Cisco DNA Center hostname.
required: true
type: str

dnac_port:
default: 443
description:
- The Cisco DNA Center port.
type: int

startTime:
description:
- StartTime query parameter. Starting epoch time in milliseconds of time window.
type: int

dnac_debug:
default: false
description:
- Flag for Cisco DNA Center SDK to enable debugging.
type: bool

macAddress:
description:
- MacAddress query parameter. Client device's MAC address (Cannot be submitted together
with siteId and deviceId).
type: str

dnac_verify:
default: true
description:
- Flag to enable or disable SSL certificate verification.
type: bool

dnac_version:
default: 2.3.5.3
description:
- Informs the SDK which version of Cisco DNA Center to use.
type: str

dnac_password:
description:
- The Cisco DNA Center password to authenticate.
type: str

dnac_username:
aliases:
- user
default: admin
description:
- The Cisco DNA Center username to authenticate.
type: str

applicationName:
description:
- ApplicationName query parameter. The name of the application to get information
on.
type: str

applicationHealth:
description:
- 'ApplicationHealth query parameter. Application health category (POOR, FAIR, or
GOOD. Optionally use with siteId only).

'
type: str

validate_response_schema:
default: true
description:
- Flag for Cisco DNA Center SDK to enable the validation of request bodies against
a JSON schema.
type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"version\": \"string\",\n  \"totalCount\": 0,\n  \"response\": [\n\
    \    {\n      \"name\": \"string\",\n      \"health\": 0,\n      \"businessRelevance\"\
    : \"string\",\n      \"trafficClass\": \"string\",\n      \"usageBytes\": 0,\n\
    \      \"averageThroughput\": 0,\n      \"packetLossPercent\": {},\n      \"networkLatency\"\
    : {},\n      \"jitter\": {},\n      \"applicationServerLatency\": {},\n      \"\
    clientNetworkLatency\": {},\n      \"serverNetworkLatency\": {},\n      \"exporterIpAddress\"\
    : \"string\",\n      \"exporterName\": \"string\",\n      \"exporterUUID\": \"\
    string\",\n      \"exporterFamily\": \"string\",\n      \"clientName\": \"string\"\
    ,\n      \"clientIp\": \"string\",\n      \"location\": \"string\",\n      \"\
    operatingSystem\": \"string\",\n      \"deviceType\": \"string\",\n      \"clientMacAddress\"\
    : \"string\",\n      \"issueId\": \"string\",\n      \"issueName\": \"string\"\
    ,\n      \"application\": \"string\",\n      \"severity\": \"string\",\n     \
    \ \"summary\": \"string\",\n      \"rootCause\": \"string\",\n      \"timestamp\"\
    : 0,\n      \"occurrences\": 0,\n      \"priority\": \"string\"\n    }\n  ]\n\
    }\n"
  type: dict