'\" t
.\"     Title: ocf_heartbeat_scsi2reservation
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_SCSI2R" "7" "04/13/2023" "resource-agents 4.12.0-2" "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_scsi2reservation \- scsi\-2 reservation
.SH "SYNOPSIS"
.HP \w'\fBscsi2reservation\fR\ 'u
\fBscsi2reservation\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
The scsi\-2\-reserve resource agent is a place holder for SCSI\-2 reservation\&. A healthy instance of scsi\-2\-reserve resource, indicates the own of the specified SCSI device\&. This resource agent depends on the scsi_reserve from scsires package, which is Linux specific\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBscsi_reserve\fR
.RS 4
The scsi_reserve is a command from scsires package\&. It helps one to issue SCSI\-2 reservation on SCSI devices\&.
.sp
(optional, string, default "/usr/sbin/scsi_reserve")
.RE
.PP
\fBsharedisk\fR
.RS 4
The shared disk that can be reserved\&.
.sp
(optional, string, default "/dev/sdb")
.RE
.PP
\fBstart_loop\fR
.RS 4
We are going to try several times before giving up\&. Start_loop indicates how many times we are going to re\-try\&.
.sp
(optional, string, default "10")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 300s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 100s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 20s\&.
.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: 30s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a scsi2reservation resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_scsi2reservation ocf:heartbeat:scsi2reservation \e
  op monitor depth="0" timeout="20s" interval="20s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a scsi2reservation resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_scsi2reservation ocf:heartbeat:scsi2reservation \e
  op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="20s" 
.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