/ home / cisco / cisco.dnac / 6.13.3 / module / client_health_info

cisco.dnac.client_health_info (6.13.3) — module

Information module for Client 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 Client Health.

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

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
headers:
    description: Additional headers.
    type: dict

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

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

timestamp:
    description:
    - Timestamp query parameter. Epoch time(in milliseconds) when the Client health data
      is required.
    type: str

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

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

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
  elements: dict
  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"
  type: list