@xen-orchestra/rest-api 0.22.1 → 0.24.0

package/dist/vbds/vbd.controller.mjs

@@ -7,24 +7,50 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { Body, Delete, Example, Get, Middlewares, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
+import { json } from 'express';
 import { inject } from 'inversify';
+import { invalidParameters as invalidParametersError } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
-import { partialVbds, vbd, vbdIds } from '../open-api/oa-examples/vbd.oa-example.mjs';
+import { asynchronousActionResp, badRequestResp, createdResp, internalServerErrorResp, invalidParameters, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { BASE_URL } from '../index.mjs';
+import { partialVbds, vbd, vbdId, vbdIds } from '../open-api/oa-examples/vbd.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
-import { taskIds, partialTasks } from '../open-api/oa-examples/task.oa-example.mjs';
+import { taskIds, taskLocation, partialTasks } from '../open-api/oa-examples/task.oa-example.mjs';
 let VbdController = class VbdController extends XapiXoController {
     #alarmService;
     constructor(restApi, alarmService) {
         super('VBD', restApi);
         this.#alarmService = alarmService;
     }
+    /**
+     * Create a VBD to attach a VDI to a VM
+     *
+     * @example body { "VM": "4fe90510-8da4-1530-38e2-a7876ef374c7", "VDI": "656052a2-2e3e-467b-88ba-63a9ea5e4a54", "bootable": false, "mode": "RW" }
+     */
+    async createVbd(body) {
+        const xoVm = this.restApi.getObject(body.VM, 'VM');
+        const xoVdi = this.restApi.getObject(body.VDI, 'VDI');
+        if (xoVm.$pool !== xoVdi.$pool) {
+            throw invalidParametersError('VM and VDI must be in the same pool');
+        }
+        const xapiVm = this.restApi.getXapiObject(xoVm.id, 'VM');
+        const xapiVdi = this.restApi.getXapiObject(xoVdi.id, 'VDI');
+        const xapi = xapiVm.$xapi;
+        const vbdRef = await xapi.VBD_create({
+            ...body,
+            VDI: xapiVdi.$ref,
+            VM: xapiVm.$ref,
+        });
+        const vbdUuid = await xapi.call('VBD.get_uuid', vbdRef);
+        this.setHeader('Location', `${BASE_URL}/vbds/${vbdUuid}`);
+        return { id: vbdUuid };
+    }
     /**
      *
      * @example fields "device,bootable,uuid"
@@ -41,6 +67,18 @@ let VbdController = class VbdController extends XapiXoController {
     getVbd(id) {
         return this.getObject(id);
     }
+    /**
+     * Delete a VBD
+     *
+     * Removes the virtual block device, detaching the VDI from the VM.
+     * The VDI itself is NOT deleted.
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async deleteVbd(id) {
+        const xapiVbd = this.getXapiObject(id);
+        await xapiVbd.$xapi.VBD_destroy(xapiVbd.$ref);
+    }
     /**
      * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
      * @example fields "id,time"
@@ -75,7 +113,54 @@ let VbdController = class VbdController extends XapiXoController {
         const tasks = await this.getTasksForObject(id, { filter, limit });
         return this.sendObjects(Object.values(tasks), req, 'tasks');
     }
+    /**
+     * Hotplug the VBD, dynamically attaching it to the running VM
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    connectVbd(id, sync) {
+        const vbdId = id;
+        const action = async () => {
+            const xapiVbd = this.getXapiObject(vbdId);
+            await xapiVbd.$xapi.callAsync('VBD.plug', xapiVbd.$ref);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'connect VBD',
+                objectId: vbdId,
+            },
+        });
+    }
+    /**
+     * Hot-unplug the VBD, dynamically detaching it from the running VM
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    disconnectVbd(id, sync) {
+        const vbdId = id;
+        const action = async () => {
+            const xapiVbd = this.getXapiObject(vbdId);
+            await xapiVbd.$xapi.VBD_unplug(xapiVbd.$ref);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'disconnect VBD',
+                objectId: vbdId,
+            },
+        });
+    }
 };
+__decorate([
+    Example(vbdId),
+    Post(''),
+    Middlewares(json()),
+    SuccessResponse(createdResp.status, createdResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(invalidParameters.status, invalidParameters.description),
+    __param(0, Body())
+], VbdController.prototype, "createVbd", null);
 __decorate([
     Example(vbdIds),
     Example(partialVbds),
@@ -92,6 +177,12 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], VbdController.prototype, "getVbd", null);
+__decorate([
+    Delete('{id}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], VbdController.prototype, "deleteVbd", null);
 __decorate([
     Example(genericAlarmsExample),
     Get('{id}/alarms'),
@@ -130,6 +221,26 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VbdController.prototype, "getVbdTasks", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/connect'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VbdController.prototype, "connectVbd", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/disconnect'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VbdController.prototype, "disconnectVbd", null);
 VbdController = __decorate([
     Route('vbds'),
     Security('*'),

package/dist/vdis/vdi.controller.mjs

@@ -7,19 +7,20 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import { Delete, Example, Get, Path, Put, Query, Request, Response, Route, Security, SuccessResponse, Tags } from 'tsoa';
+import { Body, Delete, Example, Get, Middlewares, Path, Post, Put, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
+import { json } from 'express';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { badRequestResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { asynchronousActionResp, badRequestResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
-import { partialVdis, vdi, vdiIds } from '../open-api/oa-examples/vdi.oa-example.mjs';
+import { partialVdis, vdi, vdiId, vdiIds } from '../open-api/oa-examples/vdi.oa-example.mjs';
 import { VdiService } from './vdi.service.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
-import { taskIds, partialTasks } from '../open-api/oa-examples/task.oa-example.mjs';
+import { taskIds, partialTasks, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 let VdiController = class VdiController extends XapiXoController {
     #alarmService;
     #vdiService;
@@ -110,6 +111,27 @@ let VdiController = class VdiController extends XapiXoController {
         const tasks = await this.getTasksForObject(id, { filter, limit });
         return this.sendObjects(Object.values(tasks), req, 'tasks');
     }
+    /**
+     * Migrate a VDI to another SR.
+     *
+     * Note: After migration, the VDI will have a new ID. The new ID is returned in the response.
+     *
+     * @example id "c77f9955-c1d2-4b39-aa1c-73cdb2dacb7e"
+     * @example body { "srId": "4cb0d74e-a7c1-0b7d-46e3-09382c012abb" }
+     */
+    async migrateVdi(id, body, sync) {
+        const vdiId = id;
+        return this.createAction(async () => {
+            const newVdi = await this.getXapi(vdiId).moveVdi(vdiId, body.srId);
+            return { id: newVdi.uuid };
+        }, {
+            sync,
+            taskProperties: {
+                name: 'migrate VDI',
+                objectId: vdiId,
+            },
+        });
+    }
     /**
      * @example id "c77f9955-c1d2-4b39-aa1c-73cdb2dacb7e"
      * @example tag "from-rest-api"
@@ -206,6 +228,19 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VdiController.prototype, "getVdiTasks", null);
+__decorate([
+    Example(taskLocation),
+    Example(vdiId),
+    Post('{id}/actions/migrate'),
+    Middlewares(json()),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(200, 'Ok'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Body()),
+    __param(2, Query())
+], VdiController.prototype, "migrateVdi", null);
 __decorate([
     Put('{id}/tags/{tag}'),
     SuccessResponse(noContentResp.status, noContentResp.description),

package/dist/vms/vm.controller.mjs

@@ -7,7 +7,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Tags, SuccessResponse, Body, Put, Delete, } from 'tsoa';
+import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Tags, SuccessResponse, Body, Put, Delete, Middlewares, } from 'tsoa';
+import { json } from 'express';
 import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
@@ -480,6 +481,7 @@ __decorate([
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/start'),
+    Middlewares(json()),
     SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
     Response(noContentResp.status, noContentResp.description),
     Response(notFoundResp.status, notFoundResp.description),

package/dist/vms/vm.service.mjs

@@ -21,13 +21,17 @@ export class VmService {
         this.#backupLogService = restApi.ioc.get(BackupLogService);
     }
     async #create($defer, params) {
-        const { pool, template, cloud_config, boot, destroy_cloud_config_vdi, network_config, ...rest } = params;
+        const { pool, template, cloud_config, boot, destroy_cloud_config_vdi, network_config, createVtpm, ...rest } = params;
         const xoApp = this.#restApi.xoApp;
         const xapi = xoApp.getXapi(pool);
         const currentUser = this.#restApi.getCurrentUser();
         const xapiVm = await xapi.createVm(template, rest, undefined, currentUser.id);
         $defer.onFailure(() => xapi.VM_destroy(xapiVm.$ref));
         const xoVm = this.#restApi.getObject(xapiVm.uuid, 'VM');
+        if (createVtpm) {
+            const vtpmRef = await xapi.VTPM_create({ VM: xapiVm.$ref });
+            $defer.onFailure(() => xapi.call('VTPM.destroy', vtpmRef));
+        }
         let cloudConfigVdi;
         if (cloud_config !== undefined) {
             const cloudConfigVdiUuid = await xapi.VM_createCloudInitConfig(xapiVm.$ref, cloud_config, {
@@ -88,6 +92,8 @@ export class VmService {
             }
         }
         return {
+            active: nRunning + nPaused,
+            inactive: nHalted + nSuspended,
             running: nRunning,
             halted: nHalted,
             paused: nPaused,
@@ -103,7 +109,7 @@ export class VmService {
         for (const vbdId of vm.$VBDs) {
             const vbd = getObject(vbdId, 'VBD');
             if (vbd.VDI !== undefined) {
-                const vdi = getObject(vbd.VDI, ['VDI-snapshot', 'VDI']);
+                const vdi = getObject(vbd.VDI, [vmType === 'VM-snapshot' ? 'VDI-snapshot' : 'VDI']);
                 vdis.push(vdi);
             }
         }
@@ -182,7 +188,7 @@ export class VmService {
             }
         }
         if (lastReplica === undefined) {
-            return;
+            return {};
         }
         const vdis = this.getVmVdis(id, 'VM');
         let sr = undefined;
@@ -239,7 +245,7 @@ export class VmService {
                 status,
             };
         });
-        let vmProtection = 'not-in-job';
+        let vmProtection = 'not-in-active-job';
         if (!vmContainsNoBakTag(vm)) {
             const backupLogsByJob = groupBy(backupLogs, 'jobId');
             for (const backupJob of relevantJobsWithSchedule) {
@@ -272,7 +278,7 @@ export class VmService {
         const backupArchivesByVmByBr = await this.#restApi.xoApp.listVmBackupsNg(brIds, { vmId: vm.id });
         return Object.values(backupArchivesByVmByBr)
             .filter(backupArchiveByVm => backupArchiveByVm !== undefined)
-            .flatMap(backupArchiveByVm => backupArchiveByVm[vm.id])
+            .flatMap(backupArchiveByVm => backupArchiveByVm[vm.id] ?? [])
             .sort((a, b) => b.timestamp - a.timestamp)
             .splice(0, 3)
             .map(ba => ({ id: ba.id, timestamp: ba.timestamp, backupRepository: ba.backupRepository, size: ba.size }));