Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.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.Filesystem.BTRFS: 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.Manager.BTRFS.html" title="org.freedesktop.UDisks2.Manager.BTRFS">
10 <link rel="next" href="ref-library.html" title="Part III. Library API Reference">
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.Filesystem.BTRFS.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.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.Manager.BTRFS.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="ref-library.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.Filesystem.BTRFS"></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-Filesystem-BTRFS.top_of_page"></a>org.freedesktop.UDisks2.Filesystem.BTRFS</span></h2>
31 <p>org.freedesktop.UDisks2.Filesystem.BTRFS — BTRFS filesystem interface exported on block objects</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.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.AddDevice" title="The AddDevice() method">AddDevice</a> (IN o device,
39 IN a{sv} options);
40 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveDevice" title="The RemoveDevice() method">RemoveDevice</a> (IN o device,
41 IN a{sv} options);
42 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSubvolume" title="The CreateSubvolume() method">CreateSubvolume</a> (IN s name,
43 IN a{sv} options);
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveSubvolume" title="The RemoveSubvolume() method">RemoveSubvolume</a> (IN s name,
45 IN a{sv} options);
46 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.GetSubvolumes" title="The GetSubvolumes() method">GetSubvolumes</a> (IN b snapshots_only,
47 IN a{sv} options,
48 OUT a(tts) subvolumes,
49 OUT i subvolumes_cnt);
50 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSnapshot" title="The CreateSnapshot() method">CreateSnapshot</a> (IN s source,
51 IN s dest,
52 IN b ro,
53 IN a{sv} options);
54 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Repair" title="The Repair() method">Repair</a> (IN a{sv} options);
55 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Resize" title="The Resize() method">Resize</a> (IN t size,
56 IN a{sv} options);
57 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.SetLabel" title="The SetLabel() method">SetLabel</a> (IN s label,
58 IN a{sv} options);
59 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.GetDefaultSubvolumeID" title="The GetDefaultSubvolumeID() method">GetDefaultSubvolumeID</a> (IN a{sv} options,
60 OUT u id);
61 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.SetDefaultSubvolumeID" title="The SetDefaultSubvolumeID() method">SetDefaultSubvolumeID</a> (IN u id,
62 IN a{sv} options);
63 </pre>
64 </div>
65 <div class="refsect1">
66 <a name="id-1.3.3.29.4"></a><h2>Properties</h2>
67 <pre class="synopsis">
68 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.label" title='The "label" property'>label</a> readable s
69 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.uuid" title='The "uuid" property'>uuid</a> readable s
70 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.num_devices" title='The "num_devices" property'>num_devices</a> readable t
71 <a class="link" href="gdbus-org.freedesktop.UDisks2.Filesystem.BTRFS.html#gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.used" title='The "used" property'>used</a> readable t
72 </pre>
73 </div>
74 <div class="refsect1">
75 <a name="gdbus-interface-org-freedesktop-UDisks2-Filesystem-BTRFS"></a><h2>Description</h2>
76 <p>
77 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
78 has been filtered through BTRFS plugin.
79 </p>
80 <p class="since">Since 2.1.3</p>
81 </div>
82 <div class="refsect1">
83 <a name="gdbus-methods-org.freedesktop.UDisks2.Filesystem.BTRFS"></a><h2>Method Details</h2>
84 <div class="refsect2">
85 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.AddDevice"></a><h3>The AddDevice() method</h3>
86 <pre class="programlisting">
87 AddDevice (IN o device,
88 IN a{sv} options);
89 </pre>
90 <p>
91 Adds the <em class="parameter"><code>device</code></em> to the volume.
92 </p>
93 <p>
94 No additional options are currently defined.
95 </p>
96 <p>
97 <span class="emphasis"><em>Changed in version 2.7.0.</em></span>
98 </p>
99 <div class="variablelist"><table border="0" class="variablelist">
100 <colgroup>
101 <col align="left" valign="top">
102 <col>
103 </colgroup>
104 <tbody>
105 <tr>
106 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>device</code></em></code>:</span></p></td>
107 <td><p>
108 Object path of a device to be added to BTRFS volume.
109 </p></td>
110 </tr>
111 <tr>
112 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
113 <td><p>
114 Additional options.
115 </p></td>
116 </tr>
117 </tbody>
118 </table></div>
119 <p class="since">Since 2.3.0</p>
120 </div>
121 <hr>
122 <div class="refsect2">
123 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveDevice"></a><h3>The RemoveDevice() method</h3>
124 <pre class="programlisting">
125 RemoveDevice (IN o device,
126 IN a{sv} options);
127 </pre>
128 <p>
129 Removes the <em class="parameter"><code>device</code></em> from the volume.
130 </p>
131 <p>
132 No additional options are currently defined.
133 </p>
134 <p>
135 <span class="emphasis"><em>Changed in version 2.7.0.</em></span>
136 </p>
137 <div class="variablelist"><table border="0" class="variablelist">
138 <colgroup>
139 <col align="left" valign="top">
140 <col>
141 </colgroup>
142 <tbody>
143 <tr>
144 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>device</code></em></code>:</span></p></td>
145 <td><p>
146 Object path of a device to be removed from BTRFS volume.
147 </p></td>
148 </tr>
149 <tr>
150 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
151 <td><p>
152 Additional options.
153 </p></td>
154 </tr>
155 </tbody>
156 </table></div>
157 <p class="since">Since 2.3.0</p>
158 </div>
159 <hr>
160 <div class="refsect2">
161 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSubvolume"></a><h3>The CreateSubvolume() method</h3>
162 <pre class="programlisting">
163 CreateSubvolume (IN s name,
164 IN a{sv} options);
165 </pre>
166 <p>
167 Creates a new subvolume.
168 </p>
169 <p>
170 No additional options are currently defined.
171 </p>
172 <div class="variablelist"><table border="0" class="variablelist">
173 <colgroup>
174 <col align="left" valign="top">
175 <col>
176 </colgroup>
177 <tbody>
178 <tr>
179 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
180 <td><p>
181 Name of a new subvolume.
182 </p></td>
183 </tr>
184 <tr>
185 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
186 <td><p>
187 Additional options.
188 </p></td>
189 </tr>
190 </tbody>
191 </table></div>
192 <p class="since">Since 2.1.3</p>
193 </div>
194 <hr>
195 <div class="refsect2">
196 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.RemoveSubvolume"></a><h3>The RemoveSubvolume() method</h3>
197 <pre class="programlisting">
198 RemoveSubvolume (IN s name,
199 IN a{sv} options);
200 </pre>
201 <p>
202 Deletes a subvolume.
203 </p>
204 <p>
205 No additional options are currently defined.
206 </p>
207 <div class="variablelist"><table border="0" class="variablelist">
208 <colgroup>
209 <col align="left" valign="top">
210 <col>
211 </colgroup>
212 <tbody>
213 <tr>
214 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
215 <td><p>
216 Name of the subvolume to be deleted.
217 </p></td>
218 </tr>
219 <tr>
220 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
221 <td><p>
222 Additional options.
223 </p></td>
224 </tr>
225 </tbody>
226 </table></div>
227 <p class="since">Since 2.1.3</p>
228 </div>
229 <hr>
230 <div class="refsect2">
231 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.GetSubvolumes"></a><h3>The GetSubvolumes() method</h3>
232 <pre class="programlisting">
233 GetSubvolumes (IN b snapshots_only,
234 IN a{sv} options,
235 OUT a(tts) subvolumes,
236 OUT i subvolumes_cnt);
237 </pre>
238 <p>
239 Returns a list of subvolumes.
240 </p>
241 <p>
242 No additional options are currently defined.
243 </p>
244 <div class="variablelist"><table border="0" class="variablelist">
245 <colgroup>
246 <col align="left" valign="top">
247 <col>
248 </colgroup>
249 <tbody>
250 <tr>
251 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>snapshots_only</code></em></code>:</span></p></td>
252 <td><p>
253 True if to list only snapshot subvolumes; False otherwise.
254 </p></td>
255 </tr>
256 <tr>
257 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
258 <td><p>
259 Additional options.
260 </p></td>
261 </tr>
262 <tr>
263 <td><p><span class="term"><code class="literal">OUT a(tts) <em class="parameter"><code>subvolumes</code></em></code>:</span></p></td>
264 <td><p>
265 Structure containing subvolume id, parent_id and path.
266 </p></td>
267 </tr>
268 <tr>
269 <td><p><span class="term"><code class="literal">OUT i <em class="parameter"><code>subvolumes_cnt</code></em></code>:</span></p></td>
270 <td><p>
271 The number of returned elements.
272 </p></td>
273 </tr>
274 </tbody>
275 </table></div>
276 <p class="since">Since 2.1.3</p>
277 </div>
278 <hr>
279 <div class="refsect2">
280 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.CreateSnapshot"></a><h3>The CreateSnapshot() method</h3>
281 <pre class="programlisting">
282 CreateSnapshot (IN s source,
283 IN s dest,
284 IN b ro,
285 IN a{sv} options);
286 </pre>
287 <p>
288 Creates a snapshot.
289 </p>
290 <p>
291 No additional options are currently defined.
292 </p>
293 <div class="variablelist"><table border="0" class="variablelist">
294 <colgroup>
295 <col align="left" valign="top">
296 <col>
297 </colgroup>
298 <tbody>
299 <tr>
300 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>source</code></em></code>:</span></p></td>
301 <td><p>
302 Name of the source subvolume.
303 </p></td>
304 </tr>
305 <tr>
306 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>dest</code></em></code>:</span></p></td>
307 <td><p>
308 Name for the new snapshot volume.
309 </p></td>
310 </tr>
311 <tr>
312 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>ro</code></em></code>:</span></p></td>
313 <td><p>
314 True if the snapshot should be read-only; False otherwise.
315 </p></td>
316 </tr>
317 <tr>
318 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
319 <td><p>
320 Additional options.
321 </p></td>
322 </tr>
323 </tbody>
324 </table></div>
325 <p class="since">Since 2.1.3</p>
326 </div>
327 <hr>
328 <div class="refsect2">
329 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Repair"></a><h3>The Repair() method</h3>
330 <pre class="programlisting">
331 Repair (IN a{sv} options);
332 </pre>
333 <p>
334 Checks and repairs btrfs volume.
335 </p>
336 <p>
337 No additional options are currently defined.
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><tr>
345 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
346 <td><p>
347 Additional options.
348 </p></td>
349 </tr></tbody>
350 </table></div>
351 <p class="since">Since 2.3.0</p>
352 </div>
353 <hr>
354 <div class="refsect2">
355 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.Resize"></a><h3>The Resize() method</h3>
356 <pre class="programlisting">
357 Resize (IN t size,
358 IN a{sv} options);
359 </pre>
360 <p>
361 Resizes the volume.
362 </p>
363 <p>
364 No additional options are currently defined.
365 </p>
366 <div class="variablelist"><table border="0" class="variablelist">
367 <colgroup>
368 <col align="left" valign="top">
369 <col>
370 </colgroup>
371 <tbody>
372 <tr>
373 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
374 <td><p>
375 Requested new size in Bytes.
376 </p></td>
377 </tr>
378 <tr>
379 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
380 <td><p>
381 Additional options.
382 </p></td>
383 </tr>
384 </tbody>
385 </table></div>
386 <p class="since">Since 2.3.0</p>
387 </div>
388 <hr>
389 <div class="refsect2">
390 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.SetLabel"></a><h3>The SetLabel() method</h3>
391 <pre class="programlisting">
392 SetLabel (IN s label,
393 IN a{sv} options);
394 </pre>
395 <p>
396 Sets a new label for the given volume.
397 </p>
398 <p>
399 No additional options are currently defined.
400 </p>
401 <div class="variablelist"><table border="0" class="variablelist">
402 <colgroup>
403 <col align="left" valign="top">
404 <col>
405 </colgroup>
406 <tbody>
407 <tr>
408 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>label</code></em></code>:</span></p></td>
409 <td><p>
410 New label.
411 </p></td>
412 </tr>
413 <tr>
414 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
415 <td><p>
416 Additional options.
417 </p></td>
418 </tr>
419 </tbody>
420 </table></div>
421 <p class="since">Since 2.1.3</p>
422 </div>
423 <hr>
424 <div class="refsect2">
425 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.GetDefaultSubvolumeID"></a><h3>The GetDefaultSubvolumeID() method</h3>
426 <pre class="programlisting">
427 GetDefaultSubvolumeID (IN a{sv} options,
428 OUT u id);
429 </pre>
430 <p>
431 Returns the default subvolume id.
432 </p>
433 <p>
434 No additional options are currently defined.
435 </p>
436 <div class="variablelist"><table border="0" class="variablelist">
437 <colgroup>
438 <col align="left" valign="top">
439 <col>
440 </colgroup>
441 <tbody>
442 <tr>
443 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
444 <td><p>
445 Additional options.
446 </p></td>
447 </tr>
448 <tr>
449 <td><p><span class="term"><code class="literal">OUT u <em class="parameter"><code>id</code></em></code>:</span></p></td>
450 <td>
451 <p>
452 </p>
453 <p>
454 </p>
455 </td>
456 </tr>
457 </tbody>
458 </table></div>
459 <p class="since">Since 2.11.0</p>
460 </div>
461 <hr>
462 <div class="refsect2">
463 <a name="gdbus-method-org-freedesktop-UDisks2-Filesystem-BTRFS.SetDefaultSubvolumeID"></a><h3>The SetDefaultSubvolumeID() method</h3>
464 <pre class="programlisting">
465 SetDefaultSubvolumeID (IN u id,
466 IN a{sv} options);
467 </pre>
468 <p>
469 Sets the default subvolume id.
470 </p>
471 <p>
472 No additional options are currently defined.
473 </p>
474 <div class="variablelist"><table border="0" class="variablelist">
475 <colgroup>
476 <col align="left" valign="top">
477 <col>
478 </colgroup>
479 <tbody>
480 <tr>
481 <td><p><span class="term"><code class="literal">IN u <em class="parameter"><code>id</code></em></code>:</span></p></td>
482 <td><p>
483 New default subvolume id.
484 </p></td>
485 </tr>
486 <tr>
487 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
488 <td><p>
489 Additional options.
490 </p></td>
491 </tr>
492 </tbody>
493 </table></div>
494 <p class="since">Since 2.11.0</p>
495 </div>
496 </div>
497 <div class="refsect1">
498 <a name="gdbus-properties-org.freedesktop.UDisks2.Filesystem.BTRFS"></a><h2>Property Details</h2>
499 <div class="refsect2">
500 <a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.label"></a><h3>The "label" property</h3>
501 <pre class="programlisting">
502 label readable s
503 </pre>
504 <p>
505 </p>
506 <p>
507 </p>
508 <p class="since">Since 2.1.3</p>
509 </div>
510 <hr>
511 <div class="refsect2">
512 <a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.uuid"></a><h3>The "uuid" property</h3>
513 <pre class="programlisting">
514 uuid readable s
515 </pre>
516 <p>
517 </p>
518 <p>
519 </p>
520 <p class="since">Since 2.1.3</p>
521 </div>
522 <hr>
523 <div class="refsect2">
524 <a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.num_devices"></a><h3>The "num_devices" property</h3>
525 <pre class="programlisting">
526 num_devices readable t
527 </pre>
528 <p>
529 </p>
530 <p>
531 </p>
532 <p class="since">Since 2.1.3</p>
533 </div>
534 <hr>
535 <div class="refsect2">
536 <a name="gdbus-property-org-freedesktop-UDisks2-Filesystem-BTRFS.used"></a><h3>The "used" property</h3>
537 <pre class="programlisting">
538 used readable t
539 </pre>
540 <p>
541 </p>
542 <p>
543 </p>
544 <p class="since">Since 2.1.3</p>
545 </div>
546 </div>
547 </div>
548 <div class="footer">
549 <hr>Generated by GTK-Doc V1.35.1</div>
550 </body>
551 </html>