ocf_heartbeat_ethmonitor(7)

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 independend 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: location loc_connected_node
30       my_resource_grp rule ="rule_loc_connected_node" -INF: ethmonitor eq 0
31
32       The ethmonitor works in 3 different modes to test the interface
33       vitality. 1. call ip to see if the link status is up (if link is down
34       -> error) 2. call ip and watch the RX counter (if packages come around
35       in a certain time -> success) 3. call arping to check whether any of
36       the IPs found in the local ARP cache answers an ARP REQUEST (one answer
37       -> success) 4. return error
38

SUPPORTED PARAMETERS

40       interface
41           The name of the network interface which should be monitored (e.g.
42           eth0).
43
44           (unique, required, string, no default)
45
46       name
47           The name of the CIB attribute to set. This is the name to be used
48           in the constraints. Defaults to "ethmonitor-´interface_name´".
49
50           (unique, optional, string, no default)
51
52       multiplier
53           Multiplier for the value of the CIB attriobute specified in
54           parameter name.
55
56           (optional, integer, default 1)
57
58       repeat_count
59           Specify how often the interface will be monitored, before the
60           status is set to failed. You need to set the timeout of the
61           monitoring operation to at least repeat_count * repeat_interval
62
63           (optional, integer, default 5)
64
65       repeat_interval
66           Specify how long to wait in seconds between the repeat_counts.
67
68           (optional, integer, default 10)
69
70       pktcnt_timeout
71           Timeout for the RX packet counter. Stop listening for packet
72           counter changes after the given number of seconds.
73
74           (optional, integer, default 5)
75
76       arping_count
77           Number of ARP REQUEST packets to send for every IP. Usually one ARP
78           REQUEST (arping) is send
79
80           (optional, integer, default 1)
81
82       arping_timeout
83           Time in seconds to wait for ARP REQUESTs (all packets of
84           arping_count). This is to limit the time for arp requests, to be
85           able to send requests to more than one node, without running in the
86           monitor operation timeout.
87
88           (optional, integer, default 1)
89
90       arping_cache_entries
91           Maximum number of IPs from ARP cache list to check for ARP REQUEST
92           (arping) answers. Newest entries are tried first.
93
94           (optional, integer, default 5)
95

SUPPORTED ACTIONS

97       This resource agent supports the following actions (operations):
98
99       start
100           Starts the resource. Suggested minimum timeout: 20s.
101
102       stop
103           Stops the resource. Suggested minimum timeout: 20s.
104
105       status
106           Performs a status check. Suggested minimum timeout: 20s. Suggested
107           interval: 10s.
108
109       monitor
110           Performs a detailed status check. Suggested minimum timeout: 20s.
111           Suggested interval: 10s.
112
113       meta-data
114           Retrieves resource agent metadata (internal use only). Suggested
115           minimum timeout: 5s.
116
117       validate-all
118           Performs a validation of the resource configuration. Suggested
119           minimum timeout: 20s.
120

EXAMPLE

122       The following is an example configuration for a ethmonitor resource
123       using the crm(8) shell:
124
125           primitive p_ethmonitor ocf:heartbeat:ethmonitor \
126             params \
127               interface=string \
128             op monitor depth="0" timeout="20s" interval="10s"
129

AUTHOR

134       Linux-HA contributors (see the resource agent source for information
135       about individual authors)
136
137
138
139resource-agents 3.9.2             03/24/2017           OCF_HEARTBEAT_ETHMON(7)