Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>org.freedesktop.UDisks2.Manager.ISCSI.Initiator: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="UDisks Reference Manual">
8 <link rel="up" href="ch03.html" title="D-Bus Interfaces">
9 <link rel="prev" href="gdbus-org.freedesktop.UDisks2.ISCSI.Session.html" title="org.freedesktop.UDisks2.ISCSI.Session">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.Manager.BTRFS.html" title="org.freedesktop.UDisks2.Manager.BTRFS">
11 <meta name="generator" content="GTK-Doc V1.35.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.properties" class="shortcut">Properties</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.ISCSI.Session.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Manager.BTRFS.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.top_of_page"></a>org.freedesktop.UDisks2.Manager.ISCSI.Initiator</span></h2>
31 <p>org.freedesktop.UDisks2.Manager.ISCSI.Initiator — iSCSI add-on to the manager singleton</p>
32 </td>
33 <td class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsynopsisdiv">
36 <h2>Methods</h2>
37 <pre class="synopsis">
38 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.GetFirmwareInitiatorName" title="The GetFirmwareInitiatorName() method">GetFirmwareInitiatorName</a> (OUT s result);
39 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.GetInitiatorName" title="The GetInitiatorName() method">GetInitiatorName</a> (OUT s result);
40 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.GetInitiatorNameRaw" title="The GetInitiatorNameRaw() method">GetInitiatorNameRaw</a> (OUT ay result);
41 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.SetInitiatorName" title="The SetInitiatorName() method">SetInitiatorName</a> (IN s name,
42 IN a{sv} options);
43 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.DiscoverSendTargets" title="The DiscoverSendTargets() method">DiscoverSendTargets</a> (IN s address,
44 IN q port,
45 IN a{sv} options,
46 OUT a(sisis) nodes,
47 OUT i nodes_cnt);
48 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.DiscoverFirmware" title="The DiscoverFirmware() method">DiscoverFirmware</a> (IN a{sv} options,
49 OUT a(sisis) nodes,
50 OUT i nodes_cnt);
51 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.Login" title="The Login() method">Login</a> (IN s name,
52 IN i tpgt,
53 IN s address,
54 IN i port,
55 IN s iface,
56 IN a{sv} options);
57 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.Logout" title="The Logout() method">Logout</a> (IN s name,
58 IN i tpgt,
59 IN s address,
60 IN i port,
61 IN s iface,
62 IN a{sv} options);
63 </pre>
64 </div>
65 <div class="refsect1">
66 <a name="id-1.3.3.27.4"></a><h2>Properties</h2>
67 <pre class="synopsis">
68 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-property-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.SessionsSupported" title='The "SessionsSupported" property'>SessionsSupported</a> readable b
69 </pre>
70 </div>
71 <div class="refsect1">
72 <a name="gdbus-interface-org-freedesktop-UDisks2-Manager-ISCSI-Initiator"></a><h2>Description</h2>
73 <p>
74 Additional interface with iSCSI specifics for top-level manager
75 singleton object located at the object path
76 <code class="literal">/org/freedesktop/UDisks2/Manager</code>.
77 </p>
78 <p class="since">Since 2.0.1</p>
79 </div>
80 <div class="refsect1">
81 <a name="gdbus-methods-org.freedesktop.UDisks2.Manager.ISCSI.Initiator"></a><h2>Method Details</h2>
82 <div class="refsect2">
83 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.GetFirmwareInitiatorName"></a><h3>The GetFirmwareInitiatorName() method</h3>
84 <pre class="programlisting">
85 GetFirmwareInitiatorName (OUT s result);
86 </pre>
87 <p>
88 Returns the iSCSI firmware initiator name.
89 </p>
90 <div class="variablelist"><table border="0" class="variablelist">
91 <colgroup>
92 <col align="left" valign="top">
93 <col>
94 </colgroup>
95 <tbody><tr>
96 <td><p><span class="term"><code class="literal">OUT s <em class="parameter"><code>result</code></em></code>:</span></p></td>
97 <td><p>
98 The iSCSI firmware initiator name.
99 </p></td>
100 </tr></tbody>
101 </table></div>
102 <p class="since">Since 2.4.0</p>
103 </div>
104 <hr>
105 <div class="refsect2">
106 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.GetInitiatorName"></a><h3>The GetInitiatorName() method</h3>
107 <pre class="programlisting">
108 GetInitiatorName (OUT s result);
109 </pre>
110 <p>
111 Returns a iSCSI initiator name.
112 </p>
113 <p>
114 Note: Initiator name can contain non UTF-8 characters. In this case
115 this function will return "Invalid UTF-8" string. Use
116 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.ISCSI.Initiator.html#gdbus-interface-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.top_of_page">org.freedesktop.UDisks2.Manager.ISCSI.Initiator</a>:GetInitiatorNameRaw
117 to get raw, undecoded initiator name.
118 </p>
119 <div class="variablelist"><table border="0" class="variablelist">
120 <colgroup>
121 <col align="left" valign="top">
122 <col>
123 </colgroup>
124 <tbody><tr>
125 <td><p><span class="term"><code class="literal">OUT s <em class="parameter"><code>result</code></em></code>:</span></p></td>
126 <td><p>
127 The iSCSI initiator name.
128 </p></td>
129 </tr></tbody>
130 </table></div>
131 <p class="since">Since 2.0.1</p>
132 </div>
133 <hr>
134 <div class="refsect2">
135 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.GetInitiatorNameRaw"></a><h3>The GetInitiatorNameRaw() method</h3>
136 <pre class="programlisting">
137 GetInitiatorNameRaw (OUT ay result);
138 </pre>
139 <p>
140 Returns an iSCSI initiator name as a raw NULL terminated byte array.
141 </p>
142 <div class="variablelist"><table border="0" class="variablelist">
143 <colgroup>
144 <col align="left" valign="top">
145 <col>
146 </colgroup>
147 <tbody><tr>
148 <td><p><span class="term"><code class="literal">OUT ay <em class="parameter"><code>result</code></em></code>:</span></p></td>
149 <td><p>
150 The iSCSI initiator name.
151 </p></td>
152 </tr></tbody>
153 </table></div>
154 <p class="since">Since 2.8.3</p>
155 </div>
156 <hr>
157 <div class="refsect2">
158 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.SetInitiatorName"></a><h3>The SetInitiatorName() method</h3>
159 <pre class="programlisting">
160 SetInitiatorName (IN s name,
161 IN a{sv} options);
162 </pre>
163 <p>
164 Sets a new iSCSI initiator name. This is typically done by populating the
165 <code class="filename">/etc/iscsi/initiatorname.iscsi</code> file.
166 </p>
167 <p>
168 The iscsid service needs to be restarted afterwards to reflect the change
169 (if running). This is however distribution-specific and not performed
170 by UDisks at this moment.
171 </p>
172 <p>
173 No additional options are currently defined.
174 </p>
175 <div class="variablelist"><table border="0" class="variablelist">
176 <colgroup>
177 <col align="left" valign="top">
178 <col>
179 </colgroup>
180 <tbody>
181 <tr>
182 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
183 <td><p>
184 The new iSCSI initiator name.
185 </p></td>
186 </tr>
187 <tr>
188 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
189 <td><p>
190 Additional options.
191 </p></td>
192 </tr>
193 </tbody>
194 </table></div>
195 <p class="since">Since 2.1.3</p>
196 </div>
197 <hr>
198 <div class="refsect2">
199 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.DiscoverSendTargets"></a><h3>The DiscoverSendTargets() method</h3>
200 <pre class="programlisting">
201 DiscoverSendTargets (IN s address,
202 IN q port,
203 IN a{sv} options,
204 OUT a(sisis) nodes,
205 OUT i nodes_cnt);
206 </pre>
207 <p>
208 Performs targets' discovery with no authentication data.
209 </p>
210 <p>
211 If the option <em class="parameter"><code>username</code></em> is provided, then
212 the <em class="parameter"><code>username</code></em> and <em class="parameter"><code>password</code></em>
213 will be used for CHAP authentication.
214 </p>
215 <p>
216 If the option <em class="parameter"><code>reverse-username</code></em> is provided,
217 the the <em class="parameter"><code>reverse-username</code></em> and
218 <em class="parameter"><code>reverse-password</code></em> will be used for CHAP
219 authentication.
220 </p>
221 <div class="variablelist"><table border="0" class="variablelist">
222 <colgroup>
223 <col align="left" valign="top">
224 <col>
225 </colgroup>
226 <tbody>
227 <tr>
228 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>address</code></em></code>:</span></p></td>
229 <td><p>
230 Hostname or IP-address to connect to.
231 </p></td>
232 </tr>
233 <tr>
234 <td><p><span class="term"><code class="literal">IN q <em class="parameter"><code>port</code></em></code>:</span></p></td>
235 <td><p>
236 Port to connect to, or 0 for the default port.
237 </p></td>
238 </tr>
239 <tr>
240 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
241 <td><p>
242 Additional options.
243 </p></td>
244 </tr>
245 <tr>
246 <td><p><span class="term"><code class="literal">OUT a(sisis) <em class="parameter"><code>nodes</code></em></code>:</span></p></td>
247 <td><p>
248 Discovered nodes.
249 </p></td>
250 </tr>
251 <tr>
252 <td><p><span class="term"><code class="literal">OUT i <em class="parameter"><code>nodes_cnt</code></em></code>:</span></p></td>
253 <td><p>
254 The number of found nodes.
255 </p></td>
256 </tr>
257 </tbody>
258 </table></div>
259 <p class="since">Since 2.3.1</p>
260 </div>
261 <hr>
262 <div class="refsect2">
263 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.DiscoverFirmware"></a><h3>The DiscoverFirmware() method</h3>
264 <pre class="programlisting">
265 DiscoverFirmware (IN a{sv} options,
266 OUT a(sisis) nodes,
267 OUT i nodes_cnt);
268 </pre>
269 <p>
270 Performs targets' discovery using firmware (ppc or ibft).
271 </p>
272 <p>
273 No additional options are currently defined.
274 </p>
275 <div class="variablelist"><table border="0" class="variablelist">
276 <colgroup>
277 <col align="left" valign="top">
278 <col>
279 </colgroup>
280 <tbody>
281 <tr>
282 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
283 <td><p>
284 Additional options.
285 </p></td>
286 </tr>
287 <tr>
288 <td><p><span class="term"><code class="literal">OUT a(sisis) <em class="parameter"><code>nodes</code></em></code>:</span></p></td>
289 <td><p>
290 Structure containing discovered targets (name, tpgt, address, port, iface).
291 </p></td>
292 </tr>
293 <tr>
294 <td><p><span class="term"><code class="literal">OUT i <em class="parameter"><code>nodes_cnt</code></em></code>:</span></p></td>
295 <td><p>
296 The number of found nodes.
297 </p></td>
298 </tr>
299 </tbody>
300 </table></div>
301 <p class="since">Since 2.1.3</p>
302 </div>
303 <hr>
304 <div class="refsect2">
305 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.Login"></a><h3>The Login() method</h3>
306 <pre class="programlisting">
307 Login (IN s name,
308 IN i tpgt,
309 IN s address,
310 IN i port,
311 IN s iface,
312 IN a{sv} options);
313 </pre>
314 <p>
315 Login to the iSCSI node described by the given node properties.
316 </p>
317 <p>
318 If the option <em class="parameter"><code>username</code></em> is provided, then
319 the <em class="parameter"><code>username</code></em> and <em class="parameter"><code>password</code></em>
320 will be used for CHAP authentication.
321 </p>
322 <p>
323 If the option <em class="parameter"><code>reverse-username</code></em> is provided,
324 the the <em class="parameter"><code>reverse-username</code></em> and
325 <em class="parameter"><code>reverse-password</code></em> will be used for CHAP
326 authentication.
327 </p>
328 <p>
329 Firmware-discovered nodes retain their authentication info unless
330 overriden with specified credentials (see above).
331 </p>
332 <p>
333 All the additional options are transformed into the interface
334 parameters. For example, if an automatic node startup is desired, the
335 <em class="parameter"><code>node.startup</code></em> needs to be set to
336 '<span class="emphasis"><em>automatic</em></span>' (default value is
337 '<span class="emphasis"><em>manual</em></span>').
338 </p>
339 <div class="variablelist"><table border="0" class="variablelist">
340 <colgroup>
341 <col align="left" valign="top">
342 <col>
343 </colgroup>
344 <tbody>
345 <tr>
346 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
347 <td><p>
348 iSCSI iqn for the node.
349 </p></td>
350 </tr>
351 <tr>
352 <td><p><span class="term"><code class="literal">IN i <em class="parameter"><code>tpgt</code></em></code>:</span></p></td>
353 <td><p>
354 Portal group number.
355 </p></td>
356 </tr>
357 <tr>
358 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>address</code></em></code>:</span></p></td>
359 <td><p>
360 Portal hostname or IP-address.
361 </p></td>
362 </tr>
363 <tr>
364 <td><p><span class="term"><code class="literal">IN i <em class="parameter"><code>port</code></em></code>:</span></p></td>
365 <td><p>
366 Portal port number.
367 </p></td>
368 </tr>
369 <tr>
370 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>iface</code></em></code>:</span></p></td>
371 <td><p>
372 Interface to connect through.
373 </p></td>
374 </tr>
375 <tr>
376 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
377 <td><p>
378 Additional options.
379 </p></td>
380 </tr>
381 </tbody>
382 </table></div>
383 <p class="since">Since 2.1.3</p>
384 </div>
385 <hr>
386 <div class="refsect2">
387 <a name="gdbus-method-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.Logout"></a><h3>The Logout() method</h3>
388 <pre class="programlisting">
389 Logout (IN s name,
390 IN i tpgt,
391 IN s address,
392 IN i port,
393 IN s iface,
394 IN a{sv} options);
395 </pre>
396 <p>
397 Logout of the iSCSI node described by the given node properties.
398 </p>
399 <p>
400 All the additional options are transformed into the interface
401 parameters. For example, if an automatic node startup is not desired,
402 the <em class="parameter"><code>node.startup</code></em> needs to be set to
403 '<span class="emphasis"><em>manual</em></span>'.
404 </p>
405 <div class="variablelist"><table border="0" class="variablelist">
406 <colgroup>
407 <col align="left" valign="top">
408 <col>
409 </colgroup>
410 <tbody>
411 <tr>
412 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
413 <td><p>
414 iSCSI iqn for the node.
415 </p></td>
416 </tr>
417 <tr>
418 <td><p><span class="term"><code class="literal">IN i <em class="parameter"><code>tpgt</code></em></code>:</span></p></td>
419 <td><p>
420 Portal group number.
421 </p></td>
422 </tr>
423 <tr>
424 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>address</code></em></code>:</span></p></td>
425 <td><p>
426 Portal hostname or IP-address.
427 </p></td>
428 </tr>
429 <tr>
430 <td><p><span class="term"><code class="literal">IN i <em class="parameter"><code>port</code></em></code>:</span></p></td>
431 <td><p>
432 Portal port number.
433 </p></td>
434 </tr>
435 <tr>
436 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>iface</code></em></code>:</span></p></td>
437 <td><p>
438 Interface to logout.
439 </p></td>
440 </tr>
441 <tr>
442 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
443 <td><p>
444 Additional options.
445 </p></td>
446 </tr>
447 </tbody>
448 </table></div>
449 <p class="since">Since 2.1.3</p>
450 </div>
451 </div>
452 <div class="refsect1">
453 <a name="gdbus-properties-org.freedesktop.UDisks2.Manager.ISCSI.Initiator"></a><h2>Property Details</h2>
454 <div class="refsect2">
455 <a name="gdbus-property-org-freedesktop-UDisks2-Manager-ISCSI-Initiator.SessionsSupported"></a><h3>The "SessionsSupported" property</h3>
456 <pre class="programlisting">
457 SessionsSupported readable b
458 </pre>
459 <p>
460 Whether or not this version of Udisks
461 </p>
462 <p>
463 supports ISCSI.Session objects.
464 </p>
465 <p class="since">Since 2.0.1</p>
466 </div>
467 </div>
468 </div>
469 <div class="footer">
470 <hr>Generated by GTK-Doc V1.35.1</div>
471 </body>
472 </html>