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. It is possible to use the
62 special symbols '+' and '-' instead of the broadcast address. In
63 this case, the broadcast address is derived by setting/resetting
64 the host bits of the interface prefix.
65 (optional, string, no default)
67 iflabel
69 You can specify an additional label for your IP address here. This
70 label is appended to your interface name.
71 The kernel allows alphanumeric labels up to a maximum length of 15
73 characters including the interface name and colon (e.g.
74 eth0:foobar1234)
75 A label can be specified in nic parameter but it is deprecated. If
77 a label is specified in nic name, this parameter has no effect.
78 (optional, string, no default)
80 lvs_support
82 Enable support for LVS Direct Routing configurations. In case a IP
83 address is stopped, only move it to the loopback device to allow
84 the local node to continue to service requests, but no longer
85 advertise it on the network.
86 Notes for IPv6: It is not necessary to enable this option on IPv6.
88 Instead, enable 'lvs_ipv6_addrlabel' option for LVS-DR usage on
89 IPv6.
90 (optional, boolean, default false)
92 lvs_ipv6_addrlabel
94 Enable adding IPv6 address label so IPv6 traffic originating from
95 the address's interface does not use this address as the source.
96 This is necessary for LVS-DR health checks to realservers to work.
97 Without it, the most recently added IPv6 address (probably the
98 address added by IPaddr2) will be used as the source address for
99 IPv6 traffic from that interface and since that address exists on
100 loopback on the realservers, the realserver response to
101 pings/connections will never leave its loopback. See RFC3484 for
102 the detail of the source address selection.
103 See also 'lvs_ipv6_addrlabel_value' parameter.
105 (optional, boolean, default false)
107 lvs_ipv6_addrlabel_value
109 Specify IPv6 address label value used when 'lvs_ipv6_addrlabel' is
110 enabled. The value should be an unused label in the policy table
111 which is shown by 'ip addrlabel list' command. You would rarely
112 need to change this parameter.
113 (optional, integer, default 99)
115 mac
117 Set the interface MAC address explicitly. Currently only used in
118 case of the Cluster IP Alias. Leave empty to chose automatically.
119 (optional, string, no default)
121 clusterip_hash
123 Specify the hashing algorithm used for the Cluster IP
124 functionality.
125 (optional, string, default "sourceip-sourceport")
127 unique_clone_address
129 If true, add the clone ID to the supplied value of IP to create a
130 unique address to manage
131 (optional, boolean, default false)
133 arp_interval
135 Specify the interval between unsolicited ARP packets in
136 milliseconds.
137 This parameter is deprecated and used for the backward
139 compatibility only. It is effective only for the send_arp binary
140 which is built with libnet, and send_ua for IPv6. It has no effect
141 for other arp_sender.
142 (optional, integer, default 200)
144 arp_count
146 Number of unsolicited ARP packets to send at resource
147 initialization.
148 (optional, integer, default 5)
150 arp_count_refresh
152 Number of unsolicited ARP packets to send during resource
153 monitoring. Doing so helps mitigate issues of stuck ARP caches
154 resulting from split-brain situations.
155 (optional, integer, default 0)
157 arp_bg
159 Whether or not to send the ARP packets in the background.
160 (optional, string, default "true")
162 arp_sender
164 The program to send ARP packets with on start. Available options
165 are: - send_arp: default - ipoibarping: default for infiniband
166 interfaces if ipoibarping is available - iputils_arping: use arping
167 in iputils package - libnet_arping: use another variant of arping
168 based on libnet
169 (optional, string, no default)
171 send_arp_opts
173 Extra options to pass to the arp_sender program. Available options
174 are vary depending on which arp_sender is used.
175 A typical use case is specifying '-A' for iputils_arping to use ARP
177 REPLY instead of ARP REQUEST as Gratuitous ARPs.
178 (optional, string, no default)
180 flush_routes
182 Flush the routing table on stop. This is for applications which use
183 the cluster IP address and which run on the same physical host that
184 the IP address lives on. The Linux kernel may force that
185 application to take a shortcut to the local loopback interface,
186 instead of the interface the address is really bound to. Under
187 those circumstances, an application may, somewhat unexpectedly,
188 continue to use connections for some time even after the IP address
189 is deconfigured. Set this parameter in order to immediately disable
190 said shortcut when the IP address goes away.
191 (optional, boolean, default false)
193 run_arping
195 Whether or not to run arping for IPv4 collision detection check.
196 (optional, string, default "false")
198 preferred_lft
200 For IPv6, set the preferred lifetime of the IP address. This can be
201 used to ensure that the created IP address will not be used as a
202 source address for routing. Expects a value as specified in section
203 5.5.4 of RFC 4862.
204 (optional, string, default "forever")
206 network_namespace
208 Specifies the network namespace to operate within. The namespace
209 must already exist, and the interface to be used must be within the
210 namespace.
211 (optional, string, no default)
213
215 This resource agent supports the following actions (operations):
216 start
218 Starts the resource. Suggested minimum timeout: 20s.
219 stop
221 Stops the resource. Suggested minimum timeout: 20s.
222 status
224 Performs a status check. Suggested minimum timeout: 20s. Suggested
225 interval: 10s.
226 monitor
228 Performs a detailed status check. Suggested minimum timeout: 20s.
229 Suggested interval: 10s.
230 meta-data
232 Retrieves resource agent metadata (internal use only). Suggested
233 minimum timeout: 5s.
234 validate-all
236 Performs a validation of the resource configuration. Suggested
237 minimum timeout: 20s.
238
240 The following is an example configuration for a IPaddr2 resource using
241 the crm(8) shell:
242 primitive p_IPaddr2 ocf:heartbeat:IPaddr2 \
244 params \
245 ip=string \
246 op monitor depth="0" timeout="20s" interval="10s"
247
249 The following is an example configuration for a IPaddr2 resource using
250 pcs(8)
251 pcs resource create p_IPaddr2 ocf:heartbeat:IPaddr2 \
253 ip=string \
254 op monitor depth="0" timeout="20s" interval="10s"
255
257 http://clusterlabs.org/
258
260 ClusterLabs contributors (see the resource agent source for information
261 about individual authors)
262resource-agents UNKNOWN 10/23/2019 OCF_HEARTBEAT_IPADDR(7)