@xen-orchestra/rest-api 0.6.0 → 0.8.0

package/dist/pifs/pif.controller.mjs

@@ -0,0 +1,59 @@
+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 { Example, Get, Path, Query, Request, Response, Route, Security, Tags } from 'tsoa';
+import { inject } from 'inversify';
+import { provide } from 'inversify-binding-decorators';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { partialPifs, pif, pifIds } from '../open-api/oa-examples/pif.oa-example.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+let PifController = class PifController extends XapiXoController {
+    constructor(restApi) {
+        super('PIF', restApi);
+    }
+    /**
+     * @example fields "attached,device,deviceName,id"
+     * @example filter "attached?"
+     * @example limit 42
+     */
+    getPifs(req, fields, filter, limit) {
+        return this.sendObjects(Object.values(this.getObjects({ filter, limit })), req);
+    }
+    /**
+     * @example id "d9e42451-3794-089f-de81-4ee0e6137bee"
+     */
+    getPif(id) {
+        return this.getObject(id);
+    }
+};
+__decorate([
+    Example(pifIds),
+    Example(partialPifs),
+    Get(''),
+    __param(0, Request()),
+    __param(1, Query()),
+    __param(2, Query()),
+    __param(3, Query())
+], PifController.prototype, "getPifs", null);
+__decorate([
+    Example(pif),
+    Get('{id}'),
+    Response(notFoundResp.status, notFoundResp.description),
+    __param(0, Path())
+], PifController.prototype, "getPif", null);
+PifController = __decorate([
+    Route('pifs'),
+    Security('*'),
+    Response(unauthorizedResp.status, unauthorizedResp.description),
+    Tags('pifs'),
+    provide(PifController),
+    __param(0, inject(RestApi))
+], PifController);
+export { PifController };

package/dist/servers/server.controller.mjs

@@ -7,10 +7,12 @@ 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, Example, Get, Middlewares, Path, Post, Query, Request, Response, Route, Security, SuccessResponse, Tags, } from 'tsoa';
+import { json } from 'express';
 import { provide } from 'inversify-binding-decorators';
-import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
-import { partialServers, server, serverIds } from '../open-api/oa-examples/server.oa-example.mjs';
+import { actionAsyncroneResp, 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 { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XoController } from '../abstract-classes/xo-controller.mjs';
 let ServerController = class ServerController extends XoController {
     // --- abstract methods
@@ -34,6 +36,47 @@ let ServerController = class ServerController extends XoController {
     getServer(id) {
         return this.getObject(id);
     }
+    /**
+     * @example body {
+     *   "allowUnauthorized": true,
+     *   "host": "192.168.1.10",
+     *   "label": "Example server",
+     *   "username": "root",
+     *   "password": "awes0meP4ssword"
+     * }
+     */
+    async addServer(body) {
+        const server = await this.restApi.xoApp.registerXenServer(body);
+        return { id: server.id };
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    connectServer(id, sync) {
+        const serverId = id;
+        const action = async () => {
+            await this.restApi.xoApp.connectXenServer(serverId);
+        };
+        return this.createAction(action, {
+            statusCode: noContentResp.status,
+            sync,
+            taskProperties: { name: 'connect server', objectId: serverId },
+        });
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    disconnectServer(id, sync) {
+        const serverId = id;
+        const action = async () => {
+            await this.restApi.xoApp.disconnectXenServer(serverId);
+        };
+        return this.createAction(action, {
+            statusCode: noContentResp.status,
+            sync,
+            taskProperties: { name: 'disconnect server', objectId: serverId },
+        });
+    }
 };
 __decorate([
     Example(serverIds),
@@ -50,6 +93,35 @@ __decorate([
     Response(notFoundResp.status, notFoundResp.description),
     __param(0, Path())
 ], ServerController.prototype, "getServer", null);
+__decorate([
+    Example(serverId),
+    Post(''),
+    Middlewares(json()),
+    SuccessResponse(createdResp.status, createdResp.description),
+    Response(resourceAlreadyExists.status, resourceAlreadyExists.description),
+    Response(invalidParameters.status, invalidParameters.description),
+    __param(0, Body())
+], ServerController.prototype, "addServer", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/connect'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(409, 'The server is already connected'),
+    __param(0, Path()),
+    __param(1, Query())
+], ServerController.prototype, "connectServer", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/disconnect'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(409, 'The server is already disconnected'),
+    __param(0, Path()),
+    __param(1, Query())
+], ServerController.prototype, "disconnectServer", null);
 ServerController = __decorate([
     Route('servers'),
     Security('*'),

package/dist/servers/server.type.mjs

@@ -0,0 +1 @@
+export {};

package/dist/vms/vm.controller.mjs

@@ -7,15 +7,17 @@ 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 } from 'tsoa';
+import { Example, Get, Path, Post, Query, Request, Response, Route, Security, Tags, SuccessResponse, Body } from 'tsoa';
 import { inject } from 'inversify';
 import { incorrectState, invalidParameters } from 'xo-common/api-errors.js';
 import { provide } from 'inversify-binding-decorators';
-import { actionAsyncroneResp, internalServerErrorResp, noContentResp, notFoundResp, unauthorizedResp, } from '../open-api/common/response.common.mjs';
+import { actionAsyncroneResp, 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';
 import { taskLocation } from '../open-api/oa-examples/task.oa-example.mjs';
 import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
+const IGNORED_VDIS_TAG = '[NOSNAP]';
 let VmController = class VmController extends XapiXoController {
     constructor(restApi) {
         super('VM', restApi);
@@ -70,6 +72,100 @@ let VmController = class VmController extends XapiXoController {
             },
         });
     }
+    /**
+     * Requires guest tools to be installed
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async cleanShutdownVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapiObject(vmId).$callAsync('clean_shutdown');
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'clean shutdown VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * Requires guest tools to be installed
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async cleanRebootVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapiObject(vmId).$callAsync('clean_reboot');
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'clean reboot VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async hardShutdownVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapiObject(vmId).$callAsync('hard_shutdown');
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'hard shutdown VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     */
+    async hardRebootVm(id, sync) {
+        const vmId = id;
+        const action = async () => {
+            await this.getXapiObject(vmId).$callAsync('hard_reboot');
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: noContentResp.status,
+            taskProperties: {
+                name: 'hard reboot VM',
+                objectId: vmId,
+            },
+        });
+    }
+    /**
+     * @example id "f07ab729-c0e8-721c-45ec-f11276377030"
+     * @example body { "name_label": "my_awesome_snapshot" }
+     */
+    async snapshotVm(id, body, sync) {
+        const vmId = id;
+        const action = async () => {
+            const xapiVm = this.getXapiObject(vmId);
+            const ref = await xapiVm.$snapshot({ ignoredVdisTag: IGNORED_VDIS_TAG, name_label: body?.name_label });
+            const snapshotId = await xapiVm.$xapi.getField('VM', ref, 'uuid');
+            if (sync) {
+                this.setHeader('Location', `${BASE_URL}/vm-snapshots/${snapshotId}`);
+            }
+            return { id: snapshotId };
+        };
+        return this.createAction(action, {
+            sync,
+            statusCode: createdResp.status,
+            taskProperties: {
+                name: 'snapshot VM',
+                objectId: vmId,
+            },
+        });
+    }
 };
 __decorate([
     Example(vmIds),
@@ -104,6 +200,53 @@ __decorate([
     __param(0, Path()),
     __param(1, Query())
 ], VmController.prototype, "startVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/clean_shutdown'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "cleanShutdownVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/clean_reboot'),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "cleanRebootVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/hard_shutdown'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(noContentResp.status, noContentResp.description),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Query())
+], VmController.prototype, "hardShutdownVm", null);
+__decorate([
+    Example(taskLocation),
+    Post('{id}/actions/hard_reboot'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.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/snapshot'),
+    SuccessResponse(actionAsyncroneResp.status, actionAsyncroneResp.description, actionAsyncroneResp.produce),
+    Response(createdResp.status, 'Snapshot created'),
+    Response(notFoundResp.status, notFoundResp.description),
+    Response(internalServerErrorResp.status, internalServerErrorResp.description),
+    __param(0, Path()),
+    __param(1, Body()),
+    __param(2, Query())
+], VmController.prototype, "snapshotVm", null);
 VmController = __decorate([
     Route('vms'),
     Security('*'),