OCF_HEARTBEAT_IPADDR(7)
NAME
ocf_heartbeat_IPaddr2 - Manages virtual IPv4 addresses (Linux specific
version)
SYNOPSIS
IPaddr2 [start | stop | status | monitor | meta-data | validate-all]
DESCRIPTION
This Linux-specific resource manages IP alias IP addresses. It can add
an IP alias, or remove one. In addition, it can implement Cluster Alias
IP functionality if invoked as a clone resource.
SUPPORTED PARAMETERS
- ip
- The IPv4 address to be configured in dotted quad notation, for
example "192.168.1.1". (required, string, no default) - nic
- The base network interface on which the IP address will be brought
online. If left empty, the script will try and determine this from
the routing table. Do NOT specify an alias interface in the form
eth0:1 or anything here; rather, specify the base interface only.
(optional, string, default eth0) - cidr_netmask
- The netmask for the interface in CIDR format (e.g., 24 and not
255.255.255.0) If unspecified, the script will also try to
determine this from the routing table. (optional, string, no
default) - broadcast
- Broadcast address associated with the IP. If left empty, the script
will determine this from the netmask. (optional, string, no
default) - iflabel
- You can specify an additional label for your IP address here. This
label is appended to your interface name. If a label is specified
in nic name, this parameter has no effect. (optional, string, no
default) - lvs_support
- Enable support for LVS Direct Routing configurations. In case a IP
address is stopped, only move it to the loopback device to allow
the local node to continue to service requests, but no longer
advertise it on the network. (optional, boolean, default false) - mac
- Set the interface MAC address explicitly. Currently only used in
case of the Cluster IP Alias. Leave empty to chose automatically.
(optional, string, no default) - clusterip_hash
- Specify the hashing algorithm used for the Cluster IP
functionality. (optional, string, default sourceip-sourceport) - unique_clone_address
- If true, add the clone ID to the supplied value of ip to create a
unique address to manage (optional, boolean, default false) - arp_interval
- Specify the interval between unsolicited ARP packets in
milliseconds. (optional, integer, default 200) - arp_count
- Number of unsolicited ARP packets to send. (optional, integer,
default 5) - arp_bg
- Whether or not to send the arp packets in the background.
(optional, string, default yes) - arp_mac
- MAC address to send the ARP packets too. You really shouldn't be
touching this. (optional, string, default ffffffffffff)
SUPPORTED ACTIONS
This resource agent supports the following actions (operations):
- start
- Starts the resource. Suggested minimum timeout: 20s.
- stop
- Stops the resource. Suggested minimum timeout: 20s.
- status
- Performs a status check. Suggested minimum timeout: 20s. Suggested interval: 10s.
- monitor
- Performs a detailed status check. Suggested minimum timeout: 20s.
Suggested interval: 10s. - meta-data
- Retrieves resource agent metadata (internal use only). Suggested
minimum timeout: 5s. - validate-all
- Performs a validation of the resource configuration. Suggested
minimum timeout: 20s.
EXAMPLE
- The following is an example configuration for a IPaddr2 resource using
the crm(8) shell:
- primitive example_IPaddr2 ocf:heartbeat:IPaddr2 \
params \ip=string \op monitor depth="0" timeout="20s" interval="10s"
SEE ALSO
http://www.linux-ha.org/wiki/IPaddr2_(resource_agent)
AUTHOR
- Linux-HA contributors (see the resource agent source for information about individual authors)