Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.VolumeGroup.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.VolumeGroup: 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.PhysicalVolume.html" title="org.freedesktop.UDisks2.PhysicalVolume">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.ISCSI.Session.html" title="org.freedesktop.UDisks2.ISCSI.Session">
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.VolumeGroup.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.VolumeGroup.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.PhysicalVolume.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.ISCSI.Session.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.VolumeGroup"></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-VolumeGroup.top_of_page"></a>org.freedesktop.UDisks2.VolumeGroup</span></h2>
31 <p>org.freedesktop.UDisks2.VolumeGroup — A volume group</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.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Poll" title="The Poll() method">Poll</a> ();
39 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Delete" title="The Delete() method">Delete</a> (IN b wipe,
40 IN a{sv} options);
41 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Rename" title="The Rename() method">Rename</a> (IN s new_name,
42 IN a{sv} options,
43 OUT o result);
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.AddDevice" title="The AddDevice() method">AddDevice</a> (IN o block,
45 IN a{sv} options);
46 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.EmptyDevice" title="The EmptyDevice() method">EmptyDevice</a> (IN o block,
47 IN a{sv} options);
48 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.RemoveDevice" title="The RemoveDevice() method">RemoveDevice</a> (IN o block,
49 IN b wipe,
50 IN a{sv} options);
51 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.RemoveMissingPhysicalVolumes" title="The RemoveMissingPhysicalVolumes() method">RemoveMissingPhysicalVolumes</a> (IN a{sv} options);
52 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreatePlainVolume" title="The CreatePlainVolume() method">CreatePlainVolume</a> (IN s name,
53 IN t size,
54 IN a{sv} options,
55 OUT o result);
56 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreatePlainVolumeWithLayout" title="The CreatePlainVolumeWithLayout() method">CreatePlainVolumeWithLayout</a> (IN s name,
57 IN t size,
58 IN s layout,
59 IN ao pvs,
60 IN a{sv} options,
61 OUT o result);
62 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateThinPoolVolume" title="The CreateThinPoolVolume() method">CreateThinPoolVolume</a> (IN s name,
63 IN t size,
64 IN a{sv} options,
65 OUT o result);
66 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateThinVolume" title="The CreateThinVolume() method">CreateThinVolume</a> (IN s name,
67 IN t size,
68 IN o pool,
69 IN a{sv} options,
70 OUT o result);
71 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume" title="The CreateVDOVolume() method">CreateVDOVolume</a> (IN s lv_name,
72 IN s pool_name,
73 IN t data_size,
74 IN t virtual_size,
75 IN t index_memory,
76 IN b compression,
77 IN b deduplication,
78 IN s write_policy,
79 IN a{sv} options,
80 OUT o result);
81 </pre>
82 </div>
83 <div class="refsect1">
84 <a name="id-1.3.3.25.4"></a><h2>Properties</h2>
85 <pre class="synopsis">
86 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.Name" title='The "Name" property'>Name</a> readable s
87 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.UUID" title='The "UUID" property'>UUID</a> readable s
88 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.Size" title='The "Size" property'>Size</a> readable t
89 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.FreeSize" title='The "FreeSize" property'>FreeSize</a> readable t
90 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.ExtentSize" title='The "ExtentSize" property'>ExtentSize</a> readable t
91 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.NeedsPolling" title='The "NeedsPolling" property'>NeedsPolling</a> readable b
92 <a class="link" href="gdbus-org.freedesktop.UDisks2.VolumeGroup.html#gdbus-property-org-freedesktop-UDisks2-VolumeGroup.MissingPhysicalVolumes" title='The "MissingPhysicalVolumes" property'>MissingPhysicalVolumes</a> readable as
93 </pre>
94 </div>
95 <div class="refsect1">
96 <a name="gdbus-interface-org-freedesktop-UDisks2-VolumeGroup"></a><h2>Description</h2>
97 <p>
98 Objects implementing this interface represent LVM2 volume
99 groups. They appear under /org/freedesktop/UDisks2/lvm/.
100 </p>
101 <p>
102 The logical volume objects of a volume group are the children of
103 the volume group objects in the D-Bus object hierarchy. See the
104 <a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-interface-org-freedesktop-UDisks2-LogicalVolume.top_of_page">org.freedesktop.UDisks2.LogicalVolume</a> interface.
105 </p>
106 <p>
107 The physical volume objects of a volume group can be found by
108 looking for block devices with a
109 <a class="link" href="gdbus-org.freedesktop.UDisks2.PhysicalVolume.html#gdbus-interface-org-freedesktop-UDisks2-PhysicalVolume.top_of_page">org.freedesktop.UDisks2.PhysicalVolume</a>.VolumeGroup property
110 that points to the volume group object.
111 </p>
112 <p class="since">Since 2.0.0</p>
113 </div>
114 <div class="refsect1">
115 <a name="gdbus-methods-org.freedesktop.UDisks2.VolumeGroup"></a><h2>Method Details</h2>
116 <div class="refsect2">
117 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Poll"></a><h3>The Poll() method</h3>
118 <pre class="programlisting">
119 Poll ();
120 </pre>
121 <p>
122 Make sure that all properties of this volume group and of all
123 their logical and physical volumes are up-to-date.
124 </p>
125 <p>
126 The properties are not guaranteed to be up-to-date yet when
127 this method returns.
128 </p>
129 <p class="since">Since 2.0.0</p>
130 </div>
131 <hr>
132 <div class="refsect2">
133 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Delete"></a><h3>The Delete() method</h3>
134 <pre class="programlisting">
135 Delete (IN b wipe,
136 IN a{sv} options);
137 </pre>
138 <p>
139 </p>
140 <p>
141 <em class="parameter"><code>wipe</code></em>: Whether to wipe the volume group.
142 <em class="parameter"><code>options</code></em>: Additional options.
143 </p>
144 <p>
145 Delete this volume group. All its logical volumes will be
146 deleted, too.
147 </p>
148 <p>
149 If the option <em class="parameter"><code>tear-down</code></em> is set to
150 <code class="constant">TRUE</code>, then all logical volumes will be cleaned up before
151 deletion. This cleanup consists of removing entries from
152 /etc/fstab and /etc/crypttab, and locking of encrypted block
153 devices. Entries in /etc/fstab and /etc/crypttab that have
154 been created with the 'track-parents' options to
155 AddConfigurationItem will be removed even if their block
156 device is currently unavailable.
157 </p>
158 <div class="variablelist"><table border="0" class="variablelist">
159 <colgroup>
160 <col align="left" valign="top">
161 <col>
162 </colgroup>
163 <tbody>
164 <tr>
165 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>wipe</code></em></code>:</span></p></td>
166 <td>
167 <p>
168 </p>
169 <p>
170 </p>
171 </td>
172 </tr>
173 <tr>
174 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
175 <td>
176 <p>
177 </p>
178 <p>
179 </p>
180 </td>
181 </tr>
182 </tbody>
183 </table></div>
184 <p class="since">Since 2.0.0</p>
185 </div>
186 <hr>
187 <div class="refsect2">
188 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Rename"></a><h3>The Rename() method</h3>
189 <pre class="programlisting">
190 Rename (IN s new_name,
191 IN a{sv} options,
192 OUT o result);
193 </pre>
194 <p>
195 </p>
196 <p>
197 <em class="parameter"><code>new_name</code></em>: The new name.
198 <em class="parameter"><code>options</code></em>: Additional options.
199 <em class="parameter"><code>result</code></em>: The new object path.
200 </p>
201 <p>
202 Rename this volume group. This might cause the volume group
203 object to disappear from D-Bus and reappear with a different
204 path.
205 </p>
206 <p>
207 No additional options are currently defined.
208 </p>
209 <div class="variablelist"><table border="0" class="variablelist">
210 <colgroup>
211 <col align="left" valign="top">
212 <col>
213 </colgroup>
214 <tbody>
215 <tr>
216 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>new_name</code></em></code>:</span></p></td>
217 <td>
218 <p>
219 </p>
220 <p>
221 </p>
222 </td>
223 </tr>
224 <tr>
225 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
226 <td>
227 <p>
228 </p>
229 <p>
230 </p>
231 </td>
232 </tr>
233 <tr>
234 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
235 <td>
236 <p>
237 </p>
238 <p>
239 </p>
240 </td>
241 </tr>
242 </tbody>
243 </table></div>
244 <p class="since">Since 2.0.0</p>
245 </div>
246 <hr>
247 <div class="refsect2">
248 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.AddDevice"></a><h3>The AddDevice() method</h3>
249 <pre class="programlisting">
250 AddDevice (IN o block,
251 IN a{sv} options);
252 </pre>
253 <p>
254 </p>
255 <p>
256 <em class="parameter"><code>block</code></em>: The block device to add, as a UDisks2 object path.
257 <em class="parameter"><code>options</code></em>: Additional options.
258 </p>
259 <p>
260 Add a new physical volume to the volume group. The block
261 device will be wiped and all data on it will be lost.
262 </p>
263 <div class="variablelist"><table border="0" class="variablelist">
264 <colgroup>
265 <col align="left" valign="top">
266 <col>
267 </colgroup>
268 <tbody>
269 <tr>
270 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>block</code></em></code>:</span></p></td>
271 <td>
272 <p>
273 </p>
274 <p>
275 </p>
276 </td>
277 </tr>
278 <tr>
279 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
280 <td>
281 <p>
282 </p>
283 <p>
284 </p>
285 </td>
286 </tr>
287 </tbody>
288 </table></div>
289 <p class="since">Since 2.0.0</p>
290 </div>
291 <hr>
292 <div class="refsect2">
293 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.EmptyDevice"></a><h3>The EmptyDevice() method</h3>
294 <pre class="programlisting">
295 EmptyDevice (IN o block,
296 IN a{sv} options);
297 </pre>
298 <p>
299 </p>
300 <p>
301 <em class="parameter"><code>block</code></em>: The block device to empty, as a UDisks2 object path.
302 <em class="parameter"><code>options</code></em>: Additional options.
303 </p>
304 <p>
305 Move all data on the given block device somewhere else so
306 that the block device might be removed.
307 </p>
308 <p>
309 No additional options are currently defined.
310 </p>
311 <div class="variablelist"><table border="0" class="variablelist">
312 <colgroup>
313 <col align="left" valign="top">
314 <col>
315 </colgroup>
316 <tbody>
317 <tr>
318 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>block</code></em></code>:</span></p></td>
319 <td>
320 <p>
321 </p>
322 <p>
323 </p>
324 </td>
325 </tr>
326 <tr>
327 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
328 <td>
329 <p>
330 </p>
331 <p>
332 </p>
333 </td>
334 </tr>
335 </tbody>
336 </table></div>
337 <p class="since">Since 2.0.0</p>
338 </div>
339 <hr>
340 <div class="refsect2">
341 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.RemoveDevice"></a><h3>The RemoveDevice() method</h3>
342 <pre class="programlisting">
343 RemoveDevice (IN o block,
344 IN b wipe,
345 IN a{sv} options);
346 </pre>
347 <p>
348 </p>
349 <p>
350 <em class="parameter"><code>block</code></em>: The block device to remove, as a UDisks2 object path.
351 <em class="parameter"><code>wipe</code></em>: Whether to wipe the physical volume.
352 <em class="parameter"><code>options</code></em>: Additional options.
353 </p>
354 <p>
355 Remove the indicated physical volume from the volume group.
356 The physical device must be unused.
357 </p>
358 <p>
359 No additional options are currently defined.
360 </p>
361 <div class="variablelist"><table border="0" class="variablelist">
362 <colgroup>
363 <col align="left" valign="top">
364 <col>
365 </colgroup>
366 <tbody>
367 <tr>
368 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>block</code></em></code>:</span></p></td>
369 <td>
370 <p>
371 </p>
372 <p>
373 </p>
374 </td>
375 </tr>
376 <tr>
377 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>wipe</code></em></code>:</span></p></td>
378 <td>
379 <p>
380 </p>
381 <p>
382 </p>
383 </td>
384 </tr>
385 <tr>
386 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
387 <td>
388 <p>
389 </p>
390 <p>
391 </p>
392 </td>
393 </tr>
394 </tbody>
395 </table></div>
396 <p class="since">Since 2.0.0</p>
397 </div>
398 <hr>
399 <div class="refsect2">
400 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.RemoveMissingPhysicalVolumes"></a><h3>The RemoveMissingPhysicalVolumes() method</h3>
401 <pre class="programlisting">
402 RemoveMissingPhysicalVolumes (IN a{sv} options);
403 </pre>
404 <p>
405 </p>
406 <p>
407 <em class="parameter"><code>since</code></em>: 2.10.0
408 </p>
409 <p>
410 Forget about all physical volumes that went missing.
411 </p>
412 <p>
413 No additional options are currently defined.
414 </p>
415 <div class="variablelist"><table border="0" class="variablelist">
416 <colgroup>
417 <col align="left" valign="top">
418 <col>
419 </colgroup>
420 <tbody><tr>
421 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
422 <td>
423 <p>
424 </p>
425 <p>
426 </p>
427 </td>
428 </tr></tbody>
429 </table></div>
430 <p class="since">Since 2.0.0</p>
431 </div>
432 <hr>
433 <div class="refsect2">
434 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreatePlainVolume"></a><h3>The CreatePlainVolume() method</h3>
435 <pre class="programlisting">
436 CreatePlainVolume (IN s name,
437 IN t size,
438 IN a{sv} options,
439 OUT o result);
440 </pre>
441 <p>
442 </p>
443 <p>
444 <em class="parameter"><code>name</code></em>: The name of the new logical volume.
445 <em class="parameter"><code>size</code></em>: The size.
446 <em class="parameter"><code>options</code></em>: Additional options.
447 <em class="parameter"><code>result</code></em>: The object path of the new logical volume.
448 </p>
449 <p>
450 Create a 'normal' new logical volume. Calling this method is
451 equivalent to calling CreatePlainVolumeWithLayout with
452 "linear" as the layout type and an empty array of physical
453 volumes.
454 </p>
455 <p>
456 No additional options are currently defined.
457 </p>
458 <div class="variablelist"><table border="0" class="variablelist">
459 <colgroup>
460 <col align="left" valign="top">
461 <col>
462 </colgroup>
463 <tbody>
464 <tr>
465 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
466 <td>
467 <p>
468 </p>
469 <p>
470 </p>
471 </td>
472 </tr>
473 <tr>
474 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
475 <td>
476 <p>
477 </p>
478 <p>
479 </p>
480 </td>
481 </tr>
482 <tr>
483 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
484 <td>
485 <p>
486 </p>
487 <p>
488 </p>
489 </td>
490 </tr>
491 <tr>
492 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
493 <td>
494 <p>
495 </p>
496 <p>
497 </p>
498 </td>
499 </tr>
500 </tbody>
501 </table></div>
502 <p class="since">Since 2.0.0</p>
503 </div>
504 <hr>
505 <div class="refsect2">
506 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreatePlainVolumeWithLayout"></a><h3>The CreatePlainVolumeWithLayout() method</h3>
507 <pre class="programlisting">
508 CreatePlainVolumeWithLayout (IN s name,
509 IN t size,
510 IN s layout,
511 IN ao pvs,
512 IN a{sv} options,
513 OUT o result);
514 </pre>
515 <p>
516 </p>
517 <p>
518 <em class="parameter"><code>name</code></em>: The name of the new logical volume.
519 <em class="parameter"><code>size</code></em>: The size.
520 <em class="parameter"><code>layout</code></em>: The layout type, like "linear", "raid5"
521 <em class="parameter"><code>pvs</code></em>: The physical volumes to use
522 <em class="parameter"><code>options</code></em>: Additional options.
523 <em class="parameter"><code>result</code></em>: The object path of the new logical volume.
524 <em class="parameter"><code>since</code></em>: 2.10.0
525 </p>
526 <p>
527 Create a 'normal' new logical volume with the given layout
528 type on the given physical volumes. It is okay to leave
529 "pvs" empty; LVM2 will then choose suitable ones on its own.
530 </p>
531 <p>
532 If "pvs" is not empty and the given "layout" uses subvolumes
533 (like all the raid variants), then this method will create
534 exactly one subvolume for each given physical volume.
535 </p>
536 <p>
537 For example, when "layout" is "raid5" and "pvs" contains four
538 entries, then this method will have the same effect as
539 "lvcreate --type raid5 --stripes 3 ...": The resulting logical volume
540 will have four subvolumes.
541 </p>
542 <p>
543 The "subvolumes" (i) option can be used to override the
544 number of subvolumes. The consequences of this are hard to
545 predict and might also lead to creation of logical volumes
546 that have less redundancy than expected, so it is best to
547 always create exactly one subvolume per physical volume.
548 </p>
549 <p>
550 Note again that this only happens when "pvs" is not empty.
551 When "pvs" is empty, LVM2 will decide how many subvolumes to
552 create.
553 </p>
554 <div class="variablelist"><table border="0" class="variablelist">
555 <colgroup>
556 <col align="left" valign="top">
557 <col>
558 </colgroup>
559 <tbody>
560 <tr>
561 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
562 <td>
563 <p>
564 </p>
565 <p>
566 </p>
567 </td>
568 </tr>
569 <tr>
570 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
571 <td>
572 <p>
573 </p>
574 <p>
575 </p>
576 </td>
577 </tr>
578 <tr>
579 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>layout</code></em></code>:</span></p></td>
580 <td>
581 <p>
582 </p>
583 <p>
584 </p>
585 </td>
586 </tr>
587 <tr>
588 <td><p><span class="term"><code class="literal">IN ao <em class="parameter"><code>pvs</code></em></code>:</span></p></td>
589 <td>
590 <p>
591 </p>
592 <p>
593 </p>
594 </td>
595 </tr>
596 <tr>
597 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
598 <td>
599 <p>
600 </p>
601 <p>
602 </p>
603 </td>
604 </tr>
605 <tr>
606 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
607 <td>
608 <p>
609 </p>
610 <p>
611 </p>
612 </td>
613 </tr>
614 </tbody>
615 </table></div>
616 <p class="since">Since 2.0.0</p>
617 </div>
618 <hr>
619 <div class="refsect2">
620 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateThinPoolVolume"></a><h3>The CreateThinPoolVolume() method</h3>
621 <pre class="programlisting">
622 CreateThinPoolVolume (IN s name,
623 IN t size,
624 IN a{sv} options,
625 OUT o result);
626 </pre>
627 <p>
628 </p>
629 <p>
630 <em class="parameter"><code>name</code></em>: The name of the new logical volume.
631 <em class="parameter"><code>size</code></em>: The total size.
632 <em class="parameter"><code>options</code></em>: Additional options.
633 <em class="parameter"><code>result</code></em>: The object path of the new logical volume.
634 </p>
635 <p>
636 Create a new logical volume that can be used to back
637 thinly-provisioned logical volumes. The <em class="parameter"><code>size</code></em> parameter is
638 the total amount of space taken out of the volume group.
639 That space will be used for data and metadata. The actual
640 amount of data that can be stored in the pool will be
641 slightly smaller.
642 </p>
643 <p>
644 No additional options are currently defined.
645 </p>
646 <div class="variablelist"><table border="0" class="variablelist">
647 <colgroup>
648 <col align="left" valign="top">
649 <col>
650 </colgroup>
651 <tbody>
652 <tr>
653 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
654 <td>
655 <p>
656 </p>
657 <p>
658 </p>
659 </td>
660 </tr>
661 <tr>
662 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
663 <td>
664 <p>
665 </p>
666 <p>
667 </p>
668 </td>
669 </tr>
670 <tr>
671 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
672 <td>
673 <p>
674 </p>
675 <p>
676 </p>
677 </td>
678 </tr>
679 <tr>
680 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
681 <td>
682 <p>
683 </p>
684 <p>
685 </p>
686 </td>
687 </tr>
688 </tbody>
689 </table></div>
690 <p class="since">Since 2.0.0</p>
691 </div>
692 <hr>
693 <div class="refsect2">
694 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateThinVolume"></a><h3>The CreateThinVolume() method</h3>
695 <pre class="programlisting">
696 CreateThinVolume (IN s name,
697 IN t size,
698 IN o pool,
699 IN a{sv} options,
700 OUT o result);
701 </pre>
702 <p>
703 </p>
704 <p>
705 <em class="parameter"><code>name</code></em>: The name of the new logical volume.
706 <em class="parameter"><code>size</code></em>: The virtual size.
707 <em class="parameter"><code>pool</code></em>: The thin pool to use.
708 <em class="parameter"><code>options</code></em>: Additional options.
709 <em class="parameter"><code>result</code></em>: The object path of the new logical volume.
710 </p>
711 <p>
712 Create a new thinly provisioned logical volume in the given
713 pool.
714 </p>
715 <p>
716 No additional options are currently defined.
717 </p>
718 <div class="variablelist"><table border="0" class="variablelist">
719 <colgroup>
720 <col align="left" valign="top">
721 <col>
722 </colgroup>
723 <tbody>
724 <tr>
725 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
726 <td>
727 <p>
728 </p>
729 <p>
730 </p>
731 </td>
732 </tr>
733 <tr>
734 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
735 <td>
736 <p>
737 </p>
738 <p>
739 </p>
740 </td>
741 </tr>
742 <tr>
743 <td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>pool</code></em></code>:</span></p></td>
744 <td>
745 <p>
746 </p>
747 <p>
748 </p>
749 </td>
750 </tr>
751 <tr>
752 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
753 <td>
754 <p>
755 </p>
756 <p>
757 </p>
758 </td>
759 </tr>
760 <tr>
761 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
762 <td>
763 <p>
764 </p>
765 <p>
766 </p>
767 </td>
768 </tr>
769 </tbody>
770 </table></div>
771 <p class="since">Since 2.0.0</p>
772 </div>
773 <hr>
774 <div class="refsect2">
775 <a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.CreateVDOVolume"></a><h3>The CreateVDOVolume() method</h3>
776 <pre class="programlisting">
777 CreateVDOVolume (IN s lv_name,
778 IN s pool_name,
779 IN t data_size,
780 IN t virtual_size,
781 IN t index_memory,
782 IN b compression,
783 IN b deduplication,
784 IN s write_policy,
785 IN a{sv} options,
786 OUT o result);
787 </pre>
788 <p>
789 </p>
790 <p>
791 <em class="parameter"><code>lv_name</code></em>: The name of the to-be-created VDO LV.
792 <em class="parameter"><code>pool_name</code></em>: The name of the to-be-created VDO pool LV or an empty string for a default name.
793 <em class="parameter"><code>data_size</code></em>: The size of the data VDO LV (physical size of the <em class="parameter"><code>pool_name</code></em> VDO pool LV).
794 <em class="parameter"><code>virtual_size</code></em>: The virtual_size of the <em class="parameter"><code>lv_name</code></em> VDO LV or 0 for default (<em class="parameter"><code>data_size</code></em> minus metadata).
795 <em class="parameter"><code>index_memory</code></em>: Amount of index memory in bytes or 0 for default.
796 <em class="parameter"><code>compression</code></em>: Enables or disables compression when creating the VDO volume.
797 <em class="parameter"><code>deduplication</code></em>: Enables or disables deduplication when creating the VDO volume.
798 <em class="parameter"><code>write_policy</code></em>: Specifies the write policy.
799 <em class="parameter"><code>options</code></em>: Additional options.
800 <em class="parameter"><code>result</code></em>: The object path of the new VDO logical volume.
801 <em class="parameter"><code>since</code></em>: 2.9.0
802 </p>
803 <p>
804 Create a new VDO logical volume that is backed by a newly created
805 VDO pool. The VDO data logical volume and VDO pool logical volume
806 are created together, VDO pool supports only a single VDO LV.
807 The <em class="parameter"><code>data_size</code></em> parameter is the total amount of space
808 taken out of the volume group and it's the size of the <em class="parameter"><code>pool_name</code></em>
809 VDO pool logical volume.
810 The <em class="parameter"><code>virtual_size</code></em> is the size of the <em class="parameter"><code>lv_name</code></em> VDO logical volume
811 and represents expected amount of the data that can be stored
812 after deduplication and compression.
813 </p>
814 <p>
815 No additional options are currently defined.
816 </p>
817 <p>
818 Known <em class="parameter"><code>write_policy</code></em> values include:
819 </p>
820 <div class="variablelist"><table border="0" class="variablelist">
821 <colgroup>
822 <col align="left" valign="top">
823 <col>
824 </colgroup>
825 <tbody>
826 <tr>
827 <td><p><span class="term">sync</span></p></td>
828 <td><p>Writes are acknowledged only after data is on stable storage. 'sync' policy is not supported if the underlying storage is not also synchronous.</p></td>
829 </tr>
830 <tr>
831 <td><p><span class="term">async</span></p></td>
832 <td><p>Writes are acknowledged when data has been cached for writing to stable storage; data which has not been flushed is not guaranteed to persist in this mode.</p></td>
833 </tr>
834 <tr>
835 <td><p><span class="term">auto</span></p></td>
836 <td><p>VDO will check the storage device and determine whether it supports flushes. If it does, VDO will run in async mode, otherwise it will run in sync mode.</p></td>
837 </tr>
838 </tbody>
839 </table></div>
840 <p>
841 </p>
842 <div class="variablelist"><table border="0" class="variablelist">
843 <colgroup>
844 <col align="left" valign="top">
845 <col>
846 </colgroup>
847 <tbody>
848 <tr>
849 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>lv_name</code></em></code>:</span></p></td>
850 <td>
851 <p>
852 </p>
853 <p>
854 </p>
855 </td>
856 </tr>
857 <tr>
858 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>pool_name</code></em></code>:</span></p></td>
859 <td>
860 <p>
861 </p>
862 <p>
863 </p>
864 </td>
865 </tr>
866 <tr>
867 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>data_size</code></em></code>:</span></p></td>
868 <td>
869 <p>
870 </p>
871 <p>
872 </p>
873 </td>
874 </tr>
875 <tr>
876 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>virtual_size</code></em></code>:</span></p></td>
877 <td>
878 <p>
879 </p>
880 <p>
881 </p>
882 </td>
883 </tr>
884 <tr>
885 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>index_memory</code></em></code>:</span></p></td>
886 <td>
887 <p>
888 </p>
889 <p>
890 </p>
891 </td>
892 </tr>
893 <tr>
894 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>compression</code></em></code>:</span></p></td>
895 <td>
896 <p>
897 </p>
898 <p>
899 </p>
900 </td>
901 </tr>
902 <tr>
903 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>deduplication</code></em></code>:</span></p></td>
904 <td>
905 <p>
906 </p>
907 <p>
908 </p>
909 </td>
910 </tr>
911 <tr>
912 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>write_policy</code></em></code>:</span></p></td>
913 <td>
914 <p>
915 </p>
916 <p>
917 </p>
918 </td>
919 </tr>
920 <tr>
921 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
922 <td>
923 <p>
924 </p>
925 <p>
926 </p>
927 </td>
928 </tr>
929 <tr>
930 <td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
931 <td>
932 <p>
933 </p>
934 <p>
935 </p>
936 </td>
937 </tr>
938 </tbody>
939 </table></div>
940 <p class="since">Since 2.0.0</p>
941 </div>
942 </div>
943 <div class="refsect1">
944 <a name="gdbus-properties-org.freedesktop.UDisks2.VolumeGroup"></a><h2>Property Details</h2>
945 <div class="refsect2">
946 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.Name"></a><h3>The "Name" property</h3>
947 <pre class="programlisting">
948 Name readable s
949 </pre>
950 <p>
951 The name of this volume group, as known to LVM2.
952 </p>
953 <p class="since">Since 2.0.0</p>
954 </div>
955 <hr>
956 <div class="refsect2">
957 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.UUID"></a><h3>The "UUID" property</h3>
958 <pre class="programlisting">
959 UUID readable s
960 </pre>
961 <p>
962 The UUID this volume group. It is guaranteed to be unique,
963 but it might change over time.
964 </p>
965 <p class="since">Since 2.0.0</p>
966 </div>
967 <hr>
968 <div class="refsect2">
969 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.Size"></a><h3>The "Size" property</h3>
970 <pre class="programlisting">
971 Size readable t
972 </pre>
973 <p>
974 The total capacity of this volume group, in bytes.
975 </p>
976 <p class="since">Since 2.0.0</p>
977 </div>
978 <hr>
979 <div class="refsect2">
980 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.FreeSize"></a><h3>The "FreeSize" property</h3>
981 <pre class="programlisting">
982 FreeSize readable t
983 </pre>
984 <p>
985 The unused capacity of this volume group, in bytes.
986 </p>
987 <p class="since">Since 2.0.0</p>
988 </div>
989 <hr>
990 <div class="refsect2">
991 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.ExtentSize"></a><h3>The "ExtentSize" property</h3>
992 <pre class="programlisting">
993 ExtentSize readable t
994 </pre>
995 <p>
996 The size of extents. When creating and resizing logical
997 volumes, sizes are rounded up to multiples of the extent
998 size.
999 </p>
1000 <p class="since">Since 2.0.0</p>
1001 </div>
1002 <hr>
1003 <div class="refsect2">
1004 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.NeedsPolling"></a><h3>The "NeedsPolling" property</h3>
1005 <pre class="programlisting">
1006 NeedsPolling readable b
1007 </pre>
1008 <p>
1009 Whether or not this volume group needs to be periodically
1010 polled to guarantee updates.
1011 </p>
1012 <p class="since">Since 2.0.0</p>
1013 </div>
1014 <hr>
1015 <div class="refsect2">
1016 <a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.MissingPhysicalVolumes"></a><h3>The "MissingPhysicalVolumes" property</h3>
1017 <pre class="programlisting">
1018 MissingPhysicalVolumes readable as
1019 </pre>
1020 <p>
1021 </p>
1022 <p>
1023 <em class="parameter"><code>since</code></em>: 2.10.0
1024 </p>
1025 <p>
1026 A list of the UUIDs of missing physical volumes.
1027 </p>
1028 <p class="since">Since 2.0.0</p>
1029 </div>
1030 </div>
1031 </div>
1032 <div class="footer">
1033 <hr>Generated by GTK-Doc V1.35.1</div>
1034 </body>
1035 </html>