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

FreeBSD Manual Pages

  
 
  

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

NAME
       ocf_heartbeat_anything -	Manages	an arbitrary service

SYNOPSIS

       anything	[start | stop |	monitor	| meta-data | validate-all]

DESCRIPTION
       This is a generic OCF RA	to manage almost anything.

SUPPORTED PARAMETERS
       binfile
	   The full name of the	binary to be executed. This is expected	to
	   keep	running	with the same pid and not just do something and	exit.

	   (required, string, no default)

       cmdline_options
	   Command line	options	to pass	to the binary

	   (optional, string, no default)

       workdir
	   The path from where the binfile will	be executed.

	   (optional, string, no default)

       pidfile
	   File	to read/write the PID from/to.

	   (optional, string, default "/var/run/anything_RESOURCE_ID.pid")

       logfile
	   File	to write STDOUT	to

	   (optional, string, default "/dev/null")

       errlogfile
	   File	to write STDERR	to

	   (optional, string, no default)

       user
	   User	to run the command as

	   (optional, string, default "root")

       monitor_hook
	   Command to run in monitor operation

	   (optional, string, no default)

       stop_timeout
	   In the stop operation: Seconds to wait for kill -TERM to succeed
	   before sending kill -SIGKILL. Defaults to 2/3 of the	stop operation
	   timeout.

	   (optional, string, no default)

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.
	   Suggested interval: 10s.

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

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

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

	   primitive p_anything	ocf:heartbeat:anything \
	     params \
	       binfile=string \
	     op	monitor	depth="0" timeout="20s"	interval="10s"

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

	   pcs resource	create p_anything ocf:heartbeat:anything \
	     binfile=string \
	     op	monitor	OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"

SEE ALSO
       http://clusterlabs.org/

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

resource-agents	4.13.0		  04/12/2025	       OCF_HEARTBEAT_ANYTHI(7)

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

home | help