agama/doc/dbus/org.opensuse.Agama.Storage1.Proposal.Calculator.doc.xml
Martin Vidner c8c7f81be5 doc/dbus: fix the "markup" to render all what is documented
gdbus-codegen is picky about what it lets through.
You have to check that what you write actually gets rendered
in the resulting HTML

BTW there are remnants documenting an abandoned Agama.Network design:
TODO: remove it
https://github.com/search?q=repo%3Aagama-project%2Fagama+%2Forg.*Agama.*Network%2F&type=code
2025-04-13 19:08:20 +02:00

95 lines
3.8 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" />
<!--
org.opensuse.Agama.Storage1.Proposal.Calculator
@short_description: Interface for calculating a new storage proposal.
-->
<interface name="org.opensuse.Agama.Storage1.Proposal.Calculator">
<!--
DefaultVolume:
@mount_path: E.g., /home
Gets the default values for a volume with the given mount path.
Returns:
<programlisting>
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
</programlisting>
-->
<method name="DefaultVolume">
<arg name="mount_path" direction="in" type="s"/>
<arg name="volume" direction="out" type="a{sv}"/>
</method>
<!--
Calculate:
@result: Whether the proposal was correctly calculated: 0: success, 1: failure
Calculates a new proposal.
Input:
<programlisting>
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}
</programlisting>
Each space action has the following properties:
<programlisting>
Device s
Action s (options: "force_delete", "resize")
</programlisting>
Each volume has the following properties:
<programlisting>
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)
</programlisting>
-->
<method name="Calculate">
<arg name="settings_dbus" direction="in" type="a{sv}"/>
<arg name="result" direction="out" type="u"/>
</method>
<property type="ao" name="AvailableDevices" access="read"/>
<!--
ProductMountPoints:
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>