'\" t
.\"     Title: ocf_heartbeat_IPaddr2
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_IPADDR" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "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_IPaddr2 \- Manages virtual IPv4 and IPv6 addresses (Linux specific version)
.SH "SYNOPSIS"
.HP \w'\fBIPaddr2\fR\ 'u
\fBIPaddr2\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This Linux\-specific resource manages IP alias IP addresses\&. It can add an IP alias, or remove one\&. In addition, it can implement Cluster Alias IP functionality if invoked as a clone resource\&.
.PP
If used as a clone, you should explicitly set clone\-node\-max >= 2, and/or clone\-max < number of nodes\&. In case of node failure, clone instances need to be re\-allocated on surviving nodes\&. This would not be possible if there is already an instance on those nodes, and clone\-node\-max=1 (which is the default)\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBip\fR
.RS 4
The IPv4 (dotted quad notation) or IPv6 address (colon hexadecimal notation) example IPv4 "192\&.168\&.1\&.1"\&. example IPv6 "2001:db8:DC28:0:0:FC57:D4C8:1FFF"\&.
.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\&. 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\&. If you want a label, see the iflabel parameter\&.
.sp
Prerequisite:
.sp
There must be at least one static IP address, which is not managed by the cluster, assigned to the network interface\&. If you can not assign any static IP address on the interface, modify this kernel parameter:
.sp
sysctl \-w net\&.ipv4\&.conf\&.all\&.promote_secondaries=1 # (or per device)
.sp
(optional, string, no default)
.RE
.PP
\fBcidr_netmask\fR
.RS 4
The netmask for the interface in CIDR format (e\&.g\&., 24 and not 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\&. It is possible to use the special symbols \*(Aq+\*(Aq and \*(Aq\-\*(Aq instead of the broadcast address\&. In this case, the broadcast address is derived by setting/resetting the host bits of the interface prefix\&.
.sp
(optional, string, no default)
.RE
.PP
\fBiflabel\fR
.RS 4
You can specify an additional label for your IP address here\&. This label is appended to your interface name\&.
.sp
The kernel allows alphanumeric labels up to a maximum length of 15 characters including the interface name and colon (e\&.g\&. eth0:foobar1234)
.sp
A label can be specified in nic parameter but it is deprecated\&. If a label is specified in nic name, this parameter has no effect\&.
.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
Notes for IPv6: It is not necessary to enable this option on IPv6\&. Instead, enable \*(Aqlvs_ipv6_addrlabel\*(Aq option for LVS\-DR usage on IPv6\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBlvs_ipv6_addrlabel\fR
.RS 4
Enable adding IPv6 address label so IPv6 traffic originating from the address\*(Aqs interface does not use this address as the source\&. This is necessary for LVS\-DR health checks to realservers to work\&. Without it, the most recently added IPv6 address (probably the address added by IPaddr2) will be used as the source address for IPv6 traffic from that interface and since that address exists on loopback on the realservers, the realserver response to pings/connections will never leave its loopback\&. See RFC3484 for the detail of the source address selection\&.
.sp
See also \*(Aqlvs_ipv6_addrlabel_value\*(Aq parameter\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBlvs_ipv6_addrlabel_value\fR
.RS 4
Specify IPv6 address label value used when \*(Aqlvs_ipv6_addrlabel\*(Aq is enabled\&. The value should be an unused label in the policy table which is shown by \*(Aqip addrlabel list\*(Aq command\&. You would rarely need to change this parameter\&.
.sp
(optional, integer, default
99)
.RE
.PP
\fBmac\fR
.RS 4
Set the interface MAC address explicitly\&. Currently only used in case of the Cluster IP Alias\&. Leave empty to chose automatically\&.
.sp
(optional, string, no default)
.RE
.PP
\fBclusterip_hash\fR
.RS 4
Specify the hashing algorithm used for the Cluster IP functionality\&.
.sp
(optional, string, default "sourceip\-sourceport")
.RE
.PP
\fBunique_clone_address\fR
.RS 4
If true, add the clone ID to the supplied value of IP to create a unique address to manage
.sp
(optional, boolean, default
false)
.RE
.PP
\fBarp_interval\fR
.RS 4
Specify the interval between unsolicited ARP packets in milliseconds\&.
.sp
(optional, integer, default
200)
.RE
.PP
\fBarp_count\fR
.RS 4
Number of unsolicited ARP packets to send at resource initialization\&.
.sp
(optional, integer, default
5)
.RE
.PP
\fBarp_count_refresh\fR
.RS 4
Number of unsolicited ARP packets to send during resource monitoring\&. Doing so helps mitigate issues of stuck ARP caches resulting from split\-brain situations\&.
.sp
(optional, integer, default
0)
.RE
.PP
\fBarp_bg\fR
.RS 4
Whether or not to send the ARP packets in the background\&.
.sp
(optional, string, default "true")
.RE
.PP
\fBarp_mac\fR
.RS 4
MAC address to send the ARP packets to\&.
.sp
You really shouldn\*(Aqt be touching this\&.
.sp
(optional, string, default "ffffffffffff")
.RE
.PP
\fBarp_sender\fR
.RS 4
The program to send ARP packets with on start\&. For infiniband interfaces, default is ipoibarping\&. If ipoibarping is not available, set this to send_arp\&.
.sp
(optional, string, no default)
.RE
.PP
\fBflush_routes\fR
.RS 4
Flush the routing table on stop\&. This is for applications which use the cluster IP address and which run on the same physical host that the IP address lives on\&. The Linux kernel may force that application to take a shortcut to the local loopback interface, instead of the interface the address is really bound to\&. Under those circumstances, an application may, somewhat unexpectedly, continue to use connections for some time even after the IP address is deconfigured\&. Set this parameter in order to immediately disable said shortcut when the IP address goes away\&.
.sp
(optional, boolean, default
false)
.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
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a IPaddr2 resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_IPaddr2 ocf:heartbeat:IPaddr2 \e
  params \e
    ip=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a IPaddr2 resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_IPaddr2 ocf:heartbeat:IPaddr2 \e
  ip=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="10s" 
.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