OCF_HEARTBEAT_OCIVIP(7)

💅 NAME 💅

ocf_heartbeat_ocivip — the OCI Secondary Private IP Address for Compute instances Resource Agent, bestie. Yes it's a mouthful, no we're not shortening it. 🫶

---

✨ SYNOPSIS ✨

ocivip [start | stop | monitor | migrate_to | migrate_from | meta-data |
       validate-all]

---

🦋 DESCRIPTION 🦋

Okay so, this is the Resource Agent for OCI Compute instance Secondary Private IP Addresses. It handles those OCI Secondary Private IP Addresses for your Compute instances, and it does it all through oci cli. Periodt.

Wanna know more about oci cli? The docs live here, go look:

https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm

🌸 Prerequisites (aka the vibe check you must pass) 🌸

• OCI CLI installed (https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/climanualinst.htm)
• jq installed
• dynamic group with a policy attacched
• the policy must have this statement: allow dynamic-group GROUP_NAME to use virtual-network-family in compartment id COMPARTMENT_ID
• a reserved secondary private IP address for Compute Instances high availability

Also, this resource agent may be configured for native migration if that's available in your cluster manager. For Pacemaker specifically, the allow-migrate="true" meta attribute is what enables native migration. iykyk 💅

---

👑 SUPPORTED PARAMETERS 👑

• ocicli — the OCI Command line interface (CLI) tools, literally the whole thing. (optional, string, default "/usr/local/bin/oci")
• secondary_private_ip — reserved secondary private ip for compute instance. (unique, required, string, no default — yeah bestie you must bring this one, no skipping 💀)
• cidr_netmask — netmask for the secondary_private_ip. (optional, integer, default 24)
• interface_alias — numeric alias for the interface. (optional, integer, default 0)
• api_delay — a short delay between API calls, to avoid sending API too quick. She needs a little breather between calls, ok?? 🧚 (optional, integer, default 3)

---

⭐ SUPPORTED ACTIONS ⭐

This resource agent supports the following actions (operations):

• start — Starts the resource. Suggested minimum timeout: 30s.
• stop — Stops the resource. Suggested minimum timeout: 30s.
• monitor — Performs a detailed status check. Suggested minimum timeout: 30s. Suggested interval: 20s.
• migrate_to — Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 30s.
• migrate_from — Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout: 30s.
• meta-data — Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.
• validate — Suggested minimum timeout: 10s.
• validate-all — Performs a validation of the resource configuration. Suggested minimum timeout: 10s.

---

🎀 EXAMPLE CRM SHELL 🎀

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

primitive p_ocivip ocf:heartbeat:ocivip \
  params \
    secondary_private_ip=string \
  meta allow-migrate="true" \
  op monitor timeout="30s" interval="20s" depth="0"

---

💖 EXAMPLE PCS 💖

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

pcs resource create p_ocivip ocf:heartbeat:ocivip \
  secondary_private_ip=string \
  op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0"

---

🌈 SEE ALSO 🌈

http://clusterlabs.org/

---

💜 AUTHOR 💜

ClusterLabs contributors (see the resource agent source for information about individual authors). Shoutout to the whole squad, they ate and left no crumbs. 🔥

---

okay that's the whole page, you're so welcome bestie 💅✨ this was resource-agents UNKNOWN, dated 04/08/2026, and yeah — OCF_HEARTBEAT_OCIVIP(7). go forth and cluster, mwah 🫶🎀