Skip to content

clarification on "recommended_action" field presence in passed test items' JSON output #389

@yusozhao

Description

@yusozhao

(use upvote 👍 for attentions)
Describe the enhancement
Request for official clarification (or optionally a brief documentation note) regarding the presence of the recommended_action field in JSON output files when the check has already passed ("ruleStatus": "passed").

Current behavior/output
Example from post_upgrade_cb_check — check passed, but recommended_action is still populated:

{
  "ruleId": "post_upgrade_cb_check",
  "name": "Post Upgrade Callback Integrity",
  "recommended_action": "Contact Cisco TAC with Output",
  "severity": "informational",
  "ruleStatus": "passed",
  "failureDetails": {
    "failType": "",
    "header": [],
    "data": [],
    "unformatted_header": [],
    "unformatted_data": []
  }
}

Suggested behavior/output
We are not necessarily requesting a code change, as the current design is logical and consistent.(All test items json file has follow the same rule)

Rather, it's appreciate if any of following could be provided:

  • An official confirmation that the recommended_action field is intended to be a static rule-metadata attribute
  • Optionally, a short note added to the documentation, clarifying that the recommended_action field in the JSON is a static rule-metadata attribute. Customers should only act on recommended_action when ruleStatus is not passed.

To Reproduce

  1. Run the ACI Pre-Upgrade Validation Script
  2. After execution completes, check JSON files from the script's output.
  3. Open the JSON file for any passed check.
  4. The recommended_action field is still populated despite the passed status.

Additional context
While Cisco LCS team assisting customer running the ACI Pre-Upgrade Validation Script, customer are more concern about the test item - postupgradeCB result.

  • The Summary report doesn't include the result of this check. We explain to customer that the report only displays failed (non-passed) items.
  • When the customer check the sepcific JSON files directly, they noticed that the recommended_action field (e.g., "Contact Cisco TAC with Output") is still populated even when ruleStatus is passed. This caused customer confusion — "why is a recommended action shown if the check passed?"

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions