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

NAME

6       ocf_heartbeat_ethmonitor - Monitors network interfaces
7

SYNOPSIS

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

DESCRIPTION

12       Monitor the vitality of a local network interface.
13
14       You may set up this RA as a clone resource to monitor the network
15       interfaces on different nodes, with the same interface name. This is
16       not related to the IP address or the network on which a interface is
17       configured. You may use this RA to move resources away from a node,
18       which has a faulty interface or prevent moving resources to such a
19       node. This gives you independent control of the resources, without
20       involving cluster intercommunication. But it requires your nodes to
21       have more than one network interface.
22
23       The resource configuration requires a monitor operation, because the
24       monitor does the main part of the work. In addition to the resource
25       configuration, you need to configure some location constraints, based
26       on a CIB attribute value. The name of the attribute value is configured
27       in the 'name' option of this RA.
28
29       Example constraint configuration using crmsh location
30       loc_connected_node my_resource_grp rule ="rule_loc_connected_node"
31       -INF: ethmonitor eq 0
32
33       Example constraint configuration using pcs. Only allow 'my_resource' to
34       run on nodes where eth0 ethernet device is available. pcs constraint
35       location my_resource rule score=-INFINITY ethmonitor-eth0 ne 1
36
37       The ethmonitor works in 3 different modes to test the interface
38       vitality. 1. call ip to see if the link status is up (if link is down
39       -> error) 2. call ip and watch the RX counter (if packages come around
40       in a certain time -> success) 3. call arping to check whether any of
41       the IPs found in the local ARP cache answers an ARP REQUEST (one answer
42       -> success) 4. return error
43

SUPPORTED PARAMETERS

45       interface
46           The name of the network interface which should be monitored (e.g.
47           eth0).
48
49           (unique, required, string, no default)
50
51       name
52           The name of the CIB attribute to set. This is the name to be used
53           in the constraints. Defaults to "ethmonitor-'interface_name'".
54
55           (unique, optional, string, no default)
56
57       multiplier
58           Multiplier for the value of the CIB attriobute specified in
59           parameter name.
60
61           (optional, integer, default 1)
62
63       repeat_count
64           Specify how often the interface will be monitored, before the
65           status is set to failed. You need to set the timeout of the
66           monitoring operation to at least repeat_count * repeat_interval
67
68           (optional, integer, default 5)
69
70       repeat_interval
71           Specify how long to wait in seconds between the repeat_counts.
72
73           (optional, integer, default 10)
74
75       pktcnt_timeout
76           Timeout for the RX packet counter. Stop listening for packet
77           counter changes after the given number of seconds.
78
79           (optional, integer, default 5)
80
81       arping_count
82           Number of ARP REQUEST packets to send for every IP. Usually one ARP
83           REQUEST (arping) is send
84
85           (optional, integer, default 1)
86
87       arping_timeout
88           Time in seconds to wait for ARP REQUESTs (all packets of
89           arping_count). This is to limit the time for arp requests, to be
90           able to send requests to more than one node, without running in the
91           monitor operation timeout.
92
93           (optional, integer, default 1)
94
95       arping_cache_entries
96           Maximum number of IPs from ARP cache list to check for ARP REQUEST
97           (arping) answers. Newest entries are tried first.
98
99           (optional, integer, default 5)
100
101       infiniband_device
102           For interfaces that are infiniband devices.
103
104           (optional, string, no default)
105
106       infiniband_port
107           For infiniband devices, this is the port to monitor.
108
109           (optional, integer, no default)
110
111       link_status_only
112           Only report success based on link status. Do not perform RX counter
113           or arping related connectivity tests.
114
115           (optional, boolean, default false)
116

SUPPORTED ACTIONS

118       This resource agent supports the following actions (operations):
119
120       start
121           Starts the resource. Suggested minimum timeout: 60s.
122
123       stop
124           Stops the resource. Suggested minimum timeout: 20s.
125
126       status
127           Performs a status check. Suggested minimum timeout: 60s. Suggested
128           interval: 10s.
129
130       monitor
131           Performs a detailed status check. Suggested minimum timeout: 60s.
132           Suggested interval: 10s.
133
134       meta-data
135           Retrieves resource agent metadata (internal use only). Suggested
136           minimum timeout: 5s.
137
138       validate-all
139           Performs a validation of the resource configuration. Suggested
140           minimum timeout: 20s.
141

EXAMPLE CRM SHELL

143       The following is an example configuration for a ethmonitor resource
144       using the crm(8) shell:
145
146           primitive p_ethmonitor ocf:heartbeat:ethmonitor \
147             params \
148               interface=string \
149             op monitor depth="0" timeout="60s" interval="10s"
150

EXAMPLE PCS

152       The following is an example configuration for a ethmonitor resource
153       using pcs(8)
154
155           pcs resource create p_ethmonitor ocf:heartbeat:ethmonitor \
156             interface=string \
157             op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="10s"
158

SEE ALSO

160       http://clusterlabs.org/
161

AUTHOR

163       ClusterLabs contributors (see the resource agent source for information
164       about individual authors)
165
166
167
168resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_ETHMON(7)
Impressum