npm - @xen-orchestra/rest-api - Versions diffs - 0.24.0 → 0.24.1 - Mend

@xen-orchestra/rest-api 0.24.0 → 0.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/dist/events/event.class.mjs +31 -22
package/dist/events/event.service.mjs +21 -4
package/dist/helpers/object-wrapper.helper.mjs +9 -4
package/dist/middlewares/authentication.middleware.mjs +1 -1
package/dist/open-api/oa-examples/vif.oa-example.mjs +1 -0
package/dist/open-api/routes/routes.js +71 -2
package/dist/pools/pool.controller.mjs +12 -3
package/dist/pools/pool.service.mjs +1 -1
package/dist/vifs/vif.controller.mjs +53 -3
package/open-api/spec/swagger.json +230 -22
package/package.json +2 -2

package/dist/events/event.class.mjs CHANGED Viewed

@@ -19,31 +19,35 @@ export class Subscriber {
     get connection() {
         return this.#connection;
     }
-    constructor(res, manager) {
+    constructor(connection, manager) {
         this.#id = crypto.randomUUID();
-        const headers = new Headers({
-            'Content-Type': 'text/event-stream',
-            Connection: 'keep-alive',
-            'Cache-Control': 'no-cache, no-transform',
-        });
-        res.setHeaders(headers);
-        res.on('close', () => this.clear());
+        connection.on('close', () => this.clear());
         manager.addSubscriber(this);
-        this.#connection = res;
+        this.#connection = connection;
         this.#manager = manager;
         this.#isAlive = true;
     }
+    #safeWrite(payload) {
+        const ok = this.#connection.write(payload);
+        if (!ok) {
+            log.error(`Too much data in queue for the client ${this.id} (${Math.round(this.#connection.writableLength / 1024 / 1024)} MB). The connection is going to be destroyed`);
+            this.clear();
+        }
+    }
     broadcast(event, data) {
         if (!this.#isAlive) {
             log.warn('broadcast called on a subscriber that is not alive, but still in memory! Force clear and do nothing');
             this.clear();
             return;
         }
-        this.#connection.write(`event:${event}\n`);
-        this.#connection.write(`data:${JSON.stringify(data)}\n\n`);
+        const payload = `event: ${event}\ndata: ${JSON.stringify(data)}\n\n`;
+        this.#safeWrite(payload);
     }
     clear() {
         this.#isAlive = false;
+        if (!this.#connection.closed || !this.#connection.destroyed) {
+            this.#connection.destroy();
+        }
         this.#manager.removeSubscriber(this.id);
     }
 }
@@ -58,20 +62,25 @@ export class XoListener extends Listener {
     handleData({ fields, event }, object, previousObj) {
         let _object = object;
         let _prevObject = previousObj;
-        if (this.#type === 'alarm') {
-            if (object !== undefined &&
-                'type' in object &&
-                object.type === 'message' &&
-                this.#alarmService?.isAlarm(object)) {
-                _object = this.#alarmService.parseAlarm(object);
+        if (this.#type === 'alarm' || this.#type === 'message') {
+            const isAlarm = (object) => object !== undefined && 'type' in object && object.type === 'message' && this.#alarmService.isAlarm(object);
+            const objectIsAlarm = isAlarm(object);
+            const prevObjectIsAlarm = isAlarm(previousObj);
+            // If we are in an alarm listener and the objects are messages
+            // we clean them to ensure they are not sent via the SSE
+            // Same if we are in a message listener and the objects are alarms
+            if (this.#type === 'alarm') {
+                _object = objectIsAlarm ? this.#alarmService.parseAlarm(object) : undefined;
+                _prevObject = prevObjectIsAlarm ? this.#alarmService.parseAlarm(previousObj) : undefined;
             }
-            if (previousObj !== undefined &&
-                'type' in previousObj &&
-                previousObj.type === 'message' &&
-                this.#alarmService?.isAlarm(previousObj)) {
-                _prevObject = this.#alarmService.parseAlarm(previousObj);
+            else {
+                _object = objectIsAlarm ? undefined : object;
+                _prevObject = prevObjectIsAlarm ? undefined : object;
             }
         }
+        if (_object === undefined && _prevObject === undefined) {
+            return;
+        }
         if (fields !== '*') {
             if (_object !== undefined) {
                 _object = pick(_object, fields);

package/dist/events/event.service.mjs CHANGED Viewed

@@ -1,4 +1,6 @@
+import os from 'node:os';
 import { createLogger } from '@xen-orchestra/log';
+import { PassThrough, pipeline } from 'node:stream';
 import { PingListener, Subscriber, SubscriberManager, XoListener } from './event.class.mjs';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 const log = createLogger('xo:rest-api:event-service');
@@ -26,7 +28,7 @@ export class EventService {
             listener = new PingListener();
         }
         else {
-            const isAlarm = type === 'alarm';
+            const isMessage = type === 'alarm' || type === 'message';
             let eventEmitter;
             if (type === 'task') {
                 eventEmitter = this.#restApi.xoApp.tasks;
@@ -34,15 +36,30 @@ export class EventService {
             else {
                 // alarm is purely XO-related; it doesn't exist at the XAPI level.
                 // alarm is a message with parsed values. So, in the case of an alarm listener, it listens for message collection.
-                eventEmitter = this.#restApi.xoApp.objects.allIndexes.type.getEventEmitterByType(isAlarm ? 'message' : type);
+                eventEmitter = this.#restApi.xoApp.objects.allIndexes.type.getEventEmitterByType(isMessage ? 'message' : type);
             }
-            listener = new XoListener(type, eventEmitter, isAlarm ? this.#alarmService : undefined);
+            listener = new XoListener(type, eventEmitter, isMessage ? this.#alarmService : undefined);
         }
         this.#listeners.set(type, listener);
         return listener;
     }
     createSseSubscriber(res) {
-        const subscriber = new Subscriber(res, this.#subscriberManager);
+        const headers = new Headers({
+            'Content-Type': 'text/event-stream',
+            Connection: 'keep-alive',
+            'Cache-Control': 'no-cache, no-transform',
+        });
+        res.setHeaders(headers);
+        const maxRam = this.#restApi.xoApp.config.get('rest-api.percentOfRamAllocatedPerSseClient');
+        const connection = new PassThrough({
+            highWaterMark: Math.round(os.totalmem() * (maxRam / 100)),
+        });
+        pipeline(connection, res, error => {
+            if (error?.code !== 'ERR_STREAM_PREMATURE_CLOSE') {
+                log.error(error);
+            }
+        });
+        const subscriber = new Subscriber(connection, this.#subscriberManager);
         subscriber.broadcast('init', { id: subscriber.id });
         this.addListenerFor(subscriber.id, { type: 'ping' });
         log.debug(`new SSE subscriber added: ${subscriber.id}`);

package/dist/helpers/object-wrapper.helper.mjs CHANGED Viewed

@@ -1,7 +1,5 @@
-import path from 'node:path';
 import pick from 'lodash/pick.js';
 import { BASE_URL } from '../index.mjs';
-const { join } = path.posix;
 export function makeObjectMapper(req, path) {
     const makeUrl = (obj) => {
         let _path;
@@ -9,9 +7,16 @@ export function makeObjectMapper(req, path) {
             _path = req.path;
         }
         else {
-            _path = `${BASE_URL}/${typeof path === 'string' ? path : path(obj)}`;
+            let tmpPath = typeof path === 'string' ? path : path(obj);
+            if (tmpPath.startsWith('/')) {
+                tmpPath = tmpPath.slice(1);
+            }
+            if (tmpPath.endsWith('/')) {
+                tmpPath = tmpPath.slice(0, -1);
+            }
+            _path = `${BASE_URL}/${tmpPath}`;
         }
-        return join(_path, typeof obj.id === 'number' ? String(obj.id) : obj.id);
+        return `${_path}/${String(obj.id)}`;
     };
     let objectMapper;
     const { query } = req;

package/dist/middlewares/authentication.middleware.mjs CHANGED Viewed

@@ -51,7 +51,7 @@ export function setupApiContext(xoApp) {
             res.locals.authType = 'basic';
         }
         try {
-            const { user } = await xoApp.authenticateUser(credentials, { ip });
+            const { user } = await xoApp.authenticateUser(credentials, { ip }, { bypassTaskCreation: hasToken });
             return xoApp.runWithApiContext(user, next);
         }
         catch (error) {

package/dist/open-api/oa-examples/vif.oa-example.mjs CHANGED Viewed

@@ -2,6 +2,7 @@ export const vifIds = [
     '/rest/v0/vifs/f028c5d4-578a-332c-394e-087aaca32dd3',
     '/rest/v0/vifs/9cc245bf-8dac-8550-e1ae-54bc679b68d9',
 ];
+export const vifId = { id: 'f028c5d4-578a-332c-394e-087aaca32dd3' };
 export const partialVifs = [
     {
         attached: true,

package/dist/open-api/routes/routes.js CHANGED Viewed

@@ -493,6 +493,21 @@ const models = {
         "type": { "ref": "Unbrand_XoVif_", "validators": {} },
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__": {
+        "dataType": "refAlias",
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "other_config": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "device": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "MTU": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "currently_attached": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "ipv4_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "ipv6_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "locking_mode": { "dataType": "union", "subSchemas": [{ "ref": "VIF_LOCKING_MODE" }, { "dataType": "undefined" }] }, "qos_algorithm_params": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "qos_algorithm_type": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } }, "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Omit_CreateVifParams_91_0_93_.network-or-VM_": {
+        "dataType": "refAlias",
+        "type": { "ref": "Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__", "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "CreateVifBody": {
+        "dataType": "refAlias",
+        "type": { "dataType": "intersection", "subSchemas": [{ "ref": "Omit_CreateVifParams_91_0_93_.network-or-VM_" }, { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "MAC": { "dataType": "string" } } }, { "dataType": "undefined" }] }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "vmId": { "dataType": "string", "required": true }, "networkId": { "dataType": "string", "required": true } } }], "validators": {} },
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Exclude_SUPPORTED_VDI_FORMAT.qcow2_": {
         "dataType": "refAlias",
         "type": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["raw"] }, { "dataType": "enum", "enums": ["vhd"] }], "validators": {} },
@@ -525,7 +540,7 @@ const models = {
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Pick_Unbrand_Parameters_Xapi_91_VBD_create_93___91_0_93__.Exclude_keyofUnbrand_Parameters_Xapi_91_VBD_create_93___91_0_93__.VM-or-VDI__": {
         "dataType": "refAlias",
-        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "type": { "dataType": "union", "subSchemas": [{ "ref": "VBD_TYPE" }, { "dataType": "undefined" }] }, "other_config": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "mode": { "dataType": "union", "subSchemas": [{ "ref": "VBD_MODE" }, { "dataType": "undefined" }] }, "bootable": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "empty": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "qos_algorithm_params": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "qos_algorithm_type": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "unpluggable": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "userdevice": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } }, "validators": {} },
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "type": { "dataType": "union", "subSchemas": [{ "ref": "VBD_TYPE" }, { "dataType": "undefined" }] }, "other_config": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "mode": { "dataType": "union", "subSchemas": [{ "ref": "VBD_MODE" }, { "dataType": "undefined" }] }, "qos_algorithm_params": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.string_" }, { "dataType": "undefined" }] }, "qos_algorithm_type": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "bootable": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "empty": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "unpluggable": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "userdevice": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } }, "validators": {} },
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Omit_Unbrand_Parameters_Xapi_91_VBD_create_93___91_0_93__.VM-or-VDI_": {
@@ -807,7 +822,7 @@ const models = {
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Unbrand_CreateVmBody_": {
         "dataType": "refAlias",
-        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "memory": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "string", "required": true }, "secureBoot": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "clone": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "gpuGroup": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vgpuType": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "autoPoweron": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "vifs": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "network": { "dataType": "string", "required": true }, "mtu": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "mac": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "ipv6_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "ipv4_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "device": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "device": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "copyHostBiosStrings": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "hvmBootFirmware": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["uefi"] }, { "dataType": "enum", "enums": ["bios"] }, { "dataType": "undefined" }] }, "template": { "dataType": "string", "required": true }, "affinity": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vdis": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "double", "required": true }, "name_label": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "userdevice": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "userdervice": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "install": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "repository": { "dataType": "string", "required": true }, "method": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["network"] }, { "dataType": "enum", "enums": ["cdrom"] }], "required": true } } }, { "dataType": "undefined" }] }, "cloud_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "network_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "boot": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "destroy_cloud_config_vdi": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "createVtpm": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] } }, "validators": {} },
+        "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "memory": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "string", "required": true }, "secureBoot": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "clone": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "gpuGroup": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vgpuType": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "autoPoweron": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "vifs": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "network": { "dataType": "string", "required": true }, "mtu": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "mac": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "ipv6_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "ipv4_allowed": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "string" } }, { "dataType": "undefined" }] }, "device": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "device": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "copyHostBiosStrings": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "hvmBootFirmware": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["uefi"] }, { "dataType": "enum", "enums": ["bios"] }, { "dataType": "undefined" }] }, "template": { "dataType": "string", "required": true }, "affinity": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "vdis": { "dataType": "union", "subSchemas": [{ "dataType": "array", "array": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "double", "required": true }, "name_label": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "name_description": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "sr": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "size": { "dataType": "union", "subSchemas": [{ "dataType": "double" }, { "dataType": "undefined" }] }, "name_label": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "userdevice": { "dataType": "string", "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "userdervice": { "dataType": "string", "required": true }, "destroy": { "dataType": "enum", "enums": [true], "required": true } } }] } }, { "dataType": "undefined" }] }, "install": { "dataType": "union", "subSchemas": [{ "dataType": "nestedObjectLiteral", "nestedProperties": { "repository": { "dataType": "string", "required": true }, "method": { "dataType": "enum", "enums": ["cdrom"], "required": true } } }, { "dataType": "nestedObjectLiteral", "nestedProperties": { "repository": { "dataType": "enum", "enums": [""], "required": true }, "method": { "dataType": "enum", "enums": ["network"], "required": true } } }, { "dataType": "undefined" }] }, "cloud_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "network_config": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "boot": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "destroy_cloud_config_vdi": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "createVtpm": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] } }, "validators": {} },
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "XapiHostStatsRaw": {
@@ -3054,6 +3069,60 @@ export function RegisterRoutes(app) {
         }
     });
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    const argsVifController_createVif = {
+        body: { "in": "body", "name": "body", "required": true, "ref": "CreateVifBody" },
+    };
+    app.post('/rest/v0/vifs', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VifController)), ...(fetchMiddlewares(VifController.prototype.createVif)), async function VifController_createVif(request, response, next) {
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        let validatedArgs = [];
+        try {
+            validatedArgs = templateService.getValidatedArgs({ args: argsVifController_createVif, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VifController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'createVif',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 201,
+            });
+        }
+        catch (err) {
+            return next(err);
+        }
+    });
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    const argsVifController_destroyVif = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+    };
+    app.delete('/rest/v0/vifs/:id', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VifController)), ...(fetchMiddlewares(VifController.prototype.destroyVif)), async function VifController_destroyVif(request, response, next) {
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        let validatedArgs = [];
+        try {
+            validatedArgs = templateService.getValidatedArgs({ args: argsVifController_destroyVif, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VifController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'destroyVif',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 204,
+            });
+        }
+        catch (err) {
+            return next(err);
+        }
+    });
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     const argsVdiController_getVdis = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },

package/dist/pools/pool.controller.mjs CHANGED Viewed

@@ -166,9 +166,18 @@ let PoolController = class PoolController extends XapiXoController {
     async createVm(id, body, sync) {
         const poolId = id;
         const action = async () => {
-            const { affinity, template, ...rest } = body;
-            const params = { affinityHost: affinity, ...rest };
-            const vmId = await this.#vmService.create({ pool: poolId, template, ...params });
+            const { affinity, template, install, vgpuType, gpuGroup, vdis, ...rest } = body;
+            // rebrand all branded type
+            const vmId = await this.#vmService.create({
+                affinityHost: affinity,
+                installRepository: install?.repository,
+                pool: poolId,
+                template: template,
+                vdis: vdis,
+                vgpuType: vgpuType,
+                gpuGroup: gpuGroup,
+                ...rest,
+            });
             return { id: vmId };
         };
         return this.createAction(action, {

package/dist/pools/pool.service.mjs CHANGED Viewed

@@ -163,7 +163,7 @@ export class PoolService {
     #getCpuProvisioning(poolId) {
         const pool = this.#restApi.getObject(poolId, 'pool');
         const vms = this.#restApi.getObjectsByType('VM', {
-            filter: vm => vm.$pool === poolId,
+            filter: vm => vm.$pool === poolId && vm.power_state === VM_POWER_STATE.RUNNING,
         });
         let assignedVcpu = 0;
         for (const id in vms) {

package/dist/vifs/vif.controller.mjs CHANGED Viewed

@@ -7,14 +7,16 @@ 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 { inject } from 'inversify';
+import { json } from 'express';
 import { escapeUnsafeComplexMatcher } from '../helpers/utils.helper.mjs';
 import { provide } from 'inversify-binding-decorators';
 import { RestApi } from '../rest-api/rest-api.mjs';
-import { badRequestResp, notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { badRequestResp, createdResp, internalServerErrorResp, invalidParameters as invalidParametersResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { invalidParameters } from 'xo-common/api-errors.js';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
-import { partialVifs, vif, vifIds } from '../open-api/oa-examples/vif.oa-example.mjs';
+import { partialVifs, vif, vifId, vifIds } from '../open-api/oa-examples/vif.oa-example.mjs';
 import { genericAlarmsExample } from '../open-api/oa-examples/alarm.oa-example.mjs';
 import { AlarmService } from '../alarms/alarm.service.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
@@ -73,6 +75,37 @@ let VifController = class VifController extends XapiXoController {
         const tasks = await this.getTasksForObject(id, { filter, limit });
         return this.sendObjects(Object.values(tasks), req, 'tasks');
     }
+    /**
+     * @example body {
+     *  "networkId": "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414",
+     *  "vmId": "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+     * }
+     */
+    async createVif(body) {
+        const { MAC, vmId, networkId, ...rest } = body;
+        const vm = this.restApi.getObject(vmId, 'VM');
+        const network = this.restApi.getObject(networkId, 'network');
+        if (vm.$pool !== network.$pool) {
+            throw invalidParameters(`the VM ${vmId} and network ${networkId} do not belong to the same pool`);
+        }
+        const xapi = this.getXapi(vmId);
+        const vifRef = await xapi.VIF_create({
+            ...rest,
+            VM: vm._xapiRef,
+            network: network._xapiRef,
+        }, {
+            MAC,
+        });
+        const xapiVif = await xapi.barrier(vifRef);
+        return { id: xapiVif.uuid };
+    }
+    /**
+     * @example id "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414"
+     */
+    async destroyVif(id) {
+        const xapi = this.getXapi(id);
+        await xapi.deleteVif(id);
+    }
 };
 __decorate([
     Example(vifIds),
@@ -128,6 +161,23 @@ __decorate([
     __param(4, Query()),
     __param(5, Query())
 ], VifController.prototype, "getVifTasks", null);
+__decorate([
+    Example(vifId),
+    Post(''),
+    Middlewares(json()),
+    SuccessResponse(createdResp.status, createdResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    Response(invalidParametersResp.status, invalidParametersResp.description),
+    __param(0, Body())
+], VifController.prototype, "createVif", null);
+__decorate([
+    Delete('{id}'),
+    SuccessResponse(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path())
+], VifController.prototype, "destroyVif", null);
 VifController = __decorate([
     Route('vifs'),
     Security('*'),

package/open-api/spec/swagger.json CHANGED Viewed

@@ -5559,6 +5559,80 @@
 			"UnbrandedXoVif": {
 				"$ref": "#/components/schemas/Unbrand_XoVif_"
 			},
+			"Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__": {
+				"properties": {
+					"other_config": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"device": {
+						"type": "string"
+					},
+					"MTU": {
+						"type": "number",
+						"format": "double"
+					},
+					"currently_attached": {
+						"type": "boolean"
+					},
+					"ipv4_allowed": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"ipv6_allowed": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"locking_mode": {
+						"$ref": "#/components/schemas/VIF_LOCKING_MODE"
+					},
+					"qos_algorithm_params": {
+						"$ref": "#/components/schemas/Record_string.string_"
+					},
+					"qos_algorithm_type": {
+						"type": "string"
+					}
+				},
+				"type": "object",
+				"description": "From T, pick a set of properties whose keys are in the union K"
+			},
+			"Omit_CreateVifParams_91_0_93_.network-or-VM_": {
+				"$ref": "#/components/schemas/Pick_CreateVifParams_91_0_93_.Exclude_keyofCreateVifParams_91_0_93_.network-or-VM__",
+				"description": "Construct a type with the properties of T except for those in type K."
+			},
+			"CreateVifBody": {
+				"allOf": [
+					{
+						"$ref": "#/components/schemas/Omit_CreateVifParams_91_0_93_.network-or-VM_"
+					},
+					{
+						"properties": {
+							"MAC": {
+								"type": "string"
+							}
+						},
+						"type": "object"
+					},
+					{
+						"properties": {
+							"vmId": {
+								"type": "string"
+							},
+							"networkId": {
+								"type": "string"
+							}
+						},
+						"required": [
+							"vmId",
+							"networkId"
+						],
+						"type": "object"
+					}
+				]
+			},
 			"Exclude_SUPPORTED_VDI_FORMAT.qcow2_": {
 				"type": "string",
 				"enum": [
@@ -5835,18 +5909,18 @@
 					"mode": {
 						"$ref": "#/components/schemas/VBD_MODE"
 					},
-					"bootable": {
-						"type": "boolean"
-					},
-					"empty": {
-						"type": "boolean"
-					},
 					"qos_algorithm_params": {
 						"$ref": "#/components/schemas/Record_string.string_"
 					},
 					"qos_algorithm_type": {
 						"type": "string"
 					},
+					"bootable": {
+						"type": "boolean"
+					},
+					"empty": {
+						"type": "boolean"
+					},
 					"unpluggable": {
 						"type": "boolean"
 					},
@@ -7852,23 +7926,50 @@
 						"type": "array"
 					},
 					"install": {
-						"properties": {
-							"repository": {
-								"type": "string"
+						"anyOf": [
+							{
+								"properties": {
+									"repository": {
+										"type": "string"
+									},
+									"method": {
+										"type": "string",
+										"enum": [
+											"cdrom"
+										],
+										"nullable": false
+									}
+								},
+								"required": [
+									"repository",
+									"method"
+								],
+								"type": "object"
 							},
-							"method": {
-								"type": "string",
-								"enum": [
-									"network",
-									"cdrom"
-								]
+							{
+								"properties": {
+									"repository": {
+										"type": "string",
+										"enum": [
+											""
+										],
+										"nullable": false
+									},
+									"method": {
+										"type": "string",
+										"enum": [
+											"network"
+										],
+										"nullable": false
+									}
+								},
+								"required": [
+									"repository",
+									"method"
+								],
+								"type": "object"
 							}
-						},
-						"required": [
-							"repository",
-							"method"
-						],
-						"type": "object"
+						]
 					},
 					"cloud_config": {
 						"type": "string"
@@ -12052,7 +12153,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.24.0",
+		"version": "0.24.1",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -18039,6 +18140,74 @@
 						"example": 42
 					}
 				]
+			},
+			"post": {
+				"operationId": "CreateVif",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"properties": {
+										"id": {
+											"type": "string"
+										}
+									},
+									"required": [
+										"id"
+									],
+									"type": "object"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"id": "f028c5d4-578a-332c-394e-087aaca32dd3"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"vifs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/CreateVifBody"
+							},
+							"example": {
+								"networkId": "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414",
+								"vmId": "613f541c-4bed-fc77-7ca8-2db6b68f079c"
+							}
+						}
+					}
+				}
 			}
 		},
 		"/vifs/{id}": {
@@ -18107,6 +18276,45 @@
 						"example": "f028c5d4-578a-332c-394e-087aaca32dd3"
 					}
 				]
+			},
+			"delete": {
+				"operationId": "DestroyVif",
+				"responses": {
+					"204": {
+						"description": "No content"
+					},
+					"400": {
+						"description": "Bad request"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"vifs"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "6b6ca0f5-6611-0636-4b0a-1fb1c1e96414"
+					}
+				]
 			}
 		},
 		"/vifs/{id}/alarms": {

package/package.json CHANGED Viewed

@@ -6,7 +6,7 @@
   "main": "./dist/index.mjs",
   "name": "@xen-orchestra/rest-api",
   "homepage": "https://github.com/vatesfr/xen-orchestra/tree/master/@xen-orchestra/rest-api",
-  "version": "0.24.0",
+  "version": "0.24.1",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,
@@ -36,7 +36,7 @@
     "@vates/async-each": "^1.0.1",
     "@vates/task": "^0.6.1",
     "@vates/types": "^1.18.0",
-    "@xen-orchestra/backups": "^0.68.0",
+    "@xen-orchestra/backups": "^0.68.1",
     "@xen-orchestra/log": "^0.7.1",
     "@xen-orchestra/xapi": "^8.6.5",
     "complex-matcher": "^1.0.0",