[pve-devel] [PATCH qemu-server v3 2/4] fix 4888: qmrestore: add disk-format option

[Markus Frank]

Add an option to choose a file format (qcow2, raw, vmdk) when restoring
a vm backup to file based storage. This options allows all disks to be
recreated with the specified file format if supported by the target
storage.

Signed-off-by: Markus Frank <m.frank at proxmox.com>
---
v3:
* added requires => 'archive' to disk-format
* changed descriptions
* added missing imports/uses
* check if disk_format is in validFormats

 PVE/API2/Qemu.pm     |  7 +++++++
 PVE/CLI/qmrestore.pm |  5 +++++
 PVE/QemuServer.pm    | 14 +++++++++-----
 3 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/PVE/API2/Qemu.pm b/PVE/API2/Qemu.pm
index 5ac61aa5..3f4d19cc 100644
--- a/PVE/API2/Qemu.pm
+++ b/PVE/API2/Qemu.pm
@@ -1013,6 +1013,11 @@ __PACKAGE__->register_method({
 		    default => 0,
 		    description => "Start VM after it was created successfully.",
 		},
+		'disk-format' => get_standard_option('pve-vm-image-format', {
+		    optional => 1,
+		    requires => 'archive',
+		    description => "Preferred image format used for all VM disks when restoring.",
+		}),
 		'import-working-storage' => get_standard_option('pve-storage-id', {
 		    description => "A file-based storage with 'images' content-type enabled, which"
 			." is used as an intermediary extraction storage during import. Defaults to"
@@ -1046,6 +1051,7 @@ __PACKAGE__->register_method({
 	my $storage = extract_param($param, 'storage');
 	my $unique = extract_param($param, 'unique');
 	my $live_restore = extract_param($param, 'live-restore');
+	my $disk_format = extract_param($param, 'disk-format');
 	my $extraction_storage = extract_param($param, 'import-working-storage');
 
 	if (defined(my $ssh_keys = $param->{sshkeys})) {
@@ -1143,6 +1149,7 @@ __PACKAGE__->register_method({
 		    unique => $unique,
 		    bwlimit => $bwlimit,
 		    live => $live_restore,
+		    disk_format => $disk_format,
 		    override_conf => $param,
 		};
 		if (my $volid = $archive->{volid}) {
diff --git a/PVE/CLI/qmrestore.pm b/PVE/CLI/qmrestore.pm
index a47648bd..9910f30d 100755
--- a/PVE/CLI/qmrestore.pm
+++ b/PVE/CLI/qmrestore.pm
@@ -3,6 +3,7 @@ package PVE::CLI::qmrestore;
 use strict;
 use warnings;
 use PVE::SafeSyslog;
+use PVE::Storage;
 use PVE::Tools qw(extract_param);
 use PVE::INotify;
 use PVE::RPCEnvironment;
@@ -64,6 +65,10 @@ __PACKAGE__->register_method({
 		type => 'boolean',
 		description => "Start the VM immediately from the backup and restore in background. PBS only.",
 	    },
+	    'disk-format' => get_standard_option('pve-vm-image-format', {
+		optional => 1,
+		description => "Preferred image format used for all VM disks when restoring.",
+	    }),
 	},
     },
     returns => {
diff --git a/PVE/QemuServer.pm b/PVE/QemuServer.pm
index b6fc1f17..dbc7e6be 100644
--- a/PVE/QemuServer.pm
+++ b/PVE/QemuServer.pm
@@ -6677,7 +6677,7 @@ my $parse_backup_hints = sub {
 #
 # Returns: { $virtdev => $volid }
 my $restore_allocate_devices = sub {
-    my ($storecfg, $virtdev_hash, $vmid) = @_;
+    my ($storecfg, $virtdev_hash, $vmid, $disk_format) = @_;
 
     my $map = {};
     foreach my $virtdev (sort keys %$virtdev_hash) {
@@ -6689,8 +6689,12 @@ my $restore_allocate_devices = sub {
 
 	# test if requested format is supported
 	my ($defFormat, $validFormats) = PVE::Storage::storage_default_format($storecfg, $storeid);
-	my $supported = grep { $_ eq $d->{format} } @$validFormats;
-	$d->{format} = $defFormat if !$supported;
+
+	if ($disk_format && grep { $_ eq $disk_format } @$validFormats) {
+	    $d->{format} = $disk_format;
+	} elsif (!(grep { $_ eq $d->{format} } @$validFormats)) {
+	    $d->{format} = $defFormat;
+	}
 
 	my $name;
 	if ($d->{is_cloudinit}) {
@@ -7064,7 +7068,7 @@ sub restore_proxmox_backup_archive {
 	$restore_cleanup_oldconf->($storecfg, $vmid, $oldconf, $virtdev_hash) if $oldconf;
 
 	# allocate volumes
-	my $map = $restore_allocate_devices->($storecfg, $virtdev_hash, $vmid);
+	my $map = $restore_allocate_devices->($storecfg, $virtdev_hash, $vmid, $options->{disk_format});
 
 	foreach my $virtdev (sort keys %$virtdev_hash) {
 	    my $d = $virtdev_hash->{$virtdev};
@@ -7461,7 +7465,7 @@ sub restore_vma_archive {
 	}
 
 	# allocate volumes
-	my $map = $restore_allocate_devices->($cfg, $virtdev_hash, $vmid);
+	my $map = $restore_allocate_devices->($cfg, $virtdev_hash, $vmid, $opts->{disk_format});
 
 	# print restore information to $fifofh
 	foreach my $virtdev (sort keys %$virtdev_hash) {
-- 
2.39.5