OCF_HEARTBEAT_SYMLIN(7)

✨ OCF_HEARTBEAT_SYMLIN(7) — the symlink resource agent, explained 💅

okay so bestie, welcome to OCF_HEARTBEAT_SYMLIN(7), the manual page for ocf_heartbeat_symlink. yes it's a whole manpage about symlinks. no I'm not kidding. it's lowkey iconic though, let me explain 🎀

---

💖 NAME 💖

ocf_heartbeat_symlink — Manages a symbolic link

like, that's it. that's the whole job. it manages a symlink. slay 🌸

---

🦋 SYNOPSIS 🦋

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

those are your five actions, bestie. pick one. go off 👑

---

🌈 DESCRIPTION 🌈

So this is a resource agent that manages a symbolic link (symlink). fr fr, that's the vibe.

It's primarily intended to manage config files that should be enabled or disabled depending on where the resource is running — think cron job definitions and stuff like that. so like, when your resource lives over here, the cron file gets linked in; when it's over there, it doesn't. main character energy for config files, honestly 🫶

---

✨ SUPPORTED PARAMETERS ✨

• link — Full path of the symbolic link to be managed. This must obviously be in a filesystem that supports symbolic links. (required, string, no default)
• target — Full path to the link target (the file or directory which the symlink points to). (required, string, no default)
• backup_suffix — A suffix to append to any files that the resource agent moves out of the way because they clash with link. If this is unset (the default), then the resource agent will simply refuse to create a symlink if it clashes with an existing file. (optional, string, no default)

ngl the backup_suffix thing is important — with no suffix set, your agent is just gonna ✋ refuse to make the link if something's already sitting there. so if you want it to politely shove the old file aside instead of throwing a fit, set this 💅

---

🔥 SUPPORTED ACTIONS 🔥

This resource agent supports the following actions (operations):

• start — Starts the resource. Suggested minimum timeout: 15s.
• stop — Stops the resource. Suggested minimum timeout: 15s.
• monitor — Performs a detailed status check. Suggested minimum timeout: 15s. Suggested interval: 60s.
• 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: 10s.

---

🍓 EXAMPLE CRM SHELL 🍓

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

primitive p_symlink ocf:heartbeat:symlink \
  params \
    link=string \
    target=string \
  op monitor depth="0" timeout="15s" interval="60s"

copy it, paste it, make it yours 💜

---

🧚 EXAMPLE PCS 🧚

And here's the same energy for a symlink resource using pcs(8):

pcs resource create p_symlink ocf:heartbeat:symlink \
  link=string \
  target=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="15s" interval="60s"

note the OCF_CHECK_LEVEL="0" here instead of depth="0" — that's just how pcs do 🦋

---

👑 SEE ALSO 👑

• http://clusterlabs.org/

---

💀 AUTHOR 💀

ClusterLabs contributors (see the resource agent source for information about individual authors)

---

okay that's the whole page!! no cap, you now know everything there is to know about this little symlink goblin 🎀

sign-off time: this beautiful page is from resource-agents, version UNKNOWN, dated 10/01/2026 — go forth and link your symlinks, bestie 💖✨🫶