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