OCF_HEARTBEAT_SFEX(7)

🎀 OCF_HEARTBEAT_SFEX — the whole manual page, bestie

okay so welcome to ocf_heartbeat_sfex, section 7 of the manual, and honestly? she's giving bouncer energy for your disks. Let's get into it 💖

---

✨ NAME ✨

ocf_heartbeat_sfex — manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF-EX)

---

🦋 SYNOPSIS 🦋

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

---

🌸 DESCRIPTION 🌸

It's the resource script for SF-EX, no cap. It manages a shared storage medium exclusively. That's the whole vibe. One at a time, bestie. Periodt.

---

👑 SUPPORTED PARAMETERS 👑

• device — the block device path where the exclusive control data lives. That's it, that's the whole thing. (required, string, no default — so like, you have to give her this one 💅)
• index — where in that block device the exclusive control data gets stored. You gotta specify 1 or more. Default is 1. (optional, integer, default 1)
• collision_timeout — how long you wait when a collision of lock acquisition gets detected. Default is 1 second. (optional, integer, default 1)
• monitor_interval — monitor interval, in seconds. Default is 10 seconds. (optional, integer, default 10)
• lock_timeout — the valid term of the lock, in seconds. Default is 100 seconds. And the lock_timeout is calculated by this formula right here:

lock_timeout = monitor_interval + "The expiration time of the lock"

We suggest 90 seconds as the default value of "The expiration time of the lock", but fr fr you should change it — take into account the access delay to the shared disk and the switch time of the multipath driver. Don't just leave it vibing on default if your setup is built different.

Also, the lock timeout has an impact on the start action timeout, because the start action timeout value is calculated by this formula:

start timeout = collision_timeout + lock_timeout + "safety margin"

The "safety margin" gets decided within the range of about 10-20 seconds (it depends on your system requirement, so like, know your system).

(optional, integer, default 100)

---

🔥 SUPPORTED ACTIONS 🔥

This resource agent supports the following actions (operations), bestie:

• start — starts the resource. Suggested minimum timeout: 120s.
• stop — stops the resource. Suggested minimum timeout: 20s.
• monitor — performs a detailed status check. Suggested minimum timeout: 10s. Suggested interval: 10s.
• 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: 5s.

---

🌈 EXAMPLE CRM SHELL 🌈

Here's an example configuration for a sfex resource using the crm(8) shell, enjoy:

primitive p_sfex ocf:heartbeat:sfex \
  params \
    device=string \
  op monitor depth="0" timeout="10s" interval="10s"

---

⭐ EXAMPLE PCS ⭐

And here's the same thing but for pcs(8):

pcs resource create p_sfex ocf:heartbeat:sfex \
  device=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s"

---

💜 SEE ALSO 💜

• http://clusterlabs.org/

---

🫶 AUTHOR 🫶

ClusterLabs contributors — see the resource agent source if you want the deets on individual authors.

---

okay that's the whole page, you ate that 💅✨

signing off with the vibe: this is resource-agents version UNKNOWN, dated 04/08/2026 — go forth and lock your storage exclusively, queen 👑🌸