cisco.catalystcenter.system_performance_info module -- Information module for System Performance

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all System Performance. - > Retrieves the average values of cluster key performance indicators KPIs , such as CPU utilization, memory utilization or network rates over the past 15 minutes. Query parameters 'function', '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

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

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

endTime

float

EndTime query parameter. In this release this field has been deprecated and no longer supported. Only the last 15 minutes average of cluster key performance indicators (KPIs) is returned, 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.

function

string

Function query parameter. In this release this field has been deprecated and no longer supported. Previously supported functions were 'sum', 'average', and 'max'. Now, only the last 15 minutes average of cluster key performance indicators (KPIs) is returned, regardless of the specified function. For example, if 'sum', 'average', or 'max' is provided, it will be ignored and the 'average' of the last 15 minutes will be returned.

headers

dictionary

Additional headers.

kpi

string

Kpi query parameter. Valid values cpu,memory,network.

startTime

float

StartTime query parameter. In this release this field has been deprecated and no longer supported. Only the last 15 minutes average of cluster key performance indicators (KPIs) is returned, regardless of the provided epoch time. For example, if any epoch time is specified for this field, it will be ignored and 15 minutes before the current time will be considered.

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 health_and_performance.HealthAndPerformance.system_performance,

  • Paths used are get /dna/intent/api/v1/diagnostics/system/performance,

  • 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

See Also

See also

Cisco DNA Center documentation for Health and Performance SystemPerformanceAPI

Complete reference of the SystemPerformanceAPI API.

Examples

---
- name: Get all System Performance
  cisco.catalystcenter.system_performance_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
    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

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"hostName": "string", "kpis": {"cpu": {"units": "string", "utilization": "string"}, "memory": {"units": "string", "utilization": "string"}, "network rx\_rate": {"units": "string", "utilization": "string"}, "network tx\_rate": {"units": "string", "utilization": "string"}}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)