Manage VirtualBox virtual machines using REST API. Based on Node.js and VBoxManage shell commands.
Install the package:
npm install -g vboxmanage-rest-apiMake sure the VirtualBox is installed:
vboxmanage -vStart the server:
vboxmanage-rest-api --port 8269 --verboseOpen in web browser:
http://localhost:8269/vboxmanage/list/vms
var express = require('express');
var app = express();
//Register the VBoxManage REST API with the prefix
var vboxservice = require('vboxmanage-rest-api');
app.use("/api/v1", vboxservice({ verbose: true }));
var port = 8269;
var server = app.listen(port, function() {
console.log('HTTP on port ' + server.address().port);
});Usage:
vboxmanage-rest-api [options]
Options:
--help Print this message
--port, -p [num] HTTP port number, default: 8269
--prefix [path] URL prefix: '/' for root or '/api/v1' etc.
--vboxmanage [path] Path to vboxmanage executable
--verbose Enable detailed logging
--version Print version number
Examples:
vboxmanage-rest-api
vboxmanage-rest-api --port 80
vboxmanage-rest-api --prefix /api/v1 --verbose
Run the server with --verbose argument to see what is happening
node server --vboxmanage %PROGRAMFILES%\Oracle\VirtualBox\VBoxManage.exe
The verbose argument also adds shell property to the JSON object on the HTTP response.
{
"shell": {
"command": "vboxmanage controlvm f343d863-a993-4ad5-9bcc-3a72fab79f66 pause",
"directory": "c:\\temp",
"exitCode": 0,
"output": ""
}
}In case of
{"error":"spawn vboxmanage ENOENT"}put the VirtualBox bin directory to the PATH environment variable
Windows:
set PATH=%PATH%;%PROGRAMFILES%\Oracle\VirtualBox
vboxmanage-rest-api --version
or start the server with --vboxmanage argument
vboxmanage-rest-api --vboxmanage "%PROGRAMFILES%\Oracle\VirtualBox\VBoxManage.exe"
EADDRINUSE indicates that the request socket port is in use.
Error: listen EADDRINUSE :::8269
Use another port number, e.g. 1324
vboxmanage-rest-api --port 1324
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent