cisco.dnac.system_performance_historical_info – Information module for System Performance Historical

Note

This plugin is part of the cisco.dnac collection (version 4.1.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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all System Performance Historical.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
endTime
integer
EndTime query parameter. This is the epoch end time in milliseconds upto which performance indicator need to be fetched.
headers
dictionary
Additional headers.
kpi
string
Kpi query parameter. Fetch historical data for this kpi. 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.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

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

System Performance Historical reference

Complete reference of the System Performance Historical object model.

Examples

- name: Get all System Performance Historical
  cisco.dnac.system_performance_historical_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
    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": { "legends": { "cpu": { "units": "string" }, "memory": { "units": "string" }, "network tx_rate": { "units": "string" }, "network rx_rate": { "units": "string" } }, "data": { "t1": [ "string" ] } } }


Authors

  • Rafael Campos (@racampos)