'\" t
.\"     Title: ocf_heartbeat_IPsrcaddr
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_IPSRCA" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_IPsrcaddr \- Manages the preferred source address for outgoing IP packets
.SH "SYNOPSIS"
.HP \w'\fBIPsrcaddr\fR\ 'u
\fBIPsrcaddr\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for IPsrcaddr\&. It manages the preferred source address modification\&.
.PP
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\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBipaddress\fR
.RS 4
The IP address\&.
.sp
(required, string, no default)
.RE
.PP
\fBcidr_netmask\fR
.RS 4
The netmask for the interface in CIDR format\&. (ie, 24), or in dotted quad notation 255\&.255\&.255\&.0)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBdestination\fR
.RS 4
The destination IP/subnet for the route (default: 0\&.0\&.0\&.0/0)
.sp
(optional, string, default "0\&.0\&.0\&.0/0")
.RE
.PP
\fBproto\fR
.RS 4
Proto to match when finding network\&. E\&.g\&. "kernel"\&.
.sp
(optional, string, no default)
.RE
.PP
\fBmetric\fR
.RS 4
Metric\&. Only needed if incorrect metric value is used\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtable\fR
.RS 4
Table to modify and use for interface lookup\&. E\&.g\&. "local"\&.
.sp
The table has to have a route matching the "destination" parameter\&.
.sp
This can be used for policy based routing\&. See man ip\-rule(8)\&.
.sp
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a IPsrcaddr resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_IPsrcaddr ocf:heartbeat:IPsrcaddr \e
  params \e
    ipaddress=\fIstring\fR \e
  op monitor depth="0" timeout="20s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a IPsrcaddr resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_IPsrcaddr ocf:heartbeat:IPsrcaddr \e
  ipaddress=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR