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

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

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

AUTHOR

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