xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/VirtualMedia/Proxy.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf) 
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    This interface provides methods for mounting and unmounting images.
3b1b4d261SWilliam A. Kennington III
4b1b4d261SWilliam A. Kennington IIImethods:
5b1b4d261SWilliam A. Kennington III    - name: Mount
6*9ad0a7d1SPrzemyslaw Czarnowski      description: >
7*9ad0a7d1SPrzemyslaw Czarnowski          Perform an asynchronous operation of mounting to HOST on given object.
8b1b4d261SWilliam A. Kennington III      returns:
9b1b4d261SWilliam A. Kennington III          - name: Status
10b1b4d261SWilliam A. Kennington III            type: boolean
11b1b4d261SWilliam A. Kennington III            description: mounting status. True on success.
12b1b4d261SWilliam A. Kennington III      errors:
13b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
14b1b4d261SWilliam A. Kennington III
15b1b4d261SWilliam A. Kennington III    - name: Unmount
16*9ad0a7d1SPrzemyslaw Czarnowski      description: >
17*9ad0a7d1SPrzemyslaw Czarnowski          Perform an asynchronous operation of unmount from HOST on given
18*9ad0a7d1SPrzemyslaw Czarnowski          object.
19b1b4d261SWilliam A. Kennington III      returns:
20b1b4d261SWilliam A. Kennington III          - name: Status
21b1b4d261SWilliam A. Kennington III            type: boolean
22b1b4d261SWilliam A. Kennington III            description: the unmount status. True on success.
23b1b4d261SWilliam A. Kennington III      errors:
24b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
25*9ad0a7d1SPrzemyslaw Czarnowski
26*9ad0a7d1SPrzemyslaw Czarnowskisignals:
27*9ad0a7d1SPrzemyslaw Czarnowski    - name: Completion
28*9ad0a7d1SPrzemyslaw Czarnowski      description: >
29*9ad0a7d1SPrzemyslaw Czarnowski          Signal indicating completion of mount or unmount action.
30*9ad0a7d1SPrzemyslaw Czarnowski      properties:
31*9ad0a7d1SPrzemyslaw Czarnowski          - name: Result
32*9ad0a7d1SPrzemyslaw Czarnowski            type: int32
33*9ad0a7d1SPrzemyslaw Czarnowski            description: >
34*9ad0a7d1SPrzemyslaw Czarnowski                Returns 0 for success or errno on failure after background
35*9ad0a7d1SPrzemyslaw Czarnowski                operation completes.
36