Debian Codegraph @

modules/lvm2/data/org.freedesktop.UDisks2.lvm2.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
5
6 <!--
7 Copyright (C) 2013 Marius Vollmer <[email protected]>
8 Copyright (C) 2014 Tomas Bzatek <[email protected]>
9
10 This library is free software; you can redistribute it and/or
11 modify it under the terms of the GNU Lesser General Public
12 License as published by the Free Software Foundation; either
13 version 2 of the License, or (at your option) any later version.
14
15 This library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General
21 Public License along with this library; if not, write to the
22 Free Software Foundation, Inc., 59 Temple Place, Suite 330,
23 Boston, MA 02111-1307, USA.
24 -->
25
26 <!-- ********************************************************************** -->
27
28 <!--
29 org.freedesktop.UDisks2.Manager.LVM2:
30 @short_description: LVM2 add-on to the manager singleton
31 @since: 2.0.0
32
33 Additional interface with LVM2 specifics for top-level manager singleton object
34 located at the object path <literal>/org/freedesktop/UDisks2/Manager</literal>.
35 -->
36 <interface name="org.freedesktop.UDisks2.Manager.LVM2">
37 <!-- prereq: org.freedesktop.UDisks2.Manager -->
38
39 <!--
40 VolumeGroupCreate:
41 @name: The name for the volume group.
42 @blocks: The block devices to use as physical volumes, as UDisks2 object paths.
43 @options: Additional options.
44 @result: The object path of the new volume group object.
45 @since: 2.0.0
46
47 Creates a new volume group, using @blocks as the initial
48 physical volumes. Each block device will be wiped and all
49 data on them will be lost.
50
51 You must specify at least one block device to be used as a
52 physical volume.
53
54 No additional options are currently defined.
55 -->
56 <method name="VolumeGroupCreate">
57 <arg name="name" direction="in" type="s"/>
58 <arg name="blocks" direction="in" type="ao"/>
59 <arg name="options" direction="in" type="a{sv}"/>
60 <arg name="result" direction="out" type="o"/>
61 </method>
62
63 </interface>
64
65 <!-- ********************************************************************** -->
66
67 <!--
68 org.freedesktop.UDisks2.Block.LVM2:
69 @short_description: LVM2 add-on to the block device
70 @since: 2.0.0
71
72 Additional interface with LVM2 specifics for a block device.
73 -->
74 <interface name="org.freedesktop.UDisks2.Block.LVM2">
75 <!-- prereq: org.freedesktop.UDisks2.Block -->
76
77 <!-- LogicalVolume:
78 @since: 2.0.0
79 If the block device is a logical volume in a volume group,
80 this is set to the #org.freedesktop.UDisks2.LogicalVolume
81 object that it corresponds to. It is '/' otherwise.
82 -->
83 <property name="LogicalVolume" type="o" access="read"/>
84
85 </interface>
86
87 <!-- ********************************************************************** -->
88
89 <!--
90 org.freedesktop.UDisks2.PhysicalVolume:
91 @short_description: Block device that is a physical volume
92 @since: 2.0.0
93
94 This interface is used for #org.freedesktop.UDisks2.Block
95 devices that are physical volumes in a volume group.
96 -->
97 <interface name="org.freedesktop.UDisks2.PhysicalVolume">
98 <!-- prereq: org.freedesktop.UDisks2.Block -->
99 <property name="VolumeGroup" type="o" access="read"/>
100 <property name="Size" type="t" access="read"/>
101 <property name="FreeSize" type="t" access="read"/>
102 </interface>
103
104 <!-- ********************************************************************** -->
105 <!--
106 org.freedesktop.UDisks2.VolumeGroup:
107 @short_description: A volume group
108 @since: 2.0.0
109
110 Objects implementing this interface represent LVM2 volume
111 groups. They appear under /org/freedesktop/UDisks2/lvm/.
112
113 The logical volume objects of a volume group are the children of
114 the volume group objects in the D-Bus object hierarchy. See the
115 #org.freedesktop.UDisks2.LogicalVolume interface.
116
117 The physical volume objects of a volume group can be found by
118 looking for block devices with a
119 #org.freedesktop.UDisks2.PhysicalVolume.VolumeGroup property
120 that points to the volume group object.
121 -->
122 <interface name="org.freedesktop.UDisks2.VolumeGroup">
123 <!-- Name:
124
125 The name of this volume group, as known to LVM2.
126 -->
127 <property name="Name" type="s" access="read"/>
128
129 <!-- UUID:
130
131 The UUID this volume group. It is guaranteed to be unique,
132 but it might change over time.
133 -->
134 <property name="UUID" type="s" access="read"/>
135
136 <!-- Size:
137
138 The total capacity of this volume group, in bytes.
139 -->
140 <property name="Size" type="t" access="read"/>
141
142 <!-- FreeSize:
143
144 The unused capacity of this volume group, in bytes.
145 -->
146 <property name="FreeSize" type="t" access="read"/>
147
148 <!-- ExtentSize:
149
150 The size of extents. When creating and resizing logical
151 volumes, sizes are rounded up to multiples of the extent
152 size.
153 -->
154 <property name="ExtentSize" type="t" access="read"/>
155
156 <!-- NeedsPolling:
157
158 Whether or not this volume group needs to be periodically
159 polled to guarantee updates.
160 -->
161 <property name="NeedsPolling" type="b" access="read"/>
162
163 <!-- MissingPhysicalVolumes:
164 @since: 2.10.0
165
166 A list of the UUIDs of missing physical volumes.
167 -->
168 <property name="MissingPhysicalVolumes" type="as" access="read"/>
169
170 <!-- Poll:
171
172 Make sure that all properties of this volume group and of all
173 their logical and physical volumes are up-to-date.
174
175 The properties are not guaranteed to be up-to-date yet when
176 this method returns.
177 -->
178 <method name="Poll">
179 </method>
180
181 <!-- Delete:
182 @wipe: Whether to wipe the volume group.
183 @options: Additional options.
184
185 Delete this volume group. All its logical volumes will be
186 deleted, too.
187
188 If the option <parameter>tear-down</parameter> is set to
189 %TRUE, then all logical volumes will be cleaned up before
190 deletion. This cleanup consists of removing entries from
191 /etc/fstab and /etc/crypttab, and locking of encrypted block
192 devices. Entries in /etc/fstab and /etc/crypttab that have
193 been created with the 'track-parents' options to
194 AddConfigurationItem will be removed even if their block
195 device is currently unavailable.
196 -->
197 <method name="Delete">
198 <arg name="wipe" type="b" direction="in"/>
199 <arg name="options" direction="in" type="a{sv}"/>
200 </method>
201
202 <!-- Rename:
203 @new_name: The new name.
204 @options: Additional options.
205 @result: The new object path.
206
207 Rename this volume group. This might cause the volume group
208 object to disappear from D-Bus and reappear with a different
209 path.
210
211 No additional options are currently defined.
212 -->
213 <method name="Rename">
214 <arg name="new_name" type="s" direction="in"/>
215 <arg name="options" direction="in" type="a{sv}"/>
216 <arg name="result" type="o" direction="out"/>
217 </method>
218
219 <!-- AddDevice:
220 @block: The block device to add, as a UDisks2 object path.
221 @options: Additional options.
222
223 Add a new physical volume to the volume group. The block
224 device will be wiped and all data on it will be lost.
225 -->
226 <method name="AddDevice">
227 <arg name="block" type="o" direction="in"/>
228 <arg name="options" direction="in" type="a{sv}"/>
229 </method>
230
231 <!-- EmptyDevice:
232 @block: The block device to empty, as a UDisks2 object path.
233 @options: Additional options.
234
235 Move all data on the given block device somewhere else so
236 that the block device might be removed.
237
238 No additional options are currently defined.
239 -->
240 <method name="EmptyDevice">
241 <arg name="block" type="o" direction="in"/>
242 <arg name="options" direction="in" type="a{sv}"/>
243 </method>
244
245 <!-- RemoveDevice:
246 @block: The block device to remove, as a UDisks2 object path.
247 @wipe: Whether to wipe the physical volume.
248 @options: Additional options.
249
250 Remove the indicated physical volume from the volume group.
251 The physical device must be unused.
252
253 No additional options are currently defined.
254 -->
255 <method name="RemoveDevice">
256 <arg name="block" type="o" direction="in"/>
257 <arg name="wipe" type="b" direction="in"/>
258 <arg name="options" direction="in" type="a{sv}"/>
259 </method>
260
261 <!-- RemoveMissingPhysicalVolumes:
262 @since: 2.10.0
263
264 Forget about all physical volumes that went missing.
265
266 No additional options are currently defined.
267 -->
268 <method name="RemoveMissingPhysicalVolumes">
269 <arg name="options" direction="in" type="a{sv}"/>
270 </method>
271
272 <!-- CreatePlainVolume:
273 @name: The name of the new logical volume.
274 @size: The size.
275 @options: Additional options.
276 @result: The object path of the new logical volume.
277
278 Create a 'normal' new logical volume. Calling this method is
279 equivalent to calling CreatePlainVolumeWithLayout with
280 "linear" as the layout type and an empty array of physical
281 volumes.
282
283 No additional options are currently defined.
284 -->
285 <method name="CreatePlainVolume">
286 <arg name="name" type="s" direction="in"/>
287 <arg name="size" type="t" direction="in"/>
288 <arg name="options" type="a{sv}" direction="in"/>
289 <arg name="result" type="o" direction="out"/>
290 </method>
291
292 <!-- CreatePlainVolumeWithLayout:
293 @name: The name of the new logical volume.
294 @size: The size.
295 @layout: The layout type, like "linear", "raid5"
296 @pvs: The physical volumes to use
297 @options: Additional options.
298 @result: The object path of the new logical volume.
299 @since: 2.10.0
300
301 Create a 'normal' new logical volume with the given layout
302 type on the given physical volumes. It is okay to leave
303 "pvs" empty; LVM2 will then choose suitable ones on its own.
304
305 If "pvs" is not empty and the given "layout" uses subvolumes
306 (like all the raid variants), then this method will create
307 exactly one subvolume for each given physical volume.
308
309 For example, when "layout" is "raid5" and "pvs" contains four
310 entries, then this method will have the same effect as
311 "lvcreate &#45;-type raid5 &#45;-stripes 3 ...": The resulting logical volume
312 will have four subvolumes.
313
314 The "subvolumes" (i) option can be used to override the
315 number of subvolumes. The consequences of this are hard to
316 predict and might also lead to creation of logical volumes
317 that have less redundancy than expected, so it is best to
318 always create exactly one subvolume per physical volume.
319
320 Note again that this only happens when "pvs" is not empty.
321 When "pvs" is empty, LVM2 will decide how many subvolumes to
322 create.
323 -->
324 <method name="CreatePlainVolumeWithLayout">
325 <arg name="name" type="s" direction="in"/>
326 <arg name="size" type="t" direction="in"/>
327 <arg name="layout" type="s" direction="in"/>
328 <arg name="pvs" type="ao" direction="in"/>
329 <arg name="options" type="a{sv}" direction="in"/>
330 <arg name="result" type="o" direction="out"/>
331 </method>
332
333 <!-- CreateThinPoolVolume:
334 @name: The name of the new logical volume.
335 @size: The total size.
336 @options: Additional options.
337 @result: The object path of the new logical volume.
338
339 Create a new logical volume that can be used to back
340 thinly-provisioned logical volumes. The @size parameter is
341 the total amount of space taken out of the volume group.
342 That space will be used for data and metadata. The actual
343 amount of data that can be stored in the pool will be
344 slightly smaller.
345
346 No additional options are currently defined.
347 -->
348 <method name="CreateThinPoolVolume">
349 <arg name="name" type="s" direction="in"/>
350 <arg name="size" type="t" direction="in"/>
351 <arg name="options" type="a{sv}" direction="in"/>
352 <arg name="result" type="o" direction="out"/>
353 </method>
354
355 <!-- CreateThinVolume:
356 @name: The name of the new logical volume.
357 @size: The virtual size.
358 @pool: The thin pool to use.
359 @options: Additional options.
360 @result: The object path of the new logical volume.
361
362 Create a new thinly provisioned logical volume in the given
363 pool.
364
365 No additional options are currently defined.
366 -->
367 <method name="CreateThinVolume">
368 <arg name="name" type="s" direction="in"/>
369 <arg name="size" type="t" direction="in"/>
370 <arg name="pool" type="o" direction="in"/>
371 <arg name="options" type="a{sv}" direction="in"/>
372 <arg name="result" type="o" direction="out"/>
373 </method>
374
375 <!-- CreateVDOVolume:
376 @lv_name: The name of the to-be-created VDO LV.
377 @pool_name: The name of the to-be-created VDO pool LV or an empty string for a default name.
378 @data_size: The size of the data VDO LV (physical size of the @pool_name VDO pool LV).
379 @virtual_size: The virtual_size of the @lv_name VDO LV or 0 for default (@data_size minus metadata).
380 @index_memory: Amount of index memory in bytes or 0 for default.
381 @compression: Enables or disables compression when creating the VDO volume.
382 @deduplication: Enables or disables deduplication when creating the VDO volume.
383 @write_policy: Specifies the write policy.
384 @options: Additional options.
385 @result: The object path of the new VDO logical volume.
386 @since: 2.9.0
387
388 Create a new VDO logical volume that is backed by a newly created
389 VDO pool. The VDO data logical volume and VDO pool logical volume
390 are created together, VDO pool supports only a single VDO LV.
391 The @data_size parameter is the total amount of space
392 taken out of the volume group and it's the size of the @pool_name
393 VDO pool logical volume.
394 The @virtual_size is the size of the @lv_name VDO logical volume
395 and represents expected amount of the data that can be stored
396 after deduplication and compression.
397
398 No additional options are currently defined.
399
400 Known @write_policy values include:
401 <variablelist>
402 <varlistentry><term>sync</term><listitem><para>Writes are acknowledged only after data is on stable storage. 'sync' policy is not supported if the underlying storage is not also synchronous.</para></listitem></varlistentry>
403 <varlistentry><term>async</term><listitem><para>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.</para></listitem></varlistentry>
404 <varlistentry><term>auto</term><listitem><para>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.</para></listitem></varlistentry>
405 </variablelist>
406 -->
407 <method name="CreateVDOVolume">
408 <arg name="lv_name" type="s" direction="in"/>
409 <arg name="pool_name" type="s" direction="in"/>
410 <arg name="data_size" type="t" direction="in"/>
411 <arg name="virtual_size" type="t" direction="in"/>
412 <arg name="index_memory" type="t" direction="in" />
413 <arg name="compression" type="b" direction="in" />
414 <arg name="deduplication" type="b" direction="in" />
415 <arg name="write_policy" type="s" direction="in" />
416 <arg name="options" type="a{sv}" direction="in"/>
417 <arg name="result" type="o" direction="out"/>
418 <annotation name="org.gtk.GDBus.C.Name" value="Create_VDO_Volume"/>
419 </method>
420
421 </interface>
422
423 <!-- ********************************************************************** -->
424
425 <!--
426 org.freedesktop.UDisks2.LogicalVolume:
427 @short_description: A logical volume
428 @since: 2.0.0
429
430 Objects with this interface represent logical volumes in a
431 volume group. Active logical volumes are associated with a
432 block device, which link back to the logical volume object via
433 their #org.freedesktop.UDisks2.Block.LVM2:LogicalVolume property.
434
435 Logical volume objects are children of their volume group
436 object, and also link to it via the #VolumeGroup property.
437 -->
438 <interface name="org.freedesktop.UDisks2.LogicalVolume">
439
440 <!-- VolumeGroup:
441
442 The path of the volume group object that this logical volume
443 belongs to.
444 -->
445 <property name="VolumeGroup" type="o" access="read"/>
446
447 <!-- Name:
448
449 The name of this logical volume, as it is known to LVM2.
450 -->
451 <property name="Name" type="s" access="read"/>
452
453 <!-- Active:
454
455 Whether or not this volume is active.
456 -->
457 <property name="Active" type="b" access="read"/>
458
459 <!-- UUID:
460
461 The UUID of this logical volume. It is guaranteed to be
462 unique within the group, but it might change over time.
463 -->
464 <property name="UUID" type="s" access="read"/>
465
466 <!-- Size:
467
468 The total size of this logical volume in bytes, including the
469 size of the metadata.
470 -->
471 <property name="Size" type="t" access="read"/>
472
473 <!-- DataAllocatedRatio:
474
475 For a thin pool or a non-thin snapshot, indicates how full
476 the area for storing data is. A value of 1.0 corresponds to
477 100%.
478 -->
479 <property name="DataAllocatedRatio" type="d" access="read"/>
480
481 <!-- MetadataAllocatedRatio:
482
483 For a thin pool or a non-thin snapshot, indicates how full
484 the area for storing meta data is. A value of 1.0
485 corresponds to 100%.
486 -->
487 <property name="MetadataAllocatedRatio" type="d" access="read"/>
488
489 <!-- Type:
490
491 The general type of a logical volume. One of "block", "pool"
492 or "vdopool". More types might be defined in the future.
493
494 A volume of type "block" can be used as a block device. A
495 volume of type "pool" can be used to create thin volumes.
496 A volume of type "vdopool" is the internal pool for the
497 VDO logical volume device.
498 -->
499 <property name="Type" type="s" access="read"/>
500
501 <!-- Layout:
502 @since: 2.10.0
503
504 The layout of this logical volume, such as "linear", "raid5",
505 etc.
506 -->
507 <property name="Layout" type="s" access="read"/>
508
509 <!-- Structure:
510 @since: 2.10.0
511
512 The detailed structure of how this logical volume is stored on physical volumes.
513
514 The following fields are present:
515
516 - name (s): The name of the logical volume.
517 - type (s): The layout type of the logical volume.
518 - size (t): The size in bytes of the logical volume.
519
520 If the logical volume is stored directly on physical volumes,
521 this field is present as well:
522
523 - segs (a(tto)): Information about the segments of the logical volume (see below).
524
525 A segment is represented by a "(tto)" tuple, where the fields
526 have these meanings:
527
528 - (t): The start of this segement on the physical volume, in bytes.
529 - (t): The size of the segment, in bytes.
530 - (o): The path of the org.freedesktop.UDisks.Block object of the physical volume.
531
532 For a healthy logical volume, the sizes of its segments will
533 add up exactly to its own size. If a volume group has lost
534 some physical volumes, a affected logical volume will have a
535 list of segments here that do not add up to its full size.
536
537 If the logical volume is stored on other logical volumes,
538 these fields are present in the "Structure" value instead of
539 "segs":
540
541 - data (aa{sv}): The list of "Structure" objects for the data sub-volumes.
542 - metadata (aa{sv}): The list of "Structure" objects for the metadata sub-volumes.
543
544 For example, a minimal "raid5" layout will have three "data"
545 sub-volumes (and three parallel "metadata" sub-volumes),
546 which are the three stripes of the RAID configuration. Each
547 of those sub-volume will be stored directly on physical
548 volumes and one can inspect the "segs" field of those to
549 figure out how many are damaged. From that, one can deduce
550 whether the RAID is degraded (exactly one damaged), or has
551 lost data (more than one damaged).
552 -->
553 <property name="Structure" type="a{sv}" access="read"/>
554
555 <!-- SyncRatio:
556 @since: 2.10.0
557
558 How far along the logical volume is with resynchronizing. A
559 value of 1.0 corresponds to fully synchronized and indicates
560 that no operation is in progress. This is only relevant for
561 logical volumes with some redundancy, like "raid1" or
562 "raid5".
563 -->
564 <property name="SyncRatio" type="d" access="read"/>
565
566 <!-- ThinPool:
567
568 For a thin volume, the object path of its pool.
569 -->
570 <property name="ThinPool" type="o" access="read"/>
571
572 <!-- Origin:
573
574 For a snapshot, the object path of its origin.
575 -->
576 <property name="Origin" type="o" access="read"/>
577
578 <!-- ChildConfiguration: Configuration items belonging to the
579 block device of this logical volume and its children. This
580 is also valid when this logical volume is not currently
581 active and there is no block device for it. It works via the
582 'track-parents' options of
583 org.freedesktop.UDisks2.Block.AddConfigurationItem(), which
584 see.
585 -->
586 <property name="ChildConfiguration" type="a(sa{sv})" access="read"/>
587
588 <!-- BlockDevice:
589 @since: 2.7.1
590
591 For an active LV, the object path of its block device.
592 -->
593 <property name="BlockDevice" type="o" access="read"/>
594
595 <!-- Activate:
596 @options: Additional options.
597 @result: The UDisks2 object path of the block device.
598
599 Activate this logical volume, which makes it appear as a
600 block device in the system.
601
602 Non-thin snapshots are always activated and deactivated
603 together with their origins.
604
605 No additional options are currently defined.
606 -->
607 <method name="Activate">
608 <arg name="options" direction="in" type="a{sv}"/>
609 <arg name="result" type="o" direction="out"/>
610 </method>
611
612 <!-- Deactivate:
613 @options: Additional options.
614
615 Deactivate this logical volume, which makes its block device
616 disappear.
617
618 Non-thin snapshots are always activated and deactivated
619 together with their origins.
620
621 No additional options are currently defined.
622 -->
623 <method name="Deactivate">
624 <arg name="options" direction="in" type="a{sv}"/>
625 </method>
626
627 <!-- Delete:
628 @options: Additional options.
629
630 Delete this logical volume.
631
632 If there are any non-thin snapshots of this logical volume,
633 they will be deleted as well.
634
635 If this is a thin pool, all its contained thin volumes will
636 be deleted as well.
637
638 If the option <parameter>tear-down</parameter> is set to
639 %TRUE, then the logical volume and all its children will be
640 cleaned up before deletion. This cleanup consists of
641 removing entries from /etc/fstab and /etc/crypttab, and
642 locking of encrypted block devices. Entries in /etc/fstab
643 and /etc/crypttab that have been created with the
644 'track-parents' options to AddConfigurationItem will be
645 removed even if their block device is currently unavailable.
646 -->
647 <method name="Delete">
648 <arg name="options" direction="in" type="a{sv}"/>
649 </method>
650
651 <!-- Rename:
652 @new_name: The new name.
653 @options: Additional options.
654 @result: The new object path.
655
656 Rename this logical volume. This might cause the logical
657 volume object to disappear from D-Bus and reappear with a
658 different path.
659
660 No additional options are currently defined.
661 -->
662 <method name="Rename">
663 <arg name="new_name" type="s" direction="in"/>
664 <arg name="options" direction="in" type="a{sv}"/>
665 <arg name="result" type="o" direction="out"/>
666 </method>
667
668 <!-- Resize:
669 @new_size: The new size, in bytes.
670 @options: Additional options.
671
672 Resize this logical volume.
673
674 Additional options:
675
676 resize_fsys (b): Whether to resize the filesystem on the
677 logical volume as well. Default to 'false'.
678
679 force (b): Whether to force the resize even if it might
680 destroy data.
681
682 pvs (ao): A list of physical volumes to allocate more space
683 from.
684 -->
685 <method name="Resize">
686 <arg name="new_size" type="t" direction="in"/>
687 <arg name="options" type="a{sv}" direction="in"/>
688 </method>
689
690 <!-- Repair:
691 @pvs: A list of physical volumes to use for the repair.
692 @options: Additional options.
693 @since: 2.10.0
694
695 Attempt a repair of this logical volume after it has lost
696 some physical volumes. Space is allocated from the given
697 physical volumes as needed. A empty list means to allocate
698 from all physical volumes.
699
700 No additional options are currently defined.
701 -->
702 <method name="Repair">
703 <arg name="pvs" type="ao" direction="in"/>
704 <arg name="options" direction="in" type="a{sv}"/>
705 </method>
706
707 <!-- CreateSnapshot:
708 @name: The name of the snapshot.
709 @size: The size of the backing store for the snapshot, in bytes.
710 @options: Additional options.
711
712 Create a snapshot of this logical volume.
713
714 When creating a snapshot of a non-thin volume, a non-zero
715 size must be specified. A non-thin snapshot is created in
716 this case.
717
718 When creating a snapshot of a thin volume, specifying a @size
719 of zero will create a thin snapshot in the same pool.
720
721 When creating a snapshot of a thin volume, specifying a
722 non-zero @size will create a non-thin snapshot.
723
724 No additional options are currently defined.
725 -->
726 <method name="CreateSnapshot">
727 <arg name="name" type="s" direction="in"/>
728 <arg name="size" type="t" direction="in"/>
729 <arg name="options" type="a{sv}" direction="in"/>
730 <arg name="result" type="o" direction="out"/>
731 </method>
732
733 <!-- CacheAttach:
734 @cache_name: The name of an existing volume.
735 @options: Additional options.
736 @since: 2.3.0
737
738 Creates cache LV. Logical volume which name is provided, will be formatted, converted to cache type
739 and attached to origin logical volume as a cache pool LV. Logical volumes must be in the same volume group.
740
741 No additional options are currently defined.
742 -->
743 <method name="CacheAttach">
744 <arg name="cache_name" type="s" direction="in"/>
745 <arg name="options" type= "a{sv}" direction="in"/>
746 </method>
747
748 <!-- CacheSplit:
749 @options: Additional options.
750 @since: 2.3.0
751
752 Splits Cache LV to Cache pool LV and Origin LV, not afeecting its content.
753
754 No additional options are currently defined.
755 -->
756 <method name="CacheSplit">
757 <arg name="options" type= "a{sv}" direction="in"/>
758 </method>
759
760 <!-- CacheDetach:
761 @options: Additional options.
762 @since: 2.6.3
763
764 Detaches the cached LV from its cache.
765
766 No additional options are currently defined.
767 -->
768 <method name="CacheDetach">
769 <arg name="options" type= "a{sv}" direction="in"/>
770 </method>
771
772 </interface>
773
774 <!-- ********************************************************************** -->
775
776 <!--
777 org.freedesktop.UDisks2.VDOVolume:
778 @short_description: A VDO logical volume
779 @since: 2.9.0
780
781 Objects with this interface represent VDO logical volumes in a
782 volume group.
783
784 VDO logical volume objects are children of their VDO pool
785 object, and also link to it via the #VDOPool property.
786 -->
787 <interface name="org.freedesktop.UDisks2.VDOVolume">
788 <annotation name="org.gtk.GDBus.C.Name" value="VDO_Volume"/>
789
790 <!-- VDOPool:
791
792 Object path of the VDO pool for this volume.
793 -->
794
795 <property name="VDOPool" type="o" access="read">
796 <annotation name="org.gtk.GDBus.C.Name" value="VDO_Pool"/>
797 </property>
798
799 <!-- OperatingMode:
800
801 Operating mode of the VDO volume.
802
803 One of "normal", "read-only" or "recovering".
804 -->
805 <property name="OperatingMode" type="s" access="read"/>
806
807 <!-- CompressionState:
808
809 Compression state of the VDO volume.
810
811 One of "online" or "offline".
812 -->
813 <property name="CompressionState" type="s" access="read"/>
814
815 <!-- IndexState:
816
817 State of the VDO index of the volume.
818
819 One of "online", "offline", "opening", "closing", "closed"
820 or "error".
821 -->
822 <property name="IndexState" type="s" access="read"/>
823
824 <!-- UsedSize:
825
826 The total physical size used by this VDO volume.
827 -->
828 <property name="UsedSize" type="t" access="read"/>
829
830 <!-- Compression:
831
832 Indicates whether compression is enabled.
833 -->
834 <property name="Compression" type="b" access="read" />
835
836 <!-- Deduplication:
837
838 Indicates whether deduplication is enabled.
839 -->
840 <property name="Deduplication" type="b" access="read" />
841
842 <!--
843 EnableCompression:
844 @enable: A boolean value indicating whether compression should be enabled.
845 @options: Additional options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
846
847 Enables or disables compression on the VDO volume. If the VDO volume
848 is running, takes effect immediately.
849 -->
850 <method name="EnableCompression">
851 <arg name="enable" direction="in" type="b" />
852 <arg name="options" direction="in" type="a{sv}" />
853 </method>
854
855 <!--
856 EnableDeduplication:
857 @enable: A boolean value indicating whether deduplication should be enabled.
858 @options: Additional options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
859
860 Enables or disables deduplication on the VDO volume. If the VDO volume
861 is running, takes effect immediately.
862 -->
863 <method name="EnableDeduplication">
864 <arg name="enable" direction="in" type="b" />
865 <arg name="options" direction="in" type="a{sv}" />
866 </method>
867
868 <!--
869 ResizeLogical:
870 @size: The new logical size for the VDO volume in bytes.
871 @options: Additional options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
872
873 Resizes the logical size of a VDO volume to the size specified by the @size argument.
874 This is only a convenience method and it's equivalent to using the
875 #org.freedesktop.UDisks2.LogicalVolume:Resize method.
876 -->
877 <method name="ResizeLogical">
878 <arg name="size" direction="in" type="t" />
879 <arg name="options" direction="in" type="a{sv}" />
880 </method>
881
882 <!--
883 ResizePhysical:
884 @size: The new physical size for the VDO volume in bytes.
885 @options: Additional options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
886
887 Resizes the physical size of a VDO volume to the size specified by the @size argument.
888 This is only a convenience method and it's equivalent to using the
889 #org.freedesktop.UDisks2.LogicalVolume:Resize method on the #VDOPool.
890 -->
891 <method name="ResizePhysical">
892 <arg name="size" direction="in" type="t" />
893 <arg name="options" direction="in" type="a{sv}" />
894 </method>
895
896 <!--
897 GetStatistics:
898 @options: Additional options (currently unused except for <link linkend="udisks-std-options">standard options</link>).
899 @stats: Array of key-value string pairs
900
901 Retrieves statistics for the specified VDO volume. Statistics are collected from the values exposed by the kernel <literal>dm-vdo</literal> module.
902
903 Note: This function will work with the old out-of-tree <literal>kvdo</literal> module, but the resulting keys will differ in that case.
904
905 List of known keys:
906 <variablelist>
907 <varlistentry><term>writeAmplificationRatio</term><listitem><para>The average number of block writes to the underlying storage per block written to the VDO device.</para></listitem></varlistentry>
908 <varlistentry><term>oneKBlocks</term><listitem><para>The total number of 1K blocks allocated for a VDO volume (= physical volume size * block size / 1024).</para></listitem></varlistentry>
909 <varlistentry><term>oneKBlocksUsed</term><listitem><para>The total number of 1K blocks used on a VDO volume (= physical blocks used * block size / 1024).</para></listitem></varlistentry>
910 <varlistentry><term>oneKBlocksAvailable</term><listitem><para>The total number of 1K blocks available on a VDO volume (= physical blocks free * block size / 1024).</para></listitem></varlistentry>
911 <varlistentry><term>usedPercent</term><listitem><para>The percentage of physical blocks used on a VDO volume (= used blocks / allocated blocks * 100).</para></listitem></varlistentry>
912 <varlistentry><term>savings, savingPercent</term><listitem><para>The percentage of physical blocks saved on a VDO volume (= [logical blocks used - physical blocks used] / logical blocks used).</para></listitem></varlistentry>
913 <varlistentry><term>fiveTwelveByteEmulation</term><listitem><para>Indicates whether 512 byte emulation is on or off for the volume.</para></listitem></varlistentry>
914 <varlistentry><term>allocatorSlabCount</term><listitem><para>The total number of slabs.</para></listitem></varlistentry>
915 <varlistentry><term>allocatorSlabsOpened</term><listitem><para> The total number of slabs from which blocks have ever been allocated.</para></listitem></varlistentry>
916 <varlistentry><term>allocatorSlabsReopened</term><listitem><para>The number of times slabs have been re-opened since the VDO was started.</para></listitem></varlistentry>
917 <varlistentry><term>biosAcknowledgedDiscard, biosAcknowledgedFlush, biosAcknowledgedFua, biosAcknowledgedRead, biosAcknowledgedWrite</term><listitem><para>The number of block I/O requests acknowledged by VDO.</para></listitem></varlistentry>
918 <varlistentry><term>biosAcknowledgedPartialDiscard, biosAcknowledgedPartialFlush, biosAcknowledgedPartialFua, biosAcknowledgedPartialRead, biosAcknowledgedPartialWrite</term><listitem><para>The number of partial block I/O requests acknowledged by VDO. Applies only to 512-byte emulation mode.</para></listitem></varlistentry>
919 <varlistentry><term>biosInDiscard, biosInFlush, biosInFua, biosInRead, biosInWsrite</term><listitem><para>The number of block I/O requests received by VDO.</para></listitem></varlistentry>
920 <varlistentry><term>biosInPartialDiscard, biosInPartialFlush, biosInPartialFua, biosInPartialRead, biosInPartialWrite</term><listitem><para>The number of partial block I/O requests received by VDO. Applies only to 512-byte emulation mode.</para></listitem></varlistentry>
921 <varlistentry><term>biosInProgressDiscard, biosInProgressFlush, biosInProgressFua, biosInProgressRead, biosInProgressWrite</term><listitem><para>The number of bios submitted to the VDO which have not yet been acknowledged.</para></listitem></varlistentry>
922 <varlistentry><term>biosJournalCompletedDiscard, biosJournalCompletedFlush, biosJournalCompletedFua, biosJournalCompletedRead, biosJournalCompletedWrite</term><listitem><para>The number of recovery journal block I/O requests completed by the storage device.</para></listitem></varlistentry>
923 <varlistentry><term>biosJournalDiscard, biosJournalFlush, biosJournalFua, biosJournalRead, biosJournalWrite</term><listitem><para>The number of recovery journal block I/O requests submitted by VDO to the storage device.</para></listitem></varlistentry>
924 <varlistentry><term>biosMetaCompletedDiscard, biosMetaCompletedFlush, biosMetaCompletedFua, biosMetaCompletedRead, biosMetaCompletedWrite</term><listitem><para>The number of metadata block I/O requests completed by the storage device.</para></listitem></varlistentry>
925 <varlistentry><term>biosMetaDiscard, biosMetaFlush, biosMetaFua, biosMetaRead", biosMetaWrite</term><listitem><para>The number of metadata block I/O requests submitted by VDO to the storage device.</para></listitem></varlistentry>
926 <varlistentry><term>biosOutCompletedDiscard, biosOutCompletedFlush, biosOutCompletedFua, biosOutCompletedRead, biosOutCompletedWrite</term><listitem><para>The number of non-metadata block I/O requests completed by the storage device.</para></listitem></varlistentry>
927 <varlistentry><term>biosOutDiscard, biosOutFlush, biosOutFua, biosOutRead, biosOutWrite</term><listitem><para>The number of non-metadata block I/O requests submitted by VDO to the storage device.</para></listitem></varlistentry>
928 <varlistentry><term>biosPageCacheCompletedDiscard, biosPageCacheCompletedFlush, biosPageCacheCompletedFua, biosPageCacheCompletedRead, biosPageCacheCompletedWrite</term><listitem><para>The number of block map I/O requests completed by the storage device.</para></listitem></varlistentry>
929 <varlistentry><term>biosPageCachdeDiscard, biosPageCacheFlush, biosPageCacheFua, biosPageCacheRead, biosPageCacheWrite</term><listitem><para>The number of block map I/O requests submitted by VDO to the storage device.</para></listitem></varlistentry>
930 <varlistentry><term>blockMapCachePressure</term><listitem><para>The number of times a free page was not available when needed.</para></listitem></varlistentry>
931 <varlistentry><term>blockMapCacheSize</term><listitem><para>The size of the block map cache, in bytes.</para></listitem></varlistentry>
932 <varlistentry><term>blockMapCleanPages</term><listitem><para>The number of clean pages in the block map cache.</para></listitem></varlistentry>
933 <varlistentry><term>blockMapDirtyPages</term><listitem><para>The number of dirty pages in the block map cache.</para></listitem></varlistentry>
934 <varlistentry><term>blockMapDiscardRequired</term><listitem><para>The total number of block map requests that required a page to be discarded.</para></listitem></varlistentry>
935 <varlistentry><term>blockMapFailedPages</term><listitem><para>The number of block map cache pages that have write errors.</para></listitem></varlistentry>
936 <varlistentry><term>blockMapFailedReads</term><listitem><para>The total number of block map read errors.</para></listitem></varlistentry>
937 <varlistentry><term>blockMapFailedWrites</term><listitem><para>The total number of block map write errors.</para></listitem></varlistentry>
938 <varlistentry><term>blockMapFetchRequired</term><listitem><para>The total number of requests that required a page fetch.</para></listitem></varlistentry>
939 <varlistentry><term>blockMapFlushCount</term><listitem><para>The total number of flushes issued by the block map.</para></listitem></varlistentry>
940 <varlistentry><term>blockMapFoundInCache</term><listitem><para>The total number of block map cache hits.</para></listitem></varlistentry>
941 <varlistentry><term>blockMapFreePages</term><listitem><para>The number of free pages in the block map cache.</para></listitem></varlistentry>
942 <varlistentry><term>blockMapIncomingPages</term><listitem><para>The number of block map cache pages that are being read into the cache.</para></listitem></varlistentry>
943 <varlistentry><term>blockMapOutgoingPages</term><listitem><para>The number of block map cache pages that are being written.</para></listitem></varlistentry>
944 <varlistentry><term>blockMapPagesLoaded</term><listitem><para>The total number of page fetches.</para></listitem></varlistentry>
945 <varlistentry><term>blockMapPagesSaved</term><listitem><para>The total number of page saves.</para></listitem></varlistentry>
946 <varlistentry><term>blockMapReadCount</term><listitem><para>The total number of block map page reads.</para></listitem></varlistentry>
947 <varlistentry><term>blockMapReadOutgoing</term><listitem><para>The total number of block map reads for pages that were being written.</para></listitem></varlistentry>
948 <varlistentry><term>blockMapReclaimed</term><listitem><para>The total number of block map pages that were reclaimed.</para></listitem></varlistentry>
949 <varlistentry><term>blockMapWaitForPage</term><listitem><para>The total number of requests that had to wait for a page.</para></listitem></varlistentry>
950 <varlistentry><term>blockMapWriteCount</term><listitem><para>The total number of block map page writes.</para></listitem></varlistentry>
951 <varlistentry><term>blockSize</term><listitem><para>The block size of a VDO volume, in bytes.</para></listitem></varlistentry>
952 <varlistentry><term>completeRecoveries</term><listitem><para>The number of times a VDO volume has recovered from an unclean shutdown.</para></listitem></varlistentry>
953 <varlistentry><term>currentVIOsInProgress</term><listitem><para>The number of I/O requests the VDO is current processing.</para></listitem></varlistentry>
954 <varlistentry><term>dataBlocksUsed</term><listitem><para>The number of physical blocks currently in use by a VDO volume to store data.</para></listitem></varlistentry>
955 <varlistentry><term>dedupeAdviceTimeouts</term><listitem><para>The number of times deduplication queries timed out.</para></listitem></varlistentry>
956 <varlistentry><term>errorsInvalidAdvicePBNCount</term><listitem><para>The number of times the index returned invalid advice.</para></listitem></varlistentry>
957 <varlistentry><term>errorsNoSpaceErrorCount</term><listitem><para>The number of write requests which failed due to the VDO volume being out of space.</para></listitem></varlistentry>
958 <varlistentry><term>errorsReadOnlyErrorCount</term><listitem><para>The number of write requests which failed due to the VDO volume being in read-only mode.</para></listitem></varlistentry>
959 <varlistentry><term>flushOut</term><listitem><para>The number of flush requests submitted by VDO to the underlying storage.</para></listitem></varlistentry>
960 <varlistentry><term>hashLockConcurrentDataMatches</term><listitem><para></para></listitem></varlistentry>
961 <varlistentry><term>hashLockConcurrentHashCollisions</term><listitem><para></para></listitem></varlistentry>
962 <varlistentry><term>hashLockDedupeAdviceStale</term><listitem><para>The number of times deduplication advice was incorrect.</para></listitem></varlistentry>
963 <varlistentry><term>hashLockDedupeAdviceValid</term><listitem><para>The number of times deduplication advice was correct.</para></listitem></varlistentry>
964 <varlistentry><term>indexCurrDedupeQueries</term><listitem><para>The number of deduplication queries currently in flight.</para></listitem></varlistentry>
965 <varlistentry><term>indexEntriesIndexed</term><listitem><para></para></listitem></varlistentry>
966 <varlistentry><term>indexMaxDedupeQueries</term><listitem><para>The maximum number of in-flight deduplication queries.</para></listitem></varlistentry>
967 <varlistentry><term>indexPostsFound</term><listitem><para></para></listitem></varlistentry>
968 <varlistentry><term>indexPostsNotFound</term><listitem><para></para></listitem></varlistentry>
969 <varlistentry><term>indexQueriesFound</term><listitem><para></para></listitem></varlistentry>
970 <varlistentry><term>indexQueriesNotFound</term><listitem><para></para></listitem></varlistentry>
971 <varlistentry><term>indexUpdatesFound</term><listitem><para></para></listitem></varlistentry>
972 <varlistentry><term>indexUpdatesNotFound</term><listitem><para></para></listitem></varlistentry>
973 <varlistentry><term>inRecoveryMode</term><listitem><para></para></listitem></varlistentry>
974 <varlistentry><term>instance</term><listitem><para>The VDO instance.</para></listitem></varlistentry>
975 <varlistentry><term>journalBlocksBatching</term><listitem><para>The number of journal block writes started minus the number of journal blocks written.</para></listitem></varlistentry>
976 <varlistentry><term>journalBlocksCommitted</term><listitem><para>The number of journal blocks written to storage.</para></listitem></varlistentry>
977 <varlistentry><term>journalBlocksStarted</term><listitem><para>The number of journal blocks which have been touched in memory.</para></listitem></varlistentry>
978 <varlistentry><term>journalBlocksWriting</term><listitem><para>The number of journal blocks written (with metadatata in active memory) minus the number of journal blocks committed.</para></listitem></varlistentry>
979 <varlistentry><term>journalBlocksWritten</term><listitem><para>The total number of journal blocks for which a write has been issued.</para></listitem></varlistentry>
980 <varlistentry><term>journalDiskFull</term><listitem><para>The number of times a request could not make a recovery journal entry because the recovery journal was full.</para></listitem></varlistentry>
981 <varlistentry><term>journalEntriesBatching</term><listitem><para>The number of journal entry writes started minus the number of journal entries written.</para></listitem></varlistentry>
982 <varlistentry><term>journalEntriesCommitted</term><listitem><para>The number of journal entries written to storage.</para></listitem></varlistentry>
983 <varlistentry><term>journalEntriesStarted</term><listitem><para>The number of journal entries which have been made in memory.</para></listitem></varlistentry>
984 <varlistentry><term>journalEntriesWriting</term><listitem><para>The number of journal entries in submitted writes minus the number of journal entries committed to storage.</para></listitem></varlistentry>
985 <varlistentry><term>journalEntriesWritten</term><listitem><para>The total number of journal entries for which a write has been issued.</para></listitem></varlistentry>
986 <varlistentry><term>journalSlabJournalCommitsRequested</term><listitem><para>The number of times the recovery journal requested slab journal commits.</para></listitem></varlistentry>
987 <varlistentry><term>logicalBlocks</term><listitem><para>The maximum number of logical blocks that can be mapped by a VDO volume.</para></listitem></varlistentry>
988 <varlistentry><term>logicalBlockSize</term><listitem><para></para></listitem></varlistentry>
989 <varlistentry><term>logicalBlocksUsed</term><listitem><para>The number of logical blocks currently mapped.</para></listitem></varlistentry>
990 <varlistentry><term>maxVIOs</term><listitem><para>The maximum number of simultaneous I/O requests the VDO has processed.</para></listitem></varlistentry>
991 <varlistentry><term>memoryUsageBiosUsed</term><listitem><para>KVDO module bios use.</para></listitem></varlistentry>
992 <varlistentry><term>memoryUsageBytesUsed</term><listitem><para>KVDO module bytes use.</para></listitem></varlistentry>
993 <varlistentry><term>memoryUsagePeakBioCount</term><listitem><para>KVDO module peak bio coun.</para></listitem></varlistentry>
994 <varlistentry><term>memoryUsagePeakBytesUsed</term><listitem><para>KVDO module peak bytes use.</para></listitem></varlistentry>
995 <varlistentry><term>mode</term><listitem><para>Indicates whether a VDO volume is operating normally, is in recovery mode, or is in read-only mode.</para></listitem></varlistentry>
996 <varlistentry><term>overheadBlocksUsed</term><listitem><para>The number of physical blocks currently in use by a VDO volume to store VDO metadata.</para></listitem></varlistentry>
997 <varlistentry><term>packerCompressedBlocksWritten</term><listitem><para>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.</para></listitem></varlistentry>
998 <varlistentry><term>packerCompressedFragmentsInPacker</term><listitem><para>The number of compressed fragments being processed that have not yet been written.</para></listitem></varlistentry>
999 <varlistentry><term>packerCompressedFragmentsWritten</term><listitem><para>The number of compressed fragments that have been written since the VDO volume was last restarted.</para></listitem></varlistentry>
1000 <varlistentry><term>physicalBlocks</term><listitem><para>The total number of physical blocks allocated for a VDO volume.</para></listitem></varlistentry>
1001 <varlistentry><term>readCacheAccesses</term><listitem><para>The number of times VDO searched the read cache.</para></listitem></varlistentry>
1002 <varlistentry><term>readCachdeDataHits</term><listitem><para>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.</para></listitem></varlistentry>
1003 <varlistentry><term>readCacheHits</term><listitem><para>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.</para></listitem></varlistentry>
1004 <varlistentry><term>readOnlyRecoveries</term><listitem><para>The number of times a VDO volume has been recovered from read-only mode.</para></listitem></varlistentry>
1005 <varlistentry><term>recoveryPercentage</term><listitem><para>Indicates online recovery progress (\%), or N/A if the volume is not in recovery mode.</para></listitem></varlistentry>
1006 <varlistentry><term>refCountsBlocksWritten</term><listitem><para>The number of reference block writes issued.</para></listitem></varlistentry>
1007 <varlistentry><term>slabJournalBlockedCount</term><listitem><para>The number of times an entry was added to a slab journal that was over the blocking threshold.</para></listitem></varlistentry>
1008 <varlistentry><term>slabJournalBlocksWritten</term><listitem><para>The number of slab journal block writes issued.</para></listitem></varlistentry>
1009 <varlistentry><term>slabJournalDiskFullCount</term><listitem><para>The number of times an on-disk slab journal was full.</para></listitem></varlistentry>
1010 <varlistentry><term>slabJournalFlushCount</term><listitem><para>The number of times an entry was added to a slab journal that was over the flush threshold.</para></listitem></varlistentry>
1011 <varlistentry><term>slabJournalTailBusyCount</term><listitem><para>The number of times write requests blocked waiting for a slab journal write.</para></listitem></varlistentry>
1012 <varlistentry><term>slabSummaryBlocksWritten</term><listitem><para>The number of slab summary block writes issued.</para></listitem></varlistentry>
1013 <varlistentry><term>writePolicy</term><listitem><para>The write policy (sync or async).</para></listitem></varlistentry>
1014 </variablelist>
1015 -->
1016 <method name="GetStatistics">
1017 <arg name="options" direction="in" type="a{sv}" />
1018 <arg name="stats" direction="out" type="a{ss}" />
1019 </method>
1020
1021 </interface>
1022
1023 <!-- ********************************************************************** -->
1024
1025 </node>