org.storaged.Storaged.Filesystem.BTRFS: Storaged Reference Manual

org.storaged.Storaged.Filesystem.BTRFS

org.storaged.Storaged.Filesystem.BTRFS — BTRFS filesystem interface exported on block objects

Methods

CreateSubvolume (IN  s      name,
                 IN  a{sv}  options);
RemoveSubvolume (IN  s      name,
                 IN  a{sv}  options);
GetSubvolumes   (IN  b      snapshots_only,
                 IN  a{sv}  options,
                 OUT a(tts) subvolumes,
                 OUT i      subvolumes_cnt);
CreateSnapshot  (IN  s      source,
                 IN  s      dest,
                 IN  b      ro,
                 IN  a{sv}  options);
SetLabel        (IN  s      label,
                 IN  a{sv}  options);

Properties

label        readable   s
uuid         readable   s
num_devices  readable   t
used         readable   t

Description

This interface is used for #org.storaged.Storaged.Block devices that has been filtered through BTRFS plugin.

Method Details

The CreateSubvolume() method

CreateSubvolume (IN  s     name,
                 IN  a{sv} options);

since 2.1.3

Creates a new subvolume.

No additional options are currently defined.

`IN s name`:	Name of a new subvolume.
`IN a{sv} options`:	Additional options.

The RemoveSubvolume() method

RemoveSubvolume (IN  s     name,
                 IN  a{sv} options);

since 2.1.3

Deletes a subvolume.

No additional options are currently defined.

`IN s name`:	Name of the subvolume to be deleted.
`IN a{sv} options`:	Additional options.

The GetSubvolumes() method

GetSubvolumes (IN  b      snapshots_only,
               IN  a{sv}  options,
               OUT a(tts) subvolumes,
               OUT i      subvolumes_cnt);

Returns a list of subvolumes.

No additional options are currently defined.

`IN b snapshots_only`:	True if to list only snapshot subvolumes; False otherwise.
`IN a{sv} options`:	Additional options.
`OUT a(tts) subvolumes`:	Structure containing subvolume id, parent_id and path.
`OUT i subvolumes_cnt`:	The number of returned elements.

Since 2.1.3

The CreateSnapshot() method

CreateSnapshot (IN  s     source,
                IN  s     dest,
                IN  b     ro,
                IN  a{sv} options);

Creates a snapshot.

No additional options are currently defined.

`IN s source`:	A path to source subvolume.
`IN s dest`:	A path to new snapshot volume.
`IN b ro`:	True if the snapshot should be read-only; False otherwise.
`IN a{sv} options`:	Additional options.

Since 2.1.3

The SetLabel() method

SetLabel (IN  s     label,
          IN  a{sv} options);

since 2.1.3

Sets a new label for the given volume.

No additional options are currently defined.

`IN s label`:	New label.
`IN a{sv} options`:	Additional options.

Property Details

The "label" property

label  readable   s

The "uuid" property

uuid  readable   s

The "num_devices" property

num_devices  readable   t

The "used" property

used  readable   t