1OCF_HEARTBEAT_ISCSIL(7) OCF resource agents OCF_HEARTBEAT_ISCSIL(7)
2
6 ocf_heartbeat_iSCSILogicalUnit - Manages iSCSI Logical Units (LUs)
7
9 iSCSILogicalUnit [start | stop | status | monitor | meta-data |
10 validate-all]
11
13 Manages iSCSI Logical Unit. An iSCSI Logical unit is a subdivision of
14 an SCSI Target, exported via a daemon that speaks the iSCSI protocol.
15
17 implementation
18 The iSCSI target daemon implementation. Must be one of "iet",
19 "tgt", "lio", "lio-t", or "scst". If unspecified, an implementation
20 is selected based on the availability of management utilities, with
21 "iet" being tried first, then "tgt", then "lio", then "lio-t", then
22 "scst".
23 (optional, string, no default)
25 target_iqn
27 The iSCSI Qualified Name (IQN) that this Logical Unit belongs to.
28 (required, string, no default)
30 lun
32 The Logical Unit number (LUN) exposed to initiators.
33 (required, integer, no default)
35 path
37 The path to the block device exposed. Some implementations allow
38 this to be a regular file, too.
39 (required, string, no default)
41 scsi_id
43 The SCSI ID to be configured for this Logical Unit. The default is
44 the resource name, truncated to 24 bytes.
45 (unique, optional, string, default "RESOURCE_ID")
47 scsi_sn
49 The SCSI serial number to be configured for this Logical Unit. The
50 default is a hash of the resource name, truncated to 8 bytes,
51 meaning 26 hex characters. If you are using XenServer with
52 multipath as iSCSI client, you MUST make sure this value is set, or
53 else XenServer multipath will not be able to access the LUN
54 (unique, optional, string, default "b3a49b7f")
56 emulate_tpu
58 The SCSI UNMAP command to be configured for this Logical Unit.
59 Setting this integer to 1 will enable TPU IOCTL emulation.
60 (optional, integer, no default)
62 emulate_3pc
64 The SCSI EXTENDED COPY command to be configured for this Logical
65 Unit. Setting this integer to 1 will enable 3PC IOCTL emulation.
66 (optional, integer, no default)
68 emulate_caw
70 The SCSI Compare and Write command to be configured for this
71 Logical Unit. Setting this integer to 1 will enable CAW IOCTL
72 emulation.
73 (optional, integer, no default)
75 vendor_id
77 The SCSI vendor ID to be configured for this Logical Unit.
78 (optional, string, no default)
80 product_id
82 The SCSI product ID to be configured for this Logical Unit.
83 (optional, string, no default)
85 tgt_bstype
87 TGT specific backing store type. If you want to use aio, make sure
88 your tgtadm is built against libaio. See tgtadm(8).
89 (optional, string, no default)
91 tgt_bsoflags
93 TGT specific backing store open flags (direct|sync). See tgtadm(8).
94 (optional, string, no default)
96 tgt_bsopts
98 TGT specific backing store options. See tgtadm(8).
99 (optional, string, no default)
101 tgt_device_type
103 TGT specific device type. See tgtadm(8).
104 (optional, string, no default)
106 additional_parameters
108 Additional LU parameters. A space-separated list of "name=value"
109 pairs which will be passed through to the iSCSI daemon's management
110 interface. The supported parameters are implementation dependent.
111 Neither the name nor the value may contain whitespace.
112 (optional, string, no default)
114 allowed_initiators
116 Allowed initiators. A space-separated list of initiators allowed to
117 connect to this lun. Initiators may be listed in any syntax the
118 target implementation allows. If this parameter is empty or not
119 set, access to this lun will not be allowed from any initiator, if
120 target is not in demo mode.
121 This parameter is only necessary when using LIO.
123 (optional, string, no default)
125 lio_iblock
127 LIO iblock device name, a number starting from 0.
128 Using distinct values here avoids a warning in LIO "LEGACY: SHARED
130 HBA"; and it is necessary when using multiple LUNs started at the
131 same time (eg. on node failover) to prevent a race condition in
132 tcm_core on mkdir() in /sys/kernel/config/target/core/.
133 (optional, integer, default 0)
135 liot_bstype
137 LIO-T specific backing store type. If you want to use aio, set this
138 to 'block'. If you want to use async IO, set this to 'fileio'.
139 Async I/O works also with block devices, however - you need to
140 understand the consequences. See targetcli(8). If using file
141 backend, you need to create this file in advance. If you want to
142 use SCSI Passthrough, set this to 'pscsi'. Do not use PSCSI unless
143 you know exactly how it will be used.
144 (optional, string, default "block")
146
148 This resource agent supports the following actions (operations):
149 start
151 Starts the resource. Suggested minimum timeout: 10s.
152 stop
154 Stops the resource. Suggested minimum timeout: 10s.
155 status
157 Performs a status check. Suggested minimum timeout: 10s. Suggested
158 interval: 10s.
159 monitor
161 Performs a detailed status check. Suggested minimum timeout: 10s.
162 Suggested interval: 10s.
163 meta-data
165 Retrieves resource agent metadata (internal use only). Suggested
166 minimum timeout: 5s.
167 validate-all
169 Performs a validation of the resource configuration. Suggested
170 minimum timeout: 10s.
171
173 The following is an example configuration for a iSCSILogicalUnit
174 resource using the crm(8) shell:
175 primitive p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \
177 params \
178 target_iqn=string \
179 lun=integer \
180 path=string \
181 op monitor timeout="10s" interval="10s" depth="0"
182
184 The following is an example configuration for a iSCSILogicalUnit
185 resource using pcs(8)
186 pcs resource create p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \
188 target_iqn=string \
189 lun=integer \
190 path=string \
191 op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"
192
194 http://clusterlabs.org/
195
197 ClusterLabs contributors (see the resource agent source for information
198 about individual authors)
199resource-agents UNKNOWN 10/11/2023 OCF_HEARTBEAT_ISCSIL(7)