Ravada::Request(3)

💖 NAME 💖

Ravada::Request — the requests library for Ravada, bestie. This is the whole Ravada::Request(3) situation, straight out of the User Contributed Perl Documentation corner of the perl world. ✨

You use this to request a command to the ravada backend. That's the whole vibe: you make a request object, the backend does the thing. 🫶

---

🌸 BUILD 🌸

Internal object builder, do not call. Like, i'm serious. It's giving "staff only" door. 🙈

🦋 open 🦋

Opens the information of a previous request by id. 🎀

my $req = Ravada::Request->open($id);

✨ info ✨

Returns information of the request. That's it, that's the whole job. 💅

💜 create_domain 💜

my $req = Ravada::Request->create_domain(
                    name => 'bla'
                , id_iso => 1
);

🌈 remove_domain 🌈

my $req = Ravada::Request->remove_domain(
                 name => 'bla'
                , uid => $user->id
);

🔥 start_domain 🔥

Requests to start a domain. Let's go, main character energy. 👑

my $req = Ravada::Request->start_domain(
   name => 'name'
  , uid => $user->id
);

Mandatory arguments — one of those must be passed:

• name or id_domain
• uid: user id
• remote_ip: [optional] IP of the remote client that requested to start the domain

🎀 start_clones 🎀

Requests to start the clones of a base. One base, many clones, iconic behaviour fr fr. ✨

my $req = Ravada::Request->start_clones( name => 'name', uid => $user->id );

🦋 pause_domain 🦋

Requests to pause a domain. Time for a little nap bestie 😴

my $req = Ravada::Request->pause_domain( name => 'name', uid => $user->id );

💖 resume_domain 💖

Requests to pause a domain. yes, the doc literally says "pause" here — i'm just the messenger, i don't make the rules 🙈

my $req = Ravada::Request->resume_domain( name => 'name', uid => $user->id );

💀 force_shutdown_domain 💀

Requests to stop a domain now ! No waiting, no soft exit, no "give me a sec". Straight to the point. ⚡

my $req = Ravada::Request->force_shutdown_domain( name => 'name' , uid => $user->id );

🌸 shutdown_domain 🌸

Requests to stop a domain. The gentle version. 🫶

my $req = Ravada::Request->shutdown_domain( name => 'name' , uid => $user->id );
my $req = Ravada::Request->shutdown_domain( name => 'name' , uid => $user->id
                                          ,timeout => $timeout );

💀 force_reboot_domain 💀

Requests to stop a domain now ! (same one-liner as force_shutdown_domain, copy-paste era, we've all been there 😭)

my $req = Ravada::Request->force_reboot_domain( name => 'name' , uid => $user->id );

🌈 reboot_domain 🌈

Requests to reboot a domain. Round two, but make it scheduled. 🔁

my $req = Ravada::Request->reboot_domain( name => 'name' , uid => $user->id );
my $req = Ravada::Request->reboot_domain( name => 'name' , uid => $user->id
                                          ,timeout => $timeout );

⭐ new_request ⭐

Creates a new request. Fresh out of the box, no cap. 📦

$req = Ravada::Request->new_request(
    start_domain
    ,uid => $user->id
    ,id_domain => $domain->id
);

🔒 lock_domain 🔒

Checks if that request belongs to a virtual machine and sets it as locked. Nobody touch it, it's busy. 💅

🔓 unlock_domain 🔓

Checks if that request belongs to a virtual machine and unlocks it. Free at last. 🦋

💜 status 💜

Returns or sets the status of a request.

$req->status('done');

my $status = $req->status();

⏰ at ⏰

Sets the time when the request will be scheduled. Future plans, we love to see it. ✨

🎁 result 🎁

Returns the result of the request if any.

my $result = $req->result;

🌟 command 🌟

Returns the requested command.

🌟 args 🌟

Returns the requested command. (yes bestie, the doc says "command" here too, and yes, there's another args further down — keep scrolling 🙈)

my $command = $req->command;

🍓 args 🍓

Returns the arguments of a request or the value of one argument field. Two ways to ask, both valid. 🎀

my $args = $request->args();
print $args->{name};

print $request->args('name');

💅 arg 💅

Sets or gets the value of an argument of a Request.

🧚 defined_arg 🧚

Returns if an argument is defined. Existence check, we love a boundary. ✨

📸 copy_screenshot 📸

Request to copy a screenshot from a domain to another. Say cheese. 🧀

👑 set_base_vm 👑

Enables a base in a Virtual Manager.

💀 remove_base_vm 💀

Disables a base in a Virtual Manager.

🦋 type 🦋

Returns the type of the request.

🔢 count_requests 🔢

Returns the number of working requests of the same type. Counting bestie, we're counting. 🧮

my $n = $request->working_requests();

🚧 requests_limit 🚧

Returns the limit of requests of a type.

🚀 domain_autostart 🚀

Sets the autostart flag on a domain. Up and running before you even get there. ✨

⚠️ autostart_domain ⚠️

Deprecated for domain_autostart. Old name, new name, use the new one. 🙈

🛑 enforce_limits 🛑

Enforces virtual machine limits, ie: an user can only run one virtual machine at a time, so the older ones are shut down. The limit is the limit, periodt. 💅

my $req = Ravada::Request->enforce_limits(
    timeout => $timeout
);

Arguments:

• timeout: seconds that are given to a virtual machine to shutdown itself. After this time, it gets powered off. Defaults to 120 seconds.

It is advisable configure virtual machines so they shut down easily if asked to. Just a few hints:

• install ACPI services
• Set default action for power off to shutdown, do not ask the user

🔄 refresh_machine 🔄

Refresh a machine information. Glow-up, but for data. ✨

🕰️ done_recently 🕰️

Returns whether this command has been requested successfully recently. 🎀

if ($request->done_recently($seconds)) {
  ... skips work ...
} else {
  ... does work ...
}

This method is used for commands that take long to run as garbage collection.

🛑 stop 🛑

Stops a request killing the process. Killing the process! Dramatic but correct. 💀

$request->stop();

⭐ priority ⭐

Returns the priority of the request.

✅ requirements_done ✅

Returns whether a request requirements have been fulfilled.

ie when a request must execute after another request completes.

🔁 redo 🔁

Set the request to be executed again. Round two, bestie. 🦋

🧹 remove 🧹

Remove all requests that comply with the conditions. Clean sweep, very satisfying. ✨

💫 refresh 💫

Refresh request status and data. Vibe check, but for a request. 🫶

---

💀 POD ERRORS 💀

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

Around line 1679:

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

not me calling out the doc's own typos 😭 it's fine, we still love it

---

and that's the whole page bestie!! 🌈 this one shipped as perl v5.42.0, dated 2025-09-20 — write that in your notes, it's part of the lore. 💖✨🦋🎀🌸💅🫶👑🌈⭐💜