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

  
 
  

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

NAME
     ocf_heartbeat_Stateful - Example stateful resource agent

SYNOPSIS
     Stateful  [start  |  stop	| monitor | promote | demote | meta-data | vali-
	      date-all]

DESCRIPTION
     This is an example resource agent that implements two states

SUPPORTED PARAMETERS
     state
	 Location to store the resource state in

	 (unique,  optional,  string,  default	"/var/run/resource-agents/State-
	 ful-RESOURCE_ID.state")

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.

     promote
	 Promotes  the	resource  to the Master role. Suggested minimum timeout:
	 20s.

     demote
	 Demotes the resource to the Slave role. Suggested minimum timeout: 20s.

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

     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 Stateful resource using the
     crm(8) shell:

	 primitive p_Stateful ocf:heartbeat:Stateful \
	   op monitor depth="0" timeout="20s" interval="10s"

	 ms ms_Stateful p_Stateful \
	   meta notify="true" interleave="true"

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

	 pcs resource create p_Stateful ocf:heartbeat:Stateful \
	   op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" promotable

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_STATEF(7)

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

home | help