OCF_HEARTBEAT_DUMMY(7)						OCF resource agents					    OCF_HEARTBEAT_DUMMY(7)

NAME

       ocf_heartbeat_Dummy - Example stateless resource agent

SYNOPSIS

       Dummy [start | stop | monitor | reload | migrate_to | migrate_from | meta-data | validate-all]

DESCRIPTION

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

SUPPORTED PARAMETERS

       state
	   Location to store the resource state in. (optional, string, default /var/run/resource-agents/Dummy-{OCF_RESOURCE_INSTANCE}.state)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
	   Starts the resource. Suggested minimum timeout: 20.

       stop
	   Stops the resource. Suggested minimum timeout: 20.

       monitor
	   Performs a detailed status check. Suggested minimum timeout: 20. Suggested interval: 10.

       reload
	   Suggested minimum timeout: 20.

       migrate_to
	   Executes steps necessary for migrating the resource to the node. Suggested minimum timeout: 20.

       migrate_from
	   Executes steps necessary for migrating the resource away from the node. Suggested minimum timeout: 20.

       meta-data
	   Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.

       validate-all
	   Performs a validation of the resource configuration. Suggested minimum timeout: 20.

EXAMPLE

       The following is an example configuration for a Dummy resource using the crm(8) shell:

	   primitive example_Dummy ocf:heartbeat:Dummy 

	     meta allow-migrate="true" 
	     op monitor timeout="20" interval="10" depth="0"

SEE ALSO

       http://www.linux-ha.org/wiki/Dummy_(resource_agent)

AUTHOR

       Linux-HA contributors (see the resource agent source for information about individual authors)

resource-agents 1.0.3						    07/05/2010						    OCF_HEARTBEAT_DUMMY(7)