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
|
<!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.VDOVolume: 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.LogicalVolume.html" title="org.freedesktop.UDisks2.LogicalVolume">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Manager.LVM2.html" title="org.freedesktop.UDisks2.Manager.LVM2">
<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.VDOVolume.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.VDOVolume.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.LogicalVolume.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Manager.LVM2.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.VDOVolume"></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-VDOVolume.top_of_page"></a>org.freedesktop.UDisks2.VDOVolume</span></h2>
<p>org.freedesktop.UDisks2.VDOVolume — A VDO 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.VDOVolume.html#gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression" title="The EnableCompression() method">EnableCompression</a> (IN b enable,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication" title="The EnableDeduplication() method">EnableDeduplication</a> (IN b enable,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical" title="The ResizeLogical() method">ResizeLogical</a> (IN t size,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical" title="The ResizePhysical() method">ResizePhysical</a> (IN t size,
IN a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-method-org-freedesktop-UDisks2-VDOVolume.GetStatistics" title="The GetStatistics() method">GetStatistics</a> (IN a{sv} options,
OUT a{ss} stats);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.22.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.VDOPool" title='The "VDOPool" property'>VDOPool</a> readable o
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.OperatingMode" title='The "OperatingMode" property'>OperatingMode</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.CompressionState" title='The "CompressionState" property'>CompressionState</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.IndexState" title='The "IndexState" property'>IndexState</a> readable s
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.UsedSize" title='The "UsedSize" property'>UsedSize</a> readable t
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.Compression" title='The "Compression" property'>Compression</a> readable b
<a class="link" href="gdbus-org.freedesktop.UDisks2.VDOVolume.html#gdbus-property-org-freedesktop-UDisks2-VDOVolume.Deduplication" title='The "Deduplication" property'>Deduplication</a> readable b
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-VDOVolume"></a><h2>Description</h2>
<p>
Objects with this interface represent VDO logical volumes in a
volume group.
</p>
<p>
VDO logical volume objects are children of their VDO pool
object, and also link to it via the #VDOPool property.
</p>
<p class="since">Since 2.9.0</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.VDOVolume"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableCompression"></a><h3>The EnableCompression() method</h3>
<pre class="programlisting">
EnableCompression (IN b enable,
IN a{sv} options);
</pre>
<p>
Enables or disables compression on the VDO volume. If the VDO volume
is running, takes effect immediately.
</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>enable</code></em></code>:</span></p></td>
<td><p>
A boolean value indicating whether compression should be enabled.
</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 (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VDOVolume.EnableDeduplication"></a><h3>The EnableDeduplication() method</h3>
<pre class="programlisting">
EnableDeduplication (IN b enable,
IN a{sv} options);
</pre>
<p>
Enables or disables deduplication on the VDO volume. If the VDO volume
is running, takes effect immediately.
</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>enable</code></em></code>:</span></p></td>
<td><p>
A boolean value indicating whether deduplication should be enabled.
</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 (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizeLogical"></a><h3>The ResizeLogical() method</h3>
<pre class="programlisting">
ResizeLogical (IN t size,
IN a{sv} options);
</pre>
<p>
Resizes the logical size of a VDO volume to the size specified by the <em class="parameter"><code>size</code></em> argument.
This is only a convenience method and it's equivalent to using 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>:Resize method.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>
The new logical size for the VDO volume 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 (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VDOVolume.ResizePhysical"></a><h3>The ResizePhysical() method</h3>
<pre class="programlisting">
ResizePhysical (IN t size,
IN a{sv} options);
</pre>
<p>
Resizes the physical size of a VDO volume to the size specified by the <em class="parameter"><code>size</code></em> argument.
This is only a convenience method and it's equivalent to using 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>:Resize method on the #VDOPool.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>
The new physical size for the VDO volume 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 (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-VDOVolume.GetStatistics"></a><h3>The GetStatistics() method</h3>
<pre class="programlisting">
GetStatistics (IN a{sv} options,
OUT a{ss} stats);
</pre>
<p>
Retrieves statistics for the specified VDO volume. Statistics are collected from the values exposed by the kernel <code class="literal">dm-vdo</code> module.
</p>
<p>
Note: This function will work with the old out-of-tree <code class="literal">kvdo</code> module, but the resulting keys will differ in that case.
</p>
<p>
List of known keys:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">writeAmplificationRatio</span></p></td>
<td><p>The average number of block writes to the underlying storage per block written to the VDO device.</p></td>
</tr>
<tr>
<td><p><span class="term">oneKBlocks</span></p></td>
<td><p>The total number of 1K blocks allocated for a VDO volume (= physical volume size * block size / 1024).</p></td>
</tr>
<tr>
<td><p><span class="term">oneKBlocksUsed</span></p></td>
<td><p>The total number of 1K blocks used on a VDO volume (= physical blocks used * block size / 1024).</p></td>
</tr>
<tr>
<td><p><span class="term">oneKBlocksAvailable</span></p></td>
<td><p>The total number of 1K blocks available on a VDO volume (= physical blocks free * block size / 1024).</p></td>
</tr>
<tr>
<td><p><span class="term">usedPercent</span></p></td>
<td><p>The percentage of physical blocks used on a VDO volume (= used blocks / allocated blocks * 100).</p></td>
</tr>
<tr>
<td><p><span class="term">savings, savingPercent</span></p></td>
<td><p>The percentage of physical blocks saved on a VDO volume (= [logical blocks used - physical blocks used] / logical blocks used).</p></td>
</tr>
<tr>
<td><p><span class="term">fiveTwelveByteEmulation</span></p></td>
<td><p>Indicates whether 512 byte emulation is on or off for the volume.</p></td>
</tr>
<tr>
<td><p><span class="term">allocatorSlabCount</span></p></td>
<td><p>The total number of slabs.</p></td>
</tr>
<tr>
<td><p><span class="term">allocatorSlabsOpened</span></p></td>
<td><p> The total number of slabs from which blocks have ever been allocated.</p></td>
</tr>
<tr>
<td><p><span class="term">allocatorSlabsReopened</span></p></td>
<td><p>The number of times slabs have been re-opened since the VDO was started.</p></td>
</tr>
<tr>
<td><p><span class="term">biosAcknowledgedDiscard, biosAcknowledgedFlush, biosAcknowledgedFua, biosAcknowledgedRead, biosAcknowledgedWrite</span></p></td>
<td><p>The number of block I/O requests acknowledged by VDO.</p></td>
</tr>
<tr>
<td><p><span class="term">biosAcknowledgedPartialDiscard, biosAcknowledgedPartialFlush, biosAcknowledgedPartialFua, biosAcknowledgedPartialRead, biosAcknowledgedPartialWrite</span></p></td>
<td><p>The number of partial block I/O requests acknowledged by VDO. Applies only to 512-byte emulation mode.</p></td>
</tr>
<tr>
<td><p><span class="term">biosInDiscard, biosInFlush, biosInFua, biosInRead, biosInWsrite</span></p></td>
<td><p>The number of block I/O requests received by VDO.</p></td>
</tr>
<tr>
<td><p><span class="term">biosInPartialDiscard, biosInPartialFlush, biosInPartialFua, biosInPartialRead, biosInPartialWrite</span></p></td>
<td><p>The number of partial block I/O requests received by VDO. Applies only to 512-byte emulation mode.</p></td>
</tr>
<tr>
<td><p><span class="term">biosInProgressDiscard, biosInProgressFlush, biosInProgressFua, biosInProgressRead, biosInProgressWrite</span></p></td>
<td><p>The number of bios submitted to the VDO which have not yet been acknowledged.</p></td>
</tr>
<tr>
<td><p><span class="term">biosJournalCompletedDiscard, biosJournalCompletedFlush, biosJournalCompletedFua, biosJournalCompletedRead, biosJournalCompletedWrite</span></p></td>
<td><p>The number of recovery journal block I/O requests completed by the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosJournalDiscard, biosJournalFlush, biosJournalFua, biosJournalRead, biosJournalWrite</span></p></td>
<td><p>The number of recovery journal block I/O requests submitted by VDO to the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosMetaCompletedDiscard, biosMetaCompletedFlush, biosMetaCompletedFua, biosMetaCompletedRead, biosMetaCompletedWrite</span></p></td>
<td><p>The number of metadata block I/O requests completed by the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosMetaDiscard, biosMetaFlush, biosMetaFua, biosMetaRead", biosMetaWrite</span></p></td>
<td><p>The number of metadata block I/O requests submitted by VDO to the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosOutCompletedDiscard, biosOutCompletedFlush, biosOutCompletedFua, biosOutCompletedRead, biosOutCompletedWrite</span></p></td>
<td><p>The number of non-metadata block I/O requests completed by the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosOutDiscard, biosOutFlush, biosOutFua, biosOutRead, biosOutWrite</span></p></td>
<td><p>The number of non-metadata block I/O requests submitted by VDO to the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosPageCacheCompletedDiscard, biosPageCacheCompletedFlush, biosPageCacheCompletedFua, biosPageCacheCompletedRead, biosPageCacheCompletedWrite</span></p></td>
<td><p>The number of block map I/O requests completed by the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">biosPageCachdeDiscard, biosPageCacheFlush, biosPageCacheFua, biosPageCacheRead, biosPageCacheWrite</span></p></td>
<td><p>The number of block map I/O requests submitted by VDO to the storage device.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapCachePressure</span></p></td>
<td><p>The number of times a free page was not available when needed.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapCacheSize</span></p></td>
<td><p>The size of the block map cache, in bytes.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapCleanPages</span></p></td>
<td><p>The number of clean pages in the block map cache.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapDirtyPages</span></p></td>
<td><p>The number of dirty pages in the block map cache.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapDiscardRequired</span></p></td>
<td><p>The total number of block map requests that required a page to be discarded.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFailedPages</span></p></td>
<td><p>The number of block map cache pages that have write errors.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFailedReads</span></p></td>
<td><p>The total number of block map read errors.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFailedWrites</span></p></td>
<td><p>The total number of block map write errors.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFetchRequired</span></p></td>
<td><p>The total number of requests that required a page fetch.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFlushCount</span></p></td>
<td><p>The total number of flushes issued by the block map.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFoundInCache</span></p></td>
<td><p>The total number of block map cache hits.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapFreePages</span></p></td>
<td><p>The number of free pages in the block map cache.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapIncomingPages</span></p></td>
<td><p>The number of block map cache pages that are being read into the cache.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapOutgoingPages</span></p></td>
<td><p>The number of block map cache pages that are being written.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapPagesLoaded</span></p></td>
<td><p>The total number of page fetches.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapPagesSaved</span></p></td>
<td><p>The total number of page saves.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapReadCount</span></p></td>
<td><p>The total number of block map page reads.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapReadOutgoing</span></p></td>
<td><p>The total number of block map reads for pages that were being written.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapReclaimed</span></p></td>
<td><p>The total number of block map pages that were reclaimed.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapWaitForPage</span></p></td>
<td><p>The total number of requests that had to wait for a page.</p></td>
</tr>
<tr>
<td><p><span class="term">blockMapWriteCount</span></p></td>
<td><p>The total number of block map page writes.</p></td>
</tr>
<tr>
<td><p><span class="term">blockSize</span></p></td>
<td><p>The block size of a VDO volume, in bytes.</p></td>
</tr>
<tr>
<td><p><span class="term">completeRecoveries</span></p></td>
<td><p>The number of times a VDO volume has recovered from an unclean shutdown.</p></td>
</tr>
<tr>
<td><p><span class="term">currentVIOsInProgress</span></p></td>
<td><p>The number of I/O requests the VDO is current processing.</p></td>
</tr>
<tr>
<td><p><span class="term">dataBlocksUsed</span></p></td>
<td><p>The number of physical blocks currently in use by a VDO volume to store data.</p></td>
</tr>
<tr>
<td><p><span class="term">dedupeAdviceTimeouts</span></p></td>
<td><p>The number of times deduplication queries timed out.</p></td>
</tr>
<tr>
<td><p><span class="term">errorsInvalidAdvicePBNCount</span></p></td>
<td><p>The number of times the index returned invalid advice.</p></td>
</tr>
<tr>
<td><p><span class="term">errorsNoSpaceErrorCount</span></p></td>
<td><p>The number of write requests which failed due to the VDO volume being out of space.</p></td>
</tr>
<tr>
<td><p><span class="term">errorsReadOnlyErrorCount</span></p></td>
<td><p>The number of write requests which failed due to the VDO volume being in read-only mode.</p></td>
</tr>
<tr>
<td><p><span class="term">flushOut</span></p></td>
<td><p>The number of flush requests submitted by VDO to the underlying storage.</p></td>
</tr>
<tr>
<td><p><span class="term">hashLockConcurrentDataMatches</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">hashLockConcurrentHashCollisions</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">hashLockDedupeAdviceStale</span></p></td>
<td><p>The number of times deduplication advice was incorrect.</p></td>
</tr>
<tr>
<td><p><span class="term">hashLockDedupeAdviceValid</span></p></td>
<td><p>The number of times deduplication advice was correct.</p></td>
</tr>
<tr>
<td><p><span class="term">indexCurrDedupeQueries</span></p></td>
<td><p>The number of deduplication queries currently in flight.</p></td>
</tr>
<tr>
<td><p><span class="term">indexEntriesIndexed</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">indexMaxDedupeQueries</span></p></td>
<td><p>The maximum number of in-flight deduplication queries.</p></td>
</tr>
<tr>
<td><p><span class="term">indexPostsFound</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">indexPostsNotFound</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">indexQueriesFound</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">indexQueriesNotFound</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">indexUpdatesFound</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">indexUpdatesNotFound</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">inRecoveryMode</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">instance</span></p></td>
<td><p>The VDO instance.</p></td>
</tr>
<tr>
<td><p><span class="term">journalBlocksBatching</span></p></td>
<td><p>The number of journal block writes started minus the number of journal blocks written.</p></td>
</tr>
<tr>
<td><p><span class="term">journalBlocksCommitted</span></p></td>
<td><p>The number of journal blocks written to storage.</p></td>
</tr>
<tr>
<td><p><span class="term">journalBlocksStarted</span></p></td>
<td><p>The number of journal blocks which have been touched in memory.</p></td>
</tr>
<tr>
<td><p><span class="term">journalBlocksWriting</span></p></td>
<td><p>The number of journal blocks written (with metadatata in active memory) minus the number of journal blocks committed.</p></td>
</tr>
<tr>
<td><p><span class="term">journalBlocksWritten</span></p></td>
<td><p>The total number of journal blocks for which a write has been issued.</p></td>
</tr>
<tr>
<td><p><span class="term">journalDiskFull</span></p></td>
<td><p>The number of times a request could not make a recovery journal entry because the recovery journal was full.</p></td>
</tr>
<tr>
<td><p><span class="term">journalEntriesBatching</span></p></td>
<td><p>The number of journal entry writes started minus the number of journal entries written.</p></td>
</tr>
<tr>
<td><p><span class="term">journalEntriesCommitted</span></p></td>
<td><p>The number of journal entries written to storage.</p></td>
</tr>
<tr>
<td><p><span class="term">journalEntriesStarted</span></p></td>
<td><p>The number of journal entries which have been made in memory.</p></td>
</tr>
<tr>
<td><p><span class="term">journalEntriesWriting</span></p></td>
<td><p>The number of journal entries in submitted writes minus the number of journal entries committed to storage.</p></td>
</tr>
<tr>
<td><p><span class="term">journalEntriesWritten</span></p></td>
<td><p>The total number of journal entries for which a write has been issued.</p></td>
</tr>
<tr>
<td><p><span class="term">journalSlabJournalCommitsRequested</span></p></td>
<td><p>The number of times the recovery journal requested slab journal commits.</p></td>
</tr>
<tr>
<td><p><span class="term">logicalBlocks</span></p></td>
<td><p>The maximum number of logical blocks that can be mapped by a VDO volume.</p></td>
</tr>
<tr>
<td><p><span class="term">logicalBlockSize</span></p></td>
<td><p></p></td>
</tr>
<tr>
<td><p><span class="term">logicalBlocksUsed</span></p></td>
<td><p>The number of logical blocks currently mapped.</p></td>
</tr>
<tr>
<td><p><span class="term">maxVIOs</span></p></td>
<td><p>The maximum number of simultaneous I/O requests the VDO has processed.</p></td>
</tr>
<tr>
<td><p><span class="term">memoryUsageBiosUsed</span></p></td>
<td><p>KVDO module bios use.</p></td>
</tr>
<tr>
<td><p><span class="term">memoryUsageBytesUsed</span></p></td>
<td><p>KVDO module bytes use.</p></td>
</tr>
<tr>
<td><p><span class="term">memoryUsagePeakBioCount</span></p></td>
<td><p>KVDO module peak bio coun.</p></td>
</tr>
<tr>
<td><p><span class="term">memoryUsagePeakBytesUsed</span></p></td>
<td><p>KVDO module peak bytes use.</p></td>
</tr>
<tr>
<td><p><span class="term">mode</span></p></td>
<td><p>Indicates whether a VDO volume is operating normally, is in recovery mode, or is in read-only mode.</p></td>
</tr>
<tr>
<td><p><span class="term">overheadBlocksUsed</span></p></td>
<td><p>The number of physical blocks currently in use by a VDO volume to store VDO metadata.</p></td>
</tr>
<tr>
<td><p><span class="term">packerCompressedBlocksWritten</span></p></td>
<td><p>The number of physical blocks of compressed data that have been written since the VDO volume was last restarted. The remaining fields are primarily intended for software support and are subject to change in future releases; management tools should not rely upon them.</p></td>
</tr>
<tr>
<td><p><span class="term">packerCompressedFragmentsInPacker</span></p></td>
<td><p>The number of compressed fragments being processed that have not yet been written.</p></td>
</tr>
<tr>
<td><p><span class="term">packerCompressedFragmentsWritten</span></p></td>
<td><p>The number of compressed fragments that have been written since the VDO volume was last restarted.</p></td>
</tr>
<tr>
<td><p><span class="term">physicalBlocks</span></p></td>
<td><p>The total number of physical blocks allocated for a VDO volume.</p></td>
</tr>
<tr>
<td><p><span class="term">readCacheAccesses</span></p></td>
<td><p>The number of times VDO searched the read cache.</p></td>
</tr>
<tr>
<td><p><span class="term">readCachdeDataHits</span></p></td>
<td><p>The number of times VDO found an entry in the read cache for the desired data block, where the block's contents had been read into memory.</p></td>
</tr>
<tr>
<td><p><span class="term">readCacheHits</span></p></td>
<td><p>The number of times VDO found an entry in the read cache for the desired data block, whether or not the block's contents had yet been read into memory.</p></td>
</tr>
<tr>
<td><p><span class="term">readOnlyRecoveries</span></p></td>
<td><p>The number of times a VDO volume has been recovered from read-only mode.</p></td>
</tr>
<tr>
<td><p><span class="term">recoveryPercentage</span></p></td>
<td><p>Indicates online recovery progress (\<code class="constant"></code>), or N/A if the volume is not in recovery mode.</p></td>
</tr>
<tr>
<td><p><span class="term">refCountsBlocksWritten</span></p></td>
<td><p>The number of reference block writes issued.</p></td>
</tr>
<tr>
<td><p><span class="term">slabJournalBlockedCount</span></p></td>
<td><p>The number of times an entry was added to a slab journal that was over the blocking threshold.</p></td>
</tr>
<tr>
<td><p><span class="term">slabJournalBlocksWritten</span></p></td>
<td><p>The number of slab journal block writes issued.</p></td>
</tr>
<tr>
<td><p><span class="term">slabJournalDiskFullCount</span></p></td>
<td><p>The number of times an on-disk slab journal was full.</p></td>
</tr>
<tr>
<td><p><span class="term">slabJournalFlushCount</span></p></td>
<td><p>The number of times an entry was added to a slab journal that was over the flush threshold.</p></td>
</tr>
<tr>
<td><p><span class="term">slabJournalTailBusyCount</span></p></td>
<td><p>The number of times write requests blocked waiting for a slab journal write.</p></td>
</tr>
<tr>
<td><p><span class="term">slabSummaryBlocksWritten</span></p></td>
<td><p>The number of slab summary block writes issued.</p></td>
</tr>
<tr>
<td><p><span class="term">writePolicy</span></p></td>
<td><p>The write policy (sync or async).</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 a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Additional options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT a{ss} <em class="parameter"><code>stats</code></em></code>:</span></p></td>
<td><p>
Array of key-value string pairs
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9.0</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.VDOVolume"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.VDOPool"></a><h3>The "VDOPool" property</h3>
<pre class="programlisting">
VDOPool readable o
</pre>
<p>
Object path of the VDO pool for this volume.
</p>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.OperatingMode"></a><h3>The "OperatingMode" property</h3>
<pre class="programlisting">
OperatingMode readable s
</pre>
<p>
Operating mode of the VDO volume.
</p>
<p>
One of "normal", "read-only" or "recovering".
</p>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.CompressionState"></a><h3>The "CompressionState" property</h3>
<pre class="programlisting">
CompressionState readable s
</pre>
<p>
Compression state of the VDO volume.
</p>
<p>
One of "online" or "offline".
</p>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.IndexState"></a><h3>The "IndexState" property</h3>
<pre class="programlisting">
IndexState readable s
</pre>
<p>
State of the VDO index of the volume.
</p>
<p>
One of "online", "offline", "opening", "closing", "closed"
or "error".
</p>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.UsedSize"></a><h3>The "UsedSize" property</h3>
<pre class="programlisting">
UsedSize readable t
</pre>
<p>
The total physical size used by this VDO volume.
</p>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.Compression"></a><h3>The "Compression" property</h3>
<pre class="programlisting">
Compression readable b
</pre>
<p>
Indicates whether compression is enabled.
</p>
<p class="since">Since 2.9.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-VDOVolume.Deduplication"></a><h3>The "Deduplication" property</h3>
<pre class="programlisting">
Deduplication readable b
</pre>
<p>
Indicates whether deduplication is enabled.
</p>
<p class="since">Since 2.9.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.35.1</div>
</body>
</html>
|
