Manual Chapter : Health Engine Actions Reference

Updated Date: 10/27/2026

Health Engine Actions Reference

When a heuristic script detects a condition on your F5OS platform, it can generate one or more actions. Actions tell you or the system what to do next. Some actions run automatically, while others appear as recommendations for you to act on.

This reference lists all supported actions, their required data fields, and whether the system performs them automatically.

Each action has three properties:

  • Value: The action identifier used by the engine.
  • Recommend: When true, the action appears as a recommendation only and does not run automatically. Actions that could affect system performance or operation are always recommendations. When false, the system can perform the action automatically.
  • Data fields: Additional information the heuristic script must provide when it generates the action.

You can view all current recommendations through the confd CLI:

show system health recommendations nodes node recommendation

Generate an F5OS confd alarm. The alarm appears in the show system alarms API.

Property Value
Value generate-alarm
Recommend false
Data fields alert (string), source (string)

Behavior:

  • If the alarm is already asserted, a repeated generate does not re-assert it.

Clear an asserted F5OS confd alarm.

Property Value
Value clear-alarm
Recommend false
Data fields alert (string), source (string)

Behavior:

  • If the alarm is not asserted, a repeated clear is a no-op.

Generate an F5OS confd event. The event appears in the show system events API.

Property Value
Value generate-event
Recommend false
Data fields alert (string), source (string)

Recommend that a platform reboot be performed.

Property Value
Value platform-reboot
Recommend true
Data fields node (string)

Recommend that a platform shutdown be performed.

Property Value
Value platform-shutdown
Recommend true
Data fields node (string)

Recommend that a VELOS chassis system controller failover be performed.

Property Value
Value trigger-failover
Recommend true
Data fields None

Recommend that a specific service be restarted.

Property Value
Value service-restart
Recommend true
Data fields service (string)

Recommend that a service log level be updated.

Property Value
Value log-level
Recommend true
Data fields service (string), severity (string)

Recommend that a qkview capture be performed.

Property Value
Value qkview-capture
Recommend true
Data fields file (string)

Update the health of a diag-agent component or attribute.

Property Value
Value update-health
Recommend false
Data fields component (string), value (any)

Optional fields: attribute, severity

Recommend that a node be replaced.

Property Value
Value replace-node
Recommend true
Data fields node (string)

A node can be a blade or controller.

Recommend that a hardware component be replaced.

Property Value
Value replace-component
Recommend true
Data fields None

A component can be an LCD, fan tray, Power Supply Unit (PSU), PSU controller, or drive.

No action. Used when a heuristic completes without generating an actionable recommendation.

Property Value
Value none
Recommend true
Data fields None

Action Automatic Recommended only Required data fields
generate-alarm ✅ alert, source
clear-alarm ✅ alert, source
generate-event ✅ alert, source
platform-reboot ✅ node
platform-shutdown ✅ node
trigger-failover ✅ None
service-restart ✅ service
log-level ✅ service, severity
qkview-capture ✅ file
update-health ✅ component, value
replace-node ✅ node
replace-component ✅ None
none ✅ None