---
name: "ocf_heartbeat_ocivip"
section: "7"
platform: "linux"
package: "resource-agents"
version: "1:4.16.0-3+deb13u2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ocf_heartbeat_ocivip"
---

# ocf\_heartbeat\_ocivip(7)

OCI Secondary Private IP Address for Compute instances Resource Agent

## NAME

ocf\_heartbeat\_ocivip - OCI Secondary Private IP Address for Compute instances Resource Agent

## SYNOPSIS

**ocivip** \[start \| stop \| monitor \| migrate\_to \| migrate\_from \| meta-data \| validate-all\]

## DESCRIPTION

Resource Agent for OCI Compute instance Secondary Private IP Addresses.

It manages OCI Secondary Private IP Addresses for Compute instances with oci cli.

See https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm for more information about oci cli.

Prerequisites:

\- 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

This resource agent may be configured for *native migration* if available in the cluster manager. For Pacemaker, the *allow-migrate="true"* meta attribute enables native migration.

## SUPPORTED PARAMETERS

**ocicli**

OCI Command line interface (CLI) tools

(optional, string, default "/usr/local/bin/oci")

**secondary\_private\_ip**

reserved secondary private ip for compute instance

(unique, required, string, no default)

**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

(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)](/crm/8.md) 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/8.md)

```
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)**