/ home / cisco / cisco.dnac / 6.13.3 / module / system_performance_info

cisco.dnac.system_performance_info (6.13.3) — module

Information module for System Performance

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all System Performance.

This API gives the aggregated performance indicators. The data can be retrieved for the last 3 months.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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: "{{my_headers | from_json}}"
    kpi: string
    function: string
    startTime: 0
    endTime: 0
  register: result

Inputs

    
kpi:
    description:
    - Kpi query parameter. Valid values cpu,memory,network.
    type: str

endTime:
    description:
    - 'EndTime query parameter. This is the epoch end time in milliseconds upto which
      performance indicator need to be fetched.

      '
    type: int

headers:
    description: Additional headers.
    type: dict

function:
    description:
    - Function query parameter. Valid values sum,average,max.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

startTime:
    description:
    - 'StartTime query parameter. This is the epoch start time in milliseconds from which
      performance indicator need to be fetched.

      '
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"hostName\": \"string\",\n  \"version\": \"string\",\n  \"kpis\"\
    : {\n    \"cpu\": {\n      \"units\": \"string\",\n      \"utilization\": \"string\"\
    \n    },\n    \"memory\": {\n      \"units\": \"string\",\n      \"utilization\"\
    : \"string\"\n    },\n    \"network tx_rate\": {\n      \"units\": \"string\"\
    ,\n      \"utilization\": \"string\"\n    },\n    \"network rx_rate\": {\n   \
    \   \"units\": \"string\",\n      \"utilization\": \"string\"\n    }\n  }\n}\n"
  type: dict