OCF_HEARTBEAT_ISCSI(7)

💖 ocf_heartbeat_iscsi 💖

okay bestie, welcome to the ocf_heartbeat_iscsi manual page — that's the OCF_HEARTBEAT_ISCSI(7) situation, and it's literally about managing a local iSCSI initiator and its connections to iSCSI targets. yes we're doing storage networking today, hydrate first 🥤

---

✨ NAME ✨

ocf_heartbeat_iscsi — manages a local iSCSI initiator and its connections to iSCSI targets 🦋

---

🌸 SYNOPSIS 🌸

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

---

💅 DESCRIPTION 💅

It's an OCF Resource Agent for iSCSI, no cap. You use it to add (that's start) or remove (that's stop) iSCSI targets. That's the whole vibe. 🎀

---

👑 SUPPORTED PARAMETERS 👑

okay so these are the knobs you can turn. each one got a little personality, here we go:

• portal — the iSCSI portal address, and the format is exactly this: {ip_address|hostname}[":"port]. It's required, it's a string, and there's no default — you gotta bring your own. 📍
• target — the iSCSI target IQN. This one is unique, required, a string, and again no default. you must provide it, bestie. 🎯
• discovery_type — the target discovery type. Check the open-iscsi documentation for the supported discovery types, because that's where the real tea is. Optional string, and it defaults to "sendtargets". 🔍
• iscsiadm — the open-iscsi administration utility binary. Optional string, defaults to "iscsiadm". that's just the name of the tool she's calling. 🛠️
• udev — if the next resource depends on udev creating a device, then we wait until it's finished. On a normally loaded host this should be done quickly, but you may be unlucky (💀). If you are not using udev, set this to "no" — otherwise we will spin in a loop until a timeout occurs. Optional string, defaults to "yes". ⏳
• try_recovery — if the iSCSI session exists but is currently inactive/broken, which is most probably due to network problems, the iSCSI layer will try to recover. If this parameter is set to true, we'll wait for the recovery to succeed. In that case the monitor operation can only time out, so you should set the monitor op timeout attribute appropriately. Optional boolean, defaults to false. 🚑

---

🔥 SUPPORTED ACTIONS 🔥

This resource agent supports the following actions (operations). mind the timeouts, they're giving main character energy:

• start — starts the resource. Suggested minimum timeout: 120s. 🚀
• stop — stops the resource. Suggested minimum timeout: 120s. 🛑
• status — performs a status check. Suggested minimum timeout: 30s. 👀
• monitor — performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 120s. 🔎
• validate-all — performs a validation of the resource configuration. Suggested minimum timeout: 5s. ✅
• methods — suggested minimum timeout: 5s. 📋
• meta-data — retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s. 🙈

---

🎀 EXAMPLE CRM SHELL 🎀

here's an example config for an iscsi resource using the crm(8) shell, periodt:

primitive p_iscsi ocf:heartbeat:iscsi \
  params \
    portal=string \
    target=string \
  op monitor depth="0" timeout="30s" interval="120s"

---

🌈 EXAMPLE PCS 🌈

and here's the same idea but with pcs(8). notice the OCF_CHECK_LEVEL moment, she's different:

pcs resource create p_iscsi ocf:heartbeat:iscsi \
  portal=string \
  target=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="120s"

---

⭐ SEE ALSO ⭐

• http://clusterlabs.org/ — go look, iykyk 💜

---

🫶 AUTHOR 🫶

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

---

and that's the whole page bestie, you ate 🍓 — this was resource-agents version UNKNOWN, dated 04/08/2026. slay, go configure your iSCSI targets, ily 💅✨