cisco.catalystcenter.application_health_score_definitions module -- Resource module for Application Health Score Definitions

Note

This module is part of the cisco.catalystcenter collection (version 2.12.0).

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation update of the resource Application Health Score Definitions.

  • Update application health score definition for the given id.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

badDefaultValue

float

The default upper threshold value of the KPI for poor (1-3) health score.

badMaxValue

float

Maximum value allowed for upper threshold value of the KPI for poor (1-3) health score.

badMinValue

float

Minimum value allowed for upper threshold value of the KPI for poor (1-3) health score.

badValue

float

The upper threshold value of the KPI for poor (1-3) health score.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

definitionType

string

Definition type to indicate whether the health score definition has been customized or not.

goodDefaultValue

float

The default lower threshold value of the KPI for fair (4-7) health score.

goodMaxValue

float

Maximum value allowed for lower threshold value of the KPI for fair (4-7) health score.

goodMinValue

float

Minimum value allowed for lower threshold value of the KPI for fair (4-7) health score.

goodValue

float

The lower threshold value of the KPI for fair (4-7) health score. This would be same as the upper threshold value of the KPI for good (8-10) health score.

greatDefaultValue

float

The default lower threshold value of the KPI for good (8-10) health score.

greatMaxValue

float

Maximum value allowed for the lower threshold value of the KPI for good (8-10) health score.

greatMinValue

float

Minimum value allowed for the lower threshold value of the KPI for good (8-10) health score.

greatValue

float

The lower threshold value of the KPI for good (8-10) health score.

headers

dictionary

Additional headers.

id

string

Id path parameter. Application health score definition id.

includeForHealthScore

boolean

Flag to indicate whether the KPI is included for the application health score calulation or not.

Choices:

includeForHealthScoreDefault

boolean

Default flag to indicate whether the KPI is included for application health calulation or not.

Choices:

kpiName

string

Application health KPI name.

lastModified

integer

Last modification time in milliseconds since UNIX epoch. This is applicable only for modified thresholds.

poorDefaultValue

float

The default lower threshold value of the KPI for poor (1-3) health score.

poorMaxValue

float

Maximum value allowed for lower threshold value of the KPI for poor (1-3) health score.

poorMinValue

float

Minimum value allowed for lower threshold value of the KPI for poor (1-3) health score.

poorValue

float

The lower threshold value of the KPI for poor (1-3) health score. This would be same as the upper threshold value of the KPI for fair (4-7) health score.

trafficClass

string

Traffic class for application health score definition.

unit

string

Application Health score definition unit.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

weightDefaultValue

integer

The default weightage of the KPI used for application health score calculation.

weightValue

integer

The weightage of the KPI used for application health score calculation.

Notes

Note

  • SDK Method used are applications.Applications.update_application_health_score_definition_for_the_given_id,

  • Paths used are put /dna/intent/api/v1/applicationHealthScoreDefinitions/{id},

  • Does not support 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Applications UpdateApplicationHealthScoreDefinitionForTheGivenId

Complete reference of the UpdateApplicationHealthScoreDefinitionForTheGivenId API.

Examples

---
- name: Update by id
  cisco.catalystcenter.application_health_score_definitions:
    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}}"
    state: present
    badValue: 10
    goodValue: 1
    greatValue: 0.1
    headers: '{{my_headers | from_json}}'
    id: string
    includeForHealthScore: true
    poorValue: 4
    weightValue: 10

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"badDefaultValue": 0, "badMaxValue": 0, "badMinValue": 0, "badValue": 0, "definitionType": "string", "goodDefaultValue": 0, "goodMaxValue": 0, "goodMinValue": 0, "goodValue": 0, "greatDefaultValue": 0, "greatMaxValue": 0, "greatMinValue": 0, "greatValue": 0, "id": "string", "includeForHealthScore": true, "includeForHealthScoreDefault": true, "kpiName": "string", "lastModified": 0, "poorDefaultValue": 0, "poorMaxValue": 0, "poorMinValue": 0, "poorValue": 0, "trafficClass": "string", "unit": "string", "weightDefaultValue": 0, "weightValue": 0}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)