cisco.dnac.system_performance_info – Information module for System Performance

Note

This plugin is part of the cisco.dnac collection (version 3.1.6).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all System Performance.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
endTime
integer
EndTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched.
function
string
Function query parameter. Valid values sum,average,max.
headers
dictionary
Additional headers.
kpi
string
Kpi query parameter. Valid values cpu,memory,network.
startTime
integer
StartTime query parameter. This is the epoch start time in milliseconds from which performance indicator need to be fetched.

See Also

See also

System Performance reference

Complete reference of the System Performance object model.

Examples

- name: Get all System Performance
  cisco.dnac.system_performance_info:
    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}}"
    headers:
      custom: value
    kpi: string
    function: string
    startTime: 0
    endTime: 0
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "hostName": "string", "version": "string", "kpis": { "cpu": { "units": "string", "utilization": "string" }, "memory": { "units": "string", "utilization": "string" }, "network tx_rate": { "units": "string", "utilization": "string" }, "network rx_rate": { "units": "string", "utilization": "string" } } }


Authors

  • Rafael Campos (@racampos)