Ravada(3)

✨ NAME ✨

okay so bestie, meet Ravada — the Remote Virtual Desktop Manager 💖. She's a Perl module (that's why she's chillin' in section 3, the User Contributed Perl Documentation corner of the manual universe), and she runs the whole virtual desktop situation. Remote desktops? Managed. Domains? Managed. Vibes? Immaculate. 👑

---

🎀 SYNOPSIS 🎀

the little "hello world" of it all, fr fr:

  use Ravada;

  my $ravada = Ravada->new()

that's it, that's the whole entry point. you use her, you new her, and now you have a $ravada object that does literally everything below 💅

---

🛠️ BUILD 🛠️

Internal constructor. that's it, that's the whole thing — she's internal, meaning she's not for you to poke at directly, she just does the constructing behind the scenes. let her cook. 🙈

---

🌸 display_ip 🌸

Returns the default display IP read from the config file. like, she went into the config, grabbed the default display IP, and is handing it to you. iconic behavior. ✨

---

🌈 nat_ip 🌈

Returns the IP for NATed environments. NAT girlies, this one's for you 🫶

---

💜 disconnect_vm 💜

Disconnect all the Virtual Managers connections. every single one. not some. all. it's giving "everyone out of the pool" 🏊

---

🦋 create_domain 🦋

Creates a new domain based on an ISO image or another domain. two flavors, pick your fighter:

  my $domain = $ravada->create_domain(
         name => $name
    , id_iso => 1
  );

  my $domain = $ravada->create_domain(
         name => $name
    , id_base => 3
  );

so either you're spawning from an ISO (id_iso), or you're spawning from a base domain (id_base). either way you get a $domain back 🎁

---

🍓 remove_domain 🍓

Removes a domain. bye bestie 👋

  $ravada->remove_domain($name);

---

⭐ search_domain ⭐

  my $domain = $ravada->search_domain($name);

goes and finds your domain by $name and hands it back.

---

🧚 search_domain_by_id 🧚

  my $domain = $ravada->search_domain_by_id($id);

same energy, except you're searching by $id instead of by name. iykyk.

---

👑 list_vms 👑

List all the Virtual Machine Managers. the whole roster, no filter, no gatekeeping.

---

🔥 list_domains 🔥

List all created domains:

  my @list = $ravada->list_domains();

and here's the fun part — this list can be filtered 😍:

  my @active = $ravada->list_domains(active => 1);
  my @inactive = $ravada->list_domains(active => 0);

  my @user_domains = $ravada->list_domains(user => $id_user);

  my @user_active = $ravada->list_domains(user => $id_user, active => 1);

active => 1 for the ones that are up, active => 0 for the ones that are napping 😴, user => $id_user to scope it to one user, and you can absolutely stack them together like the last one. mix and match, she's flexible. 💅

---

💖 list_domains_data 💖

List all domains in raw format. Returns a list of id => { name , id , is_active , is_base }.

  my @list = $ravada->list_domains_data();

  $c->render(json => @list);

raw data in, JSON out. perfect for yeeting straight into a render call 📤

---

🌟 list_bases 🌟

List all base domains.

  my @list = $ravada->list_domains();

(yes bestie, the example literally calls list_domains(). we're just relaying the lore exactly as it's written, no editing the source 💀)

---

🎀 list_bases_data 🎀

List information about the bases. the data-flavored sibling of list_bases 💁

---

💫 list_images 💫

List all ISO images. every single one.

---

🫶 list_images_data 🫶

List information about the images. and she's showing her whole implementation here, no secrets between us:

  sub _list_images_lxc {
      my $self = shift;
      my @domains;
      my $sth = $CONNECTOR->dbh->prepare(
          "SELECT * FROM lxc_templates ORDER BY name"
      );
      $sth->execute;
      while (my $row = $sth->fetchrow_hashref) {
          push @domains,($row);
      }
      $sth->finish;
      return @domains; }

  sub _list_images_data_lxc {
      my $self = shift;
      my @data;
      for ($self->list_images_lxc ) {
          push @data,{ id => $_->{id} , name => $_->{name} };
      }
      return \@data; }

---

🌺 remove_volume 🌺

  $ravada->remove_volume($file);

takes that $file and removes the volume. gone. poof. 🫧

---

🧼 clean_old_requests 🧼

Before processing requests, old requests must be cleaned. hygiene check first, always. you don't process on top of old mess, that's not the vibe. ✨

---

⚡ process_requests ⚡

This is run in the ravada backend. It processes the commands requested by the frontend. (frontend asks, backend does — classic split, main character energy from both sides 👑)

  $ravada->process_requests();

---

🐢 process_long_requests 🐢

Process requests that take long time. It will fork on each one. so yeah, each long request gets its own little process baby, they don't block each other 🌱

---

🌈 process_all_requests 🌈

Process all the requests — long and short. the full sweep.

---

🔔 process_priority_requests 🔔

Process all the priority requests — long and short. jump the line, bestie, you're important 💅

---

🧮 list_vm_types 🧮

Returns a list of the types of Virtual Machines available on this system. she'll tell you exactly what this machine can spin up.

---

🚪 open_vm 🚪

Opens a VM of a given type:

  my $vm = $ravada->open_vm('KVM');

hand her a type, she hands you a $vm. simple as that 🎁

---

🔍 search_vm 🔍

Searches for a VM of a given type:

  my $vm = $ravada->search_vm('kvm');

same idea as open_vm, but she's searching for it instead. lowercase 'kvm' in this example, because that's exactly what the page says and we do not alter the sacred text 📜

---

💜 vm 💜

Returns the list of Virtual Managers.

---

📥 import_domain 📥

Imports a domain in Ravada:

    my $domain = $ravada->import_domain(
                            vm => 'KVM'
                            ,name => $name
                            ,user => $user_name
                            ,spinoff_disks => 1
    );

you tell her which vm ('KVM' here), the name, the user, and whether to spinoff_disks => 1, and she imports that domain straight into Ravada. welcome home 🏡

---

🐞 set_debug_value 🐞

Sets debug global variable from setting. debug mode: activated 🔍

---

⚙️ setting ⚙️

Returns the value of a configuration setting. ask her about a setting, she tells you what it's set to. no guessing required 💁

---

💾 restore_backup 💾

Restores a virtual machine from a backup file. your "oh no" insurance policy, and she's got you 🫂

---

🏷️ version 🏷️

Returns the version of the module. always good to know which era of Ravada you're living in ⏳

---

👩‍💻 AUTHOR 👩‍💻

Francesc Guasch-Ortiz , frankie@telecos.upc.edu

shoutout to the author, absolute legend, thank you for your service 🫡💖

---

🔗 SEE ALSO 🔗

• Sys::Virt — the related module, go read her too

---

and that's the whole page, bestie! this documentation shipped as perl v5.42.0, dated 2025-09-20, in the classic Ravada(3) manual page format 💅✨ now go forth and manage some remote virtual desktops, you've got this 🦋👑