.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create module -- Resource module for Network Devices Process Kpis Trend Analytics Create ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.12.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Network Devices Process Kpis Trend Analytics Create. - \> Retrieves the time series process kpis for group of processes in 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 process kpis of a specific process in 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-aggregateattributes: .. rst-class:: ansible-option-title **aggregateAttributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Network Devices Process Kpis Trend Analytics Create's aggregateAttributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-aggregateattributes/function: .. rst-class:: ansible-option-title **function** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of aggregate function to apply on the field when querying data. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-aggregateattributes/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported aggregated attributes related to ProcessKpis | Aggregate Function | Supported Aggregate Fields | | --- | --- | | \`min\` | pid, totalRunTime, cpuPercentage, memoryPercentage, memoryUsage, apCount | | \`max\` | pid, totalRunTime, cpuPercentage, memoryPercentage, memoryUsage, apCount | | \`avg\` | cpuPercentage, memoryPercentage, memoryUsage, apCount | | \`count\` | pid |. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-attributes: .. rst-class:: ansible-option-title **attributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Network Devices Process Kpis Trend Analytics Create's attributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Network Devices Process Kpis Trend Analytics Create's filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/filters/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/filters/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported filter attributes related to ProcessKpis. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/filters/logicaloperator: .. rst-class:: ansible-option-title **logicalOperator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/filters/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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 ProcessKpis response model. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported filter attributes related to ProcessKpis. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/logicaloperator: .. rst-class:: ansible-option-title **logicalOperator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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 ProcessKpis response model. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported filter attributes related to ProcessKpis. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/logicaloperator: .. rst-class:: ansible-option-title **logicalOperator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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 ProcessKpis response model. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported filter attributes related to ProcessKpis. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/logicaloperator: .. rst-class:: ansible-option-title **logicalOperator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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 ProcessKpis response model. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported filter attributes related to ProcessKpis. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/logicaloperator: .. rst-class:: ansible-option-title **logicalOperator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of filter operator to use for querying data | in and out operator takes multiple values and applies the filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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 ProcessKpis response model. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-groupby: .. rst-class:: ansible-option-title **groupBy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Network Devices Process Kpis Trend Analytics Create's groupBy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Process Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkDeviceId path parameter. Network Device UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-page: .. rst-class:: ansible-option-title **page** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Process Kpis Trend Analytics Create's page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-page/count: .. rst-class:: ansible-option-title **count** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of records returned after applying applicable filtering. Field is ignored for request and updated by API in the response. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-page/cursor: .. rst-class:: ansible-option-title **cursor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-page/limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of records to fetch in a page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-page/timesortorder: .. rst-class:: ansible-option-title **timeSortOrder** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sort order. 'asc' for ascending and 'desc' for descending. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-trendinterval: .. rst-class:: ansible-option-title **trendInterval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The time window to aggregate the metrics. Interval can be 5 minutes or 10 minutes or 1 hour or 1 day or 7 days. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are devices.Devices.retrieves\_specific\_process\_kpis\_for\_a\_process\_in\_wlc\_over\_a\_specified\_period\_of\_time, - Paths used are post /dna/data/api/v1/networkDevices/{networkDeviceId}/processKpis/trendAnalytics, post /dna/data/api/v1/networkDevices/{networkDeviceId}/processKpis/{id}/trendAnalytics, - Does not support \ :literal:`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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Devices RetrievesGroupOfProcessesKpisInWLCOverASpecifiedPeriodOfTime `_ Complete reference of the RetrievesGroupOfProcessesKpisInWLCOverASpecifiedPeriodOfTime API. `Cisco Catalyst Center documentation for Devices RetrievesSpecificProcessKpisForAProcessInWLCOverASpecifiedPeriodOfTime `_ Complete reference of the RetrievesSpecificProcessKpisForAProcessInWLCOverASpecifiedPeriodOfTime API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.network_devices_process_kpis_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 networkDeviceId: string page: count: 0 cursor: string limit: 0 timeSortOrder: string startTime: 0 trendInterval: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_process_kpis_trend_analytics_create_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`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"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors