VirtualMedia dbus interface definition.
This interfaces definition was created on base of the VirtualMedia
design proposed in this document:
https://github.com/openbmc/docs/blob/master/designs/VirtualMedia.md
It also takes into account the design changes proposed in this review:
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/29573
Signed-off-by: Zbigniew Kurzynski <zbigniew.kurzynski@intel.com>
Change-Id: Ie5b1cdb9a8e01a54e79784837edf3b1d1f1fb017
diff --git a/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml b/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml
new file mode 100644
index 0000000..2a028dd
--- /dev/null
+++ b/xyz/openbmc_project/VirtualMedia/Legacy.interface.yaml
@@ -0,0 +1,37 @@
+description: >
+ This interface provides methods for mounting and unmounting images
+ using the legacy mode.
+
+methods:
+ - name: Mount
+ description: Perform a mount to HOST operation on given object.
+ parameters:
+ - name: ImageURL
+ type: string
+ description: >
+ Url to image. It should start with either `smb://` or
+ `https://` prefix
+ - name: ReadWrite
+ type: boolean
+ description: False if the image should be read-only.
+ - name: FileDescriptor
+ type: variant[int32,unixfd]
+ description: >
+ File descriptor of named pipe used for passing null-delimited
+ secret data (username and password). When there is no data to
+ pass `-1` should be passed as `INT`.
+ returns:
+ - name: Status
+ type: boolean
+ description: mounting status. True on success.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure
+
+ - name: Unmount
+ description: Perform an unmount from HOST on given object.
+ returns:
+ - name: Status
+ type: boolean
+ description: the unmount status. True on success.
+ errors:
+ - xyz.openbmc_project.Common.Error.InternalFailure