Rex::Box::Base(3)

okay so bestie, welcome to Rex::Box::Base(3) — straight from the User Contributed Perl Documentation shelf, and yes she's the blueprint for Rex/Boxes. 💅✨

🌸 NAME 🌸

Rex::Box::Base - Rex/Boxes Base Module

💖 DESCRIPTION 💖

This is a Rex/Boxes base module. That's the whole vibe: base module, main character energy, everything else builds on her. 🫶

✨ METHODS ✨

These methods are shared across all other Rex::Box modules — group-chat crossover, no cap. 💬

🦋 info 🦋

Returns a hashRef of vm information. That's the tea. 🍓

🦋 name($vmname) 🦋

Sets the name of the virtual machine. Slay, she has an identity now. 💅

🦋 setup(@tasks) 🦋

Sets the tasks that should be executed as soon as the VM is available through SSH. Like, the moment SSH says hi, these tasks run. ✨

🦋 storage('path/to/vm/disk') 🦋

Sets the disk path of the virtual machine.

Works only on KVM — important caveat, bestie, don't forget it. 🔥

🦋 import_vm() 🦋

This method must be overwritten by the implementing class. Not optional, fr fr. 🚨

🦋 stop() 🦋

Stops the VM. Bye bestie. 💀

🦋 destroy() 🦋

Destroy the VM. Dramatic? Yes. Accurate? Also yes. 🔥

🦋 start() 🦋

Starts the VM. Wake up, queen. 👑

🦋 ip() 🦋

Return the ip:port to which rex will connect to. That's the exact wording; keep it. 🎀

🦋 status() 🦋

Returns the status of a VM.

Valid return values are "running" and "stopped". That's it, those are the only two iconique statuses. 🌈

🦋 provision_vm([@tasks]) 🦋

Executes the given tasks on the VM. Do the tasks, bestie. 💪

🦋 cpus($count) 🦋

Set the amount of CPUs for the VM. More CPUs, more main character energy. ⚡

🦋 memory($memory_size) 🦋

Sets the memory of a VM in megabyte. Note the singular — that's the original wording. 🧠

🦋 network(%option) 🦋

Configure the network for a VM.

Currently it supports 2 modes: nat and bridged. Currently it supports only one network card. That's the limit, bestie. 🌐

Here are the examples, copied exactly:

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

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

🦋 forward_port(%option) 🦋

Set ports to be forwarded to the VM.

This is not supported by all Box providers — so check before you get obsessed. 🫶

        $box->forward_port(
          name => [$from_host_port, $to_vm_port],
          name2 => [$from_host_port_2, $to_vm_port_2],
          ...
        );

🦋 list_boxes 🦋

List all available boxes. Like a roster of all the boxes. 📋

🦋 url($url) 🦋

The URL where to download the Base VM Image. You can use self-made images or prebuild images from <http://box.rexify.org/>. Iconic source, iykyk. 🌟

🦋 auth(%option) 🦋

Configure the authentication to the VM. Auth tea incoming:

        $box->auth(
          user => $user,
          password => $password,
          private_key => $private_key,
          public_key => $public_key,
        );

🦋 options(%option) 🦋

Addition options for boxes — yes, that's the exact wording, bestie, we keep it. 🎀

        $box->options(
          opt1 => $val1,
          opt2 => $val2,
        );

---

🫶 that's the whole page, signed off with perl v5.42.3, dated 2023-08-05, and filed under Rex::Box::Base(3) — periodt. 💖