VBoxmanagerjs

Overview

VBoxmanagerjs is a VirtualBox manager library for nodeJs. With it, you are able to:

• connect to local or remote(ssh) Host
• List virtual machines
• get information about a VM
• Start/Stop/Pause/Resume a VM
• Modity memory
• Modify number of CPUs
• Clone
• Delete
• Create

Installation

$ npm install vboxmanagerjs

Example

var vbox = require('vboxmanagerjs').vboxmanager;
vbox.getVMS(function(
  // Get the first VM 
  var box = myVMS[0];
  console.log('VM Name: ' , box.name);
  console.log('VM UID: '  , uid);
  // Clone the VM
  box.cloneMe('MyNewVM' , function(error , new_box){
    if(error){
      return;
    }
    // set memory to 2048M
    new_box.setMemory(2048 , function(){
      // set 4 cpus
      new_box.setCPUS(4 , function(){
        // Start the VM
        box.start(function(){
          console.log('Gogogo !');
        });
      });
    });
  });
});
 

Example for remote connection

var vbox = require('vboxmanagerjs').vboxmanager;
vbox.setRemote('10.8.0.X',
    {
        username: 'userrunningvbox',
        passphrase: 'somePasswordIfAny',
        privateKey: require('fs').readFileSync('/home/userrunningnodejs/.ssh/id_rsa')
    }
);

Running tests

To run the tests for vboxmanager simply run:

$ make test

To run remote tests edit /test/config.js

__this module is tested with the following nodejs versions using n __

• 0.8.14
• 0.8.17
• 0.8.27
• 0.9.6
• 0.9.12
• 0.10.0
• 0.10.2
• 0.10.26
• 0.10.29
• 0.11.13

Contribution

Tests and bugfixes and ideas can be subbmited to github issue or via email to: clemo|at|cbcode.at
feel free to send me a pull request, if you implemented a new feacher.

License

(The MIT License)

Copyright (c) 2014 Clemens Burger [e-mail]
Copyright (c) 2013 Xavier TALANDIER [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.