node-vagrant-cli
A library to ease programmatic use of vagrant binary with nodejs.
Install
npm i node-vagrant-cli --save
API
### new Vagrant(opts)
ServerPool constructor.
Arguments
opts
- An object of configuration.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts;
Returns vagrant version number.
Arguments
done
- A callback called on completion.stderr
- String of stderr.version
- String of version number.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrantversion{ console; console; };
Find out if vagrant is installed and available at options.binary location.
Arguments
done
- A callback called on completion.stderr
- String of stderr.isInstalled
- Boolean.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrant;
Add box to vagrant.
Arguments
name
- String of the new vagrant box.url
- String of the location of the vagrant box image.done
- A callback called on completion.stderr
- String of stderr.stdout
- String of stdout.success
- Boolean.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrant;
Wake up a machine.
Arguments
machine
- Name of an environment or a machine.done
- A callback called on completion.stderr
- String of output.booted
- Boolean true if machine has really booted.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrant;
Halt a machine.
Arguments
done
- A callback called on completion.stderr
- An Error.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrant;
Fetch vagrant status, returns a object of machines and their status.
Arguments
done
- A callback called on completion.stderr
- An Error.machines
- An Object of machines and their status.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrantstatus{ console; /* { 'machine':{ status:'running', // poweroff provider:'virtualbox' // libvirt } } */ };
Tells if vagrant is running a machine.
Arguments
done
- A callback called on completion.stderr
- An Error.isRunning
- A Boolean, false if no machine runs, String if a machine runs.
Returns
child_process
- A child_process.spawn object.
Examples
var Vagrant = ; var opts = 'provider':'virtualbox' 'binary':'vagrant' ; var vagrant = opts; vagrant
Status
In development. It needs some tests.