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*a1347418SPatrick Williams      description:
8*a1347418SPatrick Williams          Perform an asynchronous operation of mounting to HOST on given object.
9b1b4d261SWilliam A. Kennington III      parameters:
10b1b4d261SWilliam A. Kennington III          - name: ImageURL
11b1b4d261SWilliam A. Kennington III            type: string
12b1b4d261SWilliam A. Kennington III            description: >
13*a1347418SPatrick Williams                Url to image. It should start with either `smb://` or `https://`
14*a1347418SPatrick Williams                prefix
15b1b4d261SWilliam A. Kennington III          - name: ReadWrite
16b1b4d261SWilliam A. Kennington III            type: boolean
17b1b4d261SWilliam A. Kennington III            description: False if the image should be read-only.
18b1b4d261SWilliam A. Kennington III          - name: FileDescriptor
19b1b4d261SWilliam A. Kennington III            type: variant[int32,unixfd]
20b1b4d261SWilliam A. Kennington III            description: >
21b1b4d261SWilliam A. Kennington III                File descriptor of named pipe used for passing null-delimited
22b1b4d261SWilliam A. Kennington III                secret data (username and password). When there is no data to
23b1b4d261SWilliam A. Kennington III                pass `-1` should be passed as `INT`.
24b1b4d261SWilliam A. Kennington III      returns:
25b1b4d261SWilliam A. Kennington III          - name: Status
26b1b4d261SWilliam A. Kennington III            type: boolean
27b1b4d261SWilliam A. Kennington III            description: mounting status. True on success.
28b1b4d261SWilliam A. Kennington III      errors:
29b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
30b1b4d261SWilliam A. Kennington III
31b1b4d261SWilliam A. Kennington III    - name: Unmount
32*a1347418SPatrick Williams      description:
33*a1347418SPatrick Williams          Perform an asynchronous operation of unmounting from HOST on given
34*a1347418SPatrick Williams          object.
35b1b4d261SWilliam A. Kennington III      returns:
36b1b4d261SWilliam A. Kennington III          - name: Status
37b1b4d261SWilliam A. Kennington III            type: boolean
38b1b4d261SWilliam A. Kennington III            description: the unmount status. True on success.
39b1b4d261SWilliam A. Kennington III      errors:
40b1b4d261SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.InternalFailure
419ad0a7d1SPrzemyslaw Czarnowski
429ad0a7d1SPrzemyslaw Czarnowskisignals:
439ad0a7d1SPrzemyslaw Czarnowski    - name: Completion
449ad0a7d1SPrzemyslaw Czarnowski      description: >
459ad0a7d1SPrzemyslaw Czarnowski          Signal indicating completion of mount or unmount action.
469ad0a7d1SPrzemyslaw Czarnowski      properties:
479ad0a7d1SPrzemyslaw Czarnowski          - name: Result
489ad0a7d1SPrzemyslaw Czarnowski            type: int32
499ad0a7d1SPrzemyslaw Czarnowski            description: >
509ad0a7d1SPrzemyslaw Czarnowski                Returns 0 for success or errno on failure after background
519ad0a7d1SPrzemyslaw Czarnowski                operation completes.
52