.. 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.energy_trend_analytics_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.energy_trend_analytics module -- Resource module for Energy Trend Analytics ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.2.1). 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.energy_trend_analytics`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 6.18.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Energy Trend Analytics. - \> Retrieve the energy trend analytics data related to device energy consumption for all devices, including network devices and clients assigned to specific sites. 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-deviceEnergy\_1.0-1.0.1-resolved.yaml. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.1.3.0.0 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Energy Trend Analytics's aggregateAttributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Function. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Attributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_module__parameter-catc_api_port: .. rst-class:: ansible-option-title **catc_api_port** .. raw:: html .. 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.energy_trend_analytics_module__parameter-catc_debug: .. rst-class:: ansible-option-title **catc_debug** .. raw:: html .. 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.energy_trend_analytics_module__parameter-catc_host: .. rst-class:: ansible-option-title **catc_host** .. raw:: html .. 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.energy_trend_analytics_module__parameter-catc_password: .. rst-class:: ansible-option-title **catc_password** .. raw:: html .. 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.energy_trend_analytics_module__parameter-catc_username: .. rst-class:: ansible-option-title **catc_username** .. raw:: html .. 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.energy_trend_analytics_module__parameter-catc_verify: .. rst-class:: ansible-option-title **catc_verify** .. raw:: html .. 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.energy_trend_analytics_module__parameter-catc_version: .. rst-class:: ansible-option-title **catc_version** .. raw:: html .. 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:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Energy Trend Analytics's filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Energy Trend Analytics's filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Operator. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_module__parameter-filters/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Logical Operator. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Group By. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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.energy_trend_analytics_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
Energy Trend Analytics's page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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
Limit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_module__parameter-page/offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Offset. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_module__parameter-page/timestamporder: .. rst-class:: ansible-option-title **timestampOrder** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Timestamp Order. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.energy_trend_analytics_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 know\_your\_network.KnowYourNetwork.get\_energy\_trend\_analytics, - Paths used are post /dna/data/api/v1/energy/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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Know Your Network GetEnergyTrendAnalytics `_ Complete reference of the GetEnergyTrendAnalytics API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.energy_trend_analytics: catc_host: "{{catc_host}}" catc_username: "{{catc_username}}" catc_password: "{{catc_password}}" catc_verify: "{{catc_verify}}" catc_api_port: "{{catc_api_port}}" catc_version: "{{catc_version}}" catc_debug: "{{catc_debug}}" aggregateAttributes: - function: string name: string attributes: - string endTime: 0 filters: - filters: - key: string operator: string value: - string logicalOperator: string groupBy: - string headers: '{{my_headers | from_json}}' page: limit: 0 offset: 0 timestampOrder: string startTime: 0 .. 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.energy_trend_analytics_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_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 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, "limit": 0, "offset": 0, "timestampOrder": "string"}, "response": [{"groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": "string"}], "id": "string"}], "timestamp": 0}], "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors