OCF_HEARTBEAT_CLUSTE(7)

📦
version 4.18.0 · 14 versions
, in fedora 43, fedora 44

✨ ocf_heartbeat_ClusterMon — it's giving cluster status, but make it HTML 💖

okay bestie, so this one lives in the OCF resource agents section of the manual — that's the OCF_HEARTBEAT_CLUSTE(7) page, and it's all about a little resource agent called ocf_heartbeat_ClusterMon. 🦋

🌸 NAME 🌸

ocf_heartbeat_ClusterMon — she runs crm_mon in the background and writes your cluster status into an HTML file. no cap, that's the whole job. 👑

✨ SYNOPSIS ✨

ClusterMon [start | stop | monitor | meta-data | validate-all]

like. pick one of those actions and go, babe. 💅

🎀 DESCRIPTION 🎀

This is the ClusterMon Resource Agent. It outputs the current cluster status to the html. that's it, that's the vibe. she's not complicated, she's just consistent. 🫶

💜 SUPPORTED PARAMETERS 💜

  • user — the user we want to run crm_mon as.

(optional, string, default "root")

  • update — how frequently should we update the cluster status? the lil refresh rate, basically. ⏰

(optional, integer, default 15000)

  • extra_options — additional options to pass to crm_mon. eg. -n -r. go off, add whatever you need. 🔥

(optional, string, no default)

  • pidfile — PID file location, to make sure only one instance is running at a time. no duplicate main characters here, periodt. 🙈

(unique, optional, string, default "/run/resource-agents/ClusterMon_RESOURCE_ID.pid")

  • htmlfile — location to write the HTML output to. this is where the magic lands. ✨

(unique, optional, string, default "/run/resource-agents/ClusterMon_RESOURCE_ID.html")

🌈 SUPPORTED ACTIONS 🌈

This resource agent supports the following actions (operations):

  • start — starts the resource. suggested minimum timeout: 20s.
  • stop — stops the resource. suggested minimum timeout: 20s.
  • monitor — performs a detailed status check. suggested minimum timeout: 20s. suggested interval: 10s. she's watching. always watching. 👀
  • meta-data — retrieves resource agent metadata (internal use only). suggested minimum timeout: 5s.
  • validate-all — performs a validation of the resource configuration. suggested minimum timeout: 30s.

🍓 EXAMPLE CRM SHELL 🍓

here's an example config for a ClusterMon resource using the crm(8) shell:

primitive p_ClusterMon ocf:heartbeat:ClusterMon \
  op monitor depth="0" timeout="20s" interval="10s"

copy it exactly, bestie, don't freestyle on the flags. 😭

🧚 EXAMPLE PCS 🧚

and here's the same energy for a ClusterMon resource using pcs(8):

pcs resource create p_ClusterMon ocf:heartbeat:ClusterMon \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"

(notice depth="0" over in crm land becomes OCF_CHECK_LEVEL="0" here — iykyk 💅)

⭐ SEE ALSO ⭐

💖 AUTHOR 💖

ClusterLabs contributors (see the resource agent source for information about individual authors). love that for them. 👑

and that's the whole page, fr fr. go write some HTML, you icon. 🌸

mwah 💋 this was brought to you by resource-agents version UNKNOWN, dated 04/08/2026 — from the OCF_HEARTBEAT_CLUSTE(7) page, of course. slay, stay clustered, bye bestie 🦋✨

📦 where this page comes from