OCF_HEARTBEAT_POWERV(7)

🌸 NAME 🌸

okay bestie, this is OCF_HEARTBEAT_POWERV(7) from the OCF resource agents manual, and the star of the show is ocf_heartbeat_powervs-move-ip — it manages Power Virtual Server overlay IP routes. That’s the whole name situation, iconic behavior only. 💅

---

✨ SYNOPSIS ✨

powervs-move-ip [start | stop | monitor | meta-data | validate-all]

---

💖 DESCRIPTION 💖

This resource agent moves an IP address from one Power Virtual Server instance to another. slay. ✨

Prerequisites, bestie — read these fr fr:

1. High availability cluster — the cluster nodes must be deployed across two Power Virtual Server workspaces located in separate data centers within the same region. The virtual IP can only move between a fixed pair of nodes, with each node residing in a separate workspace.
2. Predefined static routes — static routes must be configured in both workspaces. Each route must use the service IP as the destination and the corresponding node IP address as the next hop.
3. IBM Power Cloud API authentication — authentication must be configured using either the Power Virtual Server Metadata service or an IBM Cloud API key (these options are mutually exclusive):
   • use a trusted profile with the required privileges for both workspaces, or
   • use a service API key with the required privileges for both workspaces, stored locally on the cluster nodes.
   • the trusted profile name or the API key must be referenced in the resource definition.

For detailed guidance on high availability for SAP applications on PowerVS, visit: https://cloud.ibm.com/docs/sap?topic=sap-ha-overview. 🫶

---

🎀 SUPPORTED PARAMETERS 🎀

• ip — the virtual IP address is the destination address of a network route. (required, string, no default)
• api_key — IBM Cloud API key, or a file path prefixed with @ containing the API key. If this parameter is not specified or set to its default value identity_token, authentication uses the Power Virtual Server Metadata API. In this case, an IBM Cloud Identity and Access Management (IAM) trusted profile is used to establish a trust relationship with the virtual server instance, and the trusted profile can be selected with the profile parameter. (optional, string, default "identity_token")
• api_type — connection to Power Virtual Server regional endpoints over a public or private network (public|private). (optional, string, default "private")
• region — region that represents the geographic area where the instance is located. The region is used to identify the Cloud API endpoint. (required, string, no default)
• route_host_map — mapping of the hostname of the Power Virtual Server instance to the route CRN of the overlay IP route. Separate the hostname and route CRN with a colon ':', separate different hostname and route CRN pairs with a semicolon ';'. Exactly two entries are allowed. Example: hostname1:route-crn-of-instance1;hostname2:route-crn-of-instance2 (required, string, no default)
• use_token_cache — caching of the API access token in a local file to reduce authentication overhead. (optional, string, default "True")
• monitor_api — enhanced monitoring by using Power Cloud API calls to verify route configuration correctness. (optional, string, default "False")
• device — network adapter for the overlay IP address. The adapter must have the same name on all Power Virtual Server instances. If the device parameter is not specified, the IP alias is assigned to the interface whose configured IP address matches the route’s next hop address. (optional, string, no default)
• iflabel — a custom suffix for the IP address label. It is appended to the interface name in the format device:label. The full label must not exceed 15 characters. (optional, string, no default)
• proxy — proxy server used to access IBM Cloud API endpoints. The value must be a valid URL in the format http[s]://hostname:port. (optional, string, no default)
• profile — trusted profile associated with the instance for authorization using the metadata API. Use id:PROFILE_ID to select a profile by id or name:PROFILE_NAME to select a profile by name. If not specified, the default trusted profile is used. (optional, string, no default)
• atomic — when set to True, the local route is enabled and the remote route is disabled atomically using a single API call (POST /v1/routes/{id}/switch-enabled). When set to False (default), the routes are updated individually. (optional, string, default "False")

---

🦋 SUPPORTED ACTIONS 🦋

This resource agent supports the following actions (operations):

• start — starts the resource. Suggested minimum timeout: 60s.
• stop — stops the resource. Suggested minimum timeout: 60s.
• monitor — performs a detailed status check. Suggested minimum timeout: 60s. Suggested interval: 60s.
• validate-all — performs a validation of the resource configuration. Suggested minimum timeout: 60s.
• meta-data — retrieves resource agent metadata (internal use only). Suggested minimum timeout: 10s.

---

💅 EXAMPLE CRM SHELL 💅

Here’s the example config for a powervs-move-ip resource using the crm(8) shell 🫶

primitive p_powervs-move-ip ocf:heartbeat:powervs-move-ip \
  params \
    ip=string \
    region=string \
    route_host_map=string \
  op monitor timeout="60s" interval="60s" depth="0"

---

🌈 EXAMPLE PCS 🌈

And here’s the example config for a powervs-move-ip resource using pcs(8) 🌸

pcs resource create p_powervs-move-ip ocf:heartbeat:powervs-move-ip \
  ip=string \
  region=string \
  route_host_map=string \
  op monitor timeout="60s" interval="60s" OCF_CHECK_LEVEL="0"

---

🔥 SEE ALSO 🔥

http://clusterlabs.org/ — go look, bestie. 👑

---

👑 AUTHOR 👑

ClusterLabs contributors (see the resource agent source for information about individual authors). Respect the contributors, fr fr. 🫶

---

This page’s footer energy: OCF_HEARTBEAT_POWERV(7) from resource-agents, version UNKNOWN, dated 10/01/2026. Byeee, bestie! 💖✨