[pve-devel] [RFC qemu-server 3/4] fix #4474: qemu api: add overrule-shutdown parameter to stop endpoint

[Wolfgang Bumiller]

This one LGTM.

On Thu, Jan 26, 2023 at 09:32:13AM +0100, Friedrich Weber wrote:
> The new `overrule-shutdown` parameter is boolean and defaults to 0. If
> it is 1, all active `qmshutdown` tasks by the current user for the same
> VM are aborted before attempting to stop the VM.
> 
> Passing `overrule-shutdown=1` is forbidden for HA resources.
> 
> Signed-off-by: Friedrich Weber <f.weber at proxmox.com>

Acked-by: Wolfgang Bumiller <w.bumiller at proxmox.com>

> ---
>  PVE/API2/Qemu.pm | 16 +++++++++++++++-
>  1 file changed, 15 insertions(+), 1 deletion(-)
> 
> diff --git a/PVE/API2/Qemu.pm b/PVE/API2/Qemu.pm
> index c87602d..b253e1f 100644
> --- a/PVE/API2/Qemu.pm
> +++ b/PVE/API2/Qemu.pm
> @@ -2799,7 +2799,13 @@ __PACKAGE__->register_method({
>  		type => 'boolean',
>  		optional => 1,
>  		default => 0,
> -	    }
> +	    },
> +	    'overrule-shutdown' => {
> +		description => "Abort any active 'qmshutdown' task by the current user for this VM before stopping",
> +		optional => 1,
> +		type => 'boolean',
> +		default => 0,
> +	    },
>  	},
>      },
>      returns => {
> @@ -2826,10 +2832,13 @@ __PACKAGE__->register_method({
>  	raise_param_exc({ migratedfrom => "Only root may use this option." })
>  	    if $migratedfrom && $authuser ne 'root at 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;
> @@ -2849,6 +2858,11 @@ __PACKAGE__->register_method({
>  
>  		syslog('info', "stop VM $vmid: $upid\n");
>  
> +		if ($overrule_shutdown) {
> +		    my $overruled_tasks = PVE::GuestHelpers::overrule_tasks('qmshutdown', $authuser, $vmid);
> +		    print "overruled qmshutdown tasks: " . join(", ", $overruled_tasks->@*) . "\n";
> +		};
> +
>  		PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
>  					 $param->{timeout}, 0, 1, $keepActive, $migratedfrom);
>  		return;
> -- 
> 2.30.2