Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Manager.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: 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="ch03.html" title="D-Bus Interfaces">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.Drive.html" title="org.freedesktop.UDisks2.Drive">
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.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.Manager.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="ch03.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.Drive.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"></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.top_of_page"></a>org.freedesktop.UDisks2.Manager</span></h2>
31 <p>org.freedesktop.UDisks2.Manager — 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.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanFormat" title="The CanFormat() method">CanFormat</a> (IN s type,
39 OUT (bs) available);
40 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanResize" title="The CanResize() method">CanResize</a> (IN s type,
41 OUT (bts) available);
42 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanCheck" title="The CanCheck() method">CanCheck</a> (IN s type,
43 OUT (bs) available);
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanRepair" title="The CanRepair() method">CanRepair</a> (IN s type,
45 OUT (bs) available);
46 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.LoopSetup" title="The LoopSetup() method">LoopSetup</a> (IN h fd,
47 IN a{sv} options,
48 OUT o resulting_device);
49 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.MDRaidCreate" title="The MDRaidCreate() method">MDRaidCreate</a> (IN ao blocks,
50 IN s level,
51 IN s name,
52 IN t chunk,
53 IN a{sv} options,
54 OUT o resulting_array);
55 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.EnableModules" title="The EnableModules() method">EnableModules</a> (IN b enable);
56 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.EnableModule" title="The EnableModule() method">EnableModule</a> (IN s name,
57 IN b enable);
58 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.GetBlockDevices" title="The GetBlockDevices() method">GetBlockDevices</a> (IN a{sv} options,
59 OUT ao block_objects);
60 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.GetDrives" title="The GetDrives() method">GetDrives</a> (IN a{sv} options,
61 OUT ao drive_objects);
62 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.ResolveDevice" title="The ResolveDevice() method">ResolveDevice</a> (IN a{sv} devspec,
63 IN a{sv} options,
64 OUT ao devices);
65 </pre>
66 </div>
67 <div class="refsect1">
68 <a name="id-1.3.3.2.4"></a><h2>Properties</h2>
69 <pre class="synopsis">
70 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.Version" title='The "Version" property'>Version</a> readable s
71 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.SupportedFilesystems" title='The "SupportedFilesystems" property'>SupportedFilesystems</a> readable as
72 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.SupportedEncryptionTypes" title='The "SupportedEncryptionTypes" property'>SupportedEncryptionTypes</a> readable as
73 <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.DefaultEncryptionType" title='The "DefaultEncryptionType" property'>DefaultEncryptionType</a> readable s
74 </pre>
75 </div>
76 <div class="refsect1">
77 <a name="gdbus-interface-org-freedesktop-UDisks2-Manager"></a><h2>Description</h2>
78 <p>
79 Interface for top-level manager singleton object located at the
80 object path <code class="literal">/org/freedesktop/UDisks2/Manager</code>.
81 </p>
82 </div>
83 <div class="refsect1">
84 <a name="gdbus-methods-org.freedesktop.UDisks2.Manager"></a><h2>Method Details</h2>
85 <div class="refsect2">
86 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanFormat"></a><h3>The CanFormat() method</h3>
87 <pre class="programlisting">
88 CanFormat (IN s type,
89 OUT (bs) available);
90 </pre>
91 <p>
92 Tests for availability to create the given filesystem.
93 See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.SupportedFilesystems" title='The "SupportedFilesystems" property'>"SupportedFilesystems"</a> property
94 for a list of known types. Unknown or unsupported filesystems result in an error.
95 </p>
96 <div class="variablelist"><table border="0" class="variablelist">
97 <colgroup>
98 <col align="left" valign="top">
99 <col>
100 </colgroup>
101 <tbody>
102 <tr>
103 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
104 <td><p>
105 The filesystem type to be tested for formatting availability.
106 </p></td>
107 </tr>
108 <tr>
109 <td><p><span class="term"><code class="literal">OUT (bs) <em class="parameter"><code>available</code></em></code>:</span></p></td>
110 <td><p>
111 Formatting availability and the required binary name if missing (i.e. no error and returns FALSE).
112 </p></td>
113 </tr>
114 </tbody>
115 </table></div>
116 <p class="since">Since 2.7.2</p>
117 </div>
118 <hr>
119 <div class="refsect2">
120 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanResize"></a><h3>The CanResize() method</h3>
121 <pre class="programlisting">
122 CanResize (IN s type,
123 OUT (bts) available);
124 </pre>
125 <p>
126 Tests for availability to resize the given filesystem.
127 The mode flags indicate if growing and/or shriking resize is available if mounted/unmounted.
128 The mode corresponds to bitwise-OR combined BDFSResizeFlags of the libblockdev FS plugin:
129 BD_FS_OFFLINE_SHRINK = 2, shrinking resize allowed when unmounted
130 BD_FS_OFFLINE_GROW = 4, growing resize allowed when unmounted
131 BD_FS_ONLINE_SHRINK = 8, shrinking resize allowed when mounted
132 BD_FS_ONLINE_GROW = 16, growing resize allowed when mounted
133 Unknown filesystems or filesystems which do not support resizing result in errors.
134 </p>
135 <div class="variablelist"><table border="0" class="variablelist">
136 <colgroup>
137 <col align="left" valign="top">
138 <col>
139 </colgroup>
140 <tbody>
141 <tr>
142 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
143 <td><p>
144 The filesystem type to be tested for resize availability.
145 </p></td>
146 </tr>
147 <tr>
148 <td><p><span class="term"><code class="literal">OUT (bts) <em class="parameter"><code>available</code></em></code>:</span></p></td>
149 <td><p>
150 Resizing availability, flags for allowed resizing (i.e. growing/shrinking support for online/offline) and the required binary name if missing (i.e. no error and returns FALSE).
151 </p></td>
152 </tr>
153 </tbody>
154 </table></div>
155 <p class="since">Since 2.7.2</p>
156 </div>
157 <hr>
158 <div class="refsect2">
159 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanCheck"></a><h3>The CanCheck() method</h3>
160 <pre class="programlisting">
161 CanCheck (IN s type,
162 OUT (bs) available);
163 </pre>
164 <p>
165 Tests for availability to check the given filesystem.
166 Unsupported filesystems or filesystems which do not support checking result in errors.
167 </p>
168 <div class="variablelist"><table border="0" class="variablelist">
169 <colgroup>
170 <col align="left" valign="top">
171 <col>
172 </colgroup>
173 <tbody>
174 <tr>
175 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
176 <td><p>
177 The filesystem type to be tested for consistency check availability.
178 </p></td>
179 </tr>
180 <tr>
181 <td><p><span class="term"><code class="literal">OUT (bs) <em class="parameter"><code>available</code></em></code>:</span></p></td>
182 <td><p>
183 Checking availability and the required binary name if missing (i.e. no error and returns FALSE).
184 </p></td>
185 </tr>
186 </tbody>
187 </table></div>
188 <p class="since">Since 2.7.2</p>
189 </div>
190 <hr>
191 <div class="refsect2">
192 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanRepair"></a><h3>The CanRepair() method</h3>
193 <pre class="programlisting">
194 CanRepair (IN s type,
195 OUT (bs) available);
196 </pre>
197 <p>
198 Tests for availability repair the given filesystem.
199 Unsupported filesystems or filesystems which do not support repairing result in errors.
200 </p>
201 <div class="variablelist"><table border="0" class="variablelist">
202 <colgroup>
203 <col align="left" valign="top">
204 <col>
205 </colgroup>
206 <tbody>
207 <tr>
208 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
209 <td><p>
210 The filesystem type to be tested for repair availability.
211 </p></td>
212 </tr>
213 <tr>
214 <td><p><span class="term"><code class="literal">OUT (bs) <em class="parameter"><code>available</code></em></code>:</span></p></td>
215 <td><p>
216 Repair availability and the required binary name if missing (i.e. no error and returns FALSE).
217 </p></td>
218 </tr>
219 </tbody>
220 </table></div>
221 <p class="since">Since 2.7.2</p>
222 </div>
223 <hr>
224 <div class="refsect2">
225 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.LoopSetup"></a><h3>The LoopSetup() method</h3>
226 <pre class="programlisting">
227 LoopSetup (IN h fd,
228 IN a{sv} options,
229 OUT o resulting_device);
230 </pre>
231 <p>
232 Creates a block device for the file represented by <em class="parameter"><code>fd</code></em>.
233 </p>
234 <div class="variablelist"><table border="0" class="variablelist">
235 <colgroup>
236 <col align="left" valign="top">
237 <col>
238 </colgroup>
239 <tbody>
240 <tr>
241 <td><p><span class="term"><code class="literal">IN h <em class="parameter"><code>fd</code></em></code>:</span></p></td>
242 <td><p>
243 An index for the file descriptor to use.
244 </p></td>
245 </tr>
246 <tr>
247 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
248 <td><p>
249 Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>offset</code></em> (of type 't'), <em class="parameter"><code>size</code></em> (of type 't'), <em class="parameter"><code>read-only</code></em> (of type 'b'), <em class="parameter"><code>no-part-scan</code></em> (of type 'b') and <em class="parameter"><code>sector-size</code></em> (of type 't').
250 </p></td>
251 </tr>
252 <tr>
253 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>resulting_device</code></em></code>:</span></p></td>
254 <td><p>
255 An object path to the object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface.
256 </p></td>
257 </tr>
258 </tbody>
259 </table></div>
260 </div>
261 <hr>
262 <div class="refsect2">
263 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.MDRaidCreate"></a><h3>The MDRaidCreate() method</h3>
264 <pre class="programlisting">
265 MDRaidCreate (IN ao blocks,
266 IN s level,
267 IN s name,
268 IN t chunk,
269 IN a{sv} options,
270 OUT o resulting_array);
271 </pre>
272 <p>
273 Creates a new RAID array on the block devices specified by
274 <em class="parameter"><code>blocks</code></em>. Each element in this array must be an object path to
275 an object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
276 interface.
277 </p>
278 <p>
279 Known and supported values for <em class="parameter"><code>level</code></em> include
280 <span class="quote">“<span class="quote">raid0</span>”</span>, <span class="quote">“<span class="quote">raid1</span>”</span>,
281 <span class="quote">“<span class="quote">raid4</span>”</span>, <span class="quote">“<span class="quote">raid5</span>”</span>,
282 <span class="quote">“<span class="quote">raid6</span>”</span> and <span class="quote">“<span class="quote">raid10</span>”</span>.
283 </p>
284 <p>
285 Before the array is created, all devices in <em class="parameter"><code>blocks</code></em> are
286 erased. Once created (but before the method returns), the RAID
287 array will be erased.
288 </p>
289 <p>
290 The <em class="parameter"><code>bitmap</code></em> option specifies the write-intent bitmap type, currently
291 only 'none' and 'internal' values are supported. When this option
292 is not present, it is up to <code class="literal">mdadm</code> to decide
293 whether to create an internal bitmap (typically for arrays larger
294 than 100 GB) or not.
295 </p>
296 <p>
297 The <em class="parameter"><code>version</code></em> option specifies the MD metadata version, for example
298 '0.90'. If not specified the default medata version specified by
299 <code class="literal">mdadm</code> is used. (since 2.11)
300 </p>
301 <div class="variablelist"><table border="0" class="variablelist">
302 <colgroup>
303 <col align="left" valign="top">
304 <col>
305 </colgroup>
306 <tbody>
307 <tr>
308 <td><p><span class="term"><code class="literal">IN ao <em class="parameter"><code>blocks</code></em></code>:</span></p></td>
309 <td><p>
310 An array of object paths to objects implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface.
311 </p></td>
312 </tr>
313 <tr>
314 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>level</code></em></code>:</span></p></td>
315 <td><p>
316 The RAID level for the array.
317 </p></td>
318 </tr>
319 <tr>
320 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
321 <td><p>
322 The name for the array.
323 </p></td>
324 </tr>
325 <tr>
326 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>chunk</code></em></code>:</span></p></td>
327 <td><p>
328 The chunk size (in bytes) or 0 if <em class="parameter"><code>level</code></em> is <span class="quote">“<span class="quote">raid1</span>”</span>.
329 </p></td>
330 </tr>
331 <tr>
332 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
333 <td><p>
334 Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) include <em class="parameter"><code>bitmap</code></em> (of type 'ay') and <em class="parameter"><code>version</code></em> (of type 'ay').
335 </p></td>
336 </tr>
337 <tr>
338 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>resulting_array</code></em></code>:</span></p></td>
339 <td><p>
340 An object path to the object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</a> interface.
341 </p></td>
342 </tr>
343 </tbody>
344 </table></div>
345 <p class="since">Since 2.0.0</p>
346 </div>
347 <hr>
348 <div class="refsect2">
349 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.EnableModules"></a><h3>The EnableModules() method</h3>
350 <pre class="programlisting">
351 EnableModules (IN b enable);
352 </pre>
353 <p>
354 Loads and activates modules. Modules that have been already loaded are not reinitialized on subsequent calls to this method and are skipped.
355 In case any new module is getting activated by this method call a <code class="literal">add</code> uevent is triggered on all exported objects.
356 </p>
357 <p>
358 This takes in account an optional explicit list of modules to load as specified in the <code class="filename">/etc/udisks2/udisks2.conf</code>
359 config file. If unspecified all available modules will be loaded.
360 </p>
361 <p>
362 Modules cannot be deactivated at the moment. This method call never fails even if no module has been activated
363 and by nature it cannot report any particular module initialization failures. Clients have no way of finding that
364 a particular module is available.
365 </p>
366 <p>
367 </p>
368 <div class="note">
369 <span class="emphasis"><em>This method is deprecated since 2.9.0.</em></span>
370 Use <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.EnableModule" title="The EnableModule() method">EnableModule()</a> instead.
371 </div>
372 <p>
373 </p>
374 <div class="variablelist"><table border="0" class="variablelist">
375 <colgroup>
376 <col align="left" valign="top">
377 <col>
378 </colgroup>
379 <tbody><tr>
380 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>enable</code></em></code>:</span></p></td>
381 <td><p>
382 A boolean value indicating whether modules should be enabled. Currently only the <code class="constant">TRUE</code> value is permitted.
383 </p></td>
384 </tr></tbody>
385 </table></div>
386 <div class="warning"><p>The EnableModules() method is deprecated.</p></div>
387 </div>
388 <hr>
389 <div class="refsect2">
390 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.EnableModule"></a><h3>The EnableModule() method</h3>
391 <pre class="programlisting">
392 EnableModule (IN s name,
393 IN b enable);
394 </pre>
395 <p>
396 Loads and activates single module identified by <em class="parameter"><code>name</code></em>. In case the module is already active no reinitialization
397 is done and this call has no effect. Clients are supposed to call this method before using any of the particular module API.
398 In case no such module is available or its initialization fails a proper error is returned. This action also causes
399 all objects to receive <code class="literal">add</code> uevent that allows the module to attach extra interfaces before
400 this method call returns.
401 </p>
402 <p>
403 Modules cannot be deactivated at the moment.
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 Name of the module.
415 </p></td>
416 </tr>
417 <tr>
418 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>enable</code></em></code>:</span></p></td>
419 <td><p>
420 A boolean value indicating whether modules should be enabled. Currently only the <code class="constant">TRUE</code> value is permitted.
421 </p></td>
422 </tr>
423 </tbody>
424 </table></div>
425 <p class="since">Since 2.9.0</p>
426 </div>
427 <hr>
428 <div class="refsect2">
429 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.GetBlockDevices"></a><h3>The GetBlockDevices() method</h3>
430 <pre class="programlisting">
431 GetBlockDevices (IN a{sv} options,
432 OUT ao block_objects);
433 </pre>
434 <p>
435 Get list of all block devices (object paths of objects implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface) known to UDisks.
436 </p>
437 <div class="variablelist"><table border="0" class="variablelist">
438 <colgroup>
439 <col align="left" valign="top">
440 <col>
441 </colgroup>
442 <tbody>
443 <tr>
444 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
445 <td><p>
446 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
447 </p></td>
448 </tr>
449 <tr>
450 <td><p><span class="term"><code class="literal">OUT ao <em class="parameter"><code>block_objects</code></em></code>:</span></p></td>
451 <td>
452 <p>
453 </p>
454 <p>
455 </p>
456 </td>
457 </tr>
458 </tbody>
459 </table></div>
460 <p class="since">Since 2.7.2</p>
461 </div>
462 <hr>
463 <div class="refsect2">
464 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.GetDrives"></a><h3>The GetDrives() method</h3>
465 <pre class="programlisting">
466 GetDrives (IN a{sv} options,
467 OUT ao drive_objects);
468 </pre>
469 <p>
470 Get list of all drives (object paths of objects implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Drive.html#gdbus-interface-org-freedesktop-UDisks2-Drive.top_of_page">org.freedesktop.UDisks2.Drive</a> interface) known to UDisks.
471 </p>
472 <div class="variablelist"><table border="0" class="variablelist">
473 <colgroup>
474 <col align="left" valign="top">
475 <col>
476 </colgroup>
477 <tbody>
478 <tr>
479 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
480 <td><p>
481 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
482 </p></td>
483 </tr>
484 <tr>
485 <td><p><span class="term"><code class="literal">OUT ao <em class="parameter"><code>drive_objects</code></em></code>:</span></p></td>
486 <td>
487 <p>
488 </p>
489 <p>
490 </p>
491 </td>
492 </tr>
493 </tbody>
494 </table></div>
495 <p class="since">Since 2.11</p>
496 </div>
497 <hr>
498 <div class="refsect2">
499 <a name="gdbus-method-org-freedesktop-UDisks2-Manager.ResolveDevice"></a><h3>The ResolveDevice() method</h3>
500 <pre class="programlisting">
501 ResolveDevice (IN a{sv} devspec,
502 IN a{sv} options,
503 OUT ao devices);
504 </pre>
505 <p>
506 Get device(s) matching specification given in <em class="parameter"><code>devspec</code></em>.
507 </p>
508 <p>
509 Currently supported keys for <em class="parameter"><code>devspec</code></em> include:
510 </p>
511 <div class="variablelist"><table border="0" class="variablelist">
512 <colgroup>
513 <col align="left" valign="top">
514 <col>
515 </colgroup>
516 <tbody>
517 <tr>
518 <td><p><span class="term">path (type <code class="literal">'s'</code>)</span></p></td>
519 <td><p>
520 Device path (e.g. <span class="quote">“<span class="quote">/dev/sda</span>”</span>). This also includes symlinks in <span class="quote">“<span class="quote">/dev</span>”</span>
521 (both <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>"Device"</a> and <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Symlinks" title='The "Symlinks" property'>"Symlinks"</a> are used).
522 </p></td>
523 </tr>
524 <tr>
525 <td><p><span class="term">label (type <code class="literal">'s'</code>)</span></p></td>
526 <td><p>
527 Filesystem label. <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdLabel" title='The "IdLabel" property'>"IdLabel"</a> is used.
528 </p></td>
529 </tr>
530 <tr>
531 <td><p><span class="term">uuid (type <code class="literal">'s'</code>)</span></p></td>
532 <td><p>
533 Filesystem UUID. <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUUID" title='The "IdUUID" property'>"IdUUID"</a> is used.
534 </p></td>
535 </tr>
536 <tr>
537 <td><p><span class="term">partuuid (type <code class="literal">'s'</code>)</span></p></td>
538 <td><p>
539 Partition UUID. <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.UUID" title='The "UUID" property'>"UUID"</a> is used.
540 </p></td>
541 </tr>
542 <tr>
543 <td><p><span class="term">partlabel (type <code class="literal">'s'</code>)</span></p></td>
544 <td><p>
545 Partition Name. <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Name" title='The "Name" property'>"Name"</a> is used.
546 </p></td>
547 </tr>
548 </tbody>
549 </table></div>
550 <p>
551 </p>
552 <p>
553 It is possible to specify multiple keys. In this case, only devices matching all values will be returned.
554 </p>
555 <div class="variablelist"><table border="0" class="variablelist">
556 <colgroup>
557 <col align="left" valign="top">
558 <col>
559 </colgroup>
560 <tbody>
561 <tr>
562 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>devspec</code></em></code>:</span></p></td>
563 <td><p>
564 Dictionary with specification of a device.
565 </p></td>
566 </tr>
567 <tr>
568 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
569 <td><p>
570 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
571 </p></td>
572 </tr>
573 <tr>
574 <td><p><span class="term"><code class="literal">OUT ao <em class="parameter"><code>devices</code></em></code>:</span></p></td>
575 <td><p>
576 List of object paths of all devices matching <em class="parameter"><code>devspec</code></em>.
577 </p></td>
578 </tr>
579 </tbody>
580 </table></div>
581 <p class="since">Since 2.7.3</p>
582 </div>
583 </div>
584 <div class="refsect1">
585 <a name="gdbus-properties-org.freedesktop.UDisks2.Manager"></a><h2>Property Details</h2>
586 <div class="refsect2">
587 <a name="gdbus-property-org-freedesktop-UDisks2-Manager.Version"></a><h3>The "Version" property</h3>
588 <pre class="programlisting">
589 Version readable s
590 </pre>
591 <p>
592 The version of the daemon currently running
593 </p>
594 </div>
595 <hr>
596 <div class="refsect2">
597 <a name="gdbus-property-org-freedesktop-UDisks2-Manager.SupportedFilesystems"></a><h3>The "SupportedFilesystems" property</h3>
598 <pre class="programlisting">
599 SupportedFilesystems readable as
600 </pre>
601 <p>
602 List of filesystems supported by UDisks2. For each such filesystem
603 UDisks supports filesystem creation (<span class="quote">“<span class="quote">mkfs</span>”</span>) and
604 changing labels.
605 </p>
606 <p>
607 While UDisks2 can essentially mount any filesystem, only the listed
608 types are fully supported for block operations.
609 </p>
610 </div>
611 <hr>
612 <div class="refsect2">
613 <a name="gdbus-property-org-freedesktop-UDisks2-Manager.SupportedEncryptionTypes"></a><h3>The "SupportedEncryptionTypes" property</h3>
614 <pre class="programlisting">
615 SupportedEncryptionTypes readable as
616 </pre>
617 <p>
618 List of supported block encryption types by UDisks2.
619 </p>
620 <p class="since">Since 2.8.3</p>
621 </div>
622 <hr>
623 <div class="refsect2">
624 <a name="gdbus-property-org-freedesktop-UDisks2-Manager.DefaultEncryptionType"></a><h3>The "DefaultEncryptionType" property</h3>
625 <pre class="programlisting">
626 DefaultEncryptionType readable s
627 </pre>
628 <p>
629 The default block encryption type.
630 </p>
631 <p class="since">Since 2.8.3</p>
632 </div>
633 </div>
634 </div>
635 <div class="footer">
636 <hr>Generated by GTK-Doc V1.35.1</div>
637 </body>
638 </html>