ocf_heartbeat_iSCSITarget(7)

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

NAME

6       ocf_heartbeat_iSCSITarget - iSCSI target export agent
7

SYNOPSIS

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

DESCRIPTION

13       Manages iSCSI targets. An iSCSI target is a collection of SCSI Logical
14       Units (LUs) 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       iqn
26           The target iSCSI Qualified Name (IQN). Should follow the
27           conventional "iqn.yyyy-mm.<reversed domain name>[:identifier]"
28           syntax.
29
30           (unique, required, string, no default)
31
32       tid
33           The iSCSI target ID. Required for tgt.
34
35           (unique, optional, integer, no default)
36
37       portals
38           iSCSI network portal addresses. Not supported by all
39           implementations. If unset, the default is to create one portal that
40           listens on .
41
42           (optional, string, default "0.0.0.0:3260")
43
44       iser_portals
45           iSCSI iSER network portal addresses. Not supported by all
46           implementations.
47
48           (optional, string, no default)
49
50       allowed_initiators
51           Allowed initiators. A space-separated list of initiators allowed to
52           connect to this target. Initiators may be listed in any syntax the
53           target implementation allows. If this parameter is empty or not
54           set, access to this target will be allowed from any initiator.
55
56           (optional, string, no default)
57
58       incoming_username
59           A username used for incoming initiator authentication. If
60           unspecified, allowed initiators will be able to log in without
61           authentication. This is a unique parameter, as it not allowed to
62           re-use a single username across multiple target instances.
63
64           (unique, optional, string, no default)
65
66       incoming_password
67           A password used for incoming initiator authentication.
68
69           (optional, string, no default)
70
71       additional_parameters
72           Additional target parameters. A space-separated list of
73           "name=value" pairs which will be passed through to the iSCSI
74           daemon's management interface. The supported parameters are
75           implementation dependent. Neither the name nor the value may
76           contain whitespace.
77
78           (optional, string, no default)
79

SUPPORTED ACTIONS

81       This resource agent supports the following actions (operations):
82
83       start
84           Starts the resource. Suggested minimum timeout: 10s.
85
86       stop
87           Stops the resource. Suggested minimum timeout: 10s.
88
89       status
90           Performs a status check. Suggested minimum timeout: 10s. Suggested
91           interval: 10s.
92
93       monitor
94           Performs a detailed status check. Suggested minimum timeout: 10s.
95           Suggested interval: 10s.
96
97       meta-data
98           Retrieves resource agent metadata (internal use only). Suggested
99           minimum timeout: 5s.
100
101       validate-all
102           Performs a validation of the resource configuration. Suggested
103           minimum timeout: 10s.
104

EXAMPLE CRM SHELL

106       The following is an example configuration for a iSCSITarget resource
107       using the crm(8) shell:
108
109           primitive p_iSCSITarget ocf:heartbeat:iSCSITarget \
110             params \
111               iqn=string \
112             op monitor timeout="10s" interval="10s" depth="0"
113

EXAMPLE PCS

115       The following is an example configuration for a iSCSITarget resource
116       using pcs(8)
117
118           pcs resource create p_iSCSITarget ocf:heartbeat:iSCSITarget \
119             iqn=string \
120             op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"
121

AUTHOR

126       ClusterLabs contributors (see the resource agent source for information
127       about individual authors)
128
129
130
131resource-agents UNKNOWN           01/25/2023           OCF_HEARTBEAT_ISCSIT(7)