'\" t
.\"     Title: ocf_heartbeat_sfex
.\"    Author: Linux-HA contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 02/03/2011
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 1.0.3
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SFEX" "7" "02/03/2011" "resource-agents 1.0.3" "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]
.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\&. (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\&. (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\&. (optional, integer, default
1)
.RE
.PP
\fBmonitor_interval\fR
.RS 4
Monitor interval(sec)\&. Default is 10 seconds (optional, integer, default
10)
.RE
.PP
\fBlock_timeout\fR
.RS 4
Valid term of lock(sec)\&. Default is 20 seconds\&. (optional, integer, default
20)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 600\&.
.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: 10\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE"
.PP
The following is an example configuration for a sfex resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive example_sfex ocf:heartbeat:sfex \e
  params \e
    device=\fIstring\fR \e
  op monitor depth="0" timeout="10" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP

\m[blue]\fB\%http://www.linux-ha.org/wiki/sfex_(resource_agent)\fR\m[]
.SH "AUTHOR"
.PP
\fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR