OCF_HEARTBEAT_POWERV(7)

NAME
ocf_heartbeat_powervs-move-ip - Manages Power Virtual Server overlay IP routes.

SYNOPSIS

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

DESCRIPTION

Resource Agent to move an IP address from one Power Virtual Server instance to another.

Prerequisites: 1. Two-node cluster - Distributed across two PowerVS workspaces in separate data centers within the same region.

2. IBM Cloud API Key: - Create a service API key with privileges for both workspaces. - Save the key in a file and copy it to both cluster nodes using the same path and filename. - Reference the key file path 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
    API Key or @API_KEY_FILE_PATH for IBM Cloud access. The API key content or the path of an API key file that is indicated by the @ symbol.

    (required, string, no default)

api_type
    Connect to Power Virtual Server regional endpoints over a public or private network (public|private).

    (required, 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
    Map the hostname of the Power Virtual Server instance to the route CRN of the overlay IP route. Separate hostname and route CRN with a colon ':', separate different hostname and route CRN pairs with a semicolon ';'. Example: hostname1:route-crn-of-instance1;hostname2:route-crn-of-instance2

    (required, string, no default)

use_token_cache
    Enable caching of the API access token in a local file to reduce authentication overhead.

    (optional, string, default "True")

monitor_api
    Enable 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)

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

The following is an example configuration for a powervs-move-ip resource using the crm(8) shell:

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

EXAMPLE PCS

The following is an example configuration for a powervs-move-ip resource using pcs(8)

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

SEE ALSO

http://clusterlabs.org/

AUTHOR

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