racampos.dnac.client_health (0.0.1) — module

Manage ClientHealth objects of Clients

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_overall_client_health
  cisco.dnac.client_health:
    state: query  # required
    timestamp: 1  #  integer
  register: query_result

Inputs

    
timestamp:
    description:
    - Epoch time(in milliseconds) when the Client health data is required.
    type: int

Outputs

get_overall_client_health:
  contains: null
  description: Returns Overall Client Health information by Client type (Wired and
    Wireless) for any given point of time.
  response:
    contains:
      scoreDetail:
        contains:
          clientCount:
            description: It is the client health's clientCount.
            returned: always
            sample: 0
            type: int
          clientUniqueCount:
            description: It is the client health's clientUniqueCount.
            returned: always
            sample: 0
            type: int
          endtime:
            description: It is the client health's endtime.
            returned: always
            sample: 0
            type: int
          scoreCategory:
            contains:
              scoreCategory:
                description: It is the client health's scoreCategory.
                returned: always
                sample: <scorecategory>
                type: str
              value:
                description: It is the client health's value.
                returned: always
                sample: <value>
                type: str
            description: It is the client health's scoreCategory.
            returned: always
            type: dict
          scoreList:
            contains:
              clientCount:
                description: It is the client health's clientCount.
                returned: always
                sample: 0
                type: int
              clientUniqueCount:
                description: It is the client health's clientUniqueCount.
                returned: always
                sample: 0
                type: int
              endtime:
                description: It is the client health's endtime.
                returned: always
                sample: 0
                type: int
              scoreCategory:
                contains:
                  scoreCategory:
                    description: It is the client health's scoreCategory.
                    returned: always
                    sample: <scorecategory>
                    type: str
                  value:
                    description: It is the client health's value.
                    returned: always
                    sample: <value>
                    type: str
                description: It is the client health's scoreCategory.
                returned: always
                type: dict
              scoreList:
                contains:
                  clientCount:
                    description: It is the client health's clientCount.
                    returned: always
                    sample: 0
                    type: int
                  clientUniqueCount:
                    description: It is the client health's clientUniqueCount.
                    returned: always
                    type: dict
                  endtime:
                    description: It is the client health's endtime.
                    returned: always
                    sample: 0
                    type: int
                  scoreCategory:
                    contains:
                      scoreCategory:
                        description: It is the client health's scoreCategory.
                        returned: always
                        sample: <scorecategory>
                        type: str
                      value:
                        description: It is the client health's value.
                        returned: always
                        sample: <value>
                        type: str
                    description: It is the client health's scoreCategory.
                    returned: always
                    type: dict
                  scoreValue:
                    description: It is the client health's scoreValue.
                    returned: always
                    sample: 0
                    type: int
                  starttime:
                    description: It is the client health's starttime.
                    returned: always
                    sample: 0
                    type: int
                description: It is the client health's scoreList.
                returned: always
                type: list
              scoreValue:
                description: It is the client health's scoreValue.
                returned: always
                sample: 0
                type: int
              starttime:
                description: It is the client health's starttime.
                returned: always
                sample: 0
                type: int
            description: It is the client health's scoreList.
            returned: always
            type: list
          scoreValue:
            description: It is the client health's scoreValue.
            returned: always
            sample: 0
            type: int
          starttime:
            description: It is the client health's starttime.
            returned: always
            sample: 0
            type: int
        description: It is the client health's scoreDetail.
        returned: always
        type: list
      siteId:
        description: It is the client health's siteId.
        returned: always
        sample: <siteid>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict

See also