ocf_heartbeat_iSCSILogicalUnit(7)

1OCF_HEARTBEAT_ISCSIL(7)       OCF resource agents      OCF_HEARTBEAT_ISCSIL(7)
2
3
4

NAME

6       ocf_heartbeat_iSCSILogicalUnit - Manages iSCSI Logical Units (LUs)
7

SYNOPSIS

9       iSCSILogicalUnit [start | stop | status | monitor | meta-data |
10                        validate-all]
11

DESCRIPTION

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

SUPPORTED PARAMETERS

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
23           (optional, string, no default)
24
25       target_iqn
26           The iSCSI Qualified Name (IQN) that this Logical Unit belongs to.
27
28           (required, string, no default)
29
30       lun
31           The Logical Unit number (LUN) exposed to initiators.
32
33           (required, integer, no default)
34
35       path
36           The path to the block device exposed. Some implementations allow
37           this to be a regular file, too.
38
39           (required, string, no default)
40
41       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
45           (unique, optional, string, default "RESOURCE_ID")
46
47       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
51           (unique, optional, string, default "b3a49b7f")
52
53       emulate_tpu
54           The SCSI UNMAP command to be configured for this Logical Unit.
55           Setting this integer to 1 will enable TPU IOCTL emulation.
56
57           (optional, integer, no default)
58
59       emulate_3pc
60           The SCSI EXTENDED COPY command to be configured for this Logical
61           Unit. Setting this integer to 1 will enable 3PC IOCTL emulation.
62
63           (optional, integer, no default)
64
65       emulate_caw
66           The SCSI Compare and Write command to be configured for this
67           Logical Unit. Setting this integer to 1 will enable CAW IOCTL
68           emulation.
69
70           (optional, integer, no default)
71
72       vendor_id
73           The SCSI vendor ID to be configured for this Logical Unit.
74
75           (optional, string, no default)
76
77       product_id
78           The SCSI product ID to be configured for this Logical Unit.
79
80           (optional, string, no default)
81
82       tgt_bstype
83           TGT specific backing store type. If you want to use aio, make sure
84           your tgtadm is built against libaio. See tgtadm(8).
85
86           (optional, string, no default)
87
88       tgt_bsoflags
89           TGT specific backing store open flags (direct|sync). See tgtadm(8).
90
91           (optional, string, no default)
92
93       tgt_bsopts
94           TGT specific backing store options. See tgtadm(8).
95
96           (optional, string, no default)
97
98       tgt_device_type
99           TGT specific device type. See tgtadm(8).
100
101           (optional, string, no default)
102
103       additional_parameters
104           Additional LU parameters. A space-separated list of "name=value"
105           pairs which will be passed through to the iSCSI daemon's management
106           interface. The supported parameters are implementation dependent.
107           Neither the name nor the value may contain whitespace.
108
109           (optional, string, no default)
110
111       allowed_initiators
112           Allowed initiators. A space-separated list of initiators allowed to
113           connect to this lun. Initiators may be listed in any syntax the
114           target implementation allows. If this parameter is empty or not
115           set, access to this lun will not be allowed from any initiator, if
116           target is not in demo mode.
117
118           This parameter is only necessary when using LIO.
119
120           (optional, string, no default)
121
122       lio_iblock
123           LIO iblock device name, a number starting from 0.
124
125           Using distinct values here avoids a warning in LIO "LEGACY: SHARED
126           HBA"; and it is necessary when using multiple LUNs started at the
127           same time (eg. on node failover) to prevent a race condition in
128           tcm_core on mkdir() in /sys/kernel/config/target/core/.
129
130           (optional, integer, default 0)
131

SUPPORTED ACTIONS

133       This resource agent supports the following actions (operations):
134
135       start
136           Starts the resource. Suggested minimum timeout: 10s.
137
138       stop
139           Stops the resource. Suggested minimum timeout: 10s.
140
141       status
142           Performs a status check. Suggested minimum timeout: 10s. Suggested
143           interval: 10s.
144
145       monitor
146           Performs a detailed status check. Suggested minimum timeout: 10s.
147           Suggested interval: 10s.
148
149       meta-data
150           Retrieves resource agent metadata (internal use only). Suggested
151           minimum timeout: 5s.
152
153       validate-all
154           Performs a validation of the resource configuration. Suggested
155           minimum timeout: 10s.
156

EXAMPLE CRM SHELL

158       The following is an example configuration for a iSCSILogicalUnit
159       resource using the crm(8) shell:
160
161           primitive p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \
162             params \
163               target_iqn=string \
164               lun=integer \
165               path=string \
166             op monitor timeout="10s" interval="10s" depth="0"
167

EXAMPLE PCS

169       The following is an example configuration for a iSCSILogicalUnit
170       resource using pcs(8)
171
172           pcs resource create p_iSCSILogicalUnit ocf:heartbeat:iSCSILogicalUnit \
173             target_iqn=string \
174             lun=integer \
175             path=string \
176             op monitor timeout="10s" interval="10s" depth="0"
177

AUTHOR

182       ClusterLabs contributors (see the resource agent source for information
183       about individual authors)
184
185
186
187resource-agents UNKNOWN           10/24/2018           OCF_HEARTBEAT_ISCSIL(7)