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