1OCF_HEARTBEAT_IPADDR(7) OCF resource agents OCF_HEARTBEAT_IPADDR(7)
2
6 ocf_heartbeat_IPaddr2 - Manages virtual IPv4 and IPv6 addresses (Linux
7 specific version)
8
10 IPaddr2 [start | stop | status | monitor | meta-data | validate-all]
11
13 This Linux-specific resource manages IP alias IP addresses. It can add
14 an IP alias, or remove one. In addition, it can implement Cluster Alias
15 IP functionality if invoked as a clone resource.
16 If used as a clone, you should explicitly set clone-node-max >= 2,
18 and/or clone-max < number of nodes. In case of node failure, clone
19 instances need to be re-allocated on surviving nodes. This would not be
20 possible if there is already an instance on those nodes, and
21 clone-node-max=1 (which is the default).
22
24 ip
25 The IPv4 (dotted quad notation) or IPv6 address (colon hexadecimal
26 notation) example IPv4 "192.168.1.1". example IPv6
27 "2001:db8:DC28:0:0:FC57:D4C8:1FFF".
28 (unique, required, string, no default)
30 nic
32 The base network interface on which the IP address will be brought
33 online. If left empty, the script will try and determine this from
34 the routing table.
35 Do NOT specify an alias interface in the form eth0:1 or anything
37 here; rather, specify the base interface only. If you want a label,
38 see the iflabel parameter.
39 Prerequisite:
41 There must be at least one static IP address, which is not managed
43 by the cluster, assigned to the network interface. If you can not
44 assign any static IP address on the interface, modify this kernel
45 parameter:
46 sysctl -w net.ipv4.conf.all.promote_secondaries=1 # (or per device)
48 (optional, string, no default)
50 cidr_netmask
52 The netmask for the interface in CIDR format (e.g., 24 and not
53 255.255.255.0)
54 If unspecified, the script will also try to determine this from the
56 routing table.
57 (optional, string, no default)
59 broadcast
61 Broadcast address associated with the IP. If left empty, the script
62 will determine this from the netmask.
63 (optional, string, no default)
65 iflabel
67 You can specify an additional label for your IP address here. This
68 label is appended to your interface name.
69 A label can be specified in nic parameter but it is deprecated. If
71 a label is specified in nic name, this parameter has no effect.
72 (optional, string, no default)
74 lvs_support
76 Enable support for LVS Direct Routing configurations. In case a IP
77 address is stopped, only move it to the loopback device to allow
78 the local node to continue to service requests, but no longer
79 advertise it on the network.
80 Notes for IPv6: It is not necessary to enable this option on IPv6.
82 Instead, enable ´lvs_ipv6_addrlabel´ option for LVS-DR usage on
83 IPv6.
84 (optional, boolean, default false)
86 lvs_ipv6_addrlabel
88 Enable adding IPv6 address label so IPv6 traffic originating from
89 the address´s interface does not use this address as the source.
90 This is necessary for LVS-DR health checks to realservers to work.
91 Without it, the most recently added IPv6 address (probably the
92 address added by IPaddr2) will be used as the source address for
93 IPv6 traffic from that interface and since that address exists on
94 loopback on the realservers, the realserver response to
95 pings/connections will never leave its loopback. See RFC3484 for
96 the detail of the source address selection.
97 See also ´lvs_ipv6_addrlabel_value´ parameter.
99 (optional, boolean, default false)
101 lvs_ipv6_addrlabel_value
103 Specify IPv6 address label value used when ´lvs_ipv6_addrlabel´ is
104 enabled. The value should be an unused label in the policy table
105 which is shown by ´ip addrlabel list´ command. You would rarely
106 need to change this parameter.
107 (optional, integer, default 99)
109 mac
111 Set the interface MAC address explicitly. Currently only used in
112 case of the Cluster IP Alias. Leave empty to chose automatically.
113 (optional, string, no default)
115 clusterip_hash
117 Specify the hashing algorithm used for the Cluster IP
118 functionality.
119 (optional, string, default "sourceip-sourceport")
121 unique_clone_address
123 If true, add the clone ID to the supplied value of IP to create a
124 unique address to manage
125 (optional, boolean, default false)
127 arp_interval
129 Specify the interval between unsolicited ARP packets in
130 milliseconds.
131 (optional, integer, default 200)
133 arp_count
135 Number of unsolicited ARP packets to send.
136 (optional, integer, default 5)
138 arp_bg
140 Whether or not to send the ARP packets in the background.
141 (optional, string, default "true")
143 arp_mac
145 MAC address to send the ARP packets to.
146 You really shouldn´t be touching this.
148 (optional, string, default "ffffffffffff")
150 arp_sender
152 The program to send ARP packets with on start. For infiniband
153 interfaces, default is ipoibarping. If ipoibarping is not
154 available, set this to send_arp.
155 (optional, string, no default)
157 flush_routes
159 Flush the routing table on stop. This is for applications which use
160 the cluster IP address and which run on the same physical host that
161 the IP address lives on. The Linux kernel may force that
162 application to take a shortcut to the local loopback interface,
163 instead of the interface the address is really bound to. Under
164 those circumstances, an application may, somewhat unexpectedly,
165 continue to use connections for some time even after the IP address
166 is deconfigured. Set this parameter in order to immediately disable
167 said shortcut when the IP address goes away.
168 (optional, boolean, default false)
170
172 This resource agent supports the following actions (operations):
173 start
175 Starts the resource. Suggested minimum timeout: 20s.
176 stop
178 Stops the resource. Suggested minimum timeout: 20s.
179 status
181 Performs a status check. Suggested minimum timeout: 20s. Suggested
182 interval: 10s.
183 monitor
185 Performs a detailed status check. Suggested minimum timeout: 20s.
186 Suggested interval: 10s.
187 meta-data
189 Retrieves resource agent metadata (internal use only). Suggested
190 minimum timeout: 5s.
191 validate-all
193 Performs a validation of the resource configuration. Suggested
194 minimum timeout: 20s.
195
197 The following is an example configuration for a IPaddr2 resource using
198 the crm(8) shell:
199 primitive p_IPaddr2 ocf:heartbeat:IPaddr2 \
201 params \
202 ip=string \
203 op monitor depth="0" timeout="20s" interval="10s"
204
206 http://www.linux-ha.org/wiki/IPaddr2_(resource_agent)
207
209 Linux-HA contributors (see the resource agent source for information
210 about individual authors)
211resource-agents 3.9.2 03/24/2017 OCF_HEARTBEAT_IPADDR(7)