'\" t
.\"     Title: ocf_heartbeat_iSCSILogicalUnit
.\"    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_ISCSIL" "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_iSCSILogicalUnit \- Manages iSCSI Logical Units (LUs)
.SH "SYNOPSIS"
.HP \w'\fBiSCSILogicalUnit\fR\ 'u
\fBiSCSILogicalUnit\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Manages iSCSI Logical Unit\&. An iSCSI Logical unit is a subdivision of an SCSI Target, exported via a daemon that speaks the iSCSI protocol\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBimplementation\fR
.RS 4
The iSCSI target daemon implementation\&. Must be one of "iet", "tgt", "lio", or "lio\-t"\&. If unspecified, an implementation is selected based on the availability of management utilities, with "iet" being tried first, then "tgt", then "lio", then "lio\-t"\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtarget_iqn\fR
.RS 4
The iSCSI Qualified Name (IQN) that this Logical Unit belongs to\&.
.sp
(required, string, no default)
.RE
.PP
\fBlun\fR
.RS 4
The Logical Unit number (LUN) exposed to initiators\&.
.sp
(required, integer, no default)
.RE
.PP
\fBpath\fR
.RS 4
The path to the block device exposed\&. Some implementations allow this to be a regular file, too\&.
.sp
(required, string, no default)
.RE
.PP
\fBscsi_id\fR
.RS 4
The SCSI ID to be configured for this Logical Unit\&. The default is the resource name, truncated to 24 bytes\&.
.sp
(unique, optional, string, default "RESOURCE_ID")
.RE
.PP
\fBscsi_sn\fR
.RS 4
The SCSI serial number to be configured for this Logical Unit\&. The default is a hash of the resource name, truncated to 8 bytes, meaning 26 hex characters\&. If you are using XenServer with multipath as iSCSI client, you MUST make sure this value is set, or else XenServer multipath will not be able to access the LUN
.sp
(unique, optional, string, default "b3a49b7f")
.RE
.PP
\fBemulate_tpu\fR
.RS 4
The SCSI UNMAP command to be configured for this Logical Unit\&. Setting this integer to 1 will enable TPU IOCTL emulation\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBemulate_3pc\fR
.RS 4
The SCSI EXTENDED COPY command to be configured for this Logical Unit\&. Setting this integer to 1 will enable 3PC IOCTL emulation\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBemulate_caw\fR
.RS 4
The SCSI Compare and Write command to be configured for this Logical Unit\&. Setting this integer to 1 will enable CAW IOCTL emulation\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBvendor_id\fR
.RS 4
The SCSI vendor ID to be configured for this Logical Unit\&.
.sp
(optional, string, no default)
.RE
.PP
\fBproduct_id\fR
.RS 4
The SCSI product ID to be configured for this Logical Unit\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtgt_bstype\fR
.RS 4
TGT specific backing store type\&. If you want to use aio, make sure your tgtadm is built against libaio\&. See tgtadm(8)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtgt_bsoflags\fR
.RS 4
TGT specific backing store open flags (direct|sync)\&. See tgtadm(8)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtgt_bsopts\fR
.RS 4
TGT specific backing store options\&. See tgtadm(8)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBtgt_device_type\fR
.RS 4
TGT specific device type\&. See tgtadm(8)\&.
.sp
(optional, string, no default)
.RE
.PP
\fBadditional_parameters\fR
.RS 4
Additional LU parameters\&. A space\-separated list of "name=value" pairs which will be passed through to the iSCSI daemon\*(Aqs management interface\&. The supported parameters are implementation dependent\&. Neither the name nor the value may contain whitespace\&.
.sp
(optional, string, no default)
.RE
.PP
\fBallowed_initiators\fR
.RS 4
Allowed initiators\&. A space\-separated list of initiators allowed to connect to this lun\&. Initiators may be listed in any syntax the target implementation allows\&. If this parameter is empty or not set, access to this lun will not be allowed from any initiator, if target is not in demo mode\&.
.sp
This parameter is only necessary when using LIO\&.
.sp
(optional, string, no default)
.RE
.PP
\fBlio_iblock\fR
.RS 4
LIO iblock device name, a number starting from 0\&.
.sp
Using distinct values here avoids a warning in LIO "LEGACY: SHARED HBA"; and it is necessary when using multiple LUNs started at the same time (eg\&. on node failover) to prevent a race condition in tcm_core on mkdir() in /sys/kernel/config/target/core/\&.
.sp
(optional, integer, default
0)
.RE
.PP
\fBliot_bstype\fR
.RS 4
LIO\-T specific backing store type\&. If you want to use aio, set this to \*(Aqblock\*(Aq\&. If you want to use async IO, set this to \*(Aqfileio\*(Aq\&. Async I/O works also with block devices, however \- you need to understand the consequences\&. See targetcli(8)\&. If using file backend, you need to create this file in advance\&. If you want to use SCSI Passthrough, set this to \*(Aqpscsi\*(Aq\&. Do not use PSCSI unless you know exactly how it will be used\&.
.sp
(optional, string, default "block")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 10s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 10s\&. Suggested interval: 10s\&.
.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: 10s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a iSCSILogicalUnit resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \e
  params \e
    target_iqn=\fIstring\fR \e
    lun=\fIinteger\fR \e
    path=\fIstring\fR \e
  op monitor timeout="10s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a iSCSILogicalUnit resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \e
  target_iqn=\fIstring\fR \e
  lun=\fIinteger\fR \e
  path=\fIstring\fR \e
  op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0" 
.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