fix #4474: qemu api: add overrule-shutdown parameter to stop endpoint

The new `overrule-shutdown` parameter is boolean and defaults to 0. If
it is 1, all active `qmshutdown` tasks for the same VM (which are
visible to the user/token) are aborted before attempting to stop the
VM.

Passing `overrule-shutdown=1` is forbidden for HA resources.

Signed-off-by: Friedrich Weber <f.weber@proxmox.com>

diff --git a/PVE/API2/Qemu.pm b/PVE/API2/Qemu.pm
index 78f2236ccf73d797cc09b059b3786318e9d4d84f..6c9e8838916cf833d4da84c837d5b85a829b2236 100644 (file)
--- a/PVE/API2/Qemu.pm
+++ b/PVE/API2/Qemu.pm
@@ -3041,7 +3041,13 @@ __PACKAGE__->register_method({
                type => 'boolean',
                optional => 1,
                default => 0,
-           }
+           },
+           'overrule-shutdown' => {
+               description => "Abort any active and visible 'qmshutdown' tasks before stopping",
+               optional => 1,
+               type => 'boolean',
+               default => 0,
+           },
        },
     },
     returns => {
@@ -3068,10 +3074,13 @@ __PACKAGE__->register_method({
        raise_param_exc({ migratedfrom => "Only root may use this option." })
            if $migratedfrom && $authuser ne 'root@pam';
 
+       my $overrule_shutdown = extract_param($param, 'overrule-shutdown');
 
        my $storecfg = PVE::Storage::config();
 
        if (PVE::HA::Config::vm_is_ha_managed($vmid) && ($rpcenv->{type} ne 'ha') && !defined($migratedfrom)) {
+           raise_param_exc({ 'overrule-shutdown' => "Not applicable for HA resources." })
+               if $overrule_shutdown;
 
            my $hacmd = sub {
                my $upid = shift;
@@ -3091,6 +3100,14 @@ __PACKAGE__->register_method({
 
                syslog('info', "stop VM $vmid: $upid\n");
 
+               if ($overrule_shutdown) {
+                   my $overruled_tasks = PVE::GuestHelpers::abort_guest_tasks(
+                       $rpcenv, 'qmshutdown', $vmid);
+                   my $overruled_tasks_list = join(", ", $overruled_tasks->@*);
+                   print "overruled qmshutdown tasks: $overruled_tasks_list\n"
+                       if @$overruled_tasks;
+               };
+
                PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
                                         $param->{timeout}, 0, 1, $keepActive, $migratedfrom);
                return;