OCF_HEARTBEAT_IPADDR(7)

💖 ocf_heartbeat_IPaddr 💖

okay bestie, gather round, because this is the manual page for ocf_heartbeat_IPaddr, and it lives in the OCF resource agents manual set (section 7, for the record). It's the portable little icon that handles your virtual IPv4 addresses. no cap. 🦋

---

✨ NAME ✨

ocf_heartbeat_IPaddr — Manages virtual IPv4 addresses (portable version)

---

🌸 SYNOPSIS 🌸

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

---

💅 DESCRIPTION 💅

So basically this script manages IP alias IP addresses. That's the whole vibe. It can add an IP alias, and it can remove one. She's a two-trick pony and both tricks are iconic. 👑

---

🎀 SUPPORTED PARAMETERS 🎀

okay so here's the full parameter menu, and yes, we're going through ALL of them, no skipping, that's the rule.

• ip — The IPv4 address you want configured, in dotted quad notation, like for example "192.168.1.1". This one's unique, required, it's a string, and it has no default — so like, you HAVE to give it, bestie, there's no fallback. 🫶
• nic — The base network interface where the IP address gets brought online.

If you leave it empty, the script will try and figure it out from the routing table all by itself. Independent queen. ✨

Do NOT put an alias interface in the form eth0:1 or anything like that here. Specify the base interface only. fr fr.

Prerequisite:

There has to be at least one static IP address assigned to the network interface, and it must not be managed by the cluster. Just a little something for the interface to hold onto. 💖

If you literally cannot assign any static IP address on the interface, then modify this kernel parameter: sysctl -w net.ipv4.conf.all.promote_secondaries=1 (or do it per device).

(optional, string, default "eth0")

• cidr_netmask — The netmask for the interface, in CIDR format (ie, 24), or in dotted quad notation (255.255.255.0). Either way works, she's flexible. 🦋

If you don't specify it, the script will also try to determine this from the routing table.

(optional, string, no default)

• broadcast — The broadcast address associated with the IP. If you leave it empty, the script will determine this from the netmask. She's got you. ✨

(optional, string, no default)

• iflabel — Here's where you can specify an additional label for your IP address if you want one. Cute little name tag. 🎀

(optional, string, no default)

• lvs_support — Enable support for LVS Direct Routing configurations. In case an IP address is stopped, only move it to the loopback device so the local node can keep servicing requests, but no longer advertise it on the network. Sneaky but on purpose. 👑

(optional, boolean, default false)

• local_stop_script — Script called when the IP is released.

(optional, string, no default)

• local_start_script — Script called when the IP is added.

(optional, string, no default)

• ARP_INTERVAL_MS — milliseconds between ARPs.

(optional, integer, default 500)

• ARP_REPEAT — How many gratuitous ARPs to send out when bringing up a new address.

(optional, integer, default 10)

• ARP_BACKGROUND — run in background (no longer any reason to do this). Not me pointing out that the manpage itself says there's no reason anymore 💀

(optional, boolean, default yes)

• ARP_NETMASK — netmask for ARP — in nonstandard hexadecimal format. Yes, hexadecimal. Stay weird. 🌈

(optional, string, default "ffffffffffff")

---

🔥 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: 5s.
• validate-all — Performs a validation of the resource configuration. Suggested minimum timeout: 20s.
• meta-data — Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

---

🌟 EXAMPLE CRM SHELL 🌟

The following is an example configuration for a IPaddr resource using the crm(8) shell:

primitive p_IPaddr ocf:heartbeat:IPaddr \
  params \
    ip=string \
  op monitor depth="0" timeout="20s" interval="5s"

---

🧚 EXAMPLE PCS 🧚

The following is an example configuration for a IPaddr resource using pcs(8):

pcs resource create p_IPaddr ocf:heartbeat:IPaddr \
  ip=string \
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="5s"

---

💜 SEE ALSO 💜

• http://clusterlabs.org/

---

🌸 AUTHOR 🌸

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

---

okay that's the whole page, you ate that 💅 this was resource-agents UNKNOWN, dated 04/08/2026, and it's the OCF_HEARTBEAT_IPADDR(7) page, so if you need it again just type man 7 ocf_heartbeat_IPaddr and she'll be right there. slay, bye bestie 🎀✨🦋