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
|
<!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.Filesystem: 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="gdbus-org.freedesktop.UDisks2.PartitionTable.html" title="org.freedesktop.UDisks2.PartitionTable">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Swapspace.html" title="org.freedesktop.UDisks2.Swapspace">
<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.Filesystem.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.Filesystem.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="gdbus-org.freedesktop.UDisks2.PartitionTable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Swapspace.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.Filesystem"></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-Filesystem.top_of_page"></a>org.freedesktop.UDisks2.Filesystem</span></h2>
<p>org.freedesktop.UDisks2.Filesystem — Block device containing a mountable filesystem</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.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.SetLabel" title="The SetLabel() method">SetLabel</a> (IN s label,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.SetUUID" title="The SetUUID() method">SetUUID</a> (IN s uuid,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Mount" title="The Mount() method">Mount</a> (IN a{sv} options,
OUT s mount_path);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Unmount" title="The Unmount() method">Unmount</a> (IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Resize" title="The Resize() method">Resize</a> (IN t size,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Check" title="The Check() method">Check</a> (IN a{sv} options,
OUT b consistent);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Repair" title="The Repair() method">Repair</a> (IN a{sv} options,
OUT b repaired);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.TakeOwnership" title="The TakeOwnership() method">TakeOwnership</a> (IN a{sv} options);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.9.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-property-org-freedesktop-UDisks2-Filesystem.MountPoints" title='The "MountPoints" property'>MountPoints</a> readable aay
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-property-org-freedesktop-UDisks2-Filesystem.Size" title='The "Size" property'>Size</a> readable t
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Filesystem"></a><h2>Description</h2>
<p>
This interface is used for <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
devices that contain a mountable filesystem.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Filesystem"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem.SetLabel"></a><h3>The SetLabel() method</h3>
<pre class="programlisting">
SetLabel (IN s label,
IN a{sv} options);
</pre>
<p>
Sets the filesystem label.
</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>label</code></em></code>:</span></p></td>
<td><p>
The label to set.
</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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem.SetUUID"></a><h3>The SetUUID() method</h3>
<pre class="programlisting">
SetUUID (IN s uuid,
IN a{sv} options);
</pre>
<p>
Sets the filesystem UUID value.
</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>uuid</code></em></code>:</span></p></td>
<td><p>
The UUID to set.
</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>
</tbody>
</table></div>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem.Mount"></a><h3>The Mount() method</h3>
<pre class="programlisting">
Mount (IN a{sv} options,
OUT s mount_path);
</pre>
<p>
Mounts the filesystem.
</p>
<p>
The directory the filesystem will be mounted in is determined
by looking at data related to the device or filesystem (such
the filesystem UUID and label) and will be created
automatically except if the device the filesystem resides on
is referenced in the <code class="filename">/etc/fstab</code> file, see
below. In either case, the directory the filesystem is mounted
in, is returned in <em class="parameter"><code>mount_path</code></em> on success - it is usually a
sub-directory of <code class="filename">/run/media/$USER</code> but note that
any directory may be returned.
</p>
<p>
The filesystem type to use can be overridden with the <em class="parameter"><code>fstype</code></em>
option and mount options (a comma-separated string) can be
given in <em class="parameter"><code>options</code></em> option. Note that both the mount options and
filesystem types are validated against a (small) whitelist to
avoid unexpected privilege escalation. The filesystem type is
by default determined by the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdType" title='The "IdType" property'>"IdType"</a>
property. The <em class="parameter"><code>fstype</code></em> option doesn't typically need to be
specified, primarily intended as an override in corner cases.
</p>
<p>
If the <em class="parameter"><code>as-user</code></em> option is set, the
filesystem is mounted on behalf of the specified user instead
of the calling one. This has usually an effect on the returned
<em class="parameter"><code>mount_path</code></em> and it also allows that user to unmount the
filesystem later. This option expects a user name, not a UID.
</p>
<p>
If the device in question is referenced in the
<code class="filename">/etc/fstab</code> file, the
<span class="command"><strong>mount</strong></span> command is called directly (as root)
and the given options or filesystem type given in <em class="parameter"><code>options</code></em> are
ignored.
</p>
<p>
If <code class="literal">x-udisks-auth</code> is specified as an option
for the device in the <code class="filename">/etc/fstab</code> file,
then the <span class="command"><strong>mount</strong></span> command is run as the
calling user, without performing any authorization check
mentioned above. If this fails because of insufficient
permissions, an authorization check is performed (which
typically results in the user having to authenticate as an
administrator). If authorized, the <span class="command"><strong>mount</strong></span>
command is then run as root.
</p>
<p>
The filesystem should be unmounted using the
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Unmount" title="The Unmount() method">Unmount()</a> method.
</p>
<p>
If the device is removed without being unmounted (e.g. the
user yanking the device or pulling the media out) or unmounted
in a way that bypasses the
<a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Unmount" title="The Unmount() method">Unmount()</a> method
(e.g. unmounted by the super-user by using the
<span class="citerefentry"><span class="refentrytitle">umount</span>(8)</span>
command directly), the device will be unmounted (if needed)
and/or the mount point will be cleaned up.
</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 - 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>fstype</code></em> (of type 's'), <em class="parameter"><code>as-user</code></em> (of type 's') and <em class="parameter"><code>options</code></em> (of type 's').
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT s <em class="parameter"><code>mount_path</code></em></code>:</span></p></td>
<td><p>
The filesystem path where the device was mounted.
</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem.Unmount"></a><h3>The Unmount() method</h3>
<pre class="programlisting">
Unmount (IN a{sv} options);
</pre>
<p>
Unmount a mounted device.
</p>
<p>
If the device in question was mounted by the calling user
via the <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.html#gdbus-method-org-freedesktop-UDisks2-Filesystem.Mount" title="The Mount() method">Mount()</a> method the
filesystem is unmounted without any authorization checks.
Otherwise, an authorization check is performed (which
typically results in the user having to authenticate as an
administrator). If authorized, the filesystem is unmounted.
</p>
<p>
If the mountpoint was previously created by udisks it is
guaranteed it will be removed upon returning from this method
call.
</p>
<p>
If the filesystem is busy, this operation fails with the error
<a class="link" href="udisks2-UDisksError.html#UDISKS-ERROR-DEVICE-BUSY:CAPS"><code class="constant">org.freedesktop.UDisks2.Error.DeviceBusy</code></a>
unless the <em class="parameter"><code>force</code></em> option is used.
</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 - 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>force</code></em> (of type 'b').
</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem.Resize"></a><h3>The Resize() method</h3>
<pre class="programlisting">
Resize (IN t size,
IN a{sv} options);
</pre>
<p>
Resizes the filesystem.
</p>
<p>
Shrinking operations need to move data which causes this action to be
slow. The filesystem-resize job for the object might expose progress.
</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 t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>
The target size in bytes, 0 for maximum.
</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>
</tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Filesystem.Check"></a><h3>The Check() method</h3>
<pre class="programlisting">
Check (IN a{sv} options,
OUT b consistent);
</pre>
<p>
Checks the filesystem for consistency avoiding any modifications or repairs.
</p>
<p>
Mounted or unsupported filesystems will 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 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 b <em class="parameter"><code>consistent</code></em></code>:</span></p></td>
<td><p>
Whether the filesystem is undamaged.
</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-Filesystem.Repair"></a><h3>The Repair() method</h3>
<pre class="programlisting">
Repair (IN a{sv} options,
OUT b repaired);
</pre>
<p>
Tries to repair the filesystem.
</p>
<p>
Mounted or unsupported filesystems will 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 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 b <em class="parameter"><code>repaired</code></em></code>:</span></p></td>
<td><p>
Whether the filesystem could be successfully repaired.
</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-Filesystem.TakeOwnership"></a><h3>The TakeOwnership() method</h3>
<pre class="programlisting">
TakeOwnership (IN a{sv} options);
</pre>
<p>
Changes ownership of the filesystem to the UID and GID of the calling
user.
</p>
<p>
Filesystems that don't support ownership 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 a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>recursive</code></em> (of type 'b').
</p></td>
</tr></tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Filesystem"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Filesystem.MountPoints"></a><h3>The "MountPoints" property</h3>
<pre class="programlisting">
MountPoints readable aay
</pre>
<p>
An array of filesystems paths for where the file system on
the device is mounted. If the device is not mounted, this
array is empty.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Filesystem.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size readable t
</pre>
<p>
The size of the filesystem. This is the amount of
</p>
<p>
bytes used on the block device representing an outer filesystem
boundary. If this is smaller than org.freedesktop.Udisks2.Block.Size,
then the filesystem can be made larger with Resize.
</p>
<p>
If the size is unknown, the property is zero. Currently limited
to xfs and ext filesystems only.
</p>
<p>
Please note that reading value of this property typically causes
some I/O to read the filesystem superblock. Unlike the rest
of the properties this one is set to be retrieved on-demand
and is not proactively cached by the daemon.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
