Ravada::VM(3)

💖 Ravada::VM 💖

okay so bestie, welcome to the Ravada::VM page 💅 this is the Virtual Managers library for Ravada, and it lives in the User Contributed Perl Documentation part of the manual-verse. it's giving backend queen energy, and we are going through every single thing on it, no skips, no cap. grab a strawberry 🍓 and let's go.

---

🌸 Constructors 🌸

open

Opens a Virtual Machine Manager (VM) ✨

Arguments: id of the VM

---

💫 Methods 💫

timeout_down_cache

Returns the time in seconds that nodes get kept cached down for. like how long we let them nap 😴

domain_remove

Removes the domain. Returns nothing — literally nothing, it's a void, don't come looking for a return value 🙈

name

Returns the name of this Virtual Machine Manager 🏷️

my $name = $vm->name();

search_domain_by_id

Returns a domain, but you find it by its id 🔍

$domain = $vm->search_domain_by_id($id);

ip

Returns the external IP for this VM 🌐

nat_ip

Returns the IP of the VM when it's chilling in a NAT environment

display_ip

Returns the display IP of the Virtual Manager 🖥️

listen_ip

Returns the IP where virtual machines must be bound to 📌

Arguments: optional remote ip

id

Returns the id value of the domain. This id is used in the database tables and is not related to the virtual machine engine. so like, it's a database thing, not a hypervisor thing, keep them separate bestie 💀

default_storage_pool_name

Set the default storage pool name for this Virtual Machine Manager 🗄️

$vm->default_storage_pool_name('default');

base_storage_pool

Set the storage pool for bases in this Virtual Machine Manager 🧺

$vm->base_storage_pool('pool2');

clone_storage_pool

Set the storage pool for clones in this Virtual Machine Manager 🧬

$vm->clone_storage_pool('pool3');

dir_clone

Returns the directory where clone images are stored in this Virtual Manager 📂

dir_base

Returns the directory where base images are stored in this Virtual Manager 📁

min_free_memory

Returns the minimum free memory necessary to start a new virtual machine 🧠

max_load

Returns the maximum cpu load that the host can handle. she has limits, respect them 🔥

active_limit

Returns the value of active_limit in the BBDD

list_drivers

Lists the drivers available for this Virtual Machine Manager 🚗

Arguments: optional driver type

Returns a list of strings with the names of the drivers.

my @drivers = $vm->list_drivers();
my @drivers = $vm->list_drivers('image');

is_local

Returns whether this virtual manager is on the local host 🏠

is_locked

This node has requests running or waiting to be run. she's busy, she's booked, she's in her locked era 🔒

list_nodes

Returns a list of virtual machine manager nodes of the same type as this one.

my @nodes = $self->list_nodes();

list_bases

Returns a list of domains that are base in this node 🧱

ping

Returns if the virtual manager connection is available. are you there? hello? 👋

list_virtual_networks_data

Returns a list of information of the virtual networks in this virtual machines manager (VM) from the database 🕸️

Arguments:

Pass either the VM object or an id_vm

is_active

Returns if the domain is active. The active state is cached for some seconds, so heads up. Pass an optional true value to perform a real check if you want the truth-truth 💅

Arguments: optional force mode

if ($node->is_active) {
}

if ($node->is_active(1)) {
}

enabled

Returns if the domain is enabled ✅

public_ip

Returns the public IP of the virtual manager if defined

remove

Remove the virtual machine manager. bye bestie 👋💔

run_command

Run a command on the node 🏃

my ($out,$err) = $self->run_command_cache("ls");

run_command_cache

Run a command on the node 🏃‍♀️

my ($out,$err) = $self->run_command_cache("ls");

run_command_nowait

Run a command on the node, but don't wait for it 🏃‍♀️💨

$self->run_command_nowait("/sbin/poweroff");

warn "1 ".localtime(time) if $self->_data('hostname') =~ /192.168.122./;
my $chan = $self->_ssh_channel() or die "ERROR: No SSH channel to host ".$self->host;
warn "2 ".localtime(time) if $self->_data('hostname') =~ /192.168.122./;

my $command = join(" ",@command);
$chan->exec($command);# or $self->{_ssh}->die_with_error;

$chan->send_eof();

return;

write_file

Writes a file to the node ✍️

$self->write_file("filename.extension", $contents);

read_file

Reads a file in memory from the storage of the virtual manager 🧠📖

create_iptables_chain

Creates a new chain in the system iptables ⛓️

iptables

Runs an iptables command in the virtual manager 🔥

Example:

$vm->iptables( A => 'INPUT', p => 22, j => 'ACCEPT');

iptables_unique

Runs an iptables command in the virtual manager only if it wasn't already there. no duplicates, we don't do repeats 🚫

Example:

$vm->iptables_unique( A => 'INPUT', p => 22, j => 'ACCEPT');

iptables_list

Returns the list of the system iptables 📋

balance_vm

Returns a Virtual Manager from all the nodes to run a virtual machine. When the optional base argument is passed, it returns a node from the list of VMs where the base is prepared. it's the matchmaker of nodes 💘

Arguments

• uid
• base [optional]
• id_domain [optional]

shutdown_domains

Shuts down all the virtual machines in the node 🛑

shared_storage

Returns true if there is shared storage among the nodes 🤝

Arguments:

• node
• directory

copy_file_storage

Copies a volume file to another storage 📦➡️📦

Args:

• file
• storage

start

Starts the node 🚀

shutdown

Shuts down the node 🛑

list_network_interfaces

Returns a list of all the known interfaces 🕸️

Argument: type ( nat or bridge )

add_host_device

Add a new host device configuration to this Virtual Machines Manager from a previous template 🧩

$vm->add_host_device(template => 'name');

list_host_devices

List all the configured host devices in this node 🔌

list_machine_types

Placeholder for list machine types that returns an empty list by default. It can be overloaded in each backend module. so like, it's a vibe placeholder, fill it in yourself bestie 🎀

dir_backup

Directory where virtual machines backup will be stored. It can be changed from the frontend nodes page management 🗂️

list_unused_volumes

Returns a list of unused volume files 👻

can_list_cpu_models

Default for Virtual Managers that can list cpu models is 0

list_files

List files in a Virtual Manager 📄

Arguments: dir , optional regexp pattern

---

🚨 POD ERRORS 🚨

Hey! The above document had some coding errors, which are explained below:

Around line 2374:

You forgot a '=back' before '=head2'

not the pod parser catching strays 😭 it's literally just a missing =back bestie, the docs are fine, breathe 🫶

---

and that's the whole page, you ate it, you understood it, iconic behavior honestly 👑

this lil masterpiece is perl v5.42.0, dated 2025-09-20 — remember the date, it's giving vintage 💅✨🦋