ocf_heartbeat_iscsi(7)

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

NAME

6       ocf_heartbeat_iscsi - Manages a local iSCSI initiator and its
7       connections to iSCSI targets
8

SYNOPSIS

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

DESCRIPTION

13       OCF Resource Agent for iSCSI. Add (start) or remove (stop) iSCSI
14       targets.
15

SUPPORTED PARAMETERS

17       portal
18           The iSCSI portal address in the form:
19           {ip_address|hostname}[":"port]
20
21           (required, string, no default)
22
23       target
24           The iSCSI target IQN.
25
26           (unique, required, string, no default)
27
28       discovery_type
29           Target discovery type. Check the open-iscsi documentation for
30           supported discovery types.
31
32           (optional, string, default "sendtargets")
33
34       iscsiadm
35           open-iscsi administration utility binary.
36
37           (optional, string, default "iscsiadm")
38
39       udev
40           If the next resource depends on the udev creating a device then we
41           wait until it is finished. On a normally loaded host this should be
42           done quickly, but you may be unlucky. If you are not using udev set
43           this to "no", otherwise we will spin in a loop until a timeout
44           occurs.
45
46           (optional, string, default "yes")
47
48       try_recovery
49           If the iSCSI session exists but is currently inactive/broken, which
50           is most probably due to network problems, the iSCSI layer will try
51           to recover. If this parameter is set to true, we'll wait for the
52           recovery to succeed. In that case the monitor operation can only
53           time out so you should set the monitor op timeout attribute
54           appropriately.
55
56           (optional, boolean, default false)
57

SUPPORTED ACTIONS

59       This resource agent supports the following actions (operations):
60
61       start
62           Starts the resource. Suggested minimum timeout: 120s.
63
64       stop
65           Stops the resource. Suggested minimum timeout: 120s.
66
67       status
68           Performs a status check. Suggested minimum timeout: 30s.
69
70       monitor
71           Performs a detailed status check. Suggested minimum timeout: 30s.
72           Suggested interval: 120s.
73
74       validate-all
75           Performs a validation of the resource configuration. Suggested
76           minimum timeout: 5s.
77
78       methods
79           Suggested minimum timeout: 5s.
80
81       meta-data
82           Retrieves resource agent metadata (internal use only). Suggested
83           minimum timeout: 5s.
84

EXAMPLE CRM SHELL

86       The following is an example configuration for a iscsi resource using
87       the crm(8) shell:
88
89           primitive p_iscsi ocf:heartbeat:iscsi \
90             params \
91               portal=string \
92               target=string \
93             op monitor depth="0" timeout="30s" interval="120s"
94

EXAMPLE PCS

96       The following is an example configuration for a iscsi resource using
97       pcs(8)
98
99           pcs resource create p_iscsi ocf:heartbeat:iscsi \
100             portal=string \
101             target=string \
102             op monitor OCF_CHECK_LEVEL="0" timeout="30s" interval="120s"
103

AUTHOR

108       ClusterLabs contributors (see the resource agent source for information
109       about individual authors)
110
111
112
113resource-agents UNKNOWN           10/11/2023            OCF_HEARTBEAT_ISCSI(7)