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

FreeBSD Manual Pages

  
 
  

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

NAME
       ocf_heartbeat_Raid1 - Manages Linux software RAID (MD) devices on
       shared storage

SYNOPSIS

       Raid1 [start | stop | status | monitor |	meta-data | validate-all]

DESCRIPTION
       This resource agent manages Linux software RAID (MD) devices on a
       shared storage medium. It uses mdadm(8) to start, stop, and monitor the
       MD devices. Raidtools are supported, but	deprecated. See
       https://raid.wiki.kernel.org/index.php/Linux_Raid for more information.

SUPPORTED PARAMETERS
       raidconf
	   The RAID configuration file,	e.g. /etc/mdadm.conf.

	   (required, string, no default)

       raiddev
	   One or more block devices to	use, space separated. Alternatively,
	   set to "auto" to manage all devices specified in raidconf.

	   (required, string, no default)

       homehost
	   The value for the homehost directive; this is an mdadm feature to
	   protect RAIDs against being activated by accident. It is
	   recommended to create RAIDs managed by the cluster with "homehost"
	   set to a special value, so they are not accidentally	auto-assembled
	   by nodes not	supposed to own	them.

	   (optional, string, no default)

       force_stop
	   If processes	or kernel threads are using the	array, it cannot be
	   stopped. We will try	to stop	processes, first by sending TERM and
	   then, if that doesn't help in 3 seconds, using KILL.	The lsof(8)
	   program is required to get the list of array	users. Of course, the
	   kernel threads cannot be stopped this way. If the processes are
	   critical for	data integrity,	then set this parameter	to false. Note
	   that	in that	case the stop operation	will fail and the node will be
	   fenced.

	   (optional, boolean, default true)

       udev
	   Wait	until udevd creates a device in	the start operation. On	a
	   normally loaded host	this should happen quickly, but	you may	be
	   unlucky. If you are not using udev set this to "no".

	   (optional, boolean, default true)

       force_clones
	   Activating the same md RAID array on	multiple nodes at the same
	   time	will result in data corruption and thus	is forbidden by
	   default.

	   A safe example could	be an array that is only named identically
	   across all nodes, but is in fact distinct.

	   Only	set this to "true" if you know what you	are doing!

	   (optional, boolean, default false)

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.

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

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

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

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

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

	   primitive p_Raid1 ocf:heartbeat:Raid1 \
	     params \
	       raidconf=string \
	       raiddev=string \
	     op	monitor	depth="0" timeout="20s"	interval="10s"

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

	   pcs resource	create p_Raid1 ocf:heartbeat:Raid1 \
	     raidconf=string \
	     raiddev=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_RAID1(7)

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

home | help