Scroll to navigation

OCF_HEARTBEAT_IPSRCA(7) OCF resource agents OCF_HEARTBEAT_IPSRCA(7)

NAME

ocf_heartbeat_IPsrcaddr - Manages the preferred source address for outgoing IP packets

SYNOPSIS

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

DESCRIPTION

Resource script for IPsrcaddr. It manages the preferred source address modification.

Note: DHCP should not be enabled for the interface serving the preferred source address. Enabling DHCP may result in unexpected behavior, such as the automatic addition of duplicate or conflicting routes. This may cause the IPsrcaddr resource to fail, or it may produce undesired behavior while the resource continues to run.

SUPPORTED PARAMETERS

ipaddress

The IP address.

(required, string, no default)

cidr_netmask

The netmask for the interface in CIDR format. (ie, 24), or in dotted quad notation 255.255.255.0).

(optional, string, no default)

destination

The destination IP/subnet for the route (default: 0.0.0.0/0)

(optional, string, default "0.0.0.0/0")

proto

Proto to match when finding network. E.g. "kernel".

(optional, string, no default)

metric

Metric. Only needed if incorrect metric value is used.

(optional, string, no default)

pref

IPv6 route preference (low, medium or high). Only needed if incorrect pref value is used.

(optional, string, no default)

table

Table to modify and use for interface lookup. E.g. "local".

The table has to have a route matching the "destination" parameter.

This can be used for policy based routing. See man ip-rule(8).

(optional, string, no default)

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: 10s.

validate-all

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

meta-data

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

EXAMPLE CRM SHELL

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

primitive p_IPsrcaddr ocf:heartbeat:IPsrcaddr \


  params \


    ipaddress=string \


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

EXAMPLE PCS

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

pcs resource create p_IPsrcaddr ocf:heartbeat:IPsrcaddr \


  ipaddress=string \


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

SEE ALSO

http://clusterlabs.org/

AUTHOR

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

02/28/2025 resource-agents 4.16.0-3