ocf_heartbeat_Route(7)

1OCF_HEARTBEAT_ROUTE(7)        OCF resource agents       OCF_HEARTBEAT_ROUTE(7)
2
3
4

NAME

6       ocf_heartbeat_Route - Manages network routes
7

SYNOPSIS

9       Route [start | stop | monitor | meta-data | validate-all]
10

DESCRIPTION

12       Enables and disables network routes.
13
14       Supports host and net routes, routes via a gateway address, and routes
15       using specific source addresses.
16
17       This resource agent is useful if a node's routing table needs to be
18       manipulated based on node role assignment.
19
20       Consider the following example use case:
21
22       - One cluster node serves as an IPsec tunnel endpoint.
23
24       - All other nodes use the IPsec tunnel to reach hosts in a specific
25       remote network.
26
27       Then, here is how you would implement this scheme making use of the
28       Route resource agent:
29
30       - Configure an ipsec LSB resource.
31
32       - Configure a cloned Route OCF resource.
33
34       - Create an order constraint to ensure that ipsec is started before
35       Route.
36
37       - Create a colocation constraint between the ipsec and Route resources,
38       to make sure no instance of your cloned Route resource is started on
39       the tunnel endpoint itself.
40

SUPPORTED PARAMETERS

42       destination
43           The destination network (or host) to be configured for the route.
44           Specify the netmask suffix in CIDR notation (e.g. "/24"). If no
45           suffix is given, a host route will be created. Specify "0.0.0.0/0"
46           or "default" if you want this resource to set the system default
47           route.
48
49           (unique, required, string, no default)
50
51       device
52           The outgoing network device to use for this route.
53
54           (optional, string, no default)
55
56       gateway
57           The gateway IP address to use for this route.
58
59           (optional, string, no default)
60
61       source
62           The source IP address to be configured for the route.
63
64           (optional, string, no default)
65
66       table
67           The routing table to be configured for the route.
68
69           (optional, string, no default)
70
71       family
72           The address family to be used for the route ip4 IP version 4 ip6 IP
73           version 6 detect Detect from 'destination' address.
74
75           (optional, string, default "detect")
76

SUPPORTED ACTIONS

78       This resource agent supports the following actions (operations):
79
80       start
81           Starts the resource. Suggested minimum timeout: 20s.
82
83       stop
84           Stops the resource. Suggested minimum timeout: 20s.
85
86       monitor
87           Performs a detailed status check. Suggested minimum timeout: 20s.
88           Suggested interval: 10s.
89
90       reload
91           Suggested minimum timeout: 20s.
92
93       meta-data
94           Retrieves resource agent metadata (internal use only). Suggested
95           minimum timeout: 5s.
96
97       validate-all
98           Performs a validation of the resource configuration. Suggested
99           minimum timeout: 20s.
100

EXAMPLE CRM SHELL

102       The following is an example configuration for a Route resource using
103       the crm(8) shell:
104
105           primitive p_Route ocf:heartbeat:Route \
106             params \
107               destination=string \
108             op monitor timeout="20s" interval="10s" depth="0"
109

EXAMPLE PCS

111       The following is an example configuration for a Route resource using
112       pcs(8)
113
114           pcs resource create p_Route ocf:heartbeat:Route \
115             destination=string \
116             op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"
117

AUTHOR

122       ClusterLabs contributors (see the resource agent source for information
123       about individual authors)
124
125
126
127resource-agents UNKNOWN           03/25/2021            OCF_HEARTBEAT_ROUTE(7)