cisco.catalystcenter.energy_summary_analytics module -- Resource module for Energy Summary Analytics

Note

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

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

New in cisco.catalystcenter 6.18.0

Synopsis

  • Manage operation create of the resource Energy Summary Analytics. - > Retrieve the summary 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 action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

aggregateAttributes

list / elements=dictionary

Energy Summary Analytics's aggregateAttributes.

function

string

Function.

name

string

Name.

attributes

list / elements=string

Attributes.

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

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

filters

list / elements=dictionary

Energy Summary Analytics's filters.

filters

list / elements=dictionary

Energy Summary Analytics's filters.

key

string

Key.

operator

string

Operator.

value

list / elements=string

Value.

logicalOperator

string

Logical Operator.

groupBy

list / elements=string

Group By.

headers

dictionary

Additional headers.

page

dictionary

Energy Summary Analytics's page.

limit

integer

Limit.

offset

integer

Offset.

sortBy

list / elements=dictionary

Energy Summary Analytics's sortBy.

function

string

Function.

name

string

Name.

order

string

Order.

startTime

integer

Start Time.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are know_your_network.KnowYourNetwork.get_energy_summary_analytics,

  • Paths used are post /dna/data/api/v1/energy/summaryAnalytics,

  • 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

See Also

See also

Cisco DNA Center documentation for Know Your Network GetEnergySummaryAnalytics

Complete reference of the GetEnergySummaryAnalytics API.

Examples

---
- name: Create
  cisco.catalystcenter.energy_summary_analytics:
    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:
          - key: string
            operator: string
            value:
              - string
        logicalOperator: string
    groupBy:
      - string
    headers: '{{my_headers | from_json}}'
    page:
      limit: 0
      offset: 0
      sortBy:
        - function: string
          name: string
          order: string
    startTime: 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, "limit": 0, "offset": 0, "sortBy": [{"function": "string", "name": "string", "order": "string"}]}, "response": {"groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": "string"}], "id": "string"}]}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)