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