'\" t
.\"     Title: ocf_heartbeat_iscsi
.\"    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_ISCSI" "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_iscsi \- Manages a local iSCSI initiator and its connections to iSCSI targets
.SH "SYNOPSIS"
.HP \w'\fBiscsi\fR\ 'u
\fBiscsi\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
OCF Resource Agent for iSCSI\&. Add (start) or remove (stop) iSCSI targets\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBportal\fR
.RS 4
The iSCSI portal address in the form: {ip_address|hostname}[":"port]
.sp
(required, string, no default)
.RE
.PP
\fBtarget\fR
.RS 4
The iSCSI target IQN\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBdiscovery_type\fR
.RS 4
Target discovery type\&. Check the open\-iscsi documentation for supported discovery types\&.
.sp
(optional, string, default "sendtargets")
.RE
.PP
\fBiscsiadm\fR
.RS 4
open\-iscsi administration utility binary\&.
.sp
(optional, string, default "iscsiadm")
.RE
.PP
\fBudev\fR
.RS 4
If the next resource depends on the udev creating a device then we wait until it is finished\&. On a normally loaded host this should be done quickly, but you may be unlucky\&. If you are not using udev set this to "no", otherwise we will spin in a loop until a timeout occurs\&.
.sp
(optional, string, default "yes")
.RE
.PP
\fBtry_recovery\fR
.RS 4
If the iSCSI session exists but is currently inactive/broken, which is most probably due to network problems, the iSCSI layer will try to recover\&. If this parameter is set to true, we\*(Aqll wait for the recovery to succeed\&. In that case the monitor operation can only time out so you should set the monitor op timeout attribute appropriately\&.
.sp
(optional, boolean, default
false)
.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: 120s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30s\&. Suggested interval: 120s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmethods\fR
.RS 4
Suggested minimum timeout: 5s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a iscsi resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_iscsi ocf:heartbeat:iscsi \e
  params \e
    portal=\fIstring\fR \e
    target=\fIstring\fR \e
  op monitor depth="0" timeout="30s" interval="120s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a iscsi resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_iscsi ocf:heartbeat:iscsi \e
  portal=\fIstring\fR \e
  target=\fIstring\fR \e
  op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="120s" 
.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