feat(xo-server/rest-api): possibility to import in an existing VDI (#…

…7199)
vatesfr · Nov 23, 2023 · e108cb0 · e108cb0
1 parent c4535c6
commit e108cb0
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 2 deletions.
diff --git a/CHANGELOG.unreleased.md b/CHANGELOG.unreleased.md
@@ -13,6 +13,7 @@
 - [Backup/Import] Show disk import status during Incremental Replication or restoration of Incremental Backup (PR [#7171](https://github.com/vatesfr/xen-orchestra/pull/7171))
 - [VM Creation] Added ISO option in new VM form when creating from template with a disk [#3464](https://github.com/vatesfr/xen-orchestra/issues/3464) (PR [#7166](https://github.com/vatesfr/xen-orchestra/pull/7166))
 - [REST API] `tags` property can be updated (PR [#7196](https://github.com/vatesfr/xen-orchestra/pull/7196))
+- [REST API] A VDI export can now be imported in an existing VDI (PR [#7199](https://github.com/vatesfr/xen-orchestra/pull/7199))
 
 ### Bug fixes
 

diff --git a/docs/restapi.md b/docs/restapi.md
@@ -201,7 +201,26 @@ curl \
 
 ## VDI Import
 
-A VHD or a raw export can be imported on an SR to create a new VDI at `/rest/v0/srs/<sr uuid>/vdis`.
+### Existing VDI
+
+A VHD or a raw export can be imported in an existing VDI respectively at `/rest/v0/vdis/<uuid>.vhd` and `/rest/v0/vdis/<uuid>.raw`.
+
+> Note: the size of the VDI must match exactly the size of VDI that was previously exported.
+
+```sh
+curl \
+  -X PUT \
+  -b authenticationToken=KQxQdm2vMiv7jBIK0hgkmgxKzemd8wSJ7ugFGKFkTbs \
+  -T myDisk.vhd \
+  'https://xo.example.org/rest/v0/vdis/1a269782-ea93-4c4c-897a-475365f7b674.vhd' \
+  | cat
+```
+
+> Note: the final `| cat` ensures cURL's standard output is not a TTY, which is necessary for upload stats to be dislayed.
+
+### New VDI
+
+An export can also be imported on an SR to create a new VDI at `/rest/v0/srs/<sr uuid>/vdis`.
 
 ```sh
 curl \

diff --git a/packages/xo-server/docs/rest-api.md b/packages/xo-server/docs/rest-api.md
@@ -202,7 +202,26 @@ curl \
 
 ## VDI Import
 
-A VHD or a raw export can be imported on an SR to create a new VDI at `/rest/v0/srs/<sr uuid>/vdis`.
+### Existing VDI
+
+A VHD or a raw export can be imported in an existing VDI respectively at `/rest/v0/vdis/<uuid>.vhd` and `/rest/v0/vdis/<uuid>.raw`.
+
+> Note: the size of the VDI must match exactly the size of VDI that was previously exported.
+
+```sh
+curl \
+  -X PUT \
+  -b authenticationToken=KQxQdm2vMiv7jBIK0hgkmgxKzemd8wSJ7ugFGKFkTbs \
+  -T myDisk.vhd \
+  'https://xo.company.lan/rest/v0/vdis/1a269782-ea93-4c4c-897a-475365f7b674.vhd' \
+  | cat
+```
+
+> Note: the final `| cat` ensures cURL's standard output is not a TTY, which is necessary for upload stats to be dislayed.
+
+### New VDI
+
+An export can also be imported on an SR to create a new VDI at `/rest/v0/srs/<sr uuid>/vdis`.
 
 ```sh
 curl \

diff --git a/packages/xo-server/src/xo-mixins/rest-api.mjs b/packages/xo-server/src/xo-mixins/rest-api.mjs
@@ -453,6 +453,15 @@ export default class RestApi {
         await pipeline(stream, res)
       })
     )
+    api.put(
+      '/:collection(vdis|vdi-snapshots)/:object.:format(vhd|raw)',
+      wrap(async (req, res) => {
+        req.length = +req.headers['content-length']
+        await req.xapiObject.$importContent(req, { format: req.params.format })
+
+        res.sendStatus(204)
+      })
+    )
     api.get(
       '/:collection(vms|vm-snapshots|vm-templates)/:object.xva',
       wrap(async (req, res) => {