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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
|
<!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.VolumeGroup: 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.PhysicalVolume.html" title="org.freedesktop.UDisks2.PhysicalVolume">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.ISCSI.Session.html" title="org.freedesktop.UDisks2.ISCSI.Session">
<meta name="generator" content="GTK-Doc V1.35.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.VolumeGroup.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.VolumeGroup.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.PhysicalVolume.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<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>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.VolumeGroup"></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-VolumeGroup.top_of_page"></a>org.freedesktop.UDisks2.VolumeGroup</span></h2>
<p>org.freedesktop.UDisks2.VolumeGroup — A volume group</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.VolumeGroup.html#gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Poll" title="The Poll() method">Poll</a> ();
<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,
IN a{sv} options);
<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,
IN a{sv} options,
OUT o result);
<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,
IN a{sv} options);
<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,
IN a{sv} options);
<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,
IN b wipe,
IN a{sv} options);
<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);
<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,
IN t size,
IN a{sv} options,
OUT o result);
<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,
IN t size,
IN s layout,
IN ao pvs,
IN a{sv} options,
OUT o result);
<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,
IN t size,
IN a{sv} options,
OUT o result);
<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,
IN t size,
IN o pool,
IN a{sv} options,
OUT o result);
<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,
IN s pool_name,
IN t data_size,
IN t virtual_size,
IN t index_memory,
IN b compression,
IN b deduplication,
IN s write_policy,
IN a{sv} options,
OUT o result);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.25.4"></a><h2>Properties</h2>
<pre class="synopsis">
<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
<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
<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
<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
<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
<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
<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
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-VolumeGroup"></a><h2>Description</h2>
<p>
Objects implementing this interface represent LVM2 volume
groups. They appear under /org/freedesktop/UDisks2/lvm/.
</p>
<p>
The logical volume objects of a volume group are the children of
the volume group objects in the D-Bus object hierarchy. See the
<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.
</p>
<p>
The physical volume objects of a volume group can be found by
looking for block devices with a
<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
that points to the volume group object.
</p>
<p class="since">Since 2.0.0</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.VolumeGroup"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Poll"></a><h3>The Poll() method</h3>
<pre class="programlisting">
Poll ();
</pre>
<p>
Make sure that all properties of this volume group and of all
their logical and physical volumes are up-to-date.
</p>
<p>
The properties are not guaranteed to be up-to-date yet when
this method returns.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VolumeGroup.Delete"></a><h3>The Delete() method</h3>
<pre class="programlisting">
Delete (IN b wipe,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>wipe</code></em>: Whether to wipe the volume group.
<em class="parameter"><code>options</code></em>: Additional options.
</p>
<p>
Delete this volume group. All its logical volumes will be
deleted, too.
</p>
<p>
If the option <em class="parameter"><code>tear-down</code></em> is set to
<code class="constant">TRUE</code>, then all logical volumes will be cleaned up before
deletion. This cleanup consists of removing entries from
/etc/fstab and /etc/crypttab, and locking of encrypted block
devices. Entries in /etc/fstab and /etc/crypttab that have
been created with the 'track-parents' options to
AddConfigurationItem will be removed even if their block
device is currently unavailable.
</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>wipe</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</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-VolumeGroup.Rename"></a><h3>The Rename() method</h3>
<pre class="programlisting">
Rename (IN s new_name,
IN a{sv} options,
OUT o result);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>new_name</code></em>: The new name.
<em class="parameter"><code>options</code></em>: Additional options.
<em class="parameter"><code>result</code></em>: The new object path.
</p>
<p>
Rename this volume group. This might cause the volume group
object to disappear from D-Bus and reappear with a different
path.
</p>
<p>
No additional options are currently defined.
</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>new_name</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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-VolumeGroup.AddDevice"></a><h3>The AddDevice() method</h3>
<pre class="programlisting">
AddDevice (IN o block,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>block</code></em>: The block device to add, as a UDisks2 object path.
<em class="parameter"><code>options</code></em>: Additional options.
</p>
<p>
Add a new physical volume to the volume group. The block
device will be wiped and all data on it will be lost.
</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 o <em class="parameter"><code>block</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</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-VolumeGroup.EmptyDevice"></a><h3>The EmptyDevice() method</h3>
<pre class="programlisting">
EmptyDevice (IN o block,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>block</code></em>: The block device to empty, as a UDisks2 object path.
<em class="parameter"><code>options</code></em>: Additional options.
</p>
<p>
Move all data on the given block device somewhere else so
that the block device might be removed.
</p>
<p>
No additional options are currently defined.
</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 o <em class="parameter"><code>block</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</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-VolumeGroup.RemoveDevice"></a><h3>The RemoveDevice() method</h3>
<pre class="programlisting">
RemoveDevice (IN o block,
IN b wipe,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>block</code></em>: The block device to remove, as a UDisks2 object path.
<em class="parameter"><code>wipe</code></em>: Whether to wipe the physical volume.
<em class="parameter"><code>options</code></em>: Additional options.
</p>
<p>
Remove the indicated physical volume from the volume group.
The physical device must be unused.
</p>
<p>
No additional options are currently defined.
</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 o <em class="parameter"><code>block</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>wipe</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</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-VolumeGroup.RemoveMissingPhysicalVolumes"></a><h3>The RemoveMissingPhysicalVolumes() method</h3>
<pre class="programlisting">
RemoveMissingPhysicalVolumes (IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
Forget about all physical volumes that went missing.
</p>
<p>
No additional options are currently defined.
</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>
</p>
<p>
</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-VolumeGroup.CreatePlainVolume"></a><h3>The CreatePlainVolume() method</h3>
<pre class="programlisting">
CreatePlainVolume (IN s name,
IN t size,
IN a{sv} options,
OUT o result);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>name</code></em>: The name of the new logical volume.
<em class="parameter"><code>size</code></em>: The size.
<em class="parameter"><code>options</code></em>: Additional options.
<em class="parameter"><code>result</code></em>: The object path of the new logical volume.
</p>
<p>
Create a 'normal' new logical volume. Calling this method is
equivalent to calling CreatePlainVolumeWithLayout with
"linear" as the layout type and an empty array of physical
volumes.
</p>
<p>
No additional options are currently defined.
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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-VolumeGroup.CreatePlainVolumeWithLayout"></a><h3>The CreatePlainVolumeWithLayout() method</h3>
<pre class="programlisting">
CreatePlainVolumeWithLayout (IN s name,
IN t size,
IN s layout,
IN ao pvs,
IN a{sv} options,
OUT o result);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>name</code></em>: The name of the new logical volume.
<em class="parameter"><code>size</code></em>: The size.
<em class="parameter"><code>layout</code></em>: The layout type, like "linear", "raid5"
<em class="parameter"><code>pvs</code></em>: The physical volumes to use
<em class="parameter"><code>options</code></em>: Additional options.
<em class="parameter"><code>result</code></em>: The object path of the new logical volume.
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
Create a 'normal' new logical volume with the given layout
type on the given physical volumes. It is okay to leave
"pvs" empty; LVM2 will then choose suitable ones on its own.
</p>
<p>
If "pvs" is not empty and the given "layout" uses subvolumes
(like all the raid variants), then this method will create
exactly one subvolume for each given physical volume.
</p>
<p>
For example, when "layout" is "raid5" and "pvs" contains four
entries, then this method will have the same effect as
"lvcreate --type raid5 --stripes 3 ...": The resulting logical volume
will have four subvolumes.
</p>
<p>
The "subvolumes" (i) option can be used to override the
number of subvolumes. The consequences of this are hard to
predict and might also lead to creation of logical volumes
that have less redundancy than expected, so it is best to
always create exactly one subvolume per physical volume.
</p>
<p>
Note again that this only happens when "pvs" is not empty.
When "pvs" is empty, LVM2 will decide how many subvolumes to
create.
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>layout</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN ao <em class="parameter"><code>pvs</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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-VolumeGroup.CreateThinPoolVolume"></a><h3>The CreateThinPoolVolume() method</h3>
<pre class="programlisting">
CreateThinPoolVolume (IN s name,
IN t size,
IN a{sv} options,
OUT o result);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>name</code></em>: The name of the new logical volume.
<em class="parameter"><code>size</code></em>: The total size.
<em class="parameter"><code>options</code></em>: Additional options.
<em class="parameter"><code>result</code></em>: The object path of the new logical volume.
</p>
<p>
Create a new logical volume that can be used to back
thinly-provisioned logical volumes. The <em class="parameter"><code>size</code></em> parameter is
the total amount of space taken out of the volume group.
That space will be used for data and metadata. The actual
amount of data that can be stored in the pool will be
slightly smaller.
</p>
<p>
No additional options are currently defined.
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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-VolumeGroup.CreateThinVolume"></a><h3>The CreateThinVolume() method</h3>
<pre class="programlisting">
CreateThinVolume (IN s name,
IN t size,
IN o pool,
IN a{sv} options,
OUT o result);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>name</code></em>: The name of the new logical volume.
<em class="parameter"><code>size</code></em>: The virtual size.
<em class="parameter"><code>pool</code></em>: The thin pool to use.
<em class="parameter"><code>options</code></em>: Additional options.
<em class="parameter"><code>result</code></em>: The object path of the new logical volume.
</p>
<p>
Create a new thinly provisioned logical volume in the given
pool.
</p>
<p>
No additional options are currently defined.
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>pool</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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-VolumeGroup.CreateVDOVolume"></a><h3>The CreateVDOVolume() method</h3>
<pre class="programlisting">
CreateVDOVolume (IN s lv_name,
IN s pool_name,
IN t data_size,
IN t virtual_size,
IN t index_memory,
IN b compression,
IN b deduplication,
IN s write_policy,
IN a{sv} options,
OUT o result);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>lv_name</code></em>: The name of the to-be-created VDO LV.
<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.
<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).
<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).
<em class="parameter"><code>index_memory</code></em>: Amount of index memory in bytes or 0 for default.
<em class="parameter"><code>compression</code></em>: Enables or disables compression when creating the VDO volume.
<em class="parameter"><code>deduplication</code></em>: Enables or disables deduplication when creating the VDO volume.
<em class="parameter"><code>write_policy</code></em>: Specifies the write policy.
<em class="parameter"><code>options</code></em>: Additional options.
<em class="parameter"><code>result</code></em>: The object path of the new VDO logical volume.
<em class="parameter"><code>since</code></em>: 2.9.0
</p>
<p>
Create a new VDO logical volume that is backed by a newly created
VDO pool. The VDO data logical volume and VDO pool logical volume
are created together, VDO pool supports only a single VDO LV.
The <em class="parameter"><code>data_size</code></em> parameter is the total amount of space
taken out of the volume group and it's the size of the <em class="parameter"><code>pool_name</code></em>
VDO pool logical volume.
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
and represents expected amount of the data that can be stored
after deduplication and compression.
</p>
<p>
No additional options are currently defined.
</p>
<p>
Known <em class="parameter"><code>write_policy</code></em> values 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">sync</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">async</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term">auto</span></p></td>
<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>
</tr>
</tbody>
</table></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 s <em class="parameter"><code>lv_name</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>pool_name</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>data_size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>virtual_size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>index_memory</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>compression</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>deduplication</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>write_policy</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</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>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>result</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.0.0</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.VolumeGroup"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.Name"></a><h3>The "Name" property</h3>
<pre class="programlisting">
Name readable s
</pre>
<p>
The name of this volume group, as known to LVM2.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.UUID"></a><h3>The "UUID" property</h3>
<pre class="programlisting">
UUID readable s
</pre>
<p>
The UUID this volume group. It is guaranteed to be unique,
but it might change over time.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size readable t
</pre>
<p>
The total capacity of this volume group, in bytes.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.FreeSize"></a><h3>The "FreeSize" property</h3>
<pre class="programlisting">
FreeSize readable t
</pre>
<p>
The unused capacity of this volume group, in bytes.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.ExtentSize"></a><h3>The "ExtentSize" property</h3>
<pre class="programlisting">
ExtentSize readable t
</pre>
<p>
The size of extents. When creating and resizing logical
volumes, sizes are rounded up to multiples of the extent
size.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.NeedsPolling"></a><h3>The "NeedsPolling" property</h3>
<pre class="programlisting">
NeedsPolling readable b
</pre>
<p>
Whether or not this volume group needs to be periodically
polled to guarantee updates.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VolumeGroup.MissingPhysicalVolumes"></a><h3>The "MissingPhysicalVolumes" property</h3>
<pre class="programlisting">
MissingPhysicalVolumes readable as
</pre>
<p>
</p>
<p>
<em class="parameter"><code>since</code></em>: 2.10.0
</p>
<p>
A list of the UUIDs of missing physical volumes.
</p>
<p class="since">Since 2.0.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.35.1</div>
</body>
</html>
|
