Scroll to navigation

OCF_HEARTBEAT_IPADDR(7)

OCF resource agents

OCF_HEARTBEAT_IPADDR(7)

NAME¶

ocf_heartbeat_IPaddr - Manages virtual IPv4 addresses (portable version)

SYNOPSIS¶

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

DESCRIPTION¶

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

SUPPORTED PARAMETERS¶

ip

The IPv4 address to be configured in dotted quad notation, for example "192.168.1.1".

(unique, 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.

Prerequisite:

There must be at least one static IP address, which is not managed by the cluster, assigned to the network interface.

If you can not assign any static IP address on the interface, modify this kernel parameter: sysctl -w net.ipv4.conf.all.promote_secondaries=1 (or per device)

(optional, string, default "eth0")

cidr_netmask

The netmask for the interface in CIDR format. (ie, 24), or in dotted quad notation 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.

(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)

local_stop_script

Script called when the IP is released

(optional, string, no default)

local_start_script

Script called when the IP is added

(optional, string, no default)

ARP_INTERVAL_MS

milliseconds between ARPs

(optional, integer, default 500)

ARP_REPEAT

How many gratuitous ARPs to send out when bringing up a new address

(optional, integer, default 10)

ARP_BACKGROUND

run in background (no longer any reason to do this)

(optional, boolean, default yes)

ARP_NETMASK

netmask for ARP - in nonstandard hexadecimal format.

(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.

monitor

Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval: 5s.

validate-all

Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

meta-data

Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

EXAMPLE CRM SHELL¶

The following is an example configuration for a IPaddr resource using the crm(8) shell:

primitive p_IPaddr ocf:heartbeat:IPaddr \


  params \


    ip=string \


  op monitor depth="0" timeout="20s" interval="5s"

EXAMPLE PCS¶

The following is an example configuration for a IPaddr resource using pcs(8)

pcs resource create p_IPaddr ocf:heartbeat:IPaddr \


  ip=string \


  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="5s"

SEE ALSO¶

http://clusterlabs.org/

AUTHOR¶

ClusterLabs contributors (see the resource agent source for information about individual authors)

04/13/2023

resource-agents 4.12.0-2