GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  REX::BOX::VBOX (3)

.ds Aq ’

NAME

Rex::Box::VBox - Rex/Boxes VirtualBox Module

CONTENTS

DESCRIPTION

This is a Rex/Boxes module to use VirtualBox VMs.

EXAMPLES

To use this module inside your Rexfile you can use the following commands.



 use Rex::Commands::Box;
 set box => "VBox";

 task "prepare_box", sub {
   box {
     my ($box) = @_;

     $box->name("mybox");
     $box->url("http://box.rexify.org/box/ubuntu-server-12.10-amd64.ova");

     $box->network(1 => {
       type => "nat",
     });

     $box->network(1 => {
       type => "bridged",
       bridge => "eth0",
     });

     $box->forward_port(ssh => [2222, 22]);

     $box->share_folder(myhome => "/home/myuser");

     $box->auth(
       user => "root",
       password => "box",
     );

     $box->setup("setup_task");
   };
 };



If you want to use a YAML file you can use the following template.



 type: VBox
 vms:
   vmone:
     url: http://box.rexify.org/box/ubuntu-server-12.10-amd64.ova
     forward_port:
       ssh:
         - 2222
         - 22
     share_folder:
       myhome: /home/myhome
     setup: setup_task



And then you can use it the following way in your Rexfile.



 use Rex::Commands::Box init_file => "file.yml";

 task "prepare_vms", sub {
   boxes "init";
 };



HEADLESS MODE

It is also possible to run VirtualBox in headless mode. This only works on Linux and MacOS. If you want to do this you can use the following option at the top of your Rexfile.



 set box_options => { headless => TRUE };



METHODS

See also the Methods of Rex::Box::Base. This module inherits all methods of it.

new(name => CW$vmname)

Constructor if used in OO mode.



 my $box = Rex::Box::VBox->new(name => "vmname");



    share_folder(%option)

Creates a shared folder inside the VM with the content from a folder from the Host machine. This only works with VirtualBox.



 $box->share_folder(
   name => "/path/on/host",
   name2 => "/path_2/on/host",
 );



    info

Returns a hashRef of vm information.

    ip

This method return the ip of a vm on which the ssh daemon is listening.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 REX::BOX::VBOX (3) 2016-03-07

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.