Rex::Box::VBox(3)

🌸 NAME 🌸

okay so this is Rex::Box::VBox(3), the User Contributed Perl Documentation page for Rex::Box::VBox — Rex/Boxes VirtualBox Module. it's giving "the Rex/Boxes module you use to use VirtualBox VMs," and honestly that's the whole vibe. 💅✨

✨ DESCRIPTION ✨

so basically: this is a Rex/Boxes module to use VirtualBox VMs. no cap, that's the description and it ate. 🦋

🎀 EXAMPLES 🎀

bestie, if you wanna 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're more of a YAML file girlie, 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's also possible to run VirtualBox in headless mode. cute! 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 };

heads up bestie: headless mode only works on Linux and MacOS.

👑 METHODS 👑

see also the Methods of Rex::Box::Base — this module inherits all methods of it, periodt. 👑✨

🌟 new(name => $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. the way that this only works with VirtualBox is so real — bestie, this only works with VirtualBox. 💅

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

🦋 info 🦋

returns a hashRef of vm information. slay. 🦋

💜 ip 💜

this method returns the ip of a vm on which the ssh daemon is listening. iykyk. 💜

---

mwah 💋 that's the whole page. this was Rex::Box::VBox(3), from perl v5.42.3, dated 2023-08-05. bye bestie, go virtualize something iconic 🫶🌈