NAME

       ocf_heartbeat_sfex - Manages exclusive access to shared storage using Shared Disk File
       EXclusiveness (SF-EX)

SYNOPSIS

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

DESCRIPTION

       Resource script for SF-EX. It manages a shared storage medium exclusively .

SUPPORTED PARAMETERS

       device
           Block device path that stores exclusive control data.

           (required, string, no default)

       index
           Location in block device where exclusive control data is stored. 1 or more is
           specified. Default is 1.

           (optional, integer, default 1)

       collision_timeout
           Waiting time when a collision of lock acquisition is detected. Default is 1 second.

           (optional, integer, default 1)

       monitor_interval
           Monitor interval(sec). Default is 10 seconds

           (optional, integer, default 10)

       lock_timeout
           Valid term of lock(sec). Default is 100 seconds. The lock_timeout is calculated by the
           following formula.

           lock_timeout = monitor_interval + "The expiration time of the lock"

           We suggest 90 seconds as a default value of the "The expiration time of the lock", but
           you should change it in consideration of access delay to the shared disk and the
           switch time of the multipath driver.

           The lock timeout have an impact on start action timeout because start action timeout
           value is calculated by the following formula.

           start timeout = collision_timeout + lock_timeout + "safety margin"

           The "safety margin" is decided within the range of about 10-20 seconds(It depends on
           your system requirement).

           (optional, integer, default 100)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

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

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

       monitor
           Performs a detailed status check. Suggested minimum timeout: 10s. 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 sfex resource using the crm(8) shell:

           primitive p_sfex ocf:heartbeat:sfex \
             params \
               device=string \
             op monitor depth="0" timeout="10s" interval="10s"

EXAMPLE PCS

       The following is an example configuration for a sfex resource using pcs(8)

           pcs resource create p_sfex ocf:heartbeat:sfex \
             device=string \
             op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

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