cisco.dnac.clients_top_n_analytics module -- Resource module for Clients Top N Analytics

Note

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

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

New in cisco.dnac 6.15.0

Synopsis

  • This module represents an alias of the module clients_top_n_analytics_v1

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

aggregateAttributes

list / elements=dictionary

Clients Top N Analytics's aggregateAttributes.

function

string

Function.

name

string

Name.

attributes

list / elements=string

Attributes.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

endTime

integer

End Time.

filters

list / elements=dictionary

Clients Top N Analytics's filters.

key

string

Key.

operator

string

Operator.

value

integer

Value.

groupBy

list / elements=string

Group By.

headers

dictionary

Additional headers.

page

dictionary

Clients Top N Analytics's page.

cursor

string

Cursor.

limit

integer

Limit.

sortBy

list / elements=dictionary

Clients Top N Analytics's sortBy.

name

string

Name.

order

string

Order.

startTime

integer

Start Time.

topN

integer

Top N.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are clients.Clients.retrieves_the_top_n_analytics_data_related_to_clients_v1,

  • Paths used are post /dna/data/api/v1/clients/topNAnalytics,

  • It should be noted that this module is an alias of clients_top_n_analytics_v1

  • Does not support 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 RetrievesTheTopNAnalyticsDataRelatedToClientsV1

Complete reference of the RetrievesTheTopNAnalyticsDataRelatedToClientsV1 API.

Examples

- name: Create
  cisco.dnac.clients_top_n_analytics:
    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}}"
    aggregateAttributes:
    - function: string
      name: string
    attributes:
    - string
    endTime: 0
    filters:
    - key: string
      operator: string
      value: 0
    groupBy:
    - string
    headers: '{{my_headers | from_json}}'
    page:
      cursor: string
      limit: 0
      sortBy:
      - name: string
        order: string
    startTime: 0
    topN: 0

Return Values

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

Key

Description

dnac_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"page": {"count": 0, "cursor": "string", "limit": 0, "sortBy": [{"name": "string", "order": "string"}]}, "response": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": 0}], "id": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)