cisco.dnac.energy_sites_query_count module – Resource module for Energy Sites Query Count

Note

This module is part of the cisco.dnac collection (version 6.41.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

To use it in a playbook, specify: cisco.dnac.energy_sites_query_count.

New in cisco.dnac 6.18.0

Synopsis

  • Manage operation create of the resource Energy Sites Query Count. - > Submits a request to retrieve the total count of sites that provide energy data, filtered according to the specified query parameters. 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-sitesEnergy-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.

  • dnacentersdk >= 2.10.1

  • python >= 3.5

Parameters

Parameter

Comments

aggregateAttributes

list / elements=dictionary

Energy Sites Query Count’s aggregateAttributes.

function

string

Function.

name

string

Name.

attributes

list / elements=string

Attributes.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

endTime

integer

End Time.

filters

list / elements=dictionary

Energy Sites Query Count’s filters.

filters

list / elements=dictionary

Energy Sites Query Count’s filters.

key

string

Key.

operator

string

Operator.

value

list / elements=string

Value.

logicalOperator

string

Logical Operator.

page

dictionary

Energy Sites Query Count’s page.

limit

integer

Limit.

offset

integer

Offset.

sortBy

list / elements=dictionary

Energy Sites Query Count’s sortBy.

function

string

Function.

name

string

Name.

order

string

Order.

startTime

integer

Start Time.

taskId

string

TaskId query parameter. Used to retrieve asynchronously processed & stored data. When this parameter is used, the rest of the request params will be ignored.

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

views

list / elements=string

Views.

Notes

Note

  • SDK Method used are sites.Sites.submit_request_to_count_sites_energy_from_query,

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

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Sites SubmitRequestToCountSitesEnergyFromQuery

Complete reference of the SubmitRequestToCountSitesEnergyFromQuery API.

Examples

---
- name: Create
  cisco.dnac.energy_sites_query_count:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    aggregateAttributes:
      - function: string
        name: string
    attributes:
      - string
    endTime: 0
    filters:
      - filters:
          - key: string
            operator: string
            value:
              - string
        logicalOperator: string
    page:
      limit: 0
      offset: 0
      sortBy:
        - function: string
          name: string
          order: string
    startTime: 0
    taskId: string
    views:
      - string

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: {"response": {"count": 0}, "version": "string"}

Authors

  • Rafael Campos (@racampos)