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 setup 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 adress 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 contraints, based on
26       a CIB attribute value. The name of the attribute value is configured in
27       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 an watch the RX counter (if packages come around
35       in a certain time -> success) 3. call arping to check wether any of the
36       IPs found in the lokal 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).  (unique, required, string, no default)
43
44       name
45           The name of the CIB attribute to set. This is the name to be used
46           in the constraints. Defaults to "ethmonitor-'interface_name'".
47           (unique, optional, string, no default)
48
49       multiplier
50           Multiplier for the value of the CIB attriobute specified in
51           parameter name.  (optional, integer, default 1)
52
53       repeat_count
54           Specify how often the interface will be monitored, before the
55           status is set to failed. You need to set the timeout of the
56           monitoring operation to at least repeat_count * repeat_interval
57           (optional, integer, default 5)
58
59       repeat_interval
60           Specify how long to wait in seconds between the repeat_counts.
61           (optional, integer, default 10)
62
63       pktcnt_timeout
64           Timeout for the RX packet counter. Stop listening for packet
65           counter changes after the given number of seconds.  (optional,
66           integer, default 5)
67
68       arping_count
69           Number of ARP REQUEST packets to send for every IP. Usually one ARP
70           REQUEST (arping) is send (optional, integer, default 1)
71
72       arping_timeout
73           Time in seconds to wait for ARP REQUESTs (all packets of
74           arping_count). This is to limit the time for arp requests, to be
75           able to send requests to more than one node, without running in the
76           monitor operation timeout.  (optional, integer, default 1)
77
78       arping_cache_entries
79           Maximum number of IPs from ARP cache list to check for ARP REQUEST
80           (arping) answers. Newest entries are tried first.  (optional,
81           integer, default 5)
82

SUPPORTED ACTIONS

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

EXAMPLE

109       The following is an example configuration for a ethmonitor resource
110       using the crm(8) shell:
111
112           primitive p_ethmonitor ocf:heartbeat:ethmonitor \
113             params \
114               interface=string \
115             op monitor depth="0" timeout="20s" interval="10s"
116

AUTHOR

121       Linux-HA contributors (see the resource agent source for information
122       about individual authors)
123
124
125
126resource-agents 3.9.2             07/08/2011           OCF_HEARTBEAT_ETHMON(7)