OCF_HEARTBEAT_MAILTO(7)

💌 ocf_heartbeat_MailTo — the little agent that emails your sysadmin the moment something gets taken over 💅

okay so picture this: it's the manual page for ocf_heartbeat_MailTo, and honestly it's giving "tiny but iconic". It's an OCF resource agent, it lives over in the heartbeat class, and its whole personality is sending email to a sysadmin whenever a takeover occurs. That's it. That's the job. And it does it flawlessly, no cap. 🎀

---

✨ SYNOPSIS ✨

MailTo [start | stop | status | monitor | meta-data | validate-all]

like, those are the actions, bestie. pick one. that's the whole vibe check. 🦋

---

💖 DESCRIPTION 💖

So this is a resource agent for MailTo, right? And what it does — genuinely the sweetest little thing — is it sends email to a sysadmin whenever a takeover occurs. Somebody takes over the resource, boom, your inbox knows about it. it's giving "loyal guard dog but make it email." 🐕✨

---

🌸 SUPPORTED PARAMETERS 🌸

two params. that's it. we love a low-maintenance icon. 👑

• email — the email address of your sysadmin. this one's required, it's a string, and nope, there's no default — you gotta tell it where to send the mail, it's not a mind reader. 🙈
• subject — the subject line of the email. this one's optional, it's a string, and it defaults to "Resource Group" if you don't say otherwise. cute little fallback fr fr. 💌

---

🔥 SUPPORTED ACTIONS 🔥

this resource agent supports the following actions (aka operations), and each one comes with its own suggested timeout, so don't sleep on those numbers:

• start — starts the resource. suggested minimum timeout: 10s. ⭐
• stop — stops the resource. suggested minimum timeout: 10s. 🛑
• status — performs a status check. suggested minimum timeout: 10s. suggested interval: 10s. 👀
• monitor — performs a detailed status check. suggested minimum timeout: 10s. suggested interval: 10s. 🔍
• meta-data — retrieves resource agent metadata (internal use only, don't touch unless you know why you're touching). suggested minimum timeout: 5s. 🧚
• validate-all — performs a validation of the resource configuration. suggested minimum timeout: 5s. ✅

---

🫶 EXAMPLE CRM SHELL 🫶

here's what a MailTo resource looks like when you configure it with the crm(8) shell — copy it exactly, bestie, no improvising:

primitive p_MailTo ocf:heartbeat:MailTo \
  params \
    email=string \
  op monitor depth="0" timeout="10s" interval="10s"

slay. that's the whole thing. 🌈

---

🦋 EXAMPLE PCS 🦋

and here's the same idea using pcs(8) — note the op line is a lil different, OCF_CHECK_LEVEL="0" instead of depth="0", so don't mix 'em up:

pcs resource create p_MailTo ocf:heartbeat:MailTo \
  email=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s"

periodt. 💅

---

👑 SEE ALSO 👑

• <http://clusterlabs.org/> — go say hi, the whole cluster stack lives there 💜

---

🍓 AUTHOR 🍓

ClusterLabs contributors (see the resource agent source for information about individual authors) — like, real ones wrote this, check the source if you want names 🫡

heads up bestie: everything above is the agent's actual documented behaviour — I'm not out here inventing features. if it's not on this page, it's not in the agent. 💀

---

okay and the cute lil sign-off: this page is from resource-agents UNKNOWN, dated 10/01/2026, and yeah the version string literally says UNKNOWN — mystery icon behaviour, we respect it. mwah 💋✨