'\" t .\" Title: ocf_heartbeat_IPaddr2 .\" Author: Linux-HA contributors (see the resource agent source for information about individual authors) .\" Generator: DocBook XSL Stylesheets v1.76.1 .\" Date: 03/09/2014 .\" Manual: OCF resource agents .\" Source: resource-agents UNKNOWN .\" Language: English .\" .TH "OCF_HEARTBEAT_IPADDR" "7" "03/09/2014" "resource-agents UNKNOWN" "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 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\&. .SH "SUPPORTED PARAMETERS" .PP \fBip\fR .RS 4 The IPv4 address to be configured in dotted quad notation, for example "192\&.168\&.1\&.1"\&. (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 (e\&.g\&., 24 and not 255\&.255\&.255\&.0) .sp If unspecified, the script will also try to determine this from the routing table\&. (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\&. (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\&. If a label is specified in nic name, this parameter has no effect\&. (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\&. (optional, boolean, default false) .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 (optional, boolean, default false) .RE .PP \fBarp_interval\fR .RS 4 Specify the interval between unsolicited ARP packets in milliseconds\&. (optional, integer, default 200) .RE .PP \fBarp_count\fR .RS 4 Number of unsolicited ARP packets to send\&. (optional, integer, default 5) .RE .PP \fBarp_bg\fR .RS 4 Whether or not to send the arp packets in the background\&. (optional, string, default yes) .RE .PP \fBarp_mac\fR .RS 4 MAC address to send the ARP packets too\&. .sp You really shouldn\*(Aqt be touching this\&. .sp (optional, string, default ffffffffffff) .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\&. (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" .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 "SEE ALSO" .PP \m[blue]\fB\%http://www.linux-ha.org/wiki/IPaddr2_(resource_agent)\fR\m[] .SH "AUTHOR" .PP \fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR