report_if_condition

Report a Rudder report based on a condition.

⚙️ Compatible targets: Linux

Parameters

NameDocumentation
report_messageMessage subject, will be extended based on the report status.

This parameter is required.
conditionCondition to report a success.

This parameter is required.

Outcome conditions

You need to replace ${report_message} with its actual canonified value.

  • ✅ Ok: report_if_condition_${report_message}_ok
    • ☑️ Already compliant: report_if_condition_${report_message}_kept
    • 🟨 Repaired: report_if_condition_${report_message}_repaired
  • ❌ Error: report_if_condition_${report_message}_error

Example

method: report_if_condition
params:
  condition: VALUE
  report_message: VALUE

Documentation

This method will only send a Rudder report:

If the condition is met, it will report a compliant report, with the following message: **<report_message>** was correct.

Otherwise, it will report an error, with the following message: **report_message** was incorrect

This method will never be in a repaired state.