OCF_HEARTBEAT_ROUTE(7)

✨ NAME ✨

okay so bestie, this is the OCF_HEARTBEAT_ROUTE(7) page, and the star of the show is ocf_heartbeat_Route — it literally Manages network routes. That’s the whole vibe. 💅

🌸 SYNOPSIS 🌸

Use it like this, no cap:

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

🦋 DESCRIPTION 🦋

So what does it do? It enables and disables network routes. It supports host and net routes, routes via a gateway address, and routes using specific source addresses.

This resource agent is useful if a node’s routing table needs to be manipulated based on node role assignment. Highkey iconic. 🫶

Consider this example use case, bestie:

• One cluster node serves as an IPsec tunnel endpoint.
• All other nodes use the IPsec tunnel to reach hosts in a specific remote network.

Then here’s how you’d implement this scheme making use of the Route resource agent:

• Configure an ipsec LSB resource.
• Configure a cloned Route OCF resource.
• Create an order constraint to ensure that ipsec is started before Route.
• Create a colocation constraint between the ipsec and Route resources, to make sure no instance of your cloned Route resource is started on the tunnel endpoint itself.

💖 SUPPORTED PARAMETERS 💖

Parameter time, bestie. These are the knobs:

• destination — The destination network (or host) to be configured for the route. Specify the netmask suffix in CIDR notation (e.g. "/24"). If no suffix is given, a host route will be created. Specify "0.0.0.0/0" or "::/0" if you want this resource to set the system default route. The keyword "default" is also accepted, but the unique constraint on this parameter will prevent from adding both IPv4 and IPv6 default routes at the same time in this way.

(unique, required, string, no default)

• device — The outgoing network device to use for this route.

(optional, string, no default)

• gateway — The gateway IP address to use for this route.

(optional, string, no default)

• source — The source IP address to be configured for the route.

(optional, string, no default)

• table — The routing table to be configured for the route.

(optional, string, no default)

• family — The address family to be used for the route. The options are ip4 for IP version 4, ip6 for IP version 6, and detect to detect from the destination address.

(optional, string, default "detect")

🔥 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: 10s.
• reload — Suggested minimum timeout: 20s.
• 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: 20s.

🎀 EXAMPLE CRM SHELL 🎀

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

           primitive p_Route ocf:heartbeat:Route \
             params \
               destination=string \
             op monitor timeout="20s" interval="10s" depth="0"

🍓 EXAMPLE PCS 🍓

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

           pcs resource create p_Route ocf:heartbeat:Route \
             destination=string \
             op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"

🌈 SEE ALSO 🌈

Go look at http://clusterlabs.org/ — that’s the SEE ALSO, bestie. ✨

👑 AUTHOR 👑

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

---

source/version: resource-agents UNKNOWN · date: 10/01/2026 — ok bye bestie, slay your routes 💋✨