cisco.catalystcenter.wireless_controllers_stats_trend_analytics_create module -- Resource module for Wireless Controllers Stats Trend Analytics Create

Note

This module is part of the cisco.catalystcenter collection (version 2.12.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.wireless_controllers_stats_trend_analytics_create.

New in cisco.catalystcenter 2.11.0

Synopsis 

Manage operation create of the resource Wireless Controllers Stats Trend Analytics Create. - > Retrieves the time series stats of a specific WLC by applying complex filters, aggregate functions, and grouping. The data will be grouped based on the specified trend time interval. If startTime and endTime are not provided, the API defaults to the last 24 hours. - > Retrieves the time series stats of a specific WLC by applying complex filters, aggregate functions, and grouping. The data will be grouped based on the specified trend time interval. If startTime and endTime are not provided, the API defaults to the last 24 hours.

Note

This module has a corresponding action plugin.

Requirements 

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

catalystcentersdk >= 3.2.3.0.0
python >= 3.12

Parameters 

Parameter	Comments
aggregateAttributes list / elements=dictionary	Wireless Controllers Stats Trend Analytics Create's aggregateAttributes.
function string	Type of aggregate function to apply on the field when querying data.
name string	Supported aggregated attributes related to WlcStats All the aggregate attributes support min, max, avg, sum functions.
attributes list / elements=string	Wireless Controllers Stats Trend Analytics Create's attributes.
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
endTime integer	End time to which the API queries the dataset related to the resource. It must be specified in terms of milliseconds since UNIX epoch. Value is inclusive.
filters list / elements=dictionary	Wireless Controllers Stats Trend Analytics Create's filters.
filters list / elements=dictionary	Nested array of filters in case of AND/OR based filters. Only one level of nesting will be supported. Structure of nested filter is the same as parent with all operators supported except AND or OR.
filters list / elements=dictionary	Nested array of filters in case of AND/OR based filters. Only one level of nesting will be supported. Structure of nested filter is the same as parent with all operators supported except AND or OR.
filters list / elements=dictionary	Nested array of filters in case of AND/OR based filters. Only one level of nesting will be supported. Structure of nested filter is the same as parent with all operators supported except AND or OR.
filters list / elements=dictionary	Nested array of filters in case of AND/OR based filters. Only one level of nesting will be supported. Structure of nested filter is the same as parent with all operators supported except AND or OR.
filters list / elements=dictionary	Nested array of filters in case of AND/OR based filters. Only one level of nesting will be supported. Structure of nested filter is the same as parent with all operators supported except AND or OR.
key string	Supported filter attributes related to WlcStats.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Field value(s) to filter the data set. Array of values is used for "in" or "out" operator. Values will be of whatever type the specific field being filtered is defined with. For other operators, filter value is of whatever type the specific field being filtered is defined with. In the case of an "and" or "or" operator, this values array will be ignored, and the values arrays in each of the nested filters will be used. The data type of a value, or each item inside the value in case it is a list, must match the type defined in the WlcStats response model.
key string	Supported filter attributes related to WlcStats.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Field value(s) to filter the data set. Array of values is used for "in" or "out" operator. Values will be of whatever type the specific field being filtered is defined with. For other operators, filter value is of whatever type the specific field being filtered is defined with. In the case of an "and" or "or" operator, this values array will be ignored, and the values arrays in each of the nested filters will be used. The data type of a value, or each item inside the value in case it is a list, must match the type defined in the WlcStats response model.
key string	Supported filter attributes related to WlcStats.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Field value(s) to filter the data set. Array of values is used for "in" or "out" operator. Values will be of whatever type the specific field being filtered is defined with. For other operators, filter value is of whatever type the specific field being filtered is defined with. In the case of an "and" or "or" operator, this values array will be ignored, and the values arrays in each of the nested filters will be used. The data type of a value, or each item inside the value in case it is a list, must match the type defined in the WlcStats response model.
key string	Supported filter attributes related to WlcStats.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Field value(s) to filter the data set. Array of values is used for "in" or "out" operator. Values will be of whatever type the specific field being filtered is defined with. For other operators, filter value is of whatever type the specific field being filtered is defined with. In the case of an "and" or "or" operator, this values array will be ignored, and the values arrays in each of the nested filters will be used. The data type of a value, or each item inside the value in case it is a list, must match the type defined in the WlcStats response model.
key string	Supported filter attributes related to WlcStats.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Field value(s) to filter the data set. Array of values is used for "in" or "out" operator. Values will be of whatever type the specific field being filtered is defined with. For other operators, filter value is of whatever type the specific field being filtered is defined with. In the case of an "and" or "or" operator, this values array will be ignored, and the values arrays in each of the nested filters will be used. The data type of a value, or each item inside the value in case it is a list, must match the type defined in the WlcStats response model.
groupBy list / elements=string	Wireless Controllers Stats Trend Analytics Create's groupBy.
headers dictionary	Additional headers.
id string	Id path parameter. The WLC device UUID.
page dictionary	Wireless Controllers Stats Trend Analytics Create's page.
count integer	Number of records returned after applying applicable filtering. Field is ignored for request and updated by API in the response.
cursor string	It's an opaque string field that indicates the next record in the requested collection. If no records remain, the API returns a response with a count of zero. The default value is an empty string, and the initial value must be an empty string. The cursor value is populated by the API in the response page block. If the user wants more records, the cursor in the subsequent request must be updated with the value from the previous response.
limit integer	Number of records to fetch in a page.
timeSortOrder string	Sort order. 'asc' for ascending and 'desc' for descending.
startTime integer	Start time from which the API queries the dataset related to the resource. It must be specified in terms of milliseconds since UNIX epoch. Value is inclusive.
trendInterval string	The time window to aggregate the metrics. Interval can be 5 minutes or 10 minutes or 1 hour or 1 day or 7 days.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes 

Note

SDK Method used are devices.Devices.retrieves_specific_stats_for_a_wlc_over_a_specified_period_of_time_know_your_network,
Paths used are post /dna/data/api/v1/wirelessControllersStats/trendAnalytics, post /dna/data/api/v1/wirelessControllersStats/{id}/trendAnalytics,
Does not support check_mode
The plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

Examples 

---
- name: Create
  cisco.catalystcenter.wireless_controllers_stats_trend_analytics_create:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    aggregateAttributes:
      - function: string
        name: string
    attributes:
      - string
    endTime: 0
    filters:
      - filters:
          - filters:
              - filters:
                  - filters:
                      - filters:
                          - {}
                        key: string
                        logicalOperator: string
                        operator: string
                        value: {}
                    key: string
                    logicalOperator: string
                    operator: string
                    value: {}
                key: string
                logicalOperator: string
                operator: string
                value: {}
            key: string
            logicalOperator: string
            operator: string
            value: {}
        key: string
        logicalOperator: string
        operator: string
        value: {}
    groupBy:
      - string
    headers: '{{my_headers | from_json}}'
    id: string
    page:
      count: 0
      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

catalystcenter_response

dictionary

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

Returned: always

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

Authors

Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)

cisco.catalystcenter.wireless_controllers_stats_trend_analytics_create module -- Resource module for Wireless Controllers Stats Trend Analytics Create

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 