Red Hat · Schema

Rule

An Advisor rule that defines detection logic for a specific system issue, along with resolution steps and remediation guidance.

CloudContainersEnterpriseHybrid CloudKubernetesLinuxOpen Source

Properties

Name	Type	Description
rule_id	string	The unique identifier of the rule.
description	string	A description of what the rule detects.
active	boolean	Whether the rule is currently active.
category	object	The category the rule belongs to.
impact	object	The impact level of the rule.
likelihood	integer	The likelihood value (1-4).
total_risk	integer	The calculated total risk score.
risk_of_change	integer	The risk associated with applying the remediation.
has_playbook	boolean	Whether an Ansible remediation playbook is available.
publish_date	string	When the rule was published.
systems_affected	integer	The number of systems currently affected by this rule.
resolution_set	array	Available resolution options for the rule.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Rule",
  "type": "object",
  "description": "An Advisor rule that defines detection logic for a specific system issue, along with resolution steps and remediation guidance.",
  "properties": {
    "rule_id": {
      "type": "string",
      "description": "The unique identifier of the rule."
    },
    "description": {
      "type": "string",
      "description": "A description of what the rule detects."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the rule is currently active."
    },
    "category": {
      "type": "object",
      "description": "The category the rule belongs to."
    },
    "impact": {
      "type": "object",
      "description": "The impact level of the rule."
    },
    "likelihood": {
      "type": "integer",
      "description": "The likelihood value (1-4)."
    },
    "total_risk": {
      "type": "integer",
      "description": "The calculated total risk score."
    },
    "risk_of_change": {
      "type": "integer",
      "description": "The risk associated with applying the remediation."
    },
    "has_playbook": {
      "type": "boolean",
      "description": "Whether an Ansible remediation playbook is available."
    },
    "publish_date": {
      "type": "string",
      "description": "When the rule was published."
    },
    "systems_affected": {
      "type": "integer",
      "description": "The number of systems currently affected by this rule."
    },
    "resolution_set": {
      "type": "array",
      "description": "Available resolution options for the rule."
    }
  }
}