ocf_heartbeat_IPaddr(7)

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

NAME

6       ocf_heartbeat_IPaddr - Manages virtual IPv4 addresses (portable
7       version)
8

SYNOPSIS

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

DESCRIPTION

13       This script manages IP alias IP addresses It can add an IP alias, or
14       remove one.
15

SUPPORTED PARAMETERS

17       ip
18           The IPv4 address to be configured in dotted quad notation, for
19           example "192.168.1.1".
20
21           (unique, required, string, no default)
22
23       nic
24           The base network interface on which the IP address will be brought
25           online.
26
27           If left empty, the script will try and determine this from the
28           routing table.
29
30           Do NOT specify an alias interface in the form eth0:1 or anything
31           here; rather, specify the base interface only.
32
33           Prerequisite:
34
35           There must be at least one static IP address, which is not managed
36           by the cluster, assigned to the network interface.
37
38           If you can not assign any static IP address on the interface,
39           modify this kernel parameter: sysctl -w
40           net.ipv4.conf.all.promote_secondaries=1 (or per device)
41
42           (optional, string, default "eth0")
43
44       cidr_netmask
45           The netmask for the interface in CIDR format. (ie, 24), or in
46           dotted quad notation 255.255.255.0).
47
48           If unspecified, the script will also try to determine this from the
49           routing table.
50
51           (optional, string, no default)
52
53       broadcast
54           Broadcast address associated with the IP. If left empty, the script
55           will determine this from the netmask.
56
57           (optional, string, no default)
58
59       iflabel
60           You can specify an additional label for your IP address here.
61
62           (optional, string, no default)
63
64       lvs_support
65           Enable support for LVS Direct Routing configurations. In case a IP
66           address is stopped, only move it to the loopback device to allow
67           the local node to continue to service requests, but no longer
68           advertise it on the network.
69
70           (optional, boolean, default false)
71
72       local_stop_script
73           Script called when the IP is released
74
75           (optional, string, no default)
76
77       local_start_script
78           Script called when the IP is added
79
80           (optional, string, no default)
81
82       ARP_INTERVAL_MS
83           milliseconds between ARPs
84
85           (optional, integer, default 500)
86
87       ARP_REPEAT
88           How many gratuitous ARPs to send out when bringing up a new address
89
90           (optional, integer, default 10)
91
92       ARP_BACKGROUND
93           run in background (no longer any reason to do this)
94
95           (optional, boolean, default yes)
96
97       ARP_NETMASK
98           netmask for ARP - in nonstandard hexadecimal format.
99
100           (optional, string, default "ffffffffffff")
101

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

124       The following is an example configuration for a IPaddr resource using
125       the crm(8) shell:
126
127           primitive p_IPaddr ocf:heartbeat:IPaddr \
128             params \
129               ip=string \
130             op monitor depth="0" timeout="20s" interval="5s"
131

EXAMPLE PCS

133       The following is an example configuration for a IPaddr resource using
134       pcs(8)
135
136           pcs resource create p_IPaddr ocf:heartbeat:IPaddr \
137             ip=string \
138             op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="5s"
139

AUTHOR

144       ClusterLabs contributors (see the resource agent source for information
145       about individual authors)
146
147
148
149resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_IPADDR(7)