@xen-orchestra/rest-api 0.24.1 → 0.26.0

package/dist/proxies/proxy.controller.mjs

@@ -8,11 +8,16 @@ 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 { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
 import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
 import { partialProxies, proxy, proxyIds } from '../open-api/oa-examples/proxy.oa-example.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 let ProxyController = class ProxyController extends XoController {
+    constructor(restApi) {
+        super('proxy', restApi);
+    }
     getAllCollectionObjects() {
         return this.restApi.xoApp.getAllProxies();
     }
@@ -57,6 +62,7 @@ ProxyController = __decorate([
     Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('proxies'),
-    provide(ProxyController)
+    provide(ProxyController),
+    __param(0, inject(RestApi))
 ], ProxyController);
 export { ProxyController };

package/dist/restore-logs/restore-log.controller.mjs

@@ -21,7 +21,7 @@ const log = createLogger('xo:rest-api:restoreLog-controller');
 let RestoreLogController = class RestoreLogController extends XoController {
     #backupLogService;
     constructor(restApi, backupLogService) {
-        super(restApi);
+        super('restore-log', restApi);
         this.#backupLogService = backupLogService;
     }
     getAllCollectionObjects() {
@@ -81,7 +81,7 @@ export { RestoreLogController };
 let DeprecatedRestoreController = class DeprecatedRestoreController extends XoController {
     #backupLogService;
     constructor(restApi, backupLogService) {
-        super(restApi);
+        super('restore', restApi);
         this.#backupLogService = backupLogService;
     }
     getAllCollectionObjects() {

package/dist/schedules/schedule.controller.mjs

@@ -8,12 +8,17 @@ 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, SuccessResponse, Tags } from 'tsoa';
+import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
 import { asynchronousActionResp, badRequestResp, featureUnauthorized, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { partialSchedules, schedule, scheduleIds } from '../open-api/oa-examples/schedule.oa-example.mjs';
 import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 let ScheduleController = class ScheduleController extends XoController {
+    constructor(restApi) {
+        super('schedule', restApi);
+    }
     // --- abstract methods
     getAllCollectionObjects() {
         return this.restApi.xoApp.getAllSchedules();
@@ -86,6 +91,7 @@ ScheduleController = __decorate([
     Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('schedules'),
-    provide(ScheduleController)
+    provide(ScheduleController),
+    __param(0, inject(RestApi))
 ], ScheduleController);
 export { ScheduleController };

package/dist/servers/server.controller.mjs

@@ -9,12 +9,17 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 };
 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 { provide } from 'inversify-binding-decorators';
 import { asynchronousActionResp, badRequestResp, createdResp, invalidParameters, noContentResp, notFoundResp, resourceAlreadyExists, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { partialServers, server, serverId, serverIds } from '../open-api/oa-examples/server.oa-example.mjs';
 import { partialTasks, taskIds, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 let ServerController = class ServerController extends XoController {
+    constructor(restApi) {
+        super('server', restApi);
+    }
     // --- abstract methods
     getAllCollectionObjects() {
         return this.restApi.xoApp.getAllXenServers();
@@ -164,6 +169,7 @@ ServerController = __decorate([
     Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('servers'),
-    provide(ServerController)
+    provide(ServerController),
+    __param(0, inject(RestApi))
 ], ServerController);
 export { ServerController };

package/dist/srs/sr.controller.mjs

@@ -15,13 +15,13 @@ import { AlarmService } from '../alarms/alarm.service.mjs';
 import { BASE_URL } from '../index.mjs';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
-import { badRequestResp, createdResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { asynchronousActionResp, badRequestResp, createdResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { partialSrs, sr, srIds } from '../open-api/oa-examples/sr.oa-example.mjs';
 import { vdiId } from '../open-api/oa-examples/vdi.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, partialTasks, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 let SrController = class SrController extends XapiXoController {
     #alarmService;
     constructor(restApi, alarmService) {
@@ -114,6 +114,42 @@ let SrController = class SrController extends XapiXoController {
         const sr = this.getXapiObject(id);
         await sr.$call('remove_tags', tag);
     }
+    /**
+     * @example id "b61a5c92-700e-4966-a13b-00633f03eea8"
+     */
+    async reclaimSpaceSr(id, sync) {
+        const srId = id;
+        const action = async () => {
+            const sr = this.getXapiObject(srId);
+            await sr.$xapi.SR_reclaimSpace(sr.$ref);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'SR reclaim space',
+                objectId: srId,
+            },
+        });
+    }
+    /**
+     * @example id "b61a5c92-700e-4966-a13b-00633f03eea8"
+     */
+    async scanSr(id, sync) {
+        const srId = id;
+        const action = async () => {
+            const sr = this.getXapiObject(srId);
+            await sr.$xapi.callAsync('SR.scan', sr.$ref);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'SR scan',
+                objectId: srId,
+            },
+        });
+    }
 };
 __decorate([
     Example(srIds),
@@ -195,6 +231,28 @@ __decorate([
     __param(0, Path()),
     __param(1, Path())
 ], SrController.prototype, "deleteSrTag", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/reclaim_space'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(invalidParametersResp.status, invalidParametersResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], SrController.prototype, "reclaimSpaceSr", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/scan'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(invalidParametersResp.status, invalidParametersResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], SrController.prototype, "scanSr", null);
 SrController = __decorate([
     Route('srs'),
     Security('*'),

package/dist/tasks/task.controller.mjs

@@ -10,6 +10,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { XoController } from '../abstract-classes/xo-controller.mjs';
 import { Get, Path, Query, Request, Route, Security, Tags, Response, Example, Delete, Post, SuccessResponse, } from 'tsoa';
 import { asynchronousActionResp, badRequestResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
 import { partialTasks, task, taskIds, taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import pDefer from 'promise-toolbox/defer';
@@ -17,7 +18,11 @@ import { ApiError } from '../helpers/error.helper.mjs';
 import { Transform } from 'node:stream';
 import { makeObjectMapper } from '../helpers/object-wrapper.helper.mjs';
 import { safeParseComplexMatcher } from '../helpers/utils.helper.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
 let TaskController = class TaskController extends XoController {
+    constructor(restApi) {
+        super('task', restApi);
+    }
     async getAllCollectionObjects() {
         const result = [];
         for await (const task of this.restApi.tasks.list()) {
@@ -163,6 +168,7 @@ TaskController = __decorate([
     Response(badRequestResp.status, badRequestResp.description),
     Response(unauthorizedResp.status, unauthorizedResp.description),
     Tags('tasks'),
-    provide(TaskController)
+    provide(TaskController),
+    __param(0, inject(RestApi))
 ], TaskController);
 export { TaskController };

package/dist/users/user.controller.mjs

@@ -26,7 +26,7 @@ const log = createLogger('xo:rest-api:user-controller');
 let UserController = class UserController extends XoController {
     #userService;
     constructor(restApi, userService) {
-        super(restApi);
+        super('user', restApi);
         this.#userService = userService;
     }
     // --- abstract methods

package/dist/vdis/vdi.controller.mjs

@@ -14,7 +14,8 @@ 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 { asynchronousActionResp, badRequestResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { asynchronousActionResp, badRequestResp, createdResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { BASE_URL } from '../index.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 import { partialVdis, vdi, vdiId, vdiIds } from '../open-api/oa-examples/vdi.oa-example.mjs';
@@ -84,6 +85,25 @@ let VdiController = class VdiController extends XapiXoController {
         });
         return this.sendObjects(Object.values(alarms), req, 'alarms');
     }
+    /**
+     * Create an empty VDI on the given SR.
+     *
+     * @example body { "srId": "c4284e12-37c9-7967-b9e8-83ef229c3e03", "virtual_size": 10737418240, "name_label": "test VDI" }
+     */
+    async createVdi(body) {
+        const { srId, sm_config, ...rest } = body;
+        const xapiSr = this.restApi.getXapiObject(srId, 'SR');
+        const xapi = xapiSr.$xapi;
+        const vdiRef = await xapi.VDI_create({
+            ...rest,
+            SR: xapiSr.$ref,
+        }, {
+            sm_config,
+        });
+        const vdiUuid = await xapi.call('VDI.get_uuid', vdiRef);
+        this.setHeader('Location', `${BASE_URL}/vdis/${vdiUuid}`);
+        return { id: vdiUuid };
+    }
     /**
      * @example id "c77f9955-c1d2-4b39-aa1c-73cdb2dacb7e"
      */
@@ -196,6 +216,15 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VdiController.prototype, "getVdiAlarms", null);
+__decorate([
+    Example(vdiId),
+    Post(''),
+    Middlewares(json()),
+    SuccessResponse(createdResp.status, createdResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Body())
+], VdiController.prototype, "createVdi", null);
 __decorate([
     Delete('{id}'),
     SuccessResponse(noContentResp.status, noContentResp.description),

package/dist/vms/vm.controller.mjs

@@ -13,7 +13,7 @@ import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
 import { PassThrough } from 'node:stream';
-import { asynchronousActionResp, badRequestResp, createdResp, forbiddenOperationResp, incorrectStateResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { asynchronousActionResp, badRequestResp, createdResp, forbiddenOperationResp, incorrectStateResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { BASE_URL } from '../index.mjs';
 import { limitAndFilterArray, NDJSON_CONTENT_TYPE } from '../helpers/utils.helper.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
@@ -419,6 +419,33 @@ let VmController = class VmController extends XapiXoController {
             stream?.end();
         }
     }
+    /**
+     * VIF mapping is not allowed for intra-pool migration
+     *
+     * Networks and SRs must belong to the same pool as the destination host
+     *
+     * @example id "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * @example body { "hostId": "b61a5c92-700e-4966-a13b-00633f03eea8" }
+     */
+    migrateVm(id, body, sync) {
+        const vmId = id;
+        const hostId = body.hostId;
+        const action = async () => {
+            const { migrationNetworkId } = body;
+            const xapiVm = this.getXapiObject(vmId);
+            await xapiVm.$xapi.migrateVm(vmId, this.getXapi(hostId), hostId, {
+                mapVdisSrs: 'srIdByVdiId' in body ? body.srIdByVdiId : undefined,
+                mapVifsNetworks: 'networkIdByVifId' in body ? body.networkIdByVifId : undefined,
+                migrationNetworkId: migrationNetworkId,
+                sr: 'srId' in body ? body.srId : undefined,
+            });
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: 204,
+            taskProperties: { name: 'Migrate VM', objectId: vmId, params: body },
+        });
+    }
 };
 __decorate([
     Example(vmIds),
@@ -661,6 +688,19 @@ __decorate([
     __param(1, Path()),
     __param(2, Query())
 ], VmController.prototype, "getVmDashboard", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/migrate'),
+    Middlewares(json()),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(invalidParametersResp.status, invalidParametersResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Body()),
+    __param(2, Query())
+], VmController.prototype, "migrateVm", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),