ocf_heartbeat_Dummy(7)

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

NAME

6       ocf_heartbeat_Dummy - Example stateless resource agent
7

SYNOPSIS

9       Dummy [start | stop | monitor | migrate_to | migrate_from | meta-data |
10             validate-all]
11

DESCRIPTION

13       This is a Dummy Resource Agent. It does absolutely nothing except keep
14       track of whether its running or not. Its purpose in life is for testing
15       and to serve as a template for RA writers.
16
17       NB: Please pay attention to the timeouts specified in the actions
18       section below. They should be meaningful for the kind of resource the
19       agent manages. They should be the minimum advised timeouts, but they
20       shouldn't/cannot cover _all_ possible resource instances. So, try to be
21       neither overly generous nor too stingy, but moderate. The minimum
22       timeouts should never be below 10 seconds.
23

SUPPORTED PARAMETERS

25       state
26           Location to store the resource state in.  (unique, optional,
27           string, default /var/run/heartbeat/rsctmp/Dummy-default.state)
28
29       fake
30           Fake attribute that can be changed to cause a reload (optional,
31           string, default dummy)
32

SUPPORTED ACTIONS

34       This resource agent supports the following actions (operations):
35
36       start
37           Starts the resource. Suggested minimum timeout: 20.
38
39       stop
40           Stops the resource. Suggested minimum timeout: 20.
41
42       monitor
43           Performs a detailed status check. Suggested minimum timeout: 20.
44           Suggested interval: 10.
45
46       reload
47           Suggested minimum timeout: 20.
48
49       migrate_to
50           Executes steps necessary for migrating the resource to the node.
51           Suggested minimum timeout: 20.
52
53       migrate_from
54           Executes steps necessary for migrating the resource away from the
55           node. Suggested minimum timeout: 20.
56
57       meta-data
58           Retrieves resource agent metadata (internal use only). Suggested
59           minimum timeout: 5.
60
61       validate-all
62           Performs a validation of the resource configuration. Suggested
63           minimum timeout: 20.
64

EXAMPLE

66       The following is an example configuration for a Dummy resource using
67       the crm(8) shell:
68
69           primitive p_Dummy ocf:heartbeat:Dummy \
70             meta allow-migrate="true" \
71             op monitor timeout="20" interval="10" depth="0"
72

AUTHOR

77       Linux-HA contributors (see the resource agent source for information
78       about individual authors)
79
80
81
82resource-agents 3.9.2             07/08/2011            OCF_HEARTBEAT_DUMMY(7)