@xen-orchestra/rest-api 0.27.0 → 0.28.0

package/dist/pools/pool.controller.mjs

@@ -26,15 +26,18 @@ import { VmService } from '../vms/vm.service.mjs';
 import { PoolService } from './pool.service.mjs';
 import { escapeUnsafeComplexMatcher, NDJSON_CONTENT_TYPE } from '../helpers/utils.helper.mjs';
 import { messageIds, partialMessages } from '../open-api/oa-examples/message.oa-example.mjs';
+import { NetworkService } from '../networks/network.service.mjs';
 let PoolController = class PoolController extends XapiXoController {
     #vmService;
     #poolService;
     #alarmService;
-    constructor(restApi, vmService, poolService, alarmService) {
+    #networkService;
+    constructor(restApi, vmService, poolService, alarmService, networkService) {
         super('pool', restApi);
         this.#vmService = vmService;
         this.#poolService = poolService;
         this.#alarmService = alarmService;
+        this.#networkService = networkService;
     }
     /**
      *
@@ -64,10 +67,8 @@ let PoolController = class PoolController extends XapiXoController {
         const poolId = id;
         const action = async () => {
             const { pif, ...rest } = body;
-            const xapiPool = this.getXapiObject(poolId);
-            const xapiNetwork = await xapiPool.$xapi.createNetwork({ pifId: pif, ...rest });
-            const network = this.restApi.getObject(xapiNetwork.uuid, 'network');
-            return { id: network.id };
+            const networkId = await this.#networkService.create(poolId, { pifId: pif, ...rest });
+            return { id: networkId };
         };
         return this.createAction(action, {
             sync,
@@ -79,6 +80,55 @@ let PoolController = class PoolController extends XapiXoController {
             },
         });
     }
+    /**
+     * @example id "355ee47d-ff4c-4924-3db2-fd86ae629676"
+     * @example body {
+     *    "name": "awes0me_bonded_network",
+     *    "description": "random description",
+     *    "pifIds": ["ad15b2c8-3d9a-194e-c43a-e3dcda74b256", "7b6bed50-26b2-bd27-8f3a-1b5a81989a92"],
+     *    "bondMode": "lacp"
+     * }
+     */
+    createBondedNetwork(id, body, sync) {
+        const poolId = id;
+        const action = async () => {
+            const { pifIds, ...rest } = body;
+            const networkId = await this.#networkService.create(poolId, { pifIds: pifIds, ...rest });
+            return { id: networkId };
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: createdResp.status,
+            taskProperties: {
+                name: 'create bonded network',
+                objectId: poolId,
+                args: body,
+            },
+        });
+    }
+    /**
+     * @example id "355ee47d-ff4c-4924-3db2-fd86ae629676"
+     * @example body {
+     *    "name": "awes0me_internal_network",
+     *    "description": "random description"
+     * }
+     */
+    createInternalNetwork(id, body, sync) {
+        const poolId = id;
+        const action = async () => {
+            const networkId = await this.#networkService.create(poolId, body);
+            return { id: networkId };
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: createdResp.status,
+            taskProperties: {
+                name: 'create internal network',
+                objectId: poolId,
+                args: body,
+            },
+        });
+    }
     /**
      * @example id "355ee47d-ff4c-4924-3db2-fd86ae629677"
      */
@@ -331,11 +381,42 @@ __decorate([
     SuccessResponse(createdResp.status, createdResp.description),
     Response(asynchronousActionResp.status, asynchronousActionResp.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())
 ], PoolController.prototype, "createNetwork", null);
+__decorate([
+    Example(taskLocation),
+    Example(createNetwork),
+    Post('{id}/actions/create_bonded_network'),
+    Middlewares(json()),
+    Tags('networks'),
+    SuccessResponse(createdResp.status, createdResp.description),
+    Response(asynchronousActionResp.status, asynchronousActionResp.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())
+], PoolController.prototype, "createBondedNetwork", null);
+__decorate([
+    Example(taskLocation),
+    Example(createNetwork),
+    Post('{id}/actions/create_internal_network'),
+    Middlewares(json()),
+    Tags('networks'),
+    SuccessResponse(createdResp.status, createdResp.description),
+    Response(asynchronousActionResp.status, asynchronousActionResp.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())
+], PoolController.prototype, "createInternalNetwork", null);
 __decorate([
     Example(taskLocation),
     Post('{id}/actions/emergency_shutdown'),
@@ -490,6 +571,7 @@ PoolController = __decorate([
     __param(0, inject(RestApi)),
     __param(1, inject(VmService)),
     __param(2, inject(PoolService)),
-    __param(3, inject(AlarmService))
+    __param(3, inject(AlarmService)),
+    __param(4, inject(NetworkService))
 ], PoolController);
 export { PoolController };

package/dist/srs/sr.controller.mjs

@@ -150,6 +150,24 @@ let SrController = class SrController extends XapiXoController {
             },
         });
     }
+    /**
+     * @example id "c4284e12-37c9-7967-b9e8-83ef229c3e03"
+     */
+    async forgetSr(id, sync) {
+        const srId = id;
+        const action = async () => {
+            const xapiSr = this.getXapiObject(srId);
+            await xapiSr.$xapi.forgetSr(srId);
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'forget sr',
+                objectId: srId,
+            },
+        });
+    }
 };
 __decorate([
     Example(srIds),
@@ -253,6 +271,17 @@ __decorate([
     __param(0, Path()),
     __param(1, Query())
 ], SrController.prototype, "scanSr", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/forget'),
+    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, "forgetSr", null);
 SrController = __decorate([
     Route('srs'),
     Security('*'),

package/dist/vms/vm.controller.mjs

@@ -325,6 +325,51 @@ let VmController = class VmController extends XapiXoController {
             },
         });
     }
+    /**
+     *
+     * - For fast clone on the same SR, omit `srId` and set `fast` to `true`.
+     * - For full copy on the same SR, omit `srId` and set `fast` to `false`.
+     * - To copy the VM to a different SR (always a full copy), provide `srId`. Supports cross-pool copy. Optionally use `compress: "gzip"` or `compress: "zstd"` to compress the export stream during cross-pool copy.
+     *
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example body { "name_label": "cloned_vm", "fast": true }
+     */
+    async cloneVm(id, body, sync) {
+        const vmId = id;
+        const action = async () => {
+            const xapi = this.getXapi(vmId);
+            let clonedVmUuid;
+            if (body !== undefined && 'srId' in body && body.srId !== undefined) {
+                const srId = body.srId;
+                const vm = this.getObject(vmId);
+                const sr = this.restApi.getObject(srId, 'SR');
+                if (vm.$pool === sr.$pool) {
+                    clonedVmUuid = (await xapi.copyVm(vmId, { nameLabel: body.name_label, srOrSrId: srId })).uuid;
+                }
+                else {
+                    const targetXapi = this.restApi.xoApp.getXapi(srId);
+                    clonedVmUuid = (await xapi.remoteCopyVm(vmId, targetXapi, srId, { compress: body.compress, nameLabel: body.name_label })).vm.uuid;
+                }
+            }
+            else {
+                const fast = body !== undefined && 'fast' in body ? body.fast : undefined;
+                clonedVmUuid = (await xapi.cloneVm(vmId, { nameLabel: body?.name_label, fast })).uuid;
+            }
+            if (sync) {
+                this.setHeader('Location', `${BASE_URL}/vms/${clonedVmUuid}`);
+            }
+            return { id: clonedVmUuid };
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: createdResp.status,
+            taskProperties: {
+                name: 'clone VM',
+                objectId: vmId,
+                params: body,
+            },
+        });
+    }
     /**
      * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
      * @example fields "id,time"
@@ -604,6 +649,19 @@ __decorate([
     __param(1, Body()),
     __param(2, Query())
 ], VmController.prototype, "snapshotVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/clone'),
+    Middlewares(json()),
+    SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description),
+    Response(createdResp.status, createdResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    Response(invalidParametersResp.status, invalidParametersResp.description),
+    __param(0, Path()),
+    __param(1, Body()),
+    __param(2, Query())
+], VmController.prototype, "cloneVm", null);
 __decorate([
     Example(genericAlarmsExample),
     Get('{id}/alarms'),

package/dist/vms/vm.service.mjs

@@ -86,7 +86,7 @@ export class VmService {
                     nSuspended++;
                     break;
                 default:
-                    log.warn('Invalid VM power_state', vm.id, vm.power_state);
+                    log.warn('Invalid VM power_state', { vmId: vm.id, vmPowerState: vm.power_state });
                     nUnknown++;
                     break;
             }

package/dist/xoa/xoa.service.mjs

@@ -8,7 +8,7 @@ import { extractIdsFromSimplePattern } from '@xen-orchestra/backups/extractIdsFr
 import { noSuchObject } from 'xo-common/api-errors.js';
 import { parse } from 'xo-remote-parser';
 import { getFromAsyncCache } from '../helpers/cache.helper.mjs';
-import { isReplicaVm, isSrWritableOrIso, promiseWriteInStream, vmContainsNoBakTag } from '../helpers/utils.helper.mjs';
+import { isReplicaVm, isSrWritable, promiseWriteInStream, vmContainsNoBakTag } from '../helpers/utils.helper.mjs';
 import { HostService } from '../hosts/host.service.mjs';
 import { BackupLogService } from '../backup-logs/backup-log.service.mjs';
 import { VmService } from '../vms/vm.service.mjs';
@@ -115,7 +115,7 @@ export class XoaService {
         const pools = Object.values(this.#restApi.getObjectsByType('pool'));
         const hosts = Object.values(this.#restApi.getObjectsByType('host'));
         const srs = Object.values(this.#restApi.getObjectsByType('SR', {
-            filter: isSrWritableOrIso,
+            filter: isSrWritable,
         }));
         if (pools.length === 0 && hosts.length === 0 && srs.length === 0) {
             return { isEmpty: true };
@@ -243,7 +243,7 @@ export class XoaService {
     }
     #getStorageRepositoriesSizeInfo() {
         const writableSrs = this.#restApi.getObjectsByType('SR', {
-            filter: isSrWritableOrIso,
+            filter: isSrWritable,
         });
         const srs = Object.values(writableSrs);
         if (srs.length === 0) {