cisco.dnac.site_kpi_summaries_top_n_analytics module – Resource module for Site Kpi Summaries Top N Analytics

Note

This module is part of the cisco.dnac collection (version 6.27.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.site_kpi_summaries_top_n_analytics.

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module site_kpi_summaries_top_n_analytics_v1

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

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

Site Kpi Summaries Top N Analytics’s filters.

key

string

Key.

operator

string

Operator.

value

string

Value.

groupBy

list / elements=string

Group By.

startTime

integer

Start Time.

topN

integer

Top N.

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)

Notes

Note

  • SDK Method used are sites.Sites.submit_request_for_top_n_entities_related_to_site_analytics_v1,

  • Paths used are post /dna/data/api/v1/siteKpiSummaries/topNAnalytics,

  • It should be noted that this module is an alias of site_kpi_summaries_top_n_analytics_v1

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

Complete reference of the SubmitRequestForTopNEntitiesRelatedToSiteAnalyticsV1 API.

Examples

- name: Create
  cisco.dnac.site_kpi_summaries_top_n_analytics:
    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
    endTime: 0
    filters:
    - key: string
      operator: string
      value: string
    groupBy:
    - string
    startTime: 0
    topN: 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: {"response": {"taskId": "string", "taskLocation": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)