'\" t
.\"     Title: ocf_heartbeat_IPaddr
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_IPADDR" "7" "04/13/2023" "resource-agents 4.12.0-2" "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_IPaddr \- Manages virtual IPv4 addresses (portable version)
.SH "SYNOPSIS"
.HP \w'\fBIPaddr\fR\ 'u
\fBIPaddr\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This script manages IP alias IP addresses It can add an IP alias, or remove one\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBip\fR
.RS 4
The IPv4 address to be configured in dotted quad notation, for example "192\&.168\&.1\&.1"\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBnic\fR
.RS 4
The base network interface on which the IP address will be brought online\&.
.sp
If left empty, the script will try and determine this from the routing table\&.
.sp
Do NOT specify an alias interface in the form eth0:1 or anything here; rather, specify the base interface only\&.
.sp
Prerequisite:
.sp
There must be at least one static IP address, which is not managed by the cluster, assigned to the network interface\&.
.sp
If you can not assign any static IP address on the interface, modify this kernel parameter: sysctl \-w net\&.ipv4\&.conf\&.all\&.promote_secondaries=1 (or per device)
.sp
(optional, string, default "eth0")
.RE
.PP
\fBcidr_netmask\fR
.RS 4
The netmask for the interface in CIDR format\&. (ie, 24), or in dotted quad notation 255\&.255\&.255\&.0)\&.
.sp
If unspecified, the script will also try to determine this from the routing table\&.
.sp
(optional, string, no default)
.RE
.PP
\fBbroadcast\fR
.RS 4
Broadcast address associated with the IP\&. If left empty, the script will determine this from the netmask\&.
.sp
(optional, string, no default)
.RE
.PP
\fBiflabel\fR
.RS 4
You can specify an additional label for your IP address here\&.
.sp
(optional, string, no default)
.RE
.PP
\fBlvs_support\fR
.RS 4
Enable support for LVS Direct Routing configurations\&. In case a IP address is stopped, only move it to the loopback device to allow the local node to continue to service requests, but no longer advertise it on the network\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBlocal_stop_script\fR
.RS 4
Script called when the IP is released
.sp
(optional, string, no default)
.RE
.PP
\fBlocal_start_script\fR
.RS 4
Script called when the IP is added
.sp
(optional, string, no default)
.RE
.PP
\fBARP_INTERVAL_MS\fR
.RS 4
milliseconds between ARPs
.sp
(optional, integer, default
500)
.RE
.PP
\fBARP_REPEAT\fR
.RS 4
How many gratuitous ARPs to send out when bringing up a new address
.sp
(optional, integer, default
10)
.RE
.PP
\fBARP_BACKGROUND\fR
.RS 4
run in background (no longer any reason to do this)
.sp
(optional, boolean, default
yes)
.RE
.PP
\fBARP_NETMASK\fR
.RS 4
netmask for ARP \- in nonstandard hexadecimal format\&.
.sp
(optional, string, default "ffffffffffff")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a IPaddr resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_IPaddr ocf:heartbeat:IPaddr \e
  params \e
    ip=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="5s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a IPaddr resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_IPaddr ocf:heartbeat:IPaddr \e
  ip=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="5s" 
.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