'\" t
.\"     Title: ocf_heartbeat_ocivip
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_OCIVIP" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_ocivip \- OCI Secondary Private IP Address for Compute instances Resource Agent
.SH "SYNOPSIS"
.HP \w'\fBocivip\fR\ 'u
\fBocivip\fR [start | stop | monitor | migrate_to | migrate_from | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent for OCI Compute instance Secondary Private IP Addresses\&.
.PP
It manages OCI Secondary Private IP Addresses for Compute instances with oci cli\&.
.PP
See https://docs\&.oracle\&.com/en\-us/iaas/Content/API/Concepts/cliconcepts\&.htm for more information about oci cli\&.
.PP
Prerequisites:
.PP
\- OCI CLI installed (https://docs\&.oracle\&.com/en\-us/iaas/Content/API/SDKDocs/climanualinst\&.htm)
.PP
\- jq installed
.PP
\- dynamic group with a policy attacched
.PP
\- the policy must have this statement: allow dynamic\-group GROUP_NAME to use virtual\-network\-family in compartment id COMPARTMENT_ID
.PP
\- a reserved secondary private IP address for Compute Instances high availability
.PP
.PP
This resource agent may be configured for
\fInative migration\fR
if available in the cluster manager\&. For Pacemaker, the
\fIallow\-migrate="true"\fR
meta attribute enables native migration\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBocicli\fR
.RS 4
OCI Command line interface (CLI) tools
.sp
(optional, string, default "/usr/local/bin/oci")
.RE
.PP
\fBsecondary_private_ip\fR
.RS 4
reserved secondary private ip for compute instance
.sp
(unique, required, string, no default)
.RE
.PP
\fBcidr_netmask\fR
.RS 4
netmask for the secondary_private_ip
.sp
(optional, integer, default
24)
.RE
.PP
\fBinterface_alias\fR
.RS 4
numeric alias for the interface
.sp
(optional, integer, default
0)
.RE
.PP
\fBapi_delay\fR
.RS 4
a short delay between API calls, to avoid sending API too quick
.sp
(optional, integer, default
3)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 20s\&.
.RE
.PP
\fBmigrate_to\fR
.RS 4
Executes steps necessary for migrating the resource
\fIto\fR
the node\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmigrate_from\fR
.RS 4
Executes steps necessary for migrating the resource
\fIaway from\fR
the node\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\fR
.RS 4
Suggested minimum timeout: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 10s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a ocivip resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_ocivip ocf:heartbeat:ocivip \e
  params \e
    secondary_private_ip=\fIstring\fR \e
  meta allow\-migrate="true" \e
  op monitor timeout="30s" interval="20s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a ocivip resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_ocivip ocf:heartbeat:ocivip \e
  secondary_private_ip=\fIstring\fR \e
  op monitor timeout="30s" interval="20s" OCF_CHECK_LEVEL="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR