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", or "lio-t". If unspecified, an implementation is
20 selected based on the availability of management utilities, with
21 "iet" being tried first, then "tgt", then "lio", then "lio-t".
22 (optional, string, no default)
24 target_iqn
26 The iSCSI Qualified Name (IQN) that this Logical Unit belongs to.
27 (required, string, no default)
29 lun
31 The Logical Unit number (LUN) exposed to initiators.
32 (required, integer, no default)
34 path
36 The path to the block device exposed. Some implementations allow
37 this to be a regular file, too.
38 (required, string, no default)
40 scsi_id
42 The SCSI ID to be configured for this Logical Unit. The default is
43 the resource name, truncated to 24 bytes.
44 (unique, optional, string, default "RESOURCE_ID")
46 scsi_sn
48 The SCSI serial number to be configured for this Logical Unit. The
49 default is a hash of the resource name, truncated to 8 bytes,
50 meaning 26 hex characters. If you are using XenServer with
51 multipath as iSCSI client, you MUST make sure this value is set, or
52 else XenServer multipath will not be able to access the LUN
53 (unique, optional, string, default "b3a49b7f")
55 emulate_tpu
57 The SCSI UNMAP command to be configured for this Logical Unit.
58 Setting this integer to 1 will enable TPU IOCTL emulation.
59 (optional, integer, no default)
61 emulate_3pc
63 The SCSI EXTENDED COPY command to be configured for this Logical
64 Unit. Setting this integer to 1 will enable 3PC IOCTL emulation.
65 (optional, integer, no default)
67 emulate_caw
69 The SCSI Compare and Write command to be configured for this
70 Logical Unit. Setting this integer to 1 will enable CAW IOCTL
71 emulation.
72 (optional, integer, no default)
74 vendor_id
76 The SCSI vendor ID to be configured for this Logical Unit.
77 (optional, string, no default)
79 product_id
81 The SCSI product ID to be configured for this Logical Unit.
82 (optional, string, no default)
84 tgt_bstype
86 TGT specific backing store type. If you want to use aio, make sure
87 your tgtadm is built against libaio. See tgtadm(8).
88 (optional, string, no default)
90 tgt_bsoflags
92 TGT specific backing store open flags (direct|sync). See tgtadm(8).
93 (optional, string, no default)
95 tgt_bsopts
97 TGT specific backing store options. See tgtadm(8).
98 (optional, string, no default)
100 tgt_device_type
102 TGT specific device type. See tgtadm(8).
103 (optional, string, no default)
105 additional_parameters
107 Additional LU parameters. A space-separated list of "name=value"
108 pairs which will be passed through to the iSCSI daemon's management
109 interface. The supported parameters are implementation dependent.
110 Neither the name nor the value may contain whitespace.
111 (optional, string, no default)
113 allowed_initiators
115 Allowed initiators. A space-separated list of initiators allowed to
116 connect to this lun. Initiators may be listed in any syntax the
117 target implementation allows. If this parameter is empty or not
118 set, access to this lun will not be allowed from any initiator, if
119 target is not in demo mode.
120 This parameter is only necessary when using LIO.
122 (optional, string, no default)
124 lio_iblock
126 LIO iblock device name, a number starting from 0.
127 Using distinct values here avoids a warning in LIO "LEGACY: SHARED
129 HBA"; and it is necessary when using multiple LUNs started at the
130 same time (eg. on node failover) to prevent a race condition in
131 tcm_core on mkdir() in /sys/kernel/config/target/core/.
132 (optional, integer, default 0)
134 liot_bstype
136 LIO-T specific backing store type. If you want to use aio, set this
137 to 'block'. If you want to use async IO, set this to 'fileio'.
138 Async I/O works also with block devices, however - you need to
139 understand the consequences. See targetcli(8). If using file
140 backend, you need to create this file in advance.
141 (optional, string, default "block")
143
145 This resource agent supports the following actions (operations):
146 start
148 Starts the resource. Suggested minimum timeout: 10s.
149 stop
151 Stops the resource. Suggested minimum timeout: 10s.
152 status
154 Performs a status check. Suggested minimum timeout: 10s. Suggested
155 interval: 10s.
156 monitor
158 Performs a detailed status check. Suggested minimum timeout: 10s.
159 Suggested interval: 10s.
160 meta-data
162 Retrieves resource agent metadata (internal use only). Suggested
163 minimum timeout: 5s.
164 validate-all
166 Performs a validation of the resource configuration. Suggested
167 minimum timeout: 10s.
168
170 The following is an example configuration for a iSCSILogicalUnit
171 resource using the crm(8) shell:
172 primitive p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \
174 params \
175 target_iqn=string \
176 lun=integer \
177 path=string \
178 op monitor timeout="10s" interval="10s" depth="0"
179
181 The following is an example configuration for a iSCSILogicalUnit
182 resource using pcs(8)
183 pcs resource create p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \
185 target_iqn=string \
186 lun=integer \
187 path=string \
188 op monitor timeout="10s" interval="10s" depth="0"
189
191 http://clusterlabs.org/
192
194 ClusterLabs contributors (see the resource agent source for information
195 about individual authors)
196resource-agents UNKNOWN 03/09/2020 OCF_HEARTBEAT_ISCSIL(7)