cisco.catalystcenter.network_devices_top_n_analytics module -- Resource module for Network Devices Top N Analytics

Note

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

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

New in cisco.catalystcenter 6.17.0

Synopsis

  • This module represents an alias of the module network_devices_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.

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

aggregateAttributes

list / elements=dictionary

Network Devices Top N Analytics's aggregateAttributes.

function

string

Function.

name

string

Name.

attributes

list / elements=dictionary

Attributes.

endTime

integer

End Time.

filters

list / elements=dictionary

Network Devices Top N Analytics's filters.

key

string

Key.

operator

string

Operator.

value

string

Value.

groupBy

list / elements=string

Group By.

page

dictionary

Network Devices Top N Analytics's page.

limit

integer

Limit.

offset

integer

Offset.

sortBy

list / elements=dictionary

Network Devices Top N Analytics's sortBy.

function

string

Function.

name

string

Name.

order

string

Order.

startTime

integer

Start Time.

topN

integer

Top N.

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 devices.Devices.gets_the_top_n_analytics_data_related_to_network_devices_v1,

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

  • It should be noted that this module is an alias of network_devices_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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Devices GetsTheTopNAnalyticsDataRelatedToNetworkDevicesV1

Complete reference of the GetsTheTopNAnalyticsDataRelatedToNetworkDevicesV1 API.

Examples

- name: Create
  cisco.catalystcenter.network_devices_top_n_analytics:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    aggregateAttributes:
      - function: string
        name: string
    attributes:
      - {}
    endTime: 0
    filters:
      - key: string
        operator: string
        value: string
    groupBy:
      - string
    page:
      limit: 0
      offset: 0
      sortBy:
        - function: string
          name: string
          order: string
    startTime: 0
    topN: 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 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": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": "string"}], "id": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)