cisco.dnac.clients_trend_analytics_v1 module – Resource module for Clients Trend Analytics V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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_trend_analytics_v1
.
New in cisco.dnac 6.15.0
Synopsis
Manage operation create of the resource Clients Trend Analytics V1.
Retrieves the trend analytics of client data for the specified time range. The data will be grouped based on the given trend time interval. This API facilitates obtaining consolidated insights into the performance and status of the clients over the specified start and end time. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst-center-api- specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml.
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 |
---|---|
Clients Trend Analytics’s aggregateAttributes. |
|
Function. |
|
Name. |
|
Attributes. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
End Time. |
|
Clients Trend Analytics’s filters. |
|
Key. |
|
Operator. |
|
Value. |
|
Group By. |
|
Additional headers. |
|
Clients Trend Analytics’s page. |
|
Cursor. |
|
Limit. |
|
Time Sort Order. |
|
Start Time. |
|
Trend Interval. |
|
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_trend_analytics_data_related_to_clients_v1,
Paths used are post /dna/data/api/v1/clients/trendAnalytics,
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 RetrievesTheTrendAnalyticsDataRelatedToClientsV1
Complete reference of the RetrievesTheTrendAnalyticsDataRelatedToClientsV1 API.
Examples
- name: Create
cisco.dnac.clients_trend_analytics_v1:
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
timeSortOrder: string
startTime: 0
trendInterval: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |