1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III   This interface provides methods for mounting and unmounting images
3b1b4d261SWilliam A. Kennington III    using the legacy mode.
4b1b4d261SWilliam A. Kennington III
5b1b4d261SWilliam A. Kennington IIImethods:
6b1b4d261SWilliam A. Kennington III    - name: Mount
7*9ad0a7d1SPrzemyslaw Czarnowski      description: Perform an asynchronous operation of mounting to HOST on given object.
8b1b4d261SWilliam A. Kennington III      parameters:
9b1b4d261SWilliam A. Kennington III          - name: ImageURL
10b1b4d261SWilliam A. Kennington III            type: string
11b1b4d261SWilliam A. Kennington III            description: >
12b1b4d261SWilliam A. Kennington III                Url to image. It should start with either `smb://` or
13b1b4d261SWilliam A. Kennington III                `https://` prefix
14b1b4d261SWilliam A. Kennington III          - name: ReadWrite
15b1b4d261SWilliam A. Kennington III            type: boolean
16b1b4d261SWilliam A. Kennington III            description: False if the image should be read-only.
17b1b4d261SWilliam A. Kennington III          - name: FileDescriptor
18b1b4d261SWilliam A. Kennington III            type: variant[int32,unixfd]
19b1b4d261SWilliam A. Kennington III            description: >
20b1b4d261SWilliam A. Kennington III                File descriptor of named pipe used for passing null-delimited
21b1b4d261SWilliam A. Kennington III                secret data (username and password). When there is no data to
22b1b4d261SWilliam A. Kennington III                pass `-1` should be passed as `INT`.
23b1b4d261SWilliam A. Kennington III      returns:
24b1b4d261SWilliam A. Kennington III          - name: Status
25b1b4d261SWilliam A. Kennington III            type: boolean
26b1b4d261SWilliam A. Kennington III            description: mounting status. True on success.
27b1b4d261SWilliam A. Kennington III      errors:
28b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
29b1b4d261SWilliam A. Kennington III
30b1b4d261SWilliam A. Kennington III    - name: Unmount
31*9ad0a7d1SPrzemyslaw Czarnowski      description: Perform an asynchronous operation of unmounting from HOST on given object.
32b1b4d261SWilliam A. Kennington III      returns:
33b1b4d261SWilliam A. Kennington III          - name: Status
34b1b4d261SWilliam A. Kennington III            type: boolean
35b1b4d261SWilliam A. Kennington III            description: the unmount status. True on success.
36b1b4d261SWilliam A. Kennington III      errors:
37b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
38*9ad0a7d1SPrzemyslaw Czarnowski
39*9ad0a7d1SPrzemyslaw Czarnowskisignals:
40*9ad0a7d1SPrzemyslaw Czarnowski    - name: Completion
41*9ad0a7d1SPrzemyslaw Czarnowski      description: >
42*9ad0a7d1SPrzemyslaw Czarnowski        Signal indicating completion of mount or unmount action.
43*9ad0a7d1SPrzemyslaw Czarnowski      properties:
44*9ad0a7d1SPrzemyslaw Czarnowski        - name: Result
45*9ad0a7d1SPrzemyslaw Czarnowski          type: int32
46*9ad0a7d1SPrzemyslaw Czarnowski          description: >
47*9ad0a7d1SPrzemyslaw Czarnowski            Returns 0 for success or errno on failure after background
48*9ad0a7d1SPrzemyslaw Czarnowski            operation completes.
49