Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
OCF_HEARTBEAT_DUMMY(7)	       OCF resource agents	  OCF_HEARTBEAT_DUMMY(7)

NAME
     ocf_heartbeat_Dummy - Example stateless resource agent

SYNOPSIS
     Dummy  [start  |  stop  | monitor | 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  man-
     ages.  They should be the minimum advised timeouts, but they shouldn't/can-
     not 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.

     This  resource agent may be configured for native migration if available in
     the cluster manager. For Pacemaker, the allow-migrate="true" meta attribute
     enables native migration.

SUPPORTED PARAMETERS
     state
	 Location to store the resource state in.

	 (unique, optional, string, default  "/var/run/resource-agents/Dummy-RE-
	 SOURCE_ID.state")

     fake
	 Fake attribute that can be changed to cause a reload

	 (optional, string, default "dummy")

SUPPORTED ACTIONS
     This resource agent supports the following actions (operations):

     start
	 Starts the resource. Suggested minimum timeout: 20s.

     stop
	 Stops the resource. Suggested minimum timeout: 20s.

     monitor
	 Performs  a detailed status check. Suggested minimum timeout: 20s. Sug-
	 gested interval: 10s.

     reload
	 Suggested minimum timeout: 20s.

     migrate_to
	 Executes steps necessary for migrating the resource to the  node.  Sug-
	 gested minimum timeout: 20s.

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

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

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

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

	 primitive p_Dummy ocf:heartbeat:Dummy \
	   meta allow-migrate="true" \
	   op monitor timeout="20s" interval="10s" depth="0"

EXAMPLE PCS
     The following is an example configuration for a Dummy resource using pcs(8)

	 pcs resource create p_Dummy ocf:heartbeat:Dummy \
	   op monitor timeout="20s" interval="10s" OCF_CHECK_LEVEL="0"

SEE ALSO
     http://clusterlabs.org/

AUTHOR
     ClusterLabs contributors (see the resource  agent	source	for  information
     about individual authors)

resource-agents 4.13.0		   08/27/2026		  OCF_HEARTBEAT_DUMMY(7)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_Dummy&sektion=7&manpath=FreeBSD+Ports+15.1.quarterly>

home | help