Compliance details by rule

v1.0.0

Get current compliance of a rule of a Rudder server

Input

{
  "type": "object",
  "properties": {
    "level": {
      "type": "integer"
    },
    "precision": {
      "type": "integer"
    },
    "ruleId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "ruleId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "action",
    "data",
    "result"
  ],
  "properties": {
    "action": {
      "type": "string",
      "description": "The id of the action",
      "enum": [
        "getRuleCompliance"
      ]
    },
    "data": {
      "type": "object",
      "required": [
        "rules"
      ],
      "properties": {
        "rules": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "mode",
              "compliance",
              "complianceDetails"
            ],
            "properties": {
              "compliance": {
                "type": "number",
                "format": "float",
                "description": "Rule compliance level"
              },
              "complianceDetails": {
                "type": "object",
                "properties": {
                  "error": {
                    "type": "number",
                    "format": "float"
                  },
                  "noReport": {
                    "type": "number",
                    "format": "float"
                  },
                  "successAlreadyOK": {
                    "type": "number",
                    "format": "float"
                  },
                  "successNotApplicable": {
                    "type": "number",
                    "format": "float"
                  },
                  "successRepaired": {
                    "type": "number",
                    "format": "float"
                  },
                  "unexpectedMissingComponent": {
                    "type": "number",
                    "format": "float"
                  },
                  "unexpectedUnknownComponent": {
                    "type": "number",
                    "format": "float"
                  }
                }
              },
              "id": {
                "type": "string",
                "format": "uuid",
                "description": "id of the rule"
              },
              "mode": {
                "type": "string",
                "enum": [
                  "full-compliance",
                  "changes-only",
                  "reports-disabled"
                ]
              }
            }
          }
        }
      }
    },
    "result": {
      "type": "string",
      "description": "Result of the request",
      "enum": [
        "success",
        "error"
      ]
    }
  }
}