org.freedesktop.UDisks2.VDOVolume

org.freedesktop.UDisks2.VDOVolume — A VDO logical volume

Methods

EnableCompression   (IN  b     enable,
                     IN  a{sv} options);
EnableDeduplication (IN  b     enable,
                     IN  a{sv} options);
ResizeLogical       (IN  t     size,
                     IN  a{sv} options);
ResizePhysical      (IN  t     size,
                     IN  a{sv} options);

Properties

VDOPool           readable   o
OperatingMode     readable   s
CompressionState  readable   s
IndexState        readable   s
UsedSize          readable   t
Compression       readable   b
Deduplication     readable   b

Description

Objects with this interface represent VDO logical volumes in a volume group.

VDO logical volume objects are children of their VDO pool object, and also link to it via the #VDOPool property.

Since 2.9.0

Method Details

The EnableCompression() method

EnableCompression (IN  b     enable,
                   IN  a{sv} options);

Enables or disables compression on the VDO volume. If the VDO volume is running, takes effect immediately.

IN b enable:

A boolean value indicating whether compression should be enabled.

IN a{sv} options:

Additional options (currently unused except for standard options).

Since 2.9.0


The EnableDeduplication() method

EnableDeduplication (IN  b     enable,
                     IN  a{sv} options);

Enables or disables deduplication on the VDO volume. If the VDO volume is running, takes effect immediately.

IN b enable:

A boolean value indicating whether deduplication should be enabled.

IN a{sv} options:

Additional options (currently unused except for standard options).

Since 2.9.0


The ResizeLogical() method

ResizeLogical (IN  t     size,
               IN  a{sv} options);

Resizes the logical size of a VDO volume to the size specified by the size argument. This is only a convenience method and it's equivalent to using the org.freedesktop.UDisks2.LogicalVolume:Resize method.

IN t size:

The new logical size for the VDO volume in bytes.

IN a{sv} options:

Additional options (currently unused except for standard options).

Since 2.9.0


The ResizePhysical() method

ResizePhysical (IN  t     size,
                IN  a{sv} options);

Resizes the physical size of a VDO volume to the size specified by the size argument. This is only a convenience method and it's equivalent to using the org.freedesktop.UDisks2.LogicalVolume:Resize method on the #VDOPool.

IN t size:

The new physical size for the VDO volume in bytes.

IN a{sv} options:

Additional options (currently unused except for standard options).

Since 2.9.0

Property Details

The "VDOPool" property

VDOPool  readable   o

Object path of the VDO pool for this volume.

Since 2.9.0


The "OperatingMode" property

OperatingMode  readable   s

Operating mode of the VDO volume.

One of "normal", "read-only" or "recovering".

Since 2.9.0


The "CompressionState" property

CompressionState  readable   s

Compression state of the VDO volume.

One of "online" or "offline".

Since 2.9.0


The "IndexState" property

IndexState  readable   s

State of the VDO index of the volume.

One of "online", "offline", "opening", "closing", "closed" or "error".

Since 2.9.0


The "UsedSize" property

UsedSize  readable   t

The total physical size used by this VDO volume.

Since 2.9.0


The "Compression" property

Compression  readable   b

Indicates whether compression is enabled.

Since 2.9.0


The "Deduplication" property

Deduplication  readable   b

Indicates whether deduplication is enabled.

Since 2.9.0