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
|
<!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.LogicalVolume: 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.Block.LVM2.html" title="org.freedesktop.UDisks2.Block.LVM2">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html" title="org.freedesktop.UDisks2.VDOVolume">
<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.LogicalVolume.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.LogicalVolume.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.Block.LVM2.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.VDOVolume.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.LogicalVolume"></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-LogicalVolume.top_of_page"></a>org.freedesktop.UDisks2.LogicalVolume</span></h2>
<p>org.freedesktop.UDisks2.LogicalVolume — A logical volume</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.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Activate" title="The Activate() method">Activate</a> (IN a{sv} options,
OUT o result);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Deactivate" title="The Deactivate() method">Deactivate</a> (IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Delete" title="The Delete() method">Delete</a> (IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.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.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Resize" title="The Resize() method">Resize</a> (IN t new_size,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Repair" title="The Repair() method">Repair</a> (IN ao pvs,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CreateSnapshot" title="The CreateSnapshot() method">CreateSnapshot</a> (IN s name,
IN t size,
IN a{sv} options,
OUT o result);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheAttach" title="The CacheAttach() method">CacheAttach</a> (IN s cache_name,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheSplit" title="The CacheSplit() method">CacheSplit</a> (IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheDetach" title="The CacheDetach() method">CacheDetach</a> (IN a{sv} options);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.21.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.VolumeGroup" title='The "VolumeGroup" property'>VolumeGroup</a> readable o
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Name" title='The "Name" property'>Name</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Active" title='The "Active" property'>Active</a> readable b
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.UUID" title='The "UUID" property'>UUID</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Size" title='The "Size" property'>Size</a> readable t
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.DataAllocatedRatio" title='The "DataAllocatedRatio" property'>DataAllocatedRatio</a> readable d
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.MetadataAllocatedRatio" title='The "MetadataAllocatedRatio" property'>MetadataAllocatedRatio</a> readable d
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Type" title='The "Type" property'>Type</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Layout" title='The "Layout" property'>Layout</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Structure" title='The "Structure" property'>Structure</a> readable a{sv}
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.SyncRatio" title='The "SyncRatio" property'>SyncRatio</a> readable d
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ThinPool" title='The "ThinPool" property'>ThinPool</a> readable o
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Origin" title='The "Origin" property'>Origin</a> readable o
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ChildConfiguration" title='The "ChildConfiguration" property'>ChildConfiguration</a> readable a(sa{sv})
<a class="link" href="gdbus-org.freedesktop.UDisks2.LogicalVolume.html#gdbus-property-org-freedesktop-UDisks2-LogicalVolume.BlockDevice" title='The "BlockDevice" property'>BlockDevice</a> readable o
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-LogicalVolume"></a><h2>Description</h2>
<p>
Objects with this interface represent logical volumes in a
volume group. Active logical volumes are associated with a
block device, which link back to the logical volume object via
their <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.LVM2.html#gdbus-property-org-freedesktop-UDisks2-Block-LVM2.LogicalVolume" title='The "LogicalVolume" property'>"LogicalVolume"</a> property.
</p>
<p>
Logical volume objects are children of their volume group
object, and also link to it via the #VolumeGroup property.
</p>
<p class="since">Since 2.0.0</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.LogicalVolume"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.Activate"></a><h3>The Activate() method</h3>
<pre class="programlisting">
Activate (IN a{sv} options,
OUT o result);
</pre>
<p>
Activate this logical volume, which makes it appear as a
block device in the system.
</p>
<p>
Non-thin snapshots are always activated and deactivated
together with their origins.
</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>
Additional options.
</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>
The UDisks2 object path of the block device.
</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-LogicalVolume.Deactivate"></a><h3>The Deactivate() method</h3>
<pre class="programlisting">
Deactivate (IN a{sv} options);
</pre>
<p>
Deactivate this logical volume, which makes its block device
disappear.
</p>
<p>
Non-thin snapshots are always activated and deactivated
together with their origins.
</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>
Additional options.
</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-LogicalVolume.Delete"></a><h3>The Delete() method</h3>
<pre class="programlisting">
Delete (IN a{sv} options);
</pre>
<p>
Delete this logical volume.
</p>
<p>
If there are any non-thin snapshots of this logical volume,
they will be deleted as well.
</p>
<p>
If this is a thin pool, all its contained thin volumes will
be deleted as well.
</p>
<p>
If the option <em class="parameter"><code>tear-down</code></em> is set to
<code class="constant">TRUE</code>, then the logical volume and all its children 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 a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Additional options.
</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-LogicalVolume.Rename"></a><h3>The Rename() method</h3>
<pre class="programlisting">
Rename (IN s new_name,
IN a{sv} options,
OUT o result);
</pre>
<p>
Rename this logical volume. This might cause the logical
volume 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>
The new name.
</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>
Additional options.
</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>
The new object path.
</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-LogicalVolume.Resize"></a><h3>The Resize() method</h3>
<pre class="programlisting">
Resize (IN t new_size,
IN a{sv} options);
</pre>
<p>
Resize this logical volume.
</p>
<p>
Additional options:
</p>
<p>
resize_fsys (b): Whether to resize the filesystem on the
logical volume as well. Default to 'false'.
</p>
<p>
force (b): Whether to force the resize even if it might
destroy data.
</p>
<p>
pvs (ao): A list of physical volumes to allocate more space
from.
</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>new_size</code></em></code>:</span></p></td>
<td><p>
The new size, in bytes.
</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>
Additional options.
</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-LogicalVolume.Repair"></a><h3>The Repair() method</h3>
<pre class="programlisting">
Repair (IN ao pvs,
IN a{sv} options);
</pre>
<p>
Attempt a repair of this logical volume after it has lost
some physical volumes. Space is allocated from the given
physical volumes as needed. A empty list means to allocate
from all 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 ao <em class="parameter"><code>pvs</code></em></code>:</span></p></td>
<td><p>
A list of physical volumes to use for the repair.
</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>
Additional options.
</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-LogicalVolume.CreateSnapshot"></a><h3>The CreateSnapshot() method</h3>
<pre class="programlisting">
CreateSnapshot (IN s name,
IN t size,
IN a{sv} options,
OUT o result);
</pre>
<p>
Create a snapshot of this logical volume.
</p>
<p>
When creating a snapshot of a non-thin volume, a non-zero
size must be specified. A non-thin snapshot is created in
this case.
</p>
<p>
When creating a snapshot of a thin volume, specifying a <em class="parameter"><code>size</code></em>
of zero will create a thin snapshot in the same pool.
</p>
<p>
When creating a snapshot of a thin volume, specifying a
non-zero <em class="parameter"><code>size</code></em> will create a non-thin snapshot.
</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>
The name of the snapshot.
</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>
The size of the backing store for the snapshot, in bytes.
</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>
Additional options.
</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-LogicalVolume.CacheAttach"></a><h3>The CacheAttach() method</h3>
<pre class="programlisting">
CacheAttach (IN s cache_name,
IN a{sv} options);
</pre>
<p>
Creates cache LV. Logical volume which name is provided, will be formatted, converted to cache type
and attached to origin logical volume as a cache pool LV. Logical volumes must be in the same volume group.
</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>cache_name</code></em></code>:</span></p></td>
<td><p>
The name of an existing volume.
</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>
Additional options.
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheSplit"></a><h3>The CacheSplit() method</h3>
<pre class="programlisting">
CacheSplit (IN a{sv} options);
</pre>
<p>
Splits Cache LV to Cache pool LV and Origin LV, not afeecting its content.
</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>
Additional options.
</p></td>
</tr></tbody>
</table></div>
<p class="since">Since 2.3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-LogicalVolume.CacheDetach"></a><h3>The CacheDetach() method</h3>
<pre class="programlisting">
CacheDetach (IN a{sv} options);
</pre>
<p>
Detaches the cached LV from its cache.
</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>
Additional options.
</p></td>
</tr></tbody>
</table></div>
<p class="since">Since 2.6.3</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.LogicalVolume"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.VolumeGroup"></a><h3>The "VolumeGroup" property</h3>
<pre class="programlisting">
VolumeGroup readable o
</pre>
<p>
The path of the volume group object that this logical volume
belongs to.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Name"></a><h3>The "Name" property</h3>
<pre class="programlisting">
Name readable s
</pre>
<p>
The name of this logical volume, as it is known to LVM2.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Active"></a><h3>The "Active" property</h3>
<pre class="programlisting">
Active readable b
</pre>
<p>
Whether or not this volume is active.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.UUID"></a><h3>The "UUID" property</h3>
<pre class="programlisting">
UUID readable s
</pre>
<p>
The UUID of this logical volume. It is guaranteed to be
unique within the group, 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-LogicalVolume.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size readable t
</pre>
<p>
The total size of this logical volume in bytes, including the
size of the metadata.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.DataAllocatedRatio"></a><h3>The "DataAllocatedRatio" property</h3>
<pre class="programlisting">
DataAllocatedRatio readable d
</pre>
<p>
For a thin pool or a non-thin snapshot, indicates how full
the area for storing data is. A value of 1.0 corresponds to
100<code class="constant"></code>.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.MetadataAllocatedRatio"></a><h3>The "MetadataAllocatedRatio" property</h3>
<pre class="programlisting">
MetadataAllocatedRatio readable d
</pre>
<p>
For a thin pool or a non-thin snapshot, indicates how full
the area for storing meta data is. A value of 1.0
corresponds to 100<code class="constant"></code>.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Type"></a><h3>The "Type" property</h3>
<pre class="programlisting">
Type readable s
</pre>
<p>
The general type of a logical volume. One of "block", "pool"
or "vdopool". More types might be defined in the future.
</p>
<p>
A volume of type "block" can be used as a block device. A
volume of type "pool" can be used to create thin volumes.
A volume of type "vdopool" is the internal pool for the
VDO logical volume device.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Layout"></a><h3>The "Layout" property</h3>
<pre class="programlisting">
Layout readable s
</pre>
<p>
The layout of this logical volume, such as "linear", "raid5",
etc.
</p>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Structure"></a><h3>The "Structure" property</h3>
<pre class="programlisting">
Structure readable a{sv}
</pre>
<p>
The detailed structure of how this logical volume is stored on physical volumes.
</p>
<p>
The following fields are present:
</p>
<p>
- name (s): The name of the logical volume.
- type (s): The layout type of the logical volume.
- size (t): The size in bytes of the logical volume.
</p>
<p>
If the logical volume is stored directly on physical volumes,
this field is present as well:
</p>
<p>
- segs (a(tto)): Information about the segments of the logical volume (see below).
</p>
<p>
A segment is represented by a "(tto)" tuple, where the fields
have these meanings:
</p>
<p>
- (t): The start of this segement on the physical volume, in bytes.
- (t): The size of the segment, in bytes.
- (o): The path of the org.freedesktop.UDisks.Block object of the physical volume.
</p>
<p>
For a healthy logical volume, the sizes of its segments will
add up exactly to its own size. If a volume group has lost
some physical volumes, a affected logical volume will have a
list of segments here that do not add up to its full size.
</p>
<p>
If the logical volume is stored on other logical volumes,
these fields are present in the "Structure" value instead of
"segs":
</p>
<p>
- data (aa{sv}): The list of "Structure" objects for the data sub-volumes.
- metadata (aa{sv}): The list of "Structure" objects for the metadata sub-volumes.
</p>
<p>
For example, a minimal "raid5" layout will have three "data"
sub-volumes (and three parallel "metadata" sub-volumes),
which are the three stripes of the RAID configuration. Each
of those sub-volume will be stored directly on physical
volumes and one can inspect the "segs" field of those to
figure out how many are damaged. From that, one can deduce
whether the RAID is degraded (exactly one damaged), or has
lost data (more than one damaged).
</p>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.SyncRatio"></a><h3>The "SyncRatio" property</h3>
<pre class="programlisting">
SyncRatio readable d
</pre>
<p>
How far along the logical volume is with resynchronizing. A
value of 1.0 corresponds to fully synchronized and indicates
that no operation is in progress. This is only relevant for
logical volumes with some redundancy, like "raid1" or
"raid5".
</p>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ThinPool"></a><h3>The "ThinPool" property</h3>
<pre class="programlisting">
ThinPool readable o
</pre>
<p>
For a thin volume, the object path of its pool.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.Origin"></a><h3>The "Origin" property</h3>
<pre class="programlisting">
Origin readable o
</pre>
<p>
For a snapshot, the object path of its origin.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.ChildConfiguration"></a><h3>The "ChildConfiguration" property</h3>
<pre class="programlisting">
ChildConfiguration readable a(sa{sv})
</pre>
<p>
Configuration items belonging to the
</p>
<p>
block device of this logical volume and its children. This
is also valid when this logical volume is not currently
active and there is no block device for it. It works via the
'track-parents' options of
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-method-org-freedesktop-UDisks2-Block.AddConfigurationItem" title="The AddConfigurationItem() method">AddConfigurationItem()</a>, which
see.
</p>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-LogicalVolume.BlockDevice"></a><h3>The "BlockDevice" property</h3>
<pre class="programlisting">
BlockDevice readable o
</pre>
<p>
For an active LV, the object path of its block device.
</p>
<p class="since">Since 2.7.1</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
