cisco.catalystcenter.energy_clients_query_count module -- Resource module for Energy Clients Query Count

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

New in cisco.catalystcenter 2.2.0

Synopsis

• Manage operation create of the resource Energy Clients Query Count. - > Retrieves the total count of client devices based on the specified complex filters. 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.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
aggregateAttributes list / elements=dictionary	Energy Clients Query Count's aggregateAttributes.
function string	Energy Clients Query Count's function.
name string	Energy Clients Query Count's name.
attributes list / elements=string	Energy Clients Query Count'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	Energy Clients Query Count's endTime.
filters list / elements=dictionary	Energy Clients Query Count's filters.
filters list / elements=dictionary	Energy Clients Query Count's filters.
key string	Energy Clients Query Count's key.
operator string	Energy Clients Query Count's operator.
value list / elements=string	Energy Clients Query Count's value.
logicalOperator string	Energy Clients Query Count's logicalOperator.
headers dictionary	Additional headers.
page dictionary	Energy Clients Query Count's page.
limit integer	Energy Clients Query Count's limit.
offset integer	Energy Clients Query Count's offset.
sortBy list / elements=dictionary	Energy Clients Query Count's sortBy.
function string	Energy Clients Query Count's function.
name string	Energy Clients Query Count's name.
order string	Energy Clients Query Count's order.
startTime integer	Energy Clients Query Count's startTime.
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)
views list / elements=string	Energy Clients Query Count's views.

Notes

Note

• SDK Method used are clients.Clients.count_clients_energy_from_query,

• Paths used are post /dna/data/api/v1/energy/clients/query/count,

• 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)

See Also

See also

Cisco Catalyst Center documentation for Clients CountClientsEnergyFromQuery

Complete reference of the CountClientsEnergyFromQuery API.

Examples

---
- name: Create
  cisco.catalystcenter.energy_clients_query_count:
    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
    headers: '{{my_headers | from_json}}'
    page:
      limit: 0
      offset: 0
      sortBy:
        - function: string
          name: string
          order: string
    startTime: 0
    views:
      - 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:`{"response": {"count": 0}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)