agama/doc/dbus/org.opensuse.Agama.Storage1.Proposal.Calculator.doc.xml
2025-06-10 14:03:02 +01:00

92 lines
3.6 KiB
XML

<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/org/opensuse/Agama/Storage1">
<node name="ISCSI" />
<node name="iscsi_nodes" />
<node name="staging" />
<node name="system" />
<node name="zfcp_controllers" />
<node name="zfcp_disks" />
<!--
Interface for calculating a new storage proposal.
-->
<interface name="org.opensuse.Agama.Storage1.Proposal.Calculator">
<!--
Gets the default values for a volume with the given mount path.
-->
<method name="DefaultVolume">
<!--
E.g., /home
-->
<arg name="mount_path" direction="in" type="s"/>
<!--
MountPath s
MountOptions as
Target s (options: "default", "new_partition", "new_vg", "device", "filesystem")
TargetDevice s (only makes sense if Target is not "default")
FsType s
MinSize t (bytes)
MaxSize t (bytes. Optional, max size is considered as unlimited if omitted)
AutoSize b
Snapshots b (makes sense only for btrfs)
Transactional b (makes sense only for btrfs)
Outline a{sv}
Required b
FsTypes as
SupportAutoSize b
SnapshotsConfigurable b
SnapshotsAffectSizes b
SizeRelevantVolumes as
-->
<arg name="volume" direction="out" type="a{sv}"/>
</method>
<!--
Calculates a new proposal.
-->
<method name="Calculate">
<!--
Target s (options: "disk", "newLvmVg", "reusedLvmVg")
TargeDevice s (optional: does not make sense if Target is "newLvmVg")
TargetPVDevices as (optional: only makes sense if Target is "newLvmVg")
ConfigureBoot b
BootDevice s
EncryptionPassword s
EncryptionMethod s
EncryptionPBKDFunction s
SpacePolicy s
SpaceActions aa{sv}
Volumes aa{sv}
Each space action has the following properties:
Device s
Action s (options: "force_delete", "resize")
Each volume has the following properties:
MountPath s
MountOptions as
Target s (options: "default", "new_partition", "new_vg", "device", "filesystem")
TargetDevice s (only makes sense if Target is not "default")
FsType s
MinSize t (bytes)
MaxSize t (bytes. Optional, max size is considered as unlimited if omitted)
AutoSize b
Snapshots b (makes sense only for btrfs)
Transactional b (makes sense only for btrfs)
-->
<arg name="settings_dbus" direction="in" type="a{sv}"/>
<!--
Whether the proposal was correctly calculated:
0: success
1: failure
-->
<arg name="result" direction="out" type="u"/>
</method>
<!--
Relevant mount points for the selected product. Normally, the product defines some specific
values for these mount points (e.g., min and max sizes, file system type, etc).
-->
<property type="as" name="ProductMountPoints" access="read"/>
<property type="as" name="EncryptionMethods" access="read"/>
</interface>
</node>