cisco.catalystcenter.application_health_score_definitions_info module -- Information module for Application Health Score Definitions

Note

This module is part of the cisco.catalystcenter collection (version 2.11.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_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Application Health Score Definitions.

  • Get Application Health Score Definitions by id.

  • Get all application health score definitions for given filter. - > Get application health score definition for the given id. By default all supported attributes are listed in the response.

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

attribute

string

Attribute query parameter. These are the attributes supported in application health score definitions response. By default, all properties are sent in response.

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"`

headers

dictionary

Additional headers.

id

string

Id path parameter. Application health score definition id.

includeForHealthScore

boolean

IncludeForHealthScore query parameter. The inclusion of application health score definition, either true or false. True indicates that particular application health metric is included in in the application health score computation, otherwise false.

Choices:

limit

integer

Limit query parameter. Maximum number of records to return.

offset

integer

Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.

trafficClass

string

TrafficClass query parameter. The traffic class for the application health score definition. If this is not provided then all traffic class application health score definitions will be included.

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 applications.Applications.get_all_application_health_score_definitions, applications.Applications.get_application_health_score_definition_for_the_given_id,

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

  • 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

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

Complete reference of the GetAllApplicationHealthScoreDefinitions API.

Cisco Catalyst Center documentation for Applications GetApplicationHealthScoreDefinitionForTheGivenId

Complete reference of the GetApplicationHealthScoreDefinitionForTheGivenId API.

Examples

---
- name: Get all Application Health Score Definitions
  cisco.catalystcenter.application_health_score_definitions_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}}"
    trafficClass: string
    includeForHealthScore: true
    attribute: string
    offset: 1
    limit: 100
  register: result
- name: Get Application Health Score Definitions by id
  cisco.catalystcenter.application_health_score_definitions_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}}"
    attribute: string
    id: string
  register: result

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)