cisco.dnac.client_health_info module – Information module for Client Health

Note

This module is part of the cisco.dnac collection (version 6.6.0).

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.client_health_info.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Client Health.

  • Returns Overall Client Health information by Client type Wired and Wireless for any given point of time.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.5.4

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

headers

dictionary

Additional headers.

timestamp

string

Timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are clients.Clients.get_overall_client_health,

  • Paths used are get /dna/intent/api/v1/client-health,

  • Supports check_mode

  • The 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 Clients GetOverallClientHealth

Complete reference of the GetOverallClientHealth API.

Examples

- name: Get all Client Health
  cisco.dnac.client_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}}"
    timestamp: string
  register: result

Return Values

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

Key

Description

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: “[\n {\n \”siteId\”: \”string\”,\n \”scoreDetail\”: [\n {\n \”scoreCategory\”: {\n \”scoreCategory\”: \”string\”,\n \”value\”: \”string\”\n },\n \”scoreValue\”: 0,\n \”clientCount\”: 0,\n \”clientUniqueCount\”: 0,\n \”starttime\”: 0,\n \”endtime\”: 0,\n \”scoreList\”: [\n {\n \”scoreCategory\”: {\n \”scoreCategory\”: \”string\”,\n \”value\”: \”string\”\n },\n \”scoreValue\”: 0,\n \”clientCount\”: 0,\n \”clientUniqueCount\”: 0,\n \”starttime\”: 0,\n \”endtime\”: 0,\n \”scoreList\”: [\n {\n \”scoreCategory\”: {\n \”scoreCategory\”: \”string\”,\n \”value\”: \”string\”\n },\n \”scoreValue\”: 0,\n \”clientCount\”: 0,\n \”clientUniqueCount\”: {},\n \”starttime\”: 0,\n \”endtime\”: 0\n }\n ]\n }\n ]\n }\n ]\n }\n]\n”

Authors

  • Rafael Campos (@racampos)