ocf_heartbeat_IPaddr2(7)

1OCF_HEARTBEAT_IPADDR(7)       OCF resource agents      OCF_HEARTBEAT_IPADDR(7)
2
3
4

NAME

6       ocf_heartbeat_IPaddr2 - Manages virtual IPv4 addresses (Linux specific
7       version)
8

SYNOPSIS

10       IPaddr2 [start | stop | status | monitor | meta-data | validate-all]
11

DESCRIPTION

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

SUPPORTED PARAMETERS

18       ip
19           The IPv4 address to be configured in dotted quad notation, for
20           example "192.168.1.1".  (unique, required, string, no default)
21
22       nic
23           The base network interface on which the IP address will be brought
24           online. .sp If left empty, the script will try and determine this
25           from the routing table. .sp Do NOT specify an alias interface in
26           the form eth0:1 or anything here; rather, specify the base
27           interface only. .sp Prerequisite: .sp There must be at least one
28           static IP address, which is not managed by the cluster, assigned to
29           the network interface. .sp If you can not assign any static IP
30           address on the interface, modify this kernel parameter: sysctl -w
31           net.ipv4.conf.all.promote_secondaries=1 (or per device) .sp
32
33           (optional, string, default eth0)
34
35       cidr_netmask
36           The netmask for the interface in CIDR format (e.g., 24 and not
37           255.255.255.0) .sp If unspecified, the script will also try to
38           determine this from the routing table.  (optional, string, no
39           default)
40
41       broadcast
42           Broadcast address associated with the IP. If left empty, the script
43           will determine this from the netmask.  (optional, string, no
44           default)
45
46       iflabel
47           You can specify an additional label for your IP address here. This
48           label is appended to your interface name. If a label is specified
49           in nic name, this parameter has no effect.  (optional, string, no
50           default)
51
52       lvs_support
53           Enable support for LVS Direct Routing configurations. In case a IP
54           address is stopped, only move it to the loopback device to allow
55           the local node to continue to service requests, but no longer
56           advertise it on the network.  (optional, boolean, default false)
57
58       mac
59           Set the interface MAC address explicitly. Currently only used in
60           case of the Cluster IP Alias. Leave empty to chose automatically.
61           .sp
62
63           (optional, string, no default)
64
65       clusterip_hash
66           Specify the hashing algorithm used for the Cluster IP
67           functionality. .sp
68
69           (optional, string, default sourceip-sourceport)
70
71       unique_clone_address
72           If true, add the clone ID to the supplied value of ip to create a
73           unique address to manage (optional, boolean, default false)
74
75       arp_interval
76           Specify the interval between unsolicited ARP packets in
77           milliseconds.  (optional, integer, default 200)
78
79       arp_count
80           Number of unsolicited ARP packets to send.  (optional, integer,
81           default 5)
82
83       arp_bg
84           Whether or not to send the arp packets in the background.
85           (optional, string, default yes)
86
87       arp_mac
88           MAC address to send the ARP packets too. .sp You really shouldn't
89           be touching this. .sp
90
91           (optional, string, default ffffffffffff)
92
93       flush_routes
94           Flush the routing table on stop. This is for applications which use
95           the cluster IP address and which run on the same physical host that
96           the IP address lives on. The Linux kernel may force that
97           application to take a shortcut to the local loopback interface,
98           instead of the interface the address is really bound to. Under
99           those circumstances, an application may, somewhat unexpectedly,
100           continue to use connections for some time even after the IP address
101           is deconfigured. Set this parameter in order to immediately disable
102           said shortcut when the IP address goes away.  (optional, boolean,
103           default false)
104

SUPPORTED ACTIONS

106       This resource agent supports the following actions (operations):
107
108       start
109           Starts the resource. Suggested minimum timeout: 20s.
110
111       stop
112           Stops the resource. Suggested minimum timeout: 20s.
113
114       status
115           Performs a status check. Suggested minimum timeout: 20s. Suggested
116           interval: 10s.
117
118       monitor
119           Performs a detailed status check. Suggested minimum timeout: 20s.
120           Suggested interval: 10s.
121
122       meta-data
123           Retrieves resource agent metadata (internal use only). Suggested
124           minimum timeout: 5s.
125
126       validate-all
127           Performs a validation of the resource configuration. Suggested
128           minimum timeout: 20s.
129

EXAMPLE

131       The following is an example configuration for a IPaddr2 resource using
132       the crm(8) shell:
133
134           primitive p_IPaddr2 ocf:heartbeat:IPaddr2 \
135             params \
136               ip=string \
137             op monitor depth="0" timeout="20s" interval="10s"
138

AUTHOR

143       Linux-HA contributors (see the resource agent source for information
144       about individual authors)
145
146
147
148resource-agents 3.9.2             07/08/2011           OCF_HEARTBEAT_IPADDR(7)