'\" t
.\"     Title: ocf_heartbeat_iSCSITarget
.\"    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_ISCSIT" "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_iSCSITarget \- iSCSI target export agent
.SH "SYNOPSIS"
.HP \w'\fBiSCSITarget\fR\ 'u
\fBiSCSITarget\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Manages iSCSI targets\&. An iSCSI target is a collection of SCSI Logical Units (LUs) 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
\fBiqn\fR
.RS 4
The target iSCSI Qualified Name (IQN)\&. Should follow the conventional "iqn\&.yyyy\-mm\&.<reversed domain name>[:identifier]" syntax\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBtid\fR
.RS 4
The iSCSI target ID\&. Required for tgt\&.
.sp
(unique, optional, integer, no default)
.RE
.PP
\fBportals\fR
.RS 4
iSCSI network portal addresses\&. Not supported by all implementations\&. If unset, the default is to create one portal that listens on \&.
.sp
(optional, string, default "0\&.0\&.0\&.0:3260")
.RE
.PP
\fBiser_portals\fR
.RS 4
iSCSI iSER network portal addresses\&. Not supported by all implementations\&.
.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 target\&. Initiators may be listed in any syntax the target implementation allows\&. If this parameter is empty or not set, access to this target will be allowed from any initiator\&.
.sp
(optional, string, no default)
.RE
.PP
\fBincoming_username\fR
.RS 4
A username used for incoming initiator authentication\&. If unspecified, allowed initiators will be able to log in without authentication\&. This is a unique parameter, as it not allowed to re\-use a single username across multiple target instances\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBincoming_password\fR
.RS 4
A password used for incoming initiator authentication\&.
.sp
(optional, string, no default)
.RE
.PP
\fBadditional_parameters\fR
.RS 4
Additional target 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
.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 iSCSITarget resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_iSCSITarget ocf:heartbeat:iSCSITarget \e
  params \e
    iqn=\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 iSCSITarget resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_iSCSITarget ocf:heartbeat:iSCSITarget \e
  iqn=\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