'\" t
.\"     Title: ocf_heartbeat_Route
.\"    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_ROUTE" "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_Route \- Manages network routes
.SH "SYNOPSIS"
.HP \w'\fBRoute\fR\ 'u
\fBRoute\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Enables and disables network routes\&.
.PP
Supports host and net routes, routes via a gateway address, and routes using specific source addresses\&.
.PP
This resource agent is useful if a node\*(Aqs routing table needs to be manipulated based on node role assignment\&.
.PP
Consider the following example use case:
.PP
\- One cluster node serves as an IPsec tunnel endpoint\&.
.PP
\- All other nodes use the IPsec tunnel to reach hosts in a specific remote network\&.
.PP
Then, here is how you would implement this scheme making use of the Route resource agent:
.PP
\- Configure an ipsec LSB resource\&.
.PP
\- Configure a cloned Route OCF resource\&.
.PP
\- Create an order constraint to ensure that ipsec is started before Route\&.
.PP
\- Create a colocation constraint between the ipsec and Route resources, to make sure no instance of your cloned Route resource is started on the tunnel endpoint itself\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBdestination\fR
.RS 4
The destination network (or host) to be configured for the route\&. Specify the netmask suffix in CIDR notation (e\&.g\&. "/24")\&. If no suffix is given, a host route will be created\&. Specify "0\&.0\&.0\&.0/0" or "default" if you want this resource to set the system default route\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBdevice\fR
.RS 4
The outgoing network device to use for this route\&.
.sp
(optional, string, no default)
.RE
.PP
\fBgateway\fR
.RS 4
The gateway IP address to use for this route\&.
.sp
(optional, string, no default)
.RE
.PP
\fBsource\fR
.RS 4
The source IP address to be configured for the route\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtable\fR
.RS 4
The routing table to be configured for the route\&.
.sp
(optional, string, no default)
.RE
.PP
\fBfamily\fR
.RS 4
The address family to be used for the route ip4 IP version 4 ip6 IP version 6 detect Detect from \*(Aqdestination\*(Aq address\&.
.sp
(optional, string, default "detect")
.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
\fBreload\fR
.RS 4
Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a Route resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_Route ocf:heartbeat:Route \e
  params \e
    destination=\fIstring\fR \e
  op monitor timeout="20s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a Route resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_Route ocf:heartbeat:Route \e
  destination=\fIstring\fR \e
  op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0" 
.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