blob: 6f746431ac8271573c580e31861ebe34f9c23d10 [file] [log] [blame]
description: >
This interface provides methods for mounting and unmounting images
using the legacy mode.
methods:
- name: Mount
description:
Perform an asynchronous operation of mounting to HOST 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 asynchronous operation of unmounting from HOST on given
object.
returns:
- name: Status
type: boolean
description: the unmount status. True on success.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
signals:
- name: Completion
description: >
Signal indicating completion of mount or unmount action.
properties:
- name: Result
type: int32
description: >
Returns 0 for success or errno on failure after background
operation completes.