1OCF_HEARTBEAT_IPADDR(7) OCF resource agents OCF_HEARTBEAT_IPADDR(7)
2
6 ocf_heartbeat_IPaddr - Manages virtual IPv4 addresses (portable
7 version)
8
10 IPaddr [start | stop | monitor | meta-data | validate-all]
11
13 This script manages IP alias IP addresses It can add an IP alias, or
14 remove one.
15
17 ip
18 The IPv4 address to be configured in dotted quad notation, for
19 example "192.168.1.1". (unique, required, string, no default)
20 nic
22 The base network interface on which the IP address will be brought
23 online. .sp If left empty, the script will try and determine this
24 from the routing table. .sp Do NOT specify an alias interface in
25 the form eth0:1 or anything here; rather, specify the base
26 interface only. .sp Prerequisite: .sp There must be at least one
27 static IP address, which is not managed by the cluster, assigned to
28 the network interface. .sp If you can not assign any static IP
29 address on the interface, modify this kernel parameter: sysctl -w
30 net.ipv4.conf.all.promote_secondaries=1 (or per device) .sp
31 (optional, string, default eth0)
33 cidr_netmask
35 The netmask for the interface in CIDR format. (ie, 24), or in
36 dotted quad notation 255.255.255.0). .sp If unspecified, the script
37 will also try to determine this from the routing table. (optional,
38 string, no default)
39 broadcast
41 Broadcast address associated with the IP. If left empty, the script
42 will determine this from the netmask. (optional, string, no
43 default)
44 iflabel
46 You can specify an additional label for your IP address here.
47 (optional, string, no default)
48 lvs_support
50 Enable support for LVS Direct Routing configurations. In case a IP
51 address is stopped, only move it to the loopback device to allow
52 the local node to continue to service requests, but no longer
53 advertise it on the network. (optional, boolean, default false)
54 local_stop_script
56 Script called when the IP is released (optional, string, no
57 default)
58 local_start_script
60 Script called when the IP is added (optional, string, no default)
61 ARP_INTERVAL_MS
63 milliseconds between ARPs (optional, integer, default 500)
64 ARP_REPEAT
66 How many gratuitous ARPs to send out when bringing up a new address
67 (optional, integer, default 10)
68 ARP_BACKGROUND
70 run in background (no longer any reason to do this) (optional,
71 boolean, default yes)
72 ARP_NETMASK
74 netmask for ARP - in nonstandard hexadecimal format. (optional,
75 string, default ffffffffffff)
76
78 This resource agent supports the following actions (operations):
79 start
81 Starts the resource. Suggested minimum timeout: 20s.
82 stop
84 Stops the resource. Suggested minimum timeout: 20s.
85 monitor
87 Performs a detailed status check. Suggested minimum timeout: 20s.
88 Suggested interval: 5s.
89 validate-all
91 Performs a validation of the resource configuration. Suggested
92 minimum timeout: 20s.
93 meta-data
95 Retrieves resource agent metadata (internal use only). Suggested
96 minimum timeout: 5s.
97
99 The following is an example configuration for a IPaddr resource using
100 the crm(8) shell:
101 primitive p_IPaddr ocf:heartbeat:IPaddr \
103 params \
104 ip=string \
105 op monitor depth="0" timeout="20s" interval="5s"
106
108 http://www.linux-ha.org/wiki/IPaddr_(resource_agent)
109
111 Linux-HA contributors (see the resource agent source for information
112 about individual authors)
113resource-agents 3.9.2 07/08/2011 OCF_HEARTBEAT_IPADDR(7)