---
name: "Rex::Virtualization::VBox"
section: "3pm"
platform: "linux"
package: "rex"
version: "1.16.0-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Rex::Virtualization::VBox"
---

# Rex::Virtualization::VBox(3pm)

VirtualBox Virtualization Module

## NAME

Rex::Virtualization::VBox - VirtualBox Virtualization Module

## DESCRIPTION

With this module you can manage VirtualBox.

## SYNOPSIS

```
 use Rex::Commands::Virtualization;
 set virtualization => "VBox";
 use Data::Dumper;
 print Dumper vm list => "all";
 print Dumper vm list => "running";
 vm destroy => "vm01";
 vm delete => "vm01";
 vm start => "vm01";
 vm shutdown => "vm01";
 vm reboot => "vm01";
 vm option => "vm01",
       memory    => 512;
 print Dumper vm info => "vm01";
 # creating a vm
 vm create => "vm01",
    storage    => [
      {
        file  => "/mnt/data/vbox/vm01.img",
        size  => "10G",
      },
      {
        file => "/mnt/iso/debian6.iso",
      }
    ],
    memory => 512,
    type => "Linux26",
    cpus => 1,
    boot => "dvd";
 vm forward_port => "vm01", add => { http => [8080, 80] };
 vm forward_port => "vm01", remove => "http";
 print Dumper vm guestinfo => "vm01";
 vm share_folder => "vm01", add => { sharename => "/path/to/share" };
 vm share_folder => "vm01", remove => "sharename";
```

For VirtualBox memory declaration is always in megabyte.