cisco.catalystcenter.system_performance_historical_info module -- Information module for System Performance Historical
Note
This module is part of the cisco.catalystcenter collection (version 2.3.1).
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.system_performance_historical_info.
New in cisco.catalystcenter 3.1.0
Synopsis
Get all System Performance Historical. - > Retrieves hourly data of cluster key performance indicators KPIs , like CPU utilization, memory utilization or network rates for the past 24 hours. Query parameters 'startTime' and 'endTime' are no longer supported.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.6.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
EndTime query parameter. In this release this field has been deprecated and no longer supported. This is restricted to a 24-hour time range with hourly samples, regardless of the provided epoch time. For example, if any epoch time is specified for this field, it will be ignored and the current time will be considered. |
|
Additional headers. |
|
Kpi query parameter. Fetch historical data for this kpi. Valid values cpu,memory,network. |
|
StartTime query parameter. In this release this field has been deprecated and no longer supported. This is restricted to a 24-hour time range with hourly samples, regardless of the provided epoch time. For example, if any epoch time is specified for this field, it will be ignored and 24 hours before the current time will be considered. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are health_and_performance.HealthAndPerformance.system_performance_historical,
Paths used are get /dna/intent/api/v1/diagnostics/system/performance/history,
Supports
check_modeThe 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
See Also
See also
- Cisco DNA Center documentation for Health and Performance SystemPerformanceHistoricalAPI
Complete reference of the SystemPerformanceHistoricalAPI API.
Examples
---
- name: Get all System Performance Historical
cisco.catalystcenter.system_performance_historical_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}}"
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 |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always |