@xen-orchestra/rest-api 0.6.0 → 0.7.0

package/README.md

@@ -48,6 +48,7 @@ class Foo extends Controller {
  @Example(['foo', 'bar'])
  @Get('{id}')
  @Security('*')
+ @Middlewares(json())
  @SuccessResponse(202)
  @Response(404)
  getFoo(@Path() id: string) {

package/dist/middlewares/generic-error-handler.middleware.mjs

@@ -1,5 +1,5 @@
 import { createLogger } from '@xen-orchestra/log';
-import { featureUnauthorized, forbiddenOperation, invalidCredentials, invalidParameters, noSuchObject, notImplemented, unauthorized, } from 'xo-common/api-errors.js';
+import { featureUnauthorized, forbiddenOperation, incorrectState, invalidCredentials, invalidParameters, noSuchObject, notImplemented, objectAlreadyExists, unauthorized, } from 'xo-common/api-errors.js';
 const log = createLogger('xo:rest-api:error-handler');
 // must have 4 parameters to be recognized as an error middleware by express
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -19,12 +19,19 @@ export default function genericErrorHandler(error, req, res, _next) {
     else if (invalidCredentials.is(error)) {
         res.status(401);
     }
+    else if (objectAlreadyExists.is(error)) {
+        res.status(409);
+    }
     else if (invalidParameters.is(error)) {
         res.status(422);
     }
     else if (notImplemented.is(error)) {
         res.status(501);
     }
+    else if (incorrectState.is(error)) {
+        res.status(409);
+        responseError.data = error.data;
+    }
     else {
         if (error.name === 'XapiError') {
             responseError.info = 'This is a XenServer/XCP-ng error, not an XO error';

package/dist/{open-api/networks → networks}/network.controller.mjs

@@ -10,10 +10,10 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Example, Get, Path, Query, Response, Request, Route, Security, Tags } from 'tsoa';
 import { inject } from 'inversify';
 import { provide } from 'inversify-binding-decorators';
-import { network, networkIds, partialNetworks } from '../oa-examples/network.oa-example.mjs';
-import { notFoundResp, unauthorizedResp } from '../common/response.common.mjs';
-import { RestApi } from '../../rest-api/rest-api.mjs';
-import { XapiXoController } from '../../abstract-classes/xapi-xo-controller.mjs';
+import { network, networkIds, partialNetworks } from '../open-api/oa-examples/network.oa-example.mjs';
+import { notFoundResp, unauthorizedResp } from '../open-api/common/response.common.mjs';
+import { RestApi } from '../rest-api/rest-api.mjs';
+import { XapiXoController } from '../abstract-classes/xapi-xo-controller.mjs';
 let NetworkController = class NetworkController extends XapiXoController {
     constructor(restApi) {
         super('network', restApi);

package/dist/open-api/common/response.common.mjs

@@ -1,3 +1,7 @@
+export const createdResp = {
+    status: 201,
+    description: 'Resource created',
+};
 export const actionAsyncroneResp = {
     status: 202,
     description: 'Action executed asynchronously',
@@ -23,3 +27,11 @@ export const internalServerErrorResp = {
     status: 500,
     description: 'Internal server error, XenServer/XCP-ng error',
 };
+export const resourceAlreadyExists = {
+    status: 409,
+    description: 'Resource already exists',
+};
+export const invalidParameters = {
+    status: 422,
+    description: 'Invalid parameters',
+};

package/dist/open-api/oa-examples/server.oa-example.mjs

@@ -1,3 +1,4 @@
+export const serverId = { id: '38068475-3a1d-4a64-95df-8782cdea02ac' };
 export const serverIds = [
     '/rest/v0/servers/f07ab729-c0e8-721c-45ec-f11276377030',
     '/rest/v0/servers/d5d1c4a3-4c5e-ca7b-6be8-33c824f87571',

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

@@ -26,7 +26,7 @@ import { ScheduleController } from './../../schedules/schedule.controller.mjs';
 // 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
 import { PoolController } from './../../pools/pool.controller.mjs';
 // 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
-import { NetworkController } from './../networks/network.controller.mjs';
+import { NetworkController } from './../../networks/network.controller.mjs';
 // 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
 import { AlarmController } from './../../alarms/alarm.controller.mjs';
 // 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
@@ -281,6 +281,20 @@ const models = {
         "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "allowUnauthorized": { "dataType": "boolean", "required": true }, "enabled": { "dataType": "boolean", "required": true }, "error": { "dataType": "union", "subSchemas": [{ "ref": "Record_string.unknown_" }, { "dataType": "undefined" }] }, "host": { "dataType": "string", "required": true }, "httpProxy": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "id": { "dataType": "string", "required": true }, "label": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "poolId": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "poolNameDescription": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "poolNameLabel": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "readOnly": { "dataType": "boolean", "required": true }, "status": { "dataType": "union", "subSchemas": [{ "dataType": "enum", "enums": ["connected"] }, { "dataType": "enum", "enums": ["disconnected"] }, { "dataType": "enum", "enums": ["connecting"] }], "required": true }, "username": { "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
+    "InsertableXoServer": {
+        "dataType": "refObject",
+        "properties": {
+            "host": { "dataType": "string", "required": true },
+            "httpProxy": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] },
+            "label": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] },
+            "username": { "dataType": "string", "required": true },
+            "allowUnauthorized": { "dataType": "boolean" },
+            "password": { "dataType": "string", "required": true },
+            "readOnly": { "dataType": "boolean" },
+        },
+        "additionalProperties": false,
+    },
+    // 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
     "Partial_Unbrand_XoSchedule__": {
         "dataType": "refAlias",
         "type": { "dataType": "nestedObjectLiteral", "nestedProperties": { "cron": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "enable": { "dataType": "union", "subSchemas": [{ "dataType": "boolean" }, { "dataType": "undefined" }] }, "id": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "jobId": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "name": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] }, "timezone": { "dataType": "union", "subSchemas": [{ "dataType": "string" }, { "dataType": "undefined" }] } }, "validators": {} },
@@ -557,6 +571,118 @@ 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 argsVmController_cleanShutdownVm = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/vms/:id/actions/clean_shutdown', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmController)), ...(fetchMiddlewares(VmController.prototype.cleanShutdownVm)), async function VmController_cleanShutdownVm(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: argsVmController_cleanShutdownVm, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'cleanShutdownVm',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 202,
+            });
+        }
+        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 argsVmController_cleanRebootVm = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/vms/:id/actions/clean_reboot', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmController)), ...(fetchMiddlewares(VmController.prototype.cleanRebootVm)), async function VmController_cleanRebootVm(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: argsVmController_cleanRebootVm, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'cleanRebootVm',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+            });
+        }
+        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 argsVmController_hardShutdownVm = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/vms/:id/actions/hard_shutdown', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmController)), ...(fetchMiddlewares(VmController.prototype.hardShutdownVm)), async function VmController_hardShutdownVm(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: argsVmController_hardShutdownVm, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'hardShutdownVm',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 202,
+            });
+        }
+        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 argsVmController_hardRebootVm = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/vms/:id/actions/hard_reboot', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(VmController)), ...(fetchMiddlewares(VmController.prototype.hardRebootVm)), async function VmController_hardRebootVm(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: argsVmController_hardRebootVm, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(VmController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'hardRebootVm',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 202,
+            });
+        }
+        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 argsVmTemplateController_getVmTemplates = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },
@@ -1127,6 +1253,89 @@ 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 argsServerController_addServer = {
+        body: { "in": "body", "name": "body", "required": true, "ref": "InsertableXoServer" },
+    };
+    app.post('/rest/v0/servers', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(ServerController)), ...(fetchMiddlewares(ServerController.prototype.addServer)), async function ServerController_addServer(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: argsServerController_addServer, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(ServerController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'addServer',
+                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 argsServerController_connectServer = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/servers/:id/actions/connect', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(ServerController)), ...(fetchMiddlewares(ServerController.prototype.connectServer)), async function ServerController_connectServer(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: argsServerController_connectServer, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(ServerController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'connectServer',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 202,
+            });
+        }
+        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 argsServerController_disconnectServer = {
+        id: { "in": "path", "name": "id", "required": true, "dataType": "string" },
+        sync: { "in": "query", "name": "sync", "dataType": "boolean" },
+    };
+    app.post('/rest/v0/servers/:id/actions/disconnect', authenticateMiddleware([{ "*": [] }]), ...(fetchMiddlewares(ServerController)), ...(fetchMiddlewares(ServerController.prototype.disconnectServer)), async function ServerController_disconnectServer(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: argsServerController_disconnectServer, request, response });
+            const container = typeof iocContainer === 'function' ? iocContainer(request) : iocContainer;
+            const controller = await container.get(ServerController);
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            await templateService.apiHandler({
+                methodName: 'disconnectServer',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: 202,
+            });
+        }
+        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 argsScheduleController_getSchedules = {
         req: { "in": "request", "name": "req", "required": true, "dataType": "object" },
         fields: { "in": "query", "name": "fields", "dataType": "string" },

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

@@ -70,6 +70,76 @@ 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,
+            },
+        });
+    }
 };
 __decorate([
     Example(vmIds),
@@ -104,6 +174,42 @@ __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);
 VmController = __decorate([
     Route('vms'),
     Security('*'),

package/open-api/spec/swagger.json

@@ -4443,6 +4443,38 @@
 				],
 				"type": "object"
 			},
+			"InsertableXoServer": {
+				"properties": {
+					"host": {
+						"type": "string"
+					},
+					"httpProxy": {
+						"type": "string"
+					},
+					"label": {
+						"type": "string"
+					},
+					"username": {
+						"type": "string"
+					},
+					"allowUnauthorized": {
+						"type": "boolean"
+					},
+					"password": {
+						"type": "string"
+					},
+					"readOnly": {
+						"type": "boolean"
+					}
+				},
+				"required": [
+					"host",
+					"username",
+					"password"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
 			"Partial_Unbrand_XoSchedule__": {
 				"properties": {
 					"cron": {
@@ -6226,7 +6258,7 @@
 	},
 	"info": {
 		"title": "@xen-orchestra/rest-api",
-		"version": "0.6.0",
+		"version": "0.7.0",
 		"description": "REST API to manage your XOA",
 		"license": {
 			"name": "AGPL-3.0-or-later"
@@ -7825,6 +7857,263 @@
 				]
 			}
 		},
+		"/vms/{id}/actions/clean_shutdown": {
+			"post": {
+				"operationId": "CleanShutdownVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{
+											"type": "string"
+										},
+										{}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"description": "Requires guest tools to be installed",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/clean_reboot": {
+			"post": {
+				"operationId": "CleanRebootVm",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					}
+				},
+				"description": "Requires guest tools to be installed",
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/hard_shutdown": {
+			"post": {
+				"operationId": "HardShutdownVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{
+											"type": "string"
+										},
+										{}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
+		"/vms/{id}/actions/hard_reboot": {
+			"post": {
+				"operationId": "HardRebootVm",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"500": {
+						"description": "Internal server error, XenServer/XCP-ng error"
+					}
+				},
+				"tags": [
+					"vms"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
 		"/vm-templates": {
 			"get": {
 				"operationId": "GetVmTemplates",
@@ -9721,6 +10010,71 @@
 						"example": 42
 					}
 				]
+			},
+			"post": {
+				"operationId": "AddServer",
+				"responses": {
+					"201": {
+						"description": "Resource created",
+						"content": {
+							"application/json": {
+								"schema": {
+									"properties": {
+										"id": {
+											"type": "string"
+										}
+									},
+									"required": [
+										"id"
+									],
+									"type": "object"
+								},
+								"examples": {
+									"Example 1": {
+										"value": {
+											"id": "38068475-3a1d-4a64-95df-8782cdea02ac"
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"409": {
+						"description": "Resource already exists"
+					},
+					"422": {
+						"description": "Invalid parameters"
+					}
+				},
+				"tags": [
+					"servers"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/InsertableXoServer"
+							},
+							"example": {
+								"allowUnauthorized": true,
+								"host": "192.168.1.10",
+								"label": "Example server",
+								"username": "root",
+								"password": "awes0meP4ssword"
+							}
+						}
+					}
+				}
 			}
 		},
 		"/servers/{id}": {
@@ -9781,6 +10135,138 @@
 				]
 			}
 		},
+		"/servers/{id}/actions/connect": {
+			"post": {
+				"operationId": "ConnectServer",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"409": {
+						"description": "The server is already connected"
+					}
+				},
+				"tags": [
+					"servers"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
+		"/servers/{id}/actions/disconnect": {
+			"post": {
+				"operationId": "DisconnectServer",
+				"responses": {
+					"202": {
+						"description": "Action executed asynchronously",
+						"content": {
+							"text/plain": {
+								"schema": {
+									"anyOf": [
+										{},
+										{
+											"type": "string"
+										}
+									]
+								},
+								"examples": {
+									"Example 1": {
+										"value": "/rest/v0/tasks/0m7kl0j9l"
+									}
+								}
+							}
+						}
+					},
+					"204": {
+						"description": "No content"
+					},
+					"401": {
+						"description": "Authentication required"
+					},
+					"404": {
+						"description": "Resource not found"
+					},
+					"409": {
+						"description": "The server is already disconnected"
+					}
+				},
+				"tags": [
+					"servers"
+				],
+				"security": [
+					{
+						"*": []
+					}
+				],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"example": "f07ab729-c0e8-721c-45ec-f11276377030"
+					},
+					{
+						"in": "query",
+						"name": "sync",
+						"required": false,
+						"schema": {
+							"type": "boolean"
+						}
+					}
+				]
+			}
+		},
 		"/schedules": {
 			"get": {
 				"operationId": "GetSchedules",

package/package.json

@@ -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.6.0",
+  "version": "0.7.0",
   "description": "REST API to manage your XOA",
   "license": "AGPL-3.0-or-later",
   "private": false,
@@ -32,7 +32,7 @@
     "typescript-eslint": "^8.23.0"
   },
   "dependencies": {
-    "@vates/types": "^1.2.0",
+    "@vates/types": "^1.3.0",
     "@xen-orchestra/log": "^0.7.1",
     "complex-matcher": "^0.7.1",
     "inversify": "^6.2.2",