cisco.catalystcenter.network_devices_process_kpis_info module -- Information module for Network Devices Process Kpis

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

New in cisco.catalystcenter 2.11.0

Synopsis

• Get all Network Devices Process Kpis.

• Get Network Devices Process Kpis by id. - > Retrieves the Process KPIs for a given process of wireless controller. If startTime and endTime are not provided, the API defaults to the last 24 hours. - > Retrieves the list of Process CPU and Memory KPIs for a given network device. Only the latest top 13 Processes including all WNCD processes are returned. If startTime and endTime are not provided, the API defaults to the last 24 hours.

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
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	EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
headers dictionary	Additional headers.
id string	Id path parameter. Process Name.
limit integer	Limit query parameter. Maximum number of records to return.
networkDeviceId string	NetworkDeviceId path parameter. Network Device UUID.
offset integer	Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.
order string	Order query parameter. The sort order of the field ascending or descending.
sortBy string	SortBy query parameter. A field within the response to sort by.
startTime integer	StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.
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)

Notes

Note

• SDK Method used are devices.Devices.retrieves_the_list_of_process_cpu_and_memory_kpis_for_a_given_network_device, devices.Devices.retrieves_the_process_kpis_for_a_given_process_of_wireless_controller,

• Paths used are get /dna/data/api/v1/networkDevices/{networkDeviceId}/processKpis, get /dna/data/api/v1/networkDevices/{networkDeviceId}/processKpis/{id},

• Supports 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 Devices RetrievesTheListOfProcessCPUAndMemoryKPIsForAGivenNetworkDevice

Complete reference of the RetrievesTheListOfProcessCPUAndMemoryKPIsForAGivenNetworkDevice API.

Cisco Catalyst Center documentation for Devices RetrievesTheProcessKPIsForAGivenProcessOfWirelessController

Complete reference of the RetrievesTheProcessKPIsForAGivenProcessOfWirelessController API.

Examples

---
- name: Get all Network Devices Process Kpis
  cisco.catalystcenter.network_devices_process_kpis_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    startTime: 0
    endTime: 0
    limit: 100
    offset: 1
    sortBy: string
    order: asc
    networkDeviceId: string
  register: result
- name: Get Network Devices Process Kpis by id
  cisco.catalystcenter.network_devices_process_kpis_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    startTime: 0
    endTime: 0
    networkDeviceId: string
    id: string
  register: result

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": {"lastUpdatedTime": 0, "siteHierarchy": "string", "siteHierarchyId": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)