@xen-orchestra/rest-api 0.8.0 → 0.10.0

package/dist/vdis/vdi.controller.mjs

@@ -23,7 +23,7 @@ let VdiController = class VdiController extends XapiXoController {
      * @example filter "snapshots:length:>2"
      * @example limit 42
      */
-    getVdis(req, fields, filter, limit) {
+    getVdis(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -40,7 +40,8 @@ __decorate([
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
-    __param(3, Query())
+    __param(3, Query()),
+    __param(4, Query())
 ], VdiController.prototype, "getVdis", null);
 __decorate([
     Example(vdi),

package/dist/vifs/vif.controller.mjs

@@ -23,7 +23,7 @@ let VifController = class VifController extends XapiXoController {
      * @example filter "attached?"
      * @example limit 42
      */
-    getVifs(req, fields, filter, limit) {
+    getVifs(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -40,7 +40,8 @@ __decorate([
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
-    __param(3, Query())
+    __param(3, Query()),
+    __param(4, Query())
 ], VifController.prototype, "getVifs", null);
 __decorate([
     Example(vif),

package/dist/vm-controller/vm-controller.controller.mjs

@@ -24,7 +24,7 @@ let VmControllerController = class VmControllerController extends XapiXoControll
      * @example filter "power_state:Running"
      * @example limit 42
      */
-    getVmControllers(req, fields, filter, limit) {
+    getVmControllers(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -41,7 +41,8 @@ __decorate([
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
-    __param(3, Query())
+    __param(3, Query()),
+    __param(4, Query())
 ], VmControllerController.prototype, "getVmControllers", null);
 __decorate([
     Example(vmController),

package/dist/vm-snapshots/vm-snapshot.controller.mjs

@@ -24,7 +24,7 @@ let VmSnapshotController = class VmSnapshotController extends XapiXoController {
      * @example filter "snapshot_time:>1725020038"
      * @example limit 42
      */
-    getVmSnapshots(req, fields, filter, limit) {
+    getVmSnapshots(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -41,7 +41,8 @@ __decorate([
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
-    __param(3, Query())
+    __param(3, Query()),
+    __param(4, Query())
 ], VmSnapshotController.prototype, "getVmSnapshots", null);
 __decorate([
     Example(vmSnapshot),

package/dist/vm-templates/vm-template.controller.mjs

@@ -23,7 +23,7 @@ let VmTemplateController = class VmTemplateController extends XapiXoController {
      * @example filter "isDefaultTemplate?"
      * @example limit 42
      * */
-    getVmTemplates(req, fields, filter, limit) {
+    getVmTemplates(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -40,7 +40,8 @@ __decorate([
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
-    __param(3, Query())
+    __param(3, Query()),
+    __param(4, Query())
 ], VmTemplateController.prototype, "getVmTemplates", null);
 __decorate([
     Example(vmTemplate),

package/dist/vms/vm.controller.mjs

@@ -7,11 +7,11 @@ 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 } from 'tsoa';
+import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Tags, SuccessResponse, Body, Put, Delete, } from 'tsoa';
 import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
-import { actionAsyncroneResp, createdResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { asynchronousActionResp, createdResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
 import { BASE_URL } from '../index.mjs';
 import { partialVms, vm, vmIds, vmStatsExample } from '../open-api/oa-examples/vm.oa-example.mjs';
 import { RestApi } from '../rest-api/rest-api.mjs';
@@ -28,7 +28,7 @@ let VmController = class VmController extends XapiXoController {
      * @example filter "power_state:Running"
      * @example limit 42
      */
-    getVms(req, fields, filter, limit) {
+    getVms(req, fields, ndjson, filter, limit) {
         return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
     }
     /**
@@ -58,15 +58,67 @@ let VmController = class VmController extends XapiXoController {
         }
     }
     /**
+     * The VM must be running
+     *
+     * List of possible data_source (Based on [Xenserver doc](https://docs.xenserver.com/en-us/xenserver/8/monitor-performance#available-vm-metrics))
+     * - **cpu#** : Utilization of vCPU cpu (fraction). Enabled by default. *Condition*: vCPU cpu exists.
+     * - **cpu_usage** : Domain CPU usage. *Condition*: None.
+     * - **memory** : Memory currently allocated to VM (Bytes). Enabled by default. *Condition*: None.
+     * - **memory_target** : Target of VM balloon driver (Bytes). Enabled by default. *Condition*: None.
+     * - **memory_internal_free** : Memory used as reported by the guest agent (KiB). Enabled by default. *Condition*: None.
+     * - **runstate_fullrun** : Fraction of time that all vCPUs are running. *Condition*: None.
+     * - **runstate_full_contention** : Fraction of time that all vCPUs are runnable (waiting for CPU). *Condition*: None.
+     * - **runstate_concurrency_hazard** : Fraction of time that some vCPUs are running and some are runnable. *Condition*: None.
+     * - **runstate_blocked** : Fraction of time that all vCPUs are blocked or offline. *Condition*: None.
+     * - **runstate_partial_run** : Fraction of time that some vCPUs are running, and some are blocked. *Condition*: None.
+     * - **runstate_partial_contention** : Fraction of time that some vCPUs are runnable and some are blocked. *Condition*: None.
+     * - **vbd_#_write** : Writes to device vbd in bytes per second. Enabled by default. *Condition*: VBD vbd exists.
+     * - **vbd_#_read** : Reads from device vbd in bytes per second. Enabled by default. *Condition*: VBD vbd exists.
+     * - **vbd_#_write_latency** : Writes to device vbd in microseconds. *Condition*: VBD vbd exists.
+     * - **vbd_#_read_latency** : Reads from device vbd in microseconds. *Condition*: VBD vbd exists.
+     * - **vbd_#_iops_read** : Read requests per second. *Condition*: At least one plugged VBD for non-ISO VDI on the host.
+     * - **vbd_#_iops_write** : Write requests per second. *Condition*: At least one plugged VBD for non-ISO VDI on the host.
+     * - **vbd_#_iops_total** : I/O requests per second. *Condition*: At least one plugged VBD for non-ISO VDI on the host.
+     * - **vbd_#_iowait** : Percentage of time waiting for I/O. *Condition*: At least one plugged VBD for non-ISO VDI on the host.
+     * - **vbd_#_inflight** : Number of I/O requests currently in flight. *Condition*: At least one plugged VBD for non-ISO VDI on the host.
+     * - **vbd_#_avgqu_sz** : Average I/O queue size. *Condition*: At least one plugged VBD for non-ISO VDI on the host.
+     * - **vif_#_rx** : Bytes per second received on virtual interface number vif. Enabled by default. *Condition*: VIF vif exists.
+     * - **vif_#_tx** : Bytes per second transmitted on virtual interface vif. Enabled by default. *Condition*: VIF vif exists.
+     * - **vif_#_rx_errors** : Receive errors per second on virtual interface vif. Enabled by default. *Condition*: VIF vif exists.
+     * - **vif_#_tx_errors** : Transmit errors per second on virtual interface vif. Enabled by default. *Condition*: VIF vif exists.
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example dataSource "cpu0"
+     */
+    async addDataSource(id, dataSource) {
+        await this.getXapiObject(id).$call('record_data_source', dataSource);
+    }
+    /**
+     * The VM must be running
+     *
+     * For a list of possible data sources, see the endpoint documentation: `GET {id}/stats/data_source/{data_source}`
+     *
      * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example dataSource "cpu0"
      */
-    async startVm(id, sync) {
+    async deleteDataSource(id, dataSource) {
+        await this.getXapiObject(id).$call('forget_data_source_archives', dataSource);
+    }
+    /**
+     * The VM must be halted
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example body { "hostId": "b61a5c92-700e-4966-a13b-00633f03eea8" }
+     */
+    async startVm(id, body, sync) {
         const vmId = id;
-        const action = () => this.getXapiObject(vmId).$callAsync('start', false, false);
+        const action = async () => {
+            await this.getXapi(vmId).startVm(vmId, { startOnly: true, hostId: body?.hostId });
+        };
         return this.createAction(action, {
             sync,
             statusCode: noContentResp.status,
             taskProperties: {
+                args: body,
                 name: 'start VM',
                 objectId: vmId,
             },
@@ -142,6 +194,82 @@ let VmController = class VmController extends XapiXoController {
             },
         });
     }
+    /**
+     * The VM must be running
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async pauseVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapiObject(vmId).$callAsync('pause');
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'pause VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * The VM must be running
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async suspendVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapiObject(vmId).$callAsync('suspend');
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'suspend VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * The VM must be suspended
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async resumeVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapi(vmId).resumeVm(vmId);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'resume VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * The VM must be paused
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async unpauseVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapi(vmId).unpauseVm(vmId);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'unpause VM',
+                objectId: vmId,
+            },
+        });
+    }
     /**
      * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
      * @example body { "name_label": "my_awesome_snapshot" }
@@ -174,7 +302,8 @@ __decorate([
     __param(0, Request()),
     __param(1, Query()),
     __param(2, Query()),
-    __param(3, Query())
+    __param(3, Query()),
+    __param(4, Query())
 ], VmController.prototype, "getVms", null);
 __decorate([
     Example(vm),
@@ -190,20 +319,37 @@ __decorate([
     __param(0, Path()),
     __param(1, Query())
 ], VmController.prototype, "getVmStats", null);
+__decorate([
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    Put('{id}/stats/data_source/{data_source}'),
+    __param(0, Path()),
+    __param(1, Path('data_source'))
+], VmController.prototype, "addDataSource", null);
+__decorate([
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    Delete('{id}/stats/data_source/{data_source}'),
+    __param(0, Path()),
+    __param(1, Path('data_source'))
+], VmController.prototype, "deleteDataSource", null);
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/start'),
-    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
     Response(noContentResp.status, noContentResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
     __param(0, Path()),
-    __param(1, Query())
+    __param(1, Body()),
+    __param(2, Query())
 ], VmController.prototype, "startVm", null);
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/clean_shutdown'),
-    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
     Response(noContentResp.status, noContentResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
@@ -219,7 +365,7 @@ __decorate([
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/hard_shutdown'),
-    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
     Response(noContentResp.status, noContentResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
@@ -229,17 +375,57 @@ __decorate([
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/hard_reboot'),
-    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
     Response(noContentResp.status, noContentResp.description),
     Response(notFoundResp.status, notFoundResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),
     __param(0, Path()),
     __param(1, Query())
 ], VmController.prototype, "hardRebootVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/pause'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "pauseVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/suspend'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "suspendVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/resume'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "resumeVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/unpause'),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "unpauseVm", null);
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/snapshot'),
-    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description, asynchronousActionResp.produce),
     Response(createdResp.status, 'Snapshot created'),
     Response(notFoundResp.status, notFoundResp.description),
     Response(internalServerErrorResp.status, internalServerErrorResp.description),

package/dist/vms/vm.service.mjs

@@ -0,0 +1,47 @@
+import { createLogger } from '@xen-orchestra/log';
+import { defer } from 'golike-defer';
+import { Task } from '@vates/task';
+const log = createLogger('xo:rest-api:vm-service');
+export class VmService {
+    #restApi;
+    constructor(restApi) {
+        this.#restApi = restApi;
+    }
+    async #create($defer, params) {
+        const { pool, template, cloud_config, boot, destroy_cloud_config_vdi, network_config, ...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');
+        let cloudConfigVdi;
+        if (cloud_config !== undefined) {
+            const cloudConfigVdiUuid = await xapi.VM_createCloudInitConfig(xapiVm.$ref, cloud_config, {
+                networkConfig: network_config,
+            });
+            cloudConfigVdi = xoApp.getXapiObject(cloudConfigVdiUuid, 'VDI');
+        }
+        let timeLimit;
+        if (boot) {
+            timeLimit = Date.now() + 10 * 60 * 1000;
+            await xapiVm.$callAsync('start', false, false);
+        }
+        if (destroy_cloud_config_vdi && cloudConfigVdi !== undefined && boot) {
+            Task.info('Destruction of the cloud config VDI is planned and will be done as soon as possible');
+            xapi.VDI_destroyCloudInitConfig(cloudConfigVdi.$ref, { timeLimit }).catch(error => {
+                log.error('destroy cloud init config VDI failed', {
+                    error,
+                    vdi: {
+                        uuid: cloudConfigVdi.uuid,
+                    },
+                    vm: {
+                        uuid: xoVm.uuid,
+                    },
+                });
+            });
+        }
+        return xoVm.id;
+    }
+    create = defer(this.#create);
+}

package/dist/xoa/xoa.controller.mjs

@@ -0,0 +1,55 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Controller, Example, Get, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { PassThrough } from 'node:stream';
+import { provide } from 'inversify-binding-decorators';
+import { unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { xoaDashboard } from '../open-api/oa-examples/xoa.oa-example.mjs';
+import { XoaService } from './xoa.service.mjs';
+import { NDJSON_CONTENT_TYPE } from '../helpers/utils.helper.mjs';
+let XoaController = class XoaController extends Controller {
+    #xoaService;
+    constructor(xoaService) {
+        super();
+        this.#xoaService = xoaService;
+    }
+    async getDashboard(req, ndjson) {
+        const stream = ndjson ? new PassThrough() : undefined;
+        const isStream = ndjson && stream !== undefined;
+        if (isStream) {
+            const res = req.res;
+            res.setHeader('Content-Type', NDJSON_CONTENT_TYPE);
+            stream.pipe(res);
+        }
+        const dashboard = await this.#xoaService.getDashboard({ stream });
+        if (isStream) {
+            stream.end();
+        }
+        else {
+            return dashboard;
+        }
+    }
+};
+__decorate([
+    Example(xoaDashboard),
+    Get('dashboard'),
+    __param(0, Request()),
+    __param(1, Query())
+], XoaController.prototype, "getDashboard", null);
+XoaController = __decorate([
+    Route(''),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('xoa'),
+    provide(XoaController),
+    __param(0, inject(XoaService))
+], XoaController);
+export { XoaController };