cisco.catalystcenter.clients_summary_analytics module -- Resource module for Clients Summary Analytics

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

New in cisco.catalystcenter 1.0.0

Synopsis

  • Manage operation create of the resource Clients Summary Analytics.

  • Retrieves summary analytics data related to clients while applying complex.

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

Clients Summary Analytics's aggregateAttributes.

function

string

Clients Summary Analytics's function.

name

string

Clients Summary Analytics's name.

attributes

list / elements=string

Clients Summary Analytics's attributes.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

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:

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

Clients Summary Analytics's endTime.

filters

list / elements=dictionary

Clients Summary Analytics's filters.

key

string

Clients Summary Analytics's key.

operator

string

Clients Summary Analytics's operator.

value

integer

Clients Summary Analytics's value.

groupBy

list / elements=string

Clients Summary Analytics's groupBy.

headers

dictionary

Additional headers.

page

dictionary

Clients Summary Analytics's page.

cursor

string

Clients Summary Analytics's cursor.

limit

integer

Clients Summary Analytics's limit.

sortBy

list / elements=dictionary

Clients Summary Analytics's sortBy.

name

string

Clients Summary Analytics's name.

order

string

Clients Summary Analytics's order.

startTime

integer

Clients Summary Analytics's startTime.

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 clients.Clients.retrieves_summary_analytics_data_related_to_clients,

  • Paths used are post /dna/data/api/v1/clients/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

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

Complete reference of the RetrievesSummaryAnalyticsDataRelatedToClients API.

Examples

---
- name: Create
  cisco.catalystcenter.clients_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:
      - key: string
        operator: string
        value: 0
    groupBy:
      - string
    headers: '{{my_headers | from_json}}'
    page:
      cursor: string
      limit: 0
      sortBy:
        - 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

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:`{"page": {"count": 0, "cursor": "string", "limit": 0, "sortBy": [{"name": "string", "order": "string"}]}, "response": {"groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": 0}], "id": "string"}]}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)