'\" t
.\"     Title: ocf_heartbeat_sfex
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 12/17/2020
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SFEX" "7" "12/17/2020" "resource-agents UNKNOWN" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_sfex \- Manages exclusive access to shared storage using Shared Disk File EXclusiveness (SF\-EX)
.SH "SYNOPSIS"
.HP \w'\fBsfex\fR\ 'u
\fBsfex\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource script for SF\-EX\&. It manages a shared storage medium exclusively \&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBdevice\fR
.RS 4
Block device path that stores exclusive control data\&.
.sp
(required, string, no default)
.RE
.PP
\fBindex\fR
.RS 4
Location in block device where exclusive control data is stored\&. 1 or more is specified\&. Default is 1\&.
.sp
(optional, integer, default
1)
.RE
.PP
\fBcollision_timeout\fR
.RS 4
Waiting time when a collision of lock acquisition is detected\&. Default is 1 second\&.
.sp
(optional, integer, default
1)
.RE
.PP
\fBmonitor_interval\fR
.RS 4
Monitor interval(sec)\&. Default is 10 seconds
.sp
(optional, integer, default
10)
.RE
.PP
\fBlock_timeout\fR
.RS 4
Valid term of lock(sec)\&. Default is 100 seconds\&. The lock_timeout is calculated by the following formula\&.
.sp
lock_timeout = monitor_interval + "The expiration time of the lock"
.sp
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\&.
.sp
The lock timeout have an impact on start action timeout because start action timeout value is calculated by the following formula\&.
.sp
start timeout = collision_timeout + lock_timeout + "safety margin"
.sp
The "safety margin" is decided within the range of about 10\-20 seconds(It depends on your system requirement)\&.
.sp
(optional, integer, default
100)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 120s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 10s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a sfex resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_sfex ocf:heartbeat:sfex \e
  params \e
    device=\fIstring\fR \e
  op monitor depth="0" timeout="10s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a sfex resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_sfex ocf:heartbeat:sfex \e
  device=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="10s" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR