PVE/API2/Qemu.pm

   1 package PVE::API2::Qemu;
   2
   3 use strict;
   4 use warnings;
   5 use Cwd 'abs_path';
   6 use Net::SSLeay;
   7 use POSIX;
   8 use IO::Socket::IP;
   9 use URI::Escape;
  10 use Crypt::OpenSSL::Random;
  11
  12 use PVE::Cluster qw (cfs_read_file cfs_write_file);;
  13 use PVE::RRD;
  14 use PVE::SafeSyslog;
  15 use PVE::Tools qw(extract_param);
  16 use PVE::Exception qw(raise raise_param_exc raise_perm_exc);
  17 use PVE::Storage;
  18 use PVE::JSONSchema qw(get_standard_option);
  19 use PVE::RESTHandler;
  20 use PVE::ReplicationConfig;
  21 use PVE::GuestHelpers;
  22 use PVE::QemuConfig;
  23 use PVE::QemuServer;
  24 use PVE::QemuServer::CPUConfig;
  25 use PVE::QemuServer::Drive;
  26 use PVE::QemuServer::ImportDisk;
  27 use PVE::QemuServer::Monitor qw(mon_cmd);
  28 use PVE::QemuServer::Machine;
  29 use PVE::QemuMigrate;
  30 use PVE::RPCEnvironment;
  31 use PVE::AccessControl;
  32 use PVE::INotify;
  33 use PVE::Network;
  34 use PVE::Firewall;
  35 use PVE::API2::Firewall::VM;
  36 use PVE::API2::Qemu::Agent;
  37 use PVE::VZDump::Plugin;
  38 use PVE::DataCenterConfig;
  39 use PVE::SSHInfo;
  40 use PVE::Replication;
  41
  42 BEGIN {
  43     if (!$ENV{PVE_GENERATING_DOCS}) {
  44         require PVE::HA::Env::PVE2;
  45         import PVE::HA::Env::PVE2;
  46         require PVE::HA::Config;
  47         import PVE::HA::Config;
  48     }
  49 }
  50
  51 use Data::Dumper; # fixme: remove
  52
  53 use base qw(PVE::RESTHandler);
  54
  55 my $opt_force_description = "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.";
  56
  57 my $resolve_cdrom_alias = sub {
  58     my $param = shift;
  59
  60     if (my $value = $param->{cdrom}) {
  61         $value .= ",media=cdrom" if $value !~ m/media=/;
  62         $param->{ide2} = $value;
  63         delete $param->{cdrom};
  64     }
  65 };
  66
  67 # Used in import-enabled API endpoints. Parses drives using the extended '_with_alloc' schema.
  68 my $foreach_volume_with_alloc = sub {
  69     my ($param, $func) = @_;
  70
  71     for my $opt (sort keys $param->%*) {
  72         next if !PVE::QemuServer::is_valid_drivename($opt);
  73
  74         my $drive = PVE::QemuServer::Drive::parse_drive($opt, $param->{$opt}, 1);
  75         next if !$drive;
  76
  77         $func->($opt, $drive);
  78     }
  79 };
  80
  81 my $NEW_DISK_RE = qr!^(([^/:\s]+):)?(\d+(\.\d+)?)$!;
  82
  83 my $check_drive_param = sub {
  84     my ($param, $storecfg, $extra_checks) = @_;
  85
  86     for my $opt (sort keys $param->%*) {
  87         next if !PVE::QemuServer::is_valid_drivename($opt);
  88
  89         my $drive = PVE::QemuServer::parse_drive($opt, $param->{$opt}, 1);
  90         raise_param_exc({ $opt => "unable to parse drive options" }) if !$drive;
  91
  92         if ($drive->{'import-from'}) {
  93             if ($drive->{file} !~ $NEW_DISK_RE || $3 != 0) {
  94                 raise_param_exc({
  95                     $opt => "'import-from' requires special syntax - ".
  96                         "use <storage ID>:0,import-from=<source>",
  97                 });
  98             }
  99
 100             if ($opt eq 'efidisk0') {
 101                 for my $required (qw(efitype pre-enrolled-keys)) {
 102                     if (!defined($drive->{$required})) {
 103                         raise_param_exc({
 104                             $opt => "need to specify '$required' when using 'import-from'",
 105                         });
 106                     }
 107                 }
 108             } elsif ($opt eq 'tpmstate0') {
 109                 raise_param_exc({ $opt => "need to specify 'version' when using 'import-from'" })
 110                     if !defined($drive->{version});
 111             }
 112         }
 113
 114         PVE::QemuServer::cleanup_drive_path($opt, $storecfg, $drive);
 115
 116         $extra_checks->($drive) if $extra_checks;
 117
 118         $param->{$opt} = PVE::QemuServer::print_drive($drive, 1);
 119     }
 120 };
 121
 122 my $check_storage_access = sub {
 123    my ($rpcenv, $authuser, $storecfg, $vmid, $settings, $default_storage) = @_;
 124
 125    $foreach_volume_with_alloc->($settings, sub {
 126         my ($ds, $drive) = @_;
 127
 128         my $isCDROM = PVE::QemuServer::drive_is_cdrom($drive);
 129
 130         my $volid = $drive->{file};
 131         my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
 132
 133         if (!$volid || ($volid eq 'none' || $volid eq 'cloudinit' || (defined($volname) && $volname eq 'cloudinit'))) {
 134             # nothing to check
 135         } elsif ($isCDROM && ($volid eq 'cdrom')) {
 136             $rpcenv->check($authuser, "/", ['Sys.Console']);
 137         } elsif (!$isCDROM && ($volid =~ $NEW_DISK_RE)) {
 138             my ($storeid, $size) = ($2 || $default_storage, $3);
 139             die "no storage ID specified (and no default storage)\n" if !$storeid;
 140             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
 141             my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
 142             raise_param_exc({ storage => "storage '$storeid' does not support vm images"})
 143                 if !$scfg->{content}->{images};
 144         } else {
 145             PVE::Storage::check_volume_access($rpcenv, $authuser, $storecfg, $vmid, $volid);
 146             if ($storeid) {
 147                 my ($vtype) = PVE::Storage::parse_volname($storecfg, $volid);
 148                 raise_param_exc({ $ds => "content type needs to be 'images' or 'iso'" })
 149                     if $vtype ne 'images' && $vtype ne 'iso';
 150             }
 151         }
 152
 153         if (my $src_image = $drive->{'import-from'}) {
 154             my $src_vmid;
 155             if (PVE::Storage::parse_volume_id($src_image, 1)) { # PVE-managed volume
 156                 (my $vtype, undef, $src_vmid) = PVE::Storage::parse_volname($storecfg, $src_image);
 157                 raise_param_exc({ $ds => "$src_image has wrong type '$vtype' - not an image" })
 158                     if $vtype ne 'images';
 159             }
 160
 161             if ($src_vmid) { # might be actively used by VM and will be copied via clone_disk()
 162                 $rpcenv->check($authuser, "/vms/${src_vmid}", ['VM.Clone']);
 163             } else {
 164                 PVE::Storage::check_volume_access($rpcenv, $authuser, $storecfg, $vmid, $src_image);
 165             }
 166         }
 167     });
 168
 169    $rpcenv->check($authuser, "/storage/$settings->{vmstatestorage}", ['Datastore.AllocateSpace'])
 170        if defined($settings->{vmstatestorage});
 171 };
 172
 173 my $check_storage_access_clone = sub {
 174    my ($rpcenv, $authuser, $storecfg, $conf, $storage) = @_;
 175
 176    my $sharedvm = 1;
 177
 178    PVE::QemuConfig->foreach_volume($conf, sub {
 179         my ($ds, $drive) = @_;
 180
 181         my $isCDROM = PVE::QemuServer::drive_is_cdrom($drive);
 182
 183         my $volid = $drive->{file};
 184
 185         return if !$volid || $volid eq 'none';
 186
 187         if ($isCDROM) {
 188             if ($volid eq 'cdrom') {
 189                 $rpcenv->check($authuser, "/", ['Sys.Console']);
 190             } else {
 191                 # we simply allow access
 192                 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid);
 193                 my $scfg = PVE::Storage::storage_config($storecfg, $sid);
 194                 $sharedvm = 0 if !$scfg->{shared};
 195
 196             }
 197         } else {
 198             my ($sid, $volname) = PVE::Storage::parse_volume_id($volid);
 199             my $scfg = PVE::Storage::storage_config($storecfg, $sid);
 200             $sharedvm = 0 if !$scfg->{shared};
 201
 202             $sid = $storage if $storage;
 203             $rpcenv->check($authuser, "/storage/$sid", ['Datastore.AllocateSpace']);
 204         }
 205     });
 206
 207    $rpcenv->check($authuser, "/storage/$conf->{vmstatestorage}", ['Datastore.AllocateSpace'])
 208        if defined($conf->{vmstatestorage});
 209
 210    return $sharedvm;
 211 };
 212
 213 my $check_storage_access_migrate = sub {
 214     my ($rpcenv, $authuser, $storecfg, $storage, $node) = @_;
 215
 216     PVE::Storage::storage_check_enabled($storecfg, $storage, $node);
 217
 218     $rpcenv->check($authuser, "/storage/$storage", ['Datastore.AllocateSpace']);
 219
 220     my $scfg = PVE::Storage::storage_config($storecfg, $storage);
 221     die "storage '$storage' does not support vm images\n"
 222         if !$scfg->{content}->{images};
 223 };
 224
 225 my $import_from_volid = sub {
 226     my ($storecfg, $src_volid, $dest_info, $vollist) = @_;
 227
 228     die "could not get size of $src_volid\n"
 229         if !PVE::Storage::volume_size_info($storecfg, $src_volid, 10);
 230
 231     die "cannot import from cloudinit disk\n"
 232         if PVE::QemuServer::Drive::drive_is_cloudinit({ file => $src_volid });
 233
 234     my $src_vmid = (PVE::Storage::parse_volname($storecfg, $src_volid))[2];
 235
 236     my $src_vm_state = sub {
 237         my $exists = $src_vmid && PVE::Cluster::get_vmlist()->{ids}->{$src_vmid} ? 1 : 0;
 238
 239         my $runs = 0;
 240         if ($exists) {
 241             eval { PVE::QemuConfig::assert_config_exists_on_node($src_vmid); };
 242             die "owner VM $src_vmid not on local node\n" if $@;
 243             $runs = PVE::QemuServer::Helpers::vm_running_locally($src_vmid) || 0;
 244         }
 245
 246         return ($exists, $runs);
 247     };
 248
 249     my ($src_vm_exists, $running) = $src_vm_state->();
 250
 251     die "cannot import from '$src_volid' - full clone feature is not supported\n"
 252         if !PVE::Storage::volume_has_feature($storecfg, 'copy', $src_volid, undef, $running);
 253
 254     my $clonefn = sub {
 255         my ($src_vm_exists_now, $running_now) = $src_vm_state->();
 256
 257         die "owner VM $src_vmid changed state unexpectedly\n"
 258             if $src_vm_exists_now != $src_vm_exists || $running_now != $running;
 259
 260         my $src_conf = $src_vm_exists_now ? PVE::QemuConfig->load_config($src_vmid) : {};
 261
 262         my $src_drive = { file => $src_volid };
 263         my $src_drivename;
 264         PVE::QemuConfig->foreach_volume($src_conf, sub {
 265             my ($ds, $drive) = @_;
 266
 267             return if $src_drivename;
 268
 269             if ($drive->{file} eq $src_volid) {
 270                 $src_drive = $drive;
 271                 $src_drivename = $ds;
 272             }
 273         });
 274
 275         my $source_info = {
 276             vmid => $src_vmid,
 277             running => $running_now,
 278             drivename => $src_drivename,
 279             drive => $src_drive,
 280             snapname => undef,
 281         };
 282
 283         my ($src_storeid) = PVE::Storage::parse_volume_id($src_volid);
 284
 285         return PVE::QemuServer::clone_disk(
 286             $storecfg,
 287             $source_info,
 288             $dest_info,
 289             1,
 290             $vollist,
 291             undef,
 292             undef,
 293             $src_conf->{agent},
 294             PVE::Storage::get_bandwidth_limit('clone', [$src_storeid, $dest_info->{storage}]),
 295         );
 296     };
 297
 298     my $cloned;
 299     if ($running) {
 300         $cloned = PVE::QemuConfig->lock_config_full($src_vmid, 30, $clonefn);
 301     } elsif ($src_vmid) {
 302         $cloned = PVE::QemuConfig->lock_config_shared($src_vmid, 30, $clonefn);
 303     } else {
 304         $cloned = $clonefn->();
 305     }
 306
 307     return $cloned->@{qw(file size)};
 308 };
 309
 310 # Note: $pool is only needed when creating a VM, because pool permissions
 311 # are automatically inherited if VM already exists inside a pool.
 312 my $create_disks = sub {
 313     my ($rpcenv, $authuser, $conf, $arch, $storecfg, $vmid, $pool, $settings, $default_storage) = @_;
 314
 315     my $vollist = [];
 316
 317     my $res = {};
 318
 319     my $code = sub {
 320         my ($ds, $disk) = @_;
 321
 322         my $volid = $disk->{file};
 323         my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
 324
 325         if (!$volid || $volid eq 'none' || $volid eq 'cdrom') {
 326             delete $disk->{size};
 327             $res->{$ds} = PVE::QemuServer::print_drive($disk);
 328         } elsif (defined($volname) && $volname eq 'cloudinit') {
 329             $storeid = $storeid // $default_storage;
 330             die "no storage ID specified (and no default storage)\n" if !$storeid;
 331             my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
 332             my $name = "vm-$vmid-cloudinit";
 333
 334             my $fmt = undef;
 335             if ($scfg->{path}) {
 336                 $fmt = $disk->{format} // "qcow2";
 337                 $name .= ".$fmt";
 338             } else {
 339                 $fmt = $disk->{format} // "raw";
 340             }
 341
 342             # Initial disk created with 4 MB and aligned to 4MB on regeneration
 343             my $ci_size = PVE::QemuServer::Cloudinit::CLOUDINIT_DISK_SIZE;
 344             my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $fmt, $name, $ci_size/1024);
 345             $disk->{file} = $volid;
 346             $disk->{media} = 'cdrom';
 347             push @$vollist, $volid;
 348             delete $disk->{format}; # no longer needed
 349             $res->{$ds} = PVE::QemuServer::print_drive($disk);
 350             print "$ds: successfully created disk '$res->{$ds}'\n";
 351         } elsif ($volid =~ $NEW_DISK_RE) {
 352             my ($storeid, $size) = ($2 || $default_storage, $3);
 353             die "no storage ID specified (and no default storage)\n" if !$storeid;
 354
 355             if (my $source = delete $disk->{'import-from'}) {
 356                 my $dst_volid;
 357
 358                 if (PVE::Storage::parse_volume_id($source, 1)) { # PVE-managed volume
 359                     my $dest_info = {
 360                         vmid => $vmid,
 361                         drivename => $ds,
 362                         storage => $storeid,
 363                         format => $disk->{format},
 364                     };
 365
 366                     $dest_info->{efisize} = PVE::QemuServer::get_efivars_size($conf, $disk)
 367                         if $ds eq 'efidisk0';
 368
 369                     ($dst_volid, $size) = eval {
 370                         $import_from_volid->($storecfg, $source, $dest_info, $vollist);
 371                     };
 372                     die "cannot import from '$source' - $@" if $@;
 373                 } else {
 374                     $source = PVE::Storage::abs_filesystem_path($storecfg, $source, 1);
 375                     $size = PVE::Storage::file_size_info($source);
 376                     die "could not get file size of $source\n" if !$size;
 377
 378                     (undef, $dst_volid) = PVE::QemuServer::ImportDisk::do_import(
 379                         $source,
 380                         $vmid,
 381                         $storeid,
 382                         {
 383                             drive_name => $ds,
 384                             format => $disk->{format},
 385                             'skip-config-update' => 1,
 386                         },
 387                     );
 388                     push @$vollist, $dst_volid;
 389                 }
 390
 391                 $disk->{file} = $dst_volid;
 392                 $disk->{size} = $size;
 393                 delete $disk->{format}; # no longer needed
 394                 $res->{$ds} = PVE::QemuServer::print_drive($disk);
 395             } else {
 396                 my $defformat = PVE::Storage::storage_default_format($storecfg, $storeid);
 397                 my $fmt = $disk->{format} || $defformat;
 398
 399                 $size = PVE::Tools::convert_size($size, 'gb' => 'kb'); # vdisk_alloc uses kb
 400
 401                 my $volid;
 402                 if ($ds eq 'efidisk0') {
 403                     my $smm = PVE::QemuServer::Machine::machine_type_is_q35($conf);
 404                     ($volid, $size) = PVE::QemuServer::create_efidisk(
 405                         $storecfg, $storeid, $vmid, $fmt, $arch, $disk, $smm);
 406                 } elsif ($ds eq 'tpmstate0') {
 407                     # swtpm can only use raw volumes, and uses a fixed size
 408                     $size = PVE::Tools::convert_size(PVE::QemuServer::Drive::TPMSTATE_DISK_SIZE, 'b' => 'kb');
 409                     $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, "raw", undef, $size);
 410                 } else {
 411                     $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid, $fmt, undef, $size);
 412                 }
 413                 push @$vollist, $volid;
 414                 $disk->{file} = $volid;
 415                 $disk->{size} = PVE::Tools::convert_size($size, 'kb' => 'b');
 416                 delete $disk->{format}; # no longer needed
 417                 $res->{$ds} = PVE::QemuServer::print_drive($disk);
 418             }
 419
 420             print "$ds: successfully created disk '$res->{$ds}'\n";
 421         } else {
 422             PVE::Storage::check_volume_access($rpcenv, $authuser, $storecfg, $vmid, $volid);
 423             if ($storeid) {
 424                 my ($vtype) = PVE::Storage::parse_volname($storecfg, $volid);
 425                 die "cannot use volume $volid - content type needs to be 'images' or 'iso'"
 426                     if $vtype ne 'images' && $vtype ne 'iso';
 427             }
 428
 429             PVE::Storage::activate_volumes($storecfg, [ $volid ]) if $storeid;
 430
 431             my $size = PVE::Storage::volume_size_info($storecfg, $volid);
 432             die "volume $volid does not exist\n" if !$size;
 433             $disk->{size} = $size;
 434
 435             $res->{$ds} = PVE::QemuServer::print_drive($disk);
 436         }
 437     };
 438
 439     eval { $foreach_volume_with_alloc->($settings, $code); };
 440
 441     # free allocated images on error
 442     if (my $err = $@) {
 443         syslog('err', "VM $vmid creating disks failed");
 444         foreach my $volid (@$vollist) {
 445             eval { PVE::Storage::vdisk_free($storecfg, $volid); };
 446             warn $@ if $@;
 447         }
 448         die $err;
 449     }
 450
 451     return ($vollist, $res);
 452 };
 453
 454 my $check_cpu_model_access = sub {
 455     my ($rpcenv, $authuser, $new, $existing) = @_;
 456
 457     return if !defined($new->{cpu});
 458
 459     my $cpu = PVE::JSONSchema::check_format('pve-vm-cpu-conf', $new->{cpu});
 460     return if !$cpu || !$cpu->{cputype}; # always allow default
 461     my $cputype = $cpu->{cputype};
 462
 463     if ($existing && $existing->{cpu}) {
 464         # changing only other settings doesn't require permissions for CPU model
 465         my $existingCpu = PVE::JSONSchema::check_format('pve-vm-cpu-conf', $existing->{cpu});
 466         return if $existingCpu->{cputype} eq $cputype;
 467     }
 468
 469     if (PVE::QemuServer::CPUConfig::is_custom_model($cputype)) {
 470         $rpcenv->check($authuser, "/nodes", ['Sys.Audit']);
 471     }
 472 };
 473
 474 my $cpuoptions = {
 475     'cores' => 1,
 476     'cpu' => 1,
 477     'cpulimit' => 1,
 478     'cpuunits' => 1,
 479     'numa' => 1,
 480     'smp' => 1,
 481     'sockets' => 1,
 482     'vcpus' => 1,
 483 };
 484
 485 my $memoryoptions = {
 486     'memory' => 1,
 487     'balloon' => 1,
 488     'shares' => 1,
 489 };
 490
 491 my $hwtypeoptions = {
 492     'acpi' => 1,
 493     'hotplug' => 1,
 494     'kvm' => 1,
 495     'machine' => 1,
 496     'scsihw' => 1,
 497     'smbios1' => 1,
 498     'tablet' => 1,
 499     'vga' => 1,
 500     'watchdog' => 1,
 501     'audio0' => 1,
 502 };
 503
 504 my $generaloptions = {
 505     'agent' => 1,
 506     'autostart' => 1,
 507     'bios' => 1,
 508     'description' => 1,
 509     'keyboard' => 1,
 510     'localtime' => 1,
 511     'migrate_downtime' => 1,
 512     'migrate_speed' => 1,
 513     'name' => 1,
 514     'onboot' => 1,
 515     'ostype' => 1,
 516     'protection' => 1,
 517     'reboot' => 1,
 518     'startdate' => 1,
 519     'startup' => 1,
 520     'tdf' => 1,
 521     'template' => 1,
 522     'tags' => 1,
 523 };
 524
 525 my $vmpoweroptions = {
 526     'freeze' => 1,
 527 };
 528
 529 my $diskoptions = {
 530     'boot' => 1,
 531     'bootdisk' => 1,
 532     'vmstatestorage' => 1,
 533 };
 534
 535 my $cloudinitoptions = {
 536     cicustom => 1,
 537     cipassword => 1,
 538     citype => 1,
 539     ciuser => 1,
 540     nameserver => 1,
 541     searchdomain => 1,
 542     sshkeys => 1,
 543 };
 544
 545 my $check_vm_create_serial_perm = sub {
 546     my ($rpcenv, $authuser, $vmid, $pool, $param) = @_;
 547
 548     return 1 if $authuser eq 'root@pam';
 549
 550     foreach my $opt (keys %{$param}) {
 551         next if $opt !~ m/^serial\d+$/;
 552
 553         if ($param->{$opt} eq 'socket') {
 554             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.HWType']);
 555         } else {
 556             die "only root can set '$opt' config for real devices\n";
 557         }
 558     }
 559
 560     return 1;
 561 };
 562
 563 my $check_vm_create_usb_perm = sub {
 564     my ($rpcenv, $authuser, $vmid, $pool, $param) = @_;
 565
 566     return 1 if $authuser eq 'root@pam';
 567
 568     foreach my $opt (keys %{$param}) {
 569         next if $opt !~ m/^usb\d+$/;
 570
 571         if ($param->{$opt} =~ m/spice/) {
 572             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.HWType']);
 573         } else {
 574             die "only root can set '$opt' config for real devices\n";
 575         }
 576     }
 577
 578     return 1;
 579 };
 580
 581 my $check_vm_modify_config_perm = sub {
 582     my ($rpcenv, $authuser, $vmid, $pool, $key_list) = @_;
 583
 584     return 1 if $authuser eq 'root@pam';
 585
 586     foreach my $opt (@$key_list) {
 587         # some checks (e.g., disk, serial port, usb) need to be done somewhere
 588         # else, as there the permission can be value dependend
 589         next if PVE::QemuServer::is_valid_drivename($opt);
 590         next if $opt eq 'cdrom';
 591         next if $opt =~ m/^(?:unused|serial|usb)\d+$/;
 592
 593
 594         if ($cpuoptions->{$opt} || $opt =~ m/^numa\d+$/) {
 595             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.CPU']);
 596         } elsif ($memoryoptions->{$opt}) {
 597             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Memory']);
 598         } elsif ($hwtypeoptions->{$opt}) {
 599             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.HWType']);
 600         } elsif ($generaloptions->{$opt}) {
 601             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Options']);
 602             # special case for startup since it changes host behaviour
 603             if ($opt eq 'startup') {
 604                 $rpcenv->check_full($authuser, "/", ['Sys.Modify']);
 605             }
 606         } elsif ($vmpoweroptions->{$opt}) {
 607             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.PowerMgmt']);
 608         } elsif ($diskoptions->{$opt}) {
 609             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Disk']);
 610         } elsif ($opt =~ m/^(?:net|ipconfig)\d+$/) {
 611             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Network']);
 612         } elsif ($cloudinitoptions->{$opt}) {
 613             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Cloudinit', 'VM.Config.Network'], 1);
 614         } elsif ($opt eq 'vmstate') {
 615             # the user needs Disk and PowerMgmt privileges to change the vmstate
 616             # also needs privileges on the storage, that will be checked later
 617             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Disk', 'VM.PowerMgmt' ]);
 618         } else {
 619             # catches hostpci\d+, args, lock, etc.
 620             # new options will be checked here
 621             die "only root can set '$opt' config\n";
 622         }
 623     }
 624
 625     return 1;
 626 };
 627
 628 __PACKAGE__->register_method({
 629     name => 'vmlist',
 630     path => '',
 631     method => 'GET',
 632     description => "Virtual machine index (per node).",
 633     permissions => {
 634         description => "Only list VMs where you have VM.Audit permissons on /vms/<vmid>.",
 635         user => 'all',
 636     },
 637     proxyto => 'node',
 638     protected => 1, # qemu pid files are only readable by root
 639     parameters => {
 640         additionalProperties => 0,
 641         properties => {
 642             node => get_standard_option('pve-node'),
 643             full => {
 644                 type => 'boolean',
 645                 optional => 1,
 646                 description => "Determine the full status of active VMs.",
 647             },
 648         },
 649     },
 650     returns => {
 651         type => 'array',
 652         items => {
 653             type => "object",
 654             properties => $PVE::QemuServer::vmstatus_return_properties,
 655         },
 656         links => [ { rel => 'child', href => "{vmid}" } ],
 657     },
 658     code => sub {
 659         my ($param) = @_;
 660
 661         my $rpcenv = PVE::RPCEnvironment::get();
 662         my $authuser = $rpcenv->get_user();
 663
 664         my $vmstatus = PVE::QemuServer::vmstatus(undef, $param->{full});
 665
 666         my $res = [];
 667         foreach my $vmid (keys %$vmstatus) {
 668             next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Audit' ], 1);
 669
 670             my $data = $vmstatus->{$vmid};
 671             push @$res, $data;
 672         }
 673
 674         return $res;
 675     }});
 676
 677 my $parse_restore_archive = sub {
 678     my ($storecfg, $archive) = @_;
 679
 680     my ($archive_storeid, $archive_volname) = PVE::Storage::parse_volume_id($archive, 1);
 681
 682     if (defined($archive_storeid)) {
 683         my $scfg =  PVE::Storage::storage_config($storecfg, $archive_storeid);
 684         if ($scfg->{type} eq 'pbs') {
 685             return {
 686                 type => 'pbs',
 687                 volid => $archive,
 688             };
 689         }
 690     }
 691     my $path = PVE::Storage::abs_filesystem_path($storecfg, $archive);
 692     return {
 693         type => 'file',
 694         path => $path,
 695     };
 696 };
 697
 698
 699 __PACKAGE__->register_method({
 700     name => 'create_vm',
 701     path => '',
 702     method => 'POST',
 703     description => "Create or restore a virtual machine.",
 704     permissions => {
 705         description => "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. " .
 706             "For restore (option 'archive'), it is enough if the user has 'VM.Backup' permission and the VM already exists. " .
 707             "If you create disks you need 'Datastore.AllocateSpace' on any used storage.",
 708         user => 'all', # check inside
 709     },
 710     protected => 1,
 711     proxyto => 'node',
 712     parameters => {
 713         additionalProperties => 0,
 714         properties => PVE::QemuServer::json_config_properties(
 715             {
 716                 node => get_standard_option('pve-node'),
 717                 vmid => get_standard_option('pve-vmid', { completion => \&PVE::Cluster::complete_next_vmid }),
 718                 archive => {
 719                     description => "The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.",
 720                     type => 'string',
 721                     optional => 1,
 722                     maxLength => 255,
 723                     completion => \&PVE::QemuServer::complete_backup_archives,
 724                 },
 725                 storage => get_standard_option('pve-storage-id', {
 726                     description => "Default storage.",
 727                     optional => 1,
 728                     completion => \&PVE::QemuServer::complete_storage,
 729                 }),
 730                 force => {
 731                     optional => 1,
 732                     type => 'boolean',
 733                     description => "Allow to overwrite existing VM.",
 734                     requires => 'archive',
 735                 },
 736                 unique => {
 737                     optional => 1,
 738                     type => 'boolean',
 739                     description => "Assign a unique random ethernet address.",
 740                     requires => 'archive',
 741                 },
 742                 'live-restore' => {
 743                     optional => 1,
 744                     type => 'boolean',
 745                     description => "Start the VM immediately from the backup and restore in background. PBS only.",
 746                     requires => 'archive',
 747                 },
 748                 pool => {
 749                     optional => 1,
 750                     type => 'string', format => 'pve-poolid',
 751                     description => "Add the VM to the specified pool.",
 752                 },
 753                 bwlimit => {
 754                     description => "Override I/O bandwidth limit (in KiB/s).",
 755                     optional => 1,
 756                     type => 'integer',
 757                     minimum => '0',
 758                     default => 'restore limit from datacenter or storage config',
 759                 },
 760                 start => {
 761                     optional => 1,
 762                     type => 'boolean',
 763                     default => 0,
 764                     description => "Start VM after it was created successfully.",
 765                 },
 766             },
 767             1, # with_disk_alloc
 768         ),
 769     },
 770     returns => {
 771         type => 'string',
 772     },
 773     code => sub {
 774         my ($param) = @_;
 775
 776         my $rpcenv = PVE::RPCEnvironment::get();
 777         my $authuser = $rpcenv->get_user();
 778
 779         my $node = extract_param($param, 'node');
 780         my $vmid = extract_param($param, 'vmid');
 781
 782         my $archive = extract_param($param, 'archive');
 783         my $is_restore = !!$archive;
 784
 785         my $bwlimit = extract_param($param, 'bwlimit');
 786         my $force = extract_param($param, 'force');
 787         my $pool = extract_param($param, 'pool');
 788         my $start_after_create = extract_param($param, 'start');
 789         my $storage = extract_param($param, 'storage');
 790         my $unique = extract_param($param, 'unique');
 791         my $live_restore = extract_param($param, 'live-restore');
 792
 793         if (defined(my $ssh_keys = $param->{sshkeys})) {
 794                 $ssh_keys = URI::Escape::uri_unescape($ssh_keys);
 795                 PVE::Tools::validate_ssh_public_keys($ssh_keys);
 796         }
 797
 798         PVE::Cluster::check_cfs_quorum();
 799
 800         my $filename = PVE::QemuConfig->config_file($vmid);
 801         my $storecfg = PVE::Storage::config();
 802
 803         if (defined($pool)) {
 804             $rpcenv->check_pool_exist($pool);
 805         }
 806
 807         $rpcenv->check($authuser, "/storage/$storage", ['Datastore.AllocateSpace'])
 808             if defined($storage);
 809
 810         if ($rpcenv->check($authuser, "/vms/$vmid", ['VM.Allocate'], 1)) {
 811             # OK
 812         } elsif ($pool && $rpcenv->check($authuser, "/pool/$pool", ['VM.Allocate'], 1)) {
 813             # OK
 814         } elsif ($archive && $force && (-f $filename) &&
 815                  $rpcenv->check($authuser, "/vms/$vmid", ['VM.Backup'], 1)) {
 816             # OK: user has VM.Backup permissions, and want to restore an existing VM
 817         } else {
 818             raise_perm_exc();
 819         }
 820
 821         if ($archive) {
 822             for my $opt (sort keys $param->%*) {
 823                 if (PVE::QemuServer::Drive::is_valid_drivename($opt)) {
 824                     raise_param_exc({ $opt => "option conflicts with option 'archive'" });
 825                 }
 826             }
 827
 828             if ($archive eq '-') {
 829                 die "pipe requires cli environment\n" if $rpcenv->{type} ne 'cli';
 830                 $archive = { type => 'pipe' };
 831             } else {
 832                 PVE::Storage::check_volume_access(
 833                     $rpcenv,
 834                     $authuser,
 835                     $storecfg,
 836                     $vmid,
 837                     $archive,
 838                     'backup',
 839                 );
 840
 841                 $archive = $parse_restore_archive->($storecfg, $archive);
 842             }
 843         }
 844
 845         if (scalar(keys $param->%*) > 0) {
 846             &$resolve_cdrom_alias($param);
 847
 848             &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $param, $storage);
 849
 850             &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, $pool, [ keys %$param]);
 851
 852             &$check_vm_create_serial_perm($rpcenv, $authuser, $vmid, $pool, $param);
 853             &$check_vm_create_usb_perm($rpcenv, $authuser, $vmid, $pool, $param);
 854
 855             &$check_cpu_model_access($rpcenv, $authuser, $param);
 856
 857             $check_drive_param->($param, $storecfg);
 858
 859             PVE::QemuServer::add_random_macs($param);
 860         }
 861
 862         my $emsg = $is_restore ? "unable to restore VM $vmid -" : "unable to create VM $vmid -";
 863
 864         eval { PVE::QemuConfig->create_and_lock_config($vmid, $force) };
 865         die "$emsg $@" if $@;
 866
 867         my $restored_data = 0;
 868         my $restorefn = sub {
 869             my $conf = PVE::QemuConfig->load_config($vmid);
 870
 871             PVE::QemuConfig->check_protection($conf, $emsg);
 872
 873             die "$emsg vm is running\n" if PVE::QemuServer::check_running($vmid);
 874
 875             my $realcmd = sub {
 876                 my $restore_options = {
 877                     storage => $storage,
 878                     pool => $pool,
 879                     unique => $unique,
 880                     bwlimit => $bwlimit,
 881                     live => $live_restore,
 882                     override_conf => $param,
 883                 };
 884                 if ($archive->{type} eq 'file' || $archive->{type} eq 'pipe') {
 885                     die "live-restore is only compatible with backup images from a Proxmox Backup Server\n"
 886                         if $live_restore;
 887                     PVE::QemuServer::restore_file_archive($archive->{path} // '-', $vmid, $authuser, $restore_options);
 888                 } elsif ($archive->{type} eq 'pbs') {
 889                     PVE::QemuServer::restore_proxmox_backup_archive($archive->{volid}, $vmid, $authuser, $restore_options);
 890                 } else {
 891                     die "unknown backup archive type\n";
 892                 }
 893                 $restored_data = 1;
 894
 895                 my $restored_conf = PVE::QemuConfig->load_config($vmid);
 896                 # Convert restored VM to template if backup was VM template
 897                 if (PVE::QemuConfig->is_template($restored_conf)) {
 898                     warn "Convert to template.\n";
 899                     eval { PVE::QemuServer::template_create($vmid, $restored_conf) };
 900                     warn $@ if $@;
 901                 }
 902             };
 903
 904             # ensure no old replication state are exists
 905             PVE::ReplicationState::delete_guest_states($vmid);
 906
 907             PVE::QemuConfig->lock_config_full($vmid, 1, $realcmd);
 908
 909             if ($start_after_create && !$live_restore) {
 910                 print "Execute autostart\n";
 911                 eval { PVE::API2::Qemu->vm_start({ vmid => $vmid, node => $node }) };
 912                 warn $@ if $@;
 913             }
 914         };
 915
 916         my $createfn = sub {
 917             # ensure no old replication state are exists
 918             PVE::ReplicationState::delete_guest_states($vmid);
 919
 920             my $realcmd = sub {
 921                 my $conf = $param;
 922                 my $arch = PVE::QemuServer::get_vm_arch($conf);
 923
 924                 $conf->{meta} = PVE::QemuServer::new_meta_info_string();
 925
 926                 my $vollist = [];
 927                 eval {
 928                     ($vollist, my $created_opts) = $create_disks->(
 929                         $rpcenv,
 930                         $authuser,
 931                         $conf,
 932                         $arch,
 933                         $storecfg,
 934                         $vmid,
 935                         $pool,
 936                         $param,
 937                         $storage,
 938                     );
 939                     $conf->{$_} = $created_opts->{$_} for keys $created_opts->%*;
 940
 941                     if (!$conf->{boot}) {
 942                         my $devs = PVE::QemuServer::get_default_bootdevices($conf);
 943                         $conf->{boot} = PVE::QemuServer::print_bootorder($devs);
 944                     }
 945
 946                     # auto generate uuid if user did not specify smbios1 option
 947                     if (!$conf->{smbios1}) {
 948                         $conf->{smbios1} = PVE::QemuServer::generate_smbios1_uuid();
 949                     }
 950
 951                     if ((!defined($conf->{vmgenid}) || $conf->{vmgenid} eq '1') && $arch ne 'aarch64') {
 952                         $conf->{vmgenid} = PVE::QemuServer::generate_uuid();
 953                     }
 954
 955                     my $machine = $conf->{machine};
 956                     if (!$machine || $machine =~ m/^(?:pc|q35|virt)$/) {
 957                         # always pin Windows' machine version on create, they get to easily confused
 958                         if (PVE::QemuServer::windows_version($conf->{ostype})) {
 959                             $conf->{machine} = PVE::QemuServer::windows_get_pinned_machine_version($machine);
 960                         }
 961                     }
 962
 963                     PVE::QemuConfig->write_config($vmid, $conf);
 964
 965                 };
 966                 my $err = $@;
 967
 968                 if ($err) {
 969                     foreach my $volid (@$vollist) {
 970                         eval { PVE::Storage::vdisk_free($storecfg, $volid); };
 971                         warn $@ if $@;
 972                     }
 973                     die "$emsg $err";
 974                 }
 975
 976                 PVE::AccessControl::add_vm_to_pool($vmid, $pool) if $pool;
 977             };
 978
 979             PVE::QemuConfig->lock_config_full($vmid, 1, $realcmd);
 980
 981             if ($start_after_create) {
 982                 print "Execute autostart\n";
 983                 eval { PVE::API2::Qemu->vm_start({vmid => $vmid, node => $node}) };
 984                 warn $@ if $@;
 985             }
 986         };
 987
 988         my ($code, $worker_name);
 989         if ($is_restore) {
 990             $worker_name = 'qmrestore';
 991             $code = sub {
 992                 eval { $restorefn->() };
 993                 if (my $err = $@) {
 994                     eval { PVE::QemuConfig->remove_lock($vmid, 'create') };
 995                     warn $@ if $@;
 996                     if ($restored_data) {
 997                         warn "error after data was restored, VM disks should be OK but config may "
 998                             ."require adaptions. VM $vmid state is NOT cleaned up.\n";
 999                     } else {
1000                         warn "error before or during data restore, some or all disks were not "
1001                             ."completely restored. VM $vmid state is NOT cleaned up.\n";
1002                     }
1003                     die $err;
1004                 }
1005             };
1006         } else {
1007             $worker_name = 'qmcreate';
1008             $code = sub {
1009                 eval { $createfn->() };
1010                 if (my $err = $@) {
1011                     eval {
1012                         my $conffile = PVE::QemuConfig->config_file($vmid);
1013                         unlink($conffile) or die "failed to remove config file: $!\n";
1014                     };
1015                     warn $@ if $@;
1016                     die $err;
1017                 }
1018             };
1019         }
1020
1021         return $rpcenv->fork_worker($worker_name, $vmid, $authuser, $code);
1022     }});
1023
1024 __PACKAGE__->register_method({
1025     name => 'vmdiridx',
1026     path => '{vmid}',
1027     method => 'GET',
1028     proxyto => 'node',
1029     description => "Directory index",
1030     permissions => {
1031         user => 'all',
1032     },
1033     parameters => {
1034         additionalProperties => 0,
1035         properties => {
1036             node => get_standard_option('pve-node'),
1037             vmid => get_standard_option('pve-vmid'),
1038         },
1039     },
1040     returns => {
1041         type => 'array',
1042         items => {
1043             type => "object",
1044             properties => {
1045                 subdir => { type => 'string' },
1046             },
1047         },
1048         links => [ { rel => 'child', href => "{subdir}" } ],
1049     },
1050     code => sub {
1051         my ($param) = @_;
1052
1053         my $res = [
1054             { subdir => 'config' },
1055             { subdir => 'pending' },
1056             { subdir => 'status' },
1057             { subdir => 'unlink' },
1058             { subdir => 'vncproxy' },
1059             { subdir => 'termproxy' },
1060             { subdir => 'migrate' },
1061             { subdir => 'resize' },
1062             { subdir => 'move' },
1063             { subdir => 'rrd' },
1064             { subdir => 'rrddata' },
1065             { subdir => 'monitor' },
1066             { subdir => 'agent' },
1067             { subdir => 'snapshot' },
1068             { subdir => 'spiceproxy' },
1069             { subdir => 'sendkey' },
1070             { subdir => 'firewall' },
1071             ];
1072
1073         return $res;
1074     }});
1075
1076 __PACKAGE__->register_method ({
1077     subclass => "PVE::API2::Firewall::VM",
1078     path => '{vmid}/firewall',
1079 });
1080
1081 __PACKAGE__->register_method ({
1082     subclass => "PVE::API2::Qemu::Agent",
1083     path => '{vmid}/agent',
1084 });
1085
1086 __PACKAGE__->register_method({
1087     name => 'rrd',
1088     path => '{vmid}/rrd',
1089     method => 'GET',
1090     protected => 1, # fixme: can we avoid that?
1091     permissions => {
1092         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1093     },
1094     description => "Read VM RRD statistics (returns PNG)",
1095     parameters => {
1096         additionalProperties => 0,
1097         properties => {
1098             node => get_standard_option('pve-node'),
1099             vmid => get_standard_option('pve-vmid'),
1100             timeframe => {
1101                 description => "Specify the time frame you are interested in.",
1102                 type => 'string',
1103                 enum => [ 'hour', 'day', 'week', 'month', 'year' ],
1104             },
1105             ds => {
1106                 description => "The list of datasources you want to display.",
1107                 type => 'string', format => 'pve-configid-list',
1108             },
1109             cf => {
1110                 description => "The RRD consolidation function",
1111                 type => 'string',
1112                 enum => [ 'AVERAGE', 'MAX' ],
1113                 optional => 1,
1114             },
1115         },
1116     },
1117     returns => {
1118         type => "object",
1119         properties => {
1120             filename => { type => 'string' },
1121         },
1122     },
1123     code => sub {
1124         my ($param) = @_;
1125
1126         return PVE::RRD::create_rrd_graph(
1127             "pve2-vm/$param->{vmid}", $param->{timeframe},
1128             $param->{ds}, $param->{cf});
1129
1130     }});
1131
1132 __PACKAGE__->register_method({
1133     name => 'rrddata',
1134     path => '{vmid}/rrddata',
1135     method => 'GET',
1136     protected => 1, # fixme: can we avoid that?
1137     permissions => {
1138         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1139     },
1140     description => "Read VM RRD statistics",
1141     parameters => {
1142         additionalProperties => 0,
1143         properties => {
1144             node => get_standard_option('pve-node'),
1145             vmid => get_standard_option('pve-vmid'),
1146             timeframe => {
1147                 description => "Specify the time frame you are interested in.",
1148                 type => 'string',
1149                 enum => [ 'hour', 'day', 'week', 'month', 'year' ],
1150             },
1151             cf => {
1152                 description => "The RRD consolidation function",
1153                 type => 'string',
1154                 enum => [ 'AVERAGE', 'MAX' ],
1155                 optional => 1,
1156             },
1157         },
1158     },
1159     returns => {
1160         type => "array",
1161         items => {
1162             type => "object",
1163             properties => {},
1164         },
1165     },
1166     code => sub {
1167         my ($param) = @_;
1168
1169         return PVE::RRD::create_rrd_data(
1170             "pve2-vm/$param->{vmid}", $param->{timeframe}, $param->{cf});
1171     }});
1172
1173
1174 __PACKAGE__->register_method({
1175     name => 'vm_config',
1176     path => '{vmid}/config',
1177     method => 'GET',
1178     proxyto => 'node',
1179     description => "Get the virtual machine configuration with pending configuration " .
1180         "changes applied. Set the 'current' parameter to get the current configuration instead.",
1181     permissions => {
1182         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1183     },
1184     parameters => {
1185         additionalProperties => 0,
1186         properties => {
1187             node => get_standard_option('pve-node'),
1188             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
1189             current => {
1190                 description => "Get current values (instead of pending values).",
1191                 optional => 1,
1192                 default => 0,
1193                 type => 'boolean',
1194             },
1195             snapshot => get_standard_option('pve-snapshot-name', {
1196                 description => "Fetch config values from given snapshot.",
1197                 optional => 1,
1198                 completion => sub {
1199                     my ($cmd, $pname, $cur, $args) = @_;
1200                     PVE::QemuConfig->snapshot_list($args->[0]);
1201                 },
1202             }),
1203         },
1204     },
1205     returns => {
1206         description => "The VM configuration.",
1207         type => "object",
1208         properties => PVE::QemuServer::json_config_properties({
1209             digest => {
1210                 type => 'string',
1211                 description => 'SHA1 digest of configuration file. This can be used to prevent concurrent modifications.',
1212             }
1213         }),
1214     },
1215     code => sub {
1216         my ($param) = @_;
1217
1218         raise_param_exc({ snapshot => "cannot use 'snapshot' parameter with 'current'",
1219                           current => "cannot use 'snapshot' parameter with 'current'"})
1220             if ($param->{snapshot} && $param->{current});
1221
1222         my $conf;
1223         if ($param->{snapshot}) {
1224             $conf = PVE::QemuConfig->load_snapshot_config($param->{vmid}, $param->{snapshot});
1225         } else {
1226             $conf = PVE::QemuConfig->load_current_config($param->{vmid}, $param->{current});
1227         }
1228         $conf->{cipassword} = '**********' if $conf->{cipassword};
1229         return $conf;
1230
1231     }});
1232
1233 __PACKAGE__->register_method({
1234     name => 'vm_pending',
1235     path => '{vmid}/pending',
1236     method => 'GET',
1237     proxyto => 'node',
1238     description => "Get the virtual machine configuration with both current and pending values.",
1239     permissions => {
1240         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1241     },
1242     parameters => {
1243         additionalProperties => 0,
1244         properties => {
1245             node => get_standard_option('pve-node'),
1246             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
1247         },
1248     },
1249     returns => {
1250         type => "array",
1251         items => {
1252             type => "object",
1253             properties => {
1254                 key => {
1255                     description => "Configuration option name.",
1256                     type => 'string',
1257                 },
1258                 value => {
1259                     description => "Current value.",
1260                     type => 'string',
1261                     optional => 1,
1262                 },
1263                 pending => {
1264                     description => "Pending value.",
1265                     type => 'string',
1266                     optional => 1,
1267                 },
1268                 delete => {
1269                     description => "Indicates a pending delete request if present and not 0. " .
1270                                    "The value 2 indicates a force-delete request.",
1271                     type => 'integer',
1272                     minimum => 0,
1273                     maximum => 2,
1274                     optional => 1,
1275                 },
1276             },
1277         },
1278     },
1279     code => sub {
1280         my ($param) = @_;
1281
1282         my $conf = PVE::QemuConfig->load_config($param->{vmid});
1283
1284         my $pending_delete_hash = PVE::QemuConfig->parse_pending_delete($conf->{pending}->{delete});
1285
1286         $conf->{cipassword} = '**********' if defined($conf->{cipassword});
1287         $conf->{pending}->{cipassword} = '********** ' if defined($conf->{pending}->{cipassword});
1288
1289         return PVE::GuestHelpers::config_with_pending_array($conf, $pending_delete_hash);
1290    }});
1291
1292 # POST/PUT {vmid}/config implementation
1293 #
1294 # The original API used PUT (idempotent) an we assumed that all operations
1295 # are fast. But it turned out that almost any configuration change can
1296 # involve hot-plug actions, or disk alloc/free. Such actions can take long
1297 # time to complete and have side effects (not idempotent).
1298 #
1299 # The new implementation uses POST and forks a worker process. We added
1300 # a new option 'background_delay'. If specified we wait up to
1301 # 'background_delay' second for the worker task to complete. It returns null
1302 # if the task is finished within that time, else we return the UPID.
1303
1304 my $update_vm_api  = sub {
1305     my ($param, $sync) = @_;
1306
1307     my $rpcenv = PVE::RPCEnvironment::get();
1308
1309     my $authuser = $rpcenv->get_user();
1310
1311     my $node = extract_param($param, 'node');
1312
1313     my $vmid = extract_param($param, 'vmid');
1314
1315     my $digest = extract_param($param, 'digest');
1316
1317     my $background_delay = extract_param($param, 'background_delay');
1318
1319     if (defined(my $cipassword = $param->{cipassword})) {
1320         # Same logic as in cloud-init (but with the regex fixed...)
1321         $param->{cipassword} = PVE::Tools::encrypt_pw($cipassword)
1322             if $cipassword !~ /^\$(?:[156]|2[ay])(\$.+){2}/;
1323     }
1324
1325     my @paramarr = (); # used for log message
1326     foreach my $key (sort keys %$param) {
1327         my $value = $key eq 'cipassword' ? '<hidden>' : $param->{$key};
1328         push @paramarr, "-$key", $value;
1329     }
1330
1331     my $skiplock = extract_param($param, 'skiplock');
1332     raise_param_exc({ skiplock => "Only root may use this option." })
1333         if $skiplock && $authuser ne 'root@pam';
1334
1335     my $delete_str = extract_param($param, 'delete');
1336
1337     my $revert_str = extract_param($param, 'revert');
1338
1339     my $force = extract_param($param, 'force');
1340
1341     if (defined(my $ssh_keys = $param->{sshkeys})) {
1342         $ssh_keys = URI::Escape::uri_unescape($ssh_keys);
1343         PVE::Tools::validate_ssh_public_keys($ssh_keys);
1344     }
1345
1346     die "no options specified\n" if !$delete_str && !$revert_str && !scalar(keys %$param);
1347
1348     my $storecfg = PVE::Storage::config();
1349
1350     my $defaults = PVE::QemuServer::load_defaults();
1351
1352     &$resolve_cdrom_alias($param);
1353
1354     # now try to verify all parameters
1355
1356     my $revert = {};
1357     foreach my $opt (PVE::Tools::split_list($revert_str)) {
1358         if (!PVE::QemuServer::option_exists($opt)) {
1359             raise_param_exc({ revert => "unknown option '$opt'" });
1360         }
1361
1362         raise_param_exc({ delete => "you can't use '-$opt' and " .
1363                               "-revert $opt' at the same time" })
1364             if defined($param->{$opt});
1365
1366         $revert->{$opt} = 1;
1367     }
1368
1369     my @delete = ();
1370     foreach my $opt (PVE::Tools::split_list($delete_str)) {
1371         $opt = 'ide2' if $opt eq 'cdrom';
1372
1373         raise_param_exc({ delete => "you can't use '-$opt' and " .
1374                               "-delete $opt' at the same time" })
1375             if defined($param->{$opt});
1376
1377         raise_param_exc({ revert => "you can't use '-delete $opt' and " .
1378                               "-revert $opt' at the same time" })
1379             if $revert->{$opt};
1380
1381         if (!PVE::QemuServer::option_exists($opt)) {
1382             raise_param_exc({ delete => "unknown option '$opt'" });
1383         }
1384
1385         push @delete, $opt;
1386     }
1387
1388     my $repl_conf = PVE::ReplicationConfig->new();
1389     my $is_replicated = $repl_conf->check_for_existing_jobs($vmid, 1);
1390     my $check_replication = sub {
1391         my ($drive) = @_;
1392         return if !$is_replicated;
1393         my $volid = $drive->{file};
1394         return if !$volid || !($drive->{replicate}//1);
1395         return if PVE::QemuServer::drive_is_cdrom($drive);
1396
1397         my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
1398         die "cannot add non-managed/pass-through volume to a replicated VM\n"
1399             if !defined($storeid);
1400
1401         return if defined($volname) && $volname eq 'cloudinit';
1402
1403         my $format;
1404         if ($volid =~ $NEW_DISK_RE) {
1405             $storeid = $2;
1406             $format = $drive->{format} || PVE::Storage::storage_default_format($storecfg, $storeid);
1407         } else {
1408             $format = (PVE::Storage::parse_volname($storecfg, $volid))[6];
1409         }
1410         return if PVE::Storage::storage_can_replicate($storecfg, $storeid, $format);
1411         my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
1412         return if $scfg->{shared};
1413         die "cannot add non-replicatable volume to a replicated VM\n";
1414     };
1415
1416     $check_drive_param->($param, $storecfg, $check_replication);
1417
1418     foreach my $opt (keys %$param) {
1419         if ($opt =~ m/^net(\d+)$/) {
1420             # add macaddr
1421             my $net = PVE::QemuServer::parse_net($param->{$opt});
1422             $param->{$opt} = PVE::QemuServer::print_net($net);
1423         } elsif ($opt eq 'vmgenid') {
1424             if ($param->{$opt} eq '1') {
1425                 $param->{$opt} = PVE::QemuServer::generate_uuid();
1426             }
1427         } elsif ($opt eq 'hookscript') {
1428             eval { PVE::GuestHelpers::check_hookscript($param->{$opt}, $storecfg); };
1429             raise_param_exc({ $opt => $@ }) if $@;
1430         }
1431     }
1432
1433     &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, undef, [@delete]);
1434
1435     &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, undef, [keys %$param]);
1436
1437     &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $param);
1438
1439     my $updatefn =  sub {
1440
1441         my $conf = PVE::QemuConfig->load_config($vmid);
1442
1443         die "checksum missmatch (file change by other user?)\n"
1444             if $digest && $digest ne $conf->{digest};
1445
1446         &$check_cpu_model_access($rpcenv, $authuser, $param, $conf);
1447
1448         # FIXME: 'suspended' lock should probabyl be a state or "weak" lock?!
1449         if (scalar(@delete) && grep { $_ eq 'vmstate'} @delete) {
1450             if (defined($conf->{lock}) && $conf->{lock} eq 'suspended') {
1451                 delete $conf->{lock}; # for check lock check, not written out
1452                 push @delete, 'lock'; # this is the real deal to write it out
1453             }
1454             push @delete, 'runningmachine' if $conf->{runningmachine};
1455             push @delete, 'runningcpu' if $conf->{runningcpu};
1456         }
1457
1458         PVE::QemuConfig->check_lock($conf) if !$skiplock;
1459
1460         foreach my $opt (keys %$revert) {
1461             if (defined($conf->{$opt})) {
1462                 $param->{$opt} = $conf->{$opt};
1463             } elsif (defined($conf->{pending}->{$opt})) {
1464                 push @delete, $opt;
1465             }
1466         }
1467
1468         if ($param->{memory} || defined($param->{balloon})) {
1469             my $maxmem = $param->{memory} || $conf->{pending}->{memory} || $conf->{memory} || $defaults->{memory};
1470             my $balloon = defined($param->{balloon}) ? $param->{balloon} : $conf->{pending}->{balloon} || $conf->{balloon};
1471
1472             die "balloon value too large (must be smaller than assigned memory)\n"
1473                 if $balloon && $balloon > $maxmem;
1474         }
1475
1476         PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: " . join (' ', @paramarr));
1477
1478         my $worker = sub {
1479
1480             print "update VM $vmid: " . join (' ', @paramarr) . "\n";
1481
1482             # write updates to pending section
1483
1484             my $modified = {}; # record what $option we modify
1485
1486             my @bootorder;
1487             if (my $boot = $conf->{boot}) {
1488                 my $bootcfg = PVE::JSONSchema::parse_property_string('pve-qm-boot', $boot);
1489                 @bootorder = PVE::Tools::split_list($bootcfg->{order}) if $bootcfg && $bootcfg->{order};
1490             }
1491             my $bootorder_deleted = grep {$_ eq 'bootorder'} @delete;
1492
1493             my $check_drive_perms = sub {
1494                 my ($opt, $val) = @_;
1495                 my $drive = PVE::QemuServer::parse_drive($opt, $val, 1);
1496                 # FIXME: cloudinit: CDROM or Disk?
1497                 if (PVE::QemuServer::drive_is_cdrom($drive)) { # CDROM
1498                     $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.CDROM']);
1499                 } else {
1500                     $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
1501                 }
1502             };
1503
1504             foreach my $opt (@delete) {
1505                 $modified->{$opt} = 1;
1506                 $conf = PVE::QemuConfig->load_config($vmid); # update/reload
1507
1508                 # value of what we want to delete, independent if pending or not
1509                 my $val = $conf->{$opt} // $conf->{pending}->{$opt};
1510                 if (!defined($val)) {
1511                     warn "cannot delete '$opt' - not set in current configuration!\n";
1512                     $modified->{$opt} = 0;
1513                     next;
1514                 }
1515                 my $is_pending_val = defined($conf->{pending}->{$opt});
1516                 delete $conf->{pending}->{$opt};
1517
1518                 # remove from bootorder if necessary
1519                 if (!$bootorder_deleted && @bootorder && grep {$_ eq $opt} @bootorder) {
1520                     @bootorder = grep {$_ ne $opt} @bootorder;
1521                     $conf->{pending}->{boot} = PVE::QemuServer::print_bootorder(\@bootorder);
1522                     $modified->{boot} = 1;
1523                 }
1524
1525                 if ($opt =~ m/^unused/) {
1526                     my $drive = PVE::QemuServer::parse_drive($opt, $val);
1527                     PVE::QemuConfig->check_protection($conf, "can't remove unused disk '$drive->{file}'");
1528                     $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
1529                     if (PVE::QemuServer::try_deallocate_drive($storecfg, $vmid, $conf, $opt, $drive, $rpcenv, $authuser)) {
1530                         delete $conf->{$opt};
1531                         PVE::QemuConfig->write_config($vmid, $conf);
1532                     }
1533                 } elsif ($opt eq 'vmstate') {
1534                     PVE::QemuConfig->check_protection($conf, "can't remove vmstate '$val'");
1535                     if (PVE::QemuServer::try_deallocate_drive($storecfg, $vmid, $conf, $opt, { file => $val }, $rpcenv, $authuser, 1)) {
1536                         delete $conf->{$opt};
1537                         PVE::QemuConfig->write_config($vmid, $conf);
1538                     }
1539                 } elsif (PVE::QemuServer::is_valid_drivename($opt)) {
1540                     PVE::QemuConfig->check_protection($conf, "can't remove drive '$opt'");
1541                     $check_drive_perms->($opt, $val);
1542                     PVE::QemuServer::vmconfig_register_unused_drive($storecfg, $vmid, $conf, PVE::QemuServer::parse_drive($opt, $val))
1543                         if $is_pending_val;
1544                     PVE::QemuConfig->add_to_pending_delete($conf, $opt, $force);
1545                     PVE::QemuConfig->write_config($vmid, $conf);
1546                 } elsif ($opt =~ m/^serial\d+$/) {
1547                     if ($val eq 'socket') {
1548                         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.HWType']);
1549                     } elsif ($authuser ne 'root@pam') {
1550                         die "only root can delete '$opt' config for real devices\n";
1551                     }
1552                     PVE::QemuConfig->add_to_pending_delete($conf, $opt, $force);
1553                     PVE::QemuConfig->write_config($vmid, $conf);
1554                 } elsif ($opt =~ m/^usb\d+$/) {
1555                     if ($val =~ m/spice/) {
1556                         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.HWType']);
1557                     } elsif ($authuser ne 'root@pam') {
1558                         die "only root can delete '$opt' config for real devices\n";
1559                     }
1560                     PVE::QemuConfig->add_to_pending_delete($conf, $opt, $force);
1561                     PVE::QemuConfig->write_config($vmid, $conf);
1562                 } else {
1563                     PVE::QemuConfig->add_to_pending_delete($conf, $opt, $force);
1564                     PVE::QemuConfig->write_config($vmid, $conf);
1565                 }
1566             }
1567
1568             foreach my $opt (keys %$param) { # add/change
1569                 $modified->{$opt} = 1;
1570                 $conf = PVE::QemuConfig->load_config($vmid); # update/reload
1571                 next if defined($conf->{pending}->{$opt}) && ($param->{$opt} eq $conf->{pending}->{$opt}); # skip if nothing changed
1572
1573                 my $arch = PVE::QemuServer::get_vm_arch($conf);
1574
1575                 if (PVE::QemuServer::is_valid_drivename($opt)) {
1576                     # old drive
1577                     if ($conf->{$opt}) {
1578                         $check_drive_perms->($opt, $conf->{$opt});
1579                     }
1580
1581                     # new drive
1582                     $check_drive_perms->($opt, $param->{$opt});
1583                     PVE::QemuServer::vmconfig_register_unused_drive($storecfg, $vmid, $conf, PVE::QemuServer::parse_drive($opt, $conf->{pending}->{$opt}))
1584                         if defined($conf->{pending}->{$opt});
1585
1586                     my (undef, $created_opts) = $create_disks->(
1587                         $rpcenv,
1588                         $authuser,
1589                         $conf,
1590                         $arch,
1591                         $storecfg,
1592                         $vmid,
1593                         undef,
1594                         {$opt => $param->{$opt}},
1595                     );
1596                     $conf->{pending}->{$_} = $created_opts->{$_} for keys $created_opts->%*;
1597
1598                     # default legacy boot order implies all cdroms anyway
1599                     if (@bootorder) {
1600                         # append new CD drives to bootorder to mark them bootable
1601                         my $drive = PVE::QemuServer::parse_drive($opt, $param->{$opt}, 1);
1602                         if (PVE::QemuServer::drive_is_cdrom($drive, 1) && !grep(/^$opt$/, @bootorder)) {
1603                             push @bootorder, $opt;
1604                             $conf->{pending}->{boot} = PVE::QemuServer::print_bootorder(\@bootorder);
1605                             $modified->{boot} = 1;
1606                         }
1607                     }
1608                 } elsif ($opt =~ m/^serial\d+/) {
1609                     if ((!defined($conf->{$opt}) || $conf->{$opt} eq 'socket') && $param->{$opt} eq 'socket') {
1610                         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.HWType']);
1611                     } elsif ($authuser ne 'root@pam') {
1612                         die "only root can modify '$opt' config for real devices\n";
1613                     }
1614                     $conf->{pending}->{$opt} = $param->{$opt};
1615                 } elsif ($opt =~ m/^usb\d+/) {
1616                     if ((!defined($conf->{$opt}) || $conf->{$opt} =~ m/spice/) && $param->{$opt} =~ m/spice/) {
1617                         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.HWType']);
1618                     } elsif ($authuser ne 'root@pam') {
1619                         die "only root can modify '$opt' config for real devices\n";
1620                     }
1621                     $conf->{pending}->{$opt} = $param->{$opt};
1622                 } else {
1623                     $conf->{pending}->{$opt} = $param->{$opt};
1624
1625                     if ($opt eq 'boot') {
1626                         my $new_bootcfg = PVE::JSONSchema::parse_property_string('pve-qm-boot', $param->{$opt});
1627                         if ($new_bootcfg->{order}) {
1628                             my @devs = PVE::Tools::split_list($new_bootcfg->{order});
1629                             for my $dev (@devs) {
1630                                 my $exists = $conf->{$dev} || $conf->{pending}->{$dev} || $param->{$dev};
1631                                 my $deleted = grep {$_ eq $dev} @delete;
1632                                 die "invalid bootorder: device '$dev' does not exist'\n"
1633                                     if !$exists || $deleted;
1634                             }
1635
1636                             # remove legacy boot order settings if new one set
1637                             $conf->{pending}->{$opt} = PVE::QemuServer::print_bootorder(\@devs);
1638                             PVE::QemuConfig->add_to_pending_delete($conf, "bootdisk")
1639                                 if $conf->{bootdisk};
1640                         }
1641                     }
1642                 }
1643                 PVE::QemuConfig->remove_from_pending_delete($conf, $opt);
1644                 PVE::QemuConfig->write_config($vmid, $conf);
1645             }
1646
1647             # remove pending changes when nothing changed
1648             $conf = PVE::QemuConfig->load_config($vmid); # update/reload
1649             my $changes = PVE::QemuConfig->cleanup_pending($conf);
1650             PVE::QemuConfig->write_config($vmid, $conf) if $changes;
1651
1652             return if !scalar(keys %{$conf->{pending}});
1653
1654             my $running = PVE::QemuServer::check_running($vmid);
1655
1656             # apply pending changes
1657
1658             $conf = PVE::QemuConfig->load_config($vmid); # update/reload
1659
1660             my $errors = {};
1661             if ($running) {
1662                 PVE::QemuServer::vmconfig_hotplug_pending($vmid, $conf, $storecfg, $modified, $errors);
1663             } else {
1664                 PVE::QemuServer::vmconfig_apply_pending($vmid, $conf, $storecfg, $errors);
1665             }
1666             raise_param_exc($errors) if scalar(keys %$errors);
1667
1668             return;
1669         };
1670
1671         if ($sync) {
1672             &$worker();
1673             return;
1674         } else {
1675             my $upid = $rpcenv->fork_worker('qmconfig', $vmid, $authuser, $worker);
1676
1677             if ($background_delay) {
1678
1679                 # Note: It would be better to do that in the Event based HTTPServer
1680                 # to avoid blocking call to sleep.
1681
1682                 my $end_time = time() + $background_delay;
1683
1684                 my $task = PVE::Tools::upid_decode($upid);
1685
1686                 my $running = 1;
1687                 while (time() < $end_time) {
1688                     $running = PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart});
1689                     last if !$running;
1690                     sleep(1); # this gets interrupted when child process ends
1691                 }
1692
1693                 if (!$running) {
1694                     my $status = PVE::Tools::upid_read_status($upid);
1695                     return if !PVE::Tools::upid_status_is_error($status);
1696                     die "failed to update VM $vmid: $status\n";
1697                 }
1698             }
1699
1700             return $upid;
1701         }
1702     };
1703
1704     return PVE::QemuConfig->lock_config($vmid, $updatefn);
1705 };
1706
1707 my $vm_config_perm_list = [
1708             'VM.Config.Disk',
1709             'VM.Config.CDROM',
1710             'VM.Config.CPU',
1711             'VM.Config.Memory',
1712             'VM.Config.Network',
1713             'VM.Config.HWType',
1714             'VM.Config.Options',
1715             'VM.Config.Cloudinit',
1716     ];
1717
1718 __PACKAGE__->register_method({
1719     name => 'update_vm_async',
1720     path => '{vmid}/config',
1721     method => 'POST',
1722     protected => 1,
1723     proxyto => 'node',
1724     description => "Set virtual machine options (asynchrounous API).",
1725     permissions => {
1726         check => ['perm', '/vms/{vmid}', $vm_config_perm_list, any => 1],
1727     },
1728     parameters => {
1729         additionalProperties => 0,
1730         properties => PVE::QemuServer::json_config_properties(
1731             {
1732                 node => get_standard_option('pve-node'),
1733                 vmid => get_standard_option('pve-vmid'),
1734                 skiplock => get_standard_option('skiplock'),
1735                 delete => {
1736                     type => 'string', format => 'pve-configid-list',
1737                     description => "A list of settings you want to delete.",
1738                     optional => 1,
1739                 },
1740                 revert => {
1741                     type => 'string', format => 'pve-configid-list',
1742                     description => "Revert a pending change.",
1743                     optional => 1,
1744                 },
1745                 force => {
1746                     type => 'boolean',
1747                     description => $opt_force_description,
1748                     optional => 1,
1749                     requires => 'delete',
1750                 },
1751                 digest => {
1752                     type => 'string',
1753                     description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1754                     maxLength => 40,
1755                     optional => 1,
1756                 },
1757                 background_delay => {
1758                     type => 'integer',
1759                     description => "Time to wait for the task to finish. We return 'null' if the task finish within that time.",
1760                     minimum => 1,
1761                     maximum => 30,
1762                     optional => 1,
1763                 },
1764             },
1765             1, # with_disk_alloc
1766         ),
1767     },
1768     returns => {
1769         type => 'string',
1770         optional => 1,
1771     },
1772     code => $update_vm_api,
1773 });
1774
1775 __PACKAGE__->register_method({
1776     name => 'update_vm',
1777     path => '{vmid}/config',
1778     method => 'PUT',
1779     protected => 1,
1780     proxyto => 'node',
1781     description => "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.",
1782     permissions => {
1783         check => ['perm', '/vms/{vmid}', $vm_config_perm_list, any => 1],
1784     },
1785     parameters => {
1786         additionalProperties => 0,
1787         properties => PVE::QemuServer::json_config_properties(
1788             {
1789                 node => get_standard_option('pve-node'),
1790                 vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
1791                 skiplock => get_standard_option('skiplock'),
1792                 delete => {
1793                     type => 'string', format => 'pve-configid-list',
1794                     description => "A list of settings you want to delete.",
1795                     optional => 1,
1796                 },
1797                 revert => {
1798                     type => 'string', format => 'pve-configid-list',
1799                     description => "Revert a pending change.",
1800                     optional => 1,
1801                 },
1802                 force => {
1803                     type => 'boolean',
1804                     description => $opt_force_description,
1805                     optional => 1,
1806                     requires => 'delete',
1807                 },
1808                 digest => {
1809                     type => 'string',
1810                     description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1811                     maxLength => 40,
1812                     optional => 1,
1813                 },
1814             },
1815             1, # with_disk_alloc
1816         ),
1817     },
1818     returns => { type => 'null' },
1819     code => sub {
1820         my ($param) = @_;
1821         &$update_vm_api($param, 1);
1822         return;
1823     }
1824 });
1825
1826 __PACKAGE__->register_method({
1827     name => 'destroy_vm',
1828     path => '{vmid}',
1829     method => 'DELETE',
1830     protected => 1,
1831     proxyto => 'node',
1832     description => "Destroy the VM and  all used/owned volumes. Removes any VM specific permissions"
1833         ." and firewall rules",
1834     permissions => {
1835         check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
1836     },
1837     parameters => {
1838         additionalProperties => 0,
1839         properties => {
1840             node => get_standard_option('pve-node'),
1841             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid_stopped }),
1842             skiplock => get_standard_option('skiplock'),
1843             purge => {
1844                 type => 'boolean',
1845                 description => "Remove VMID from configurations, like backup & replication jobs and HA.",
1846                 optional => 1,
1847             },
1848             'destroy-unreferenced-disks' => {
1849                 type => 'boolean',
1850                 description => "If set, destroy additionally all disks not referenced in the config"
1851                  ." but with a matching VMID from all enabled storages.",
1852                 optional => 1,
1853                 default => 0,
1854             },
1855         },
1856     },
1857     returns => {
1858         type => 'string',
1859     },
1860     code => sub {
1861         my ($param) = @_;
1862
1863         my $rpcenv = PVE::RPCEnvironment::get();
1864         my $authuser = $rpcenv->get_user();
1865         my $vmid = $param->{vmid};
1866
1867         my $skiplock = $param->{skiplock};
1868         raise_param_exc({ skiplock => "Only root may use this option." })
1869             if $skiplock && $authuser ne 'root@pam';
1870
1871         my $early_checks = sub {
1872             # test if VM exists
1873             my $conf = PVE::QemuConfig->load_config($vmid);
1874             PVE::QemuConfig->check_protection($conf, "can't remove VM $vmid");
1875
1876             my $ha_managed = PVE::HA::Config::service_is_configured("vm:$vmid");
1877
1878             if (!$param->{purge}) {
1879                 die "unable to remove VM $vmid - used in HA resources and purge parameter not set.\n"
1880                     if $ha_managed;
1881                 # don't allow destroy if with replication jobs but no purge param
1882                 my $repl_conf = PVE::ReplicationConfig->new();
1883                 $repl_conf->check_for_existing_jobs($vmid);
1884             }
1885
1886             die "VM $vmid is running - destroy failed\n"
1887                 if PVE::QemuServer::check_running($vmid);
1888
1889             return $ha_managed;
1890         };
1891
1892         $early_checks->();
1893
1894         my $realcmd = sub {
1895             my $upid = shift;
1896
1897             my $storecfg = PVE::Storage::config();
1898
1899             syslog('info', "destroy VM $vmid: $upid\n");
1900             PVE::QemuConfig->lock_config($vmid, sub {
1901                 # repeat, config might have changed
1902                 my $ha_managed = $early_checks->();
1903
1904                 my $purge_unreferenced = $param->{'destroy-unreferenced-disks'};
1905
1906                 PVE::QemuServer::destroy_vm(
1907                     $storecfg,
1908                     $vmid,
1909                     $skiplock, { lock => 'destroyed' },
1910                     $purge_unreferenced,
1911                 );
1912
1913                 PVE::AccessControl::remove_vm_access($vmid);
1914                 PVE::Firewall::remove_vmfw_conf($vmid);
1915                 if ($param->{purge}) {
1916                     print "purging VM $vmid from related configurations..\n";
1917                     PVE::ReplicationConfig::remove_vmid_jobs($vmid);
1918                     PVE::VZDump::Plugin::remove_vmid_from_backup_jobs($vmid);
1919
1920                     if ($ha_managed) {
1921                         PVE::HA::Config::delete_service_from_config("vm:$vmid");
1922                         print "NOTE: removed VM $vmid from HA resource configuration.\n";
1923                     }
1924                 }
1925
1926                 # only now remove the zombie config, else we can have reuse race
1927                 PVE::QemuConfig->destroy_config($vmid);
1928             });
1929         };
1930
1931         return $rpcenv->fork_worker('qmdestroy', $vmid, $authuser, $realcmd);
1932     }});
1933
1934 __PACKAGE__->register_method({
1935     name => 'unlink',
1936     path => '{vmid}/unlink',
1937     method => 'PUT',
1938     protected => 1,
1939     proxyto => 'node',
1940     description => "Unlink/delete disk images.",
1941     permissions => {
1942         check => [ 'perm', '/vms/{vmid}', ['VM.Config.Disk']],
1943     },
1944     parameters => {
1945         additionalProperties => 0,
1946         properties => {
1947             node => get_standard_option('pve-node'),
1948             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
1949             idlist => {
1950                 type => 'string', format => 'pve-configid-list',
1951                 description => "A list of disk IDs you want to delete.",
1952             },
1953             force => {
1954                 type => 'boolean',
1955                 description => $opt_force_description,
1956                 optional => 1,
1957             },
1958         },
1959     },
1960     returns => { type => 'null'},
1961     code => sub {
1962         my ($param) = @_;
1963
1964         $param->{delete} = extract_param($param, 'idlist');
1965
1966         __PACKAGE__->update_vm($param);
1967
1968         return;
1969     }});
1970
1971 # uses good entropy, each char is limited to 6 bit to get printable chars simply
1972 my $gen_rand_chars = sub {
1973     my ($length) = @_;
1974
1975     die "invalid length $length" if $length < 1;
1976
1977     my $min = ord('!'); # first printable ascii
1978
1979     my $rand_bytes = Crypt::OpenSSL::Random::random_bytes($length);
1980     die "failed to generate random bytes!\n"
1981       if !$rand_bytes;
1982
1983     my $str = join('', map { chr((ord($_) & 0x3F) + $min) } split('', $rand_bytes));
1984
1985     return $str;
1986 };
1987
1988 my $sslcert;
1989
1990 __PACKAGE__->register_method({
1991     name => 'vncproxy',
1992     path => '{vmid}/vncproxy',
1993     method => 'POST',
1994     protected => 1,
1995     permissions => {
1996         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1997     },
1998     description => "Creates a TCP VNC proxy connections.",
1999     parameters => {
2000         additionalProperties => 0,
2001         properties => {
2002             node => get_standard_option('pve-node'),
2003             vmid => get_standard_option('pve-vmid'),
2004             websocket => {
2005                 optional => 1,
2006                 type => 'boolean',
2007                 description => "starts websockify instead of vncproxy",
2008             },
2009             'generate-password' => {
2010                 optional => 1,
2011                 type => 'boolean',
2012                 default => 0,
2013                 description => "Generates a random password to be used as ticket instead of the API ticket.",
2014             },
2015         },
2016     },
2017     returns => {
2018         additionalProperties => 0,
2019         properties => {
2020             user => { type => 'string' },
2021             ticket => { type => 'string' },
2022             password => {
2023                 optional => 1,
2024                 description => "Returned if requested with 'generate-password' param."
2025                     ." Consists of printable ASCII characters ('!' .. '~').",
2026                 type => 'string',
2027             },
2028             cert => { type => 'string' },
2029             port => { type => 'integer' },
2030             upid => { type => 'string' },
2031         },
2032     },
2033     code => sub {
2034         my ($param) = @_;
2035
2036         my $rpcenv = PVE::RPCEnvironment::get();
2037
2038         my $authuser = $rpcenv->get_user();
2039
2040         my $vmid = $param->{vmid};
2041         my $node = $param->{node};
2042         my $websocket = $param->{websocket};
2043
2044         my $conf = PVE::QemuConfig->load_config($vmid, $node); # check if VM exists
2045
2046         my $serial;
2047         if ($conf->{vga}) {
2048             my $vga = PVE::QemuServer::parse_vga($conf->{vga});
2049             $serial = $vga->{type} if $vga->{type} =~ m/^serial\d+$/;
2050         }
2051
2052         my $authpath = "/vms/$vmid";
2053
2054         my $ticket = PVE::AccessControl::assemble_vnc_ticket($authuser, $authpath);
2055         my $password = $ticket;
2056         if ($param->{'generate-password'}) {
2057             $password = $gen_rand_chars->(8);
2058         }
2059
2060         $sslcert = PVE::Tools::file_get_contents("/etc/pve/pve-root-ca.pem", 8192)
2061             if !$sslcert;
2062
2063         my $family;
2064         my $remcmd = [];
2065
2066         if ($node ne 'localhost' && $node ne PVE::INotify::nodename()) {
2067             (undef, $family) = PVE::Cluster::remote_node_ip($node);
2068             my $sshinfo = PVE::SSHInfo::get_ssh_info($node);
2069             # NOTE: kvm VNC traffic is already TLS encrypted or is known unsecure
2070             $remcmd = PVE::SSHInfo::ssh_info_to_command($sshinfo, defined($serial) ? '-t' : '-T');
2071         } else {
2072             $family = PVE::Tools::get_host_address_family($node);
2073         }
2074
2075         my $port = PVE::Tools::next_vnc_port($family);
2076
2077         my $timeout = 10;
2078
2079         my $realcmd = sub {
2080             my $upid = shift;
2081
2082             syslog('info', "starting vnc proxy $upid\n");
2083
2084             my $cmd;
2085
2086             if (defined($serial)) {
2087
2088                 my $termcmd = [ '/usr/sbin/qm', 'terminal', $vmid, '-iface', $serial, '-escape', '0' ];
2089
2090                 $cmd = ['/usr/bin/vncterm', '-rfbport', $port,
2091                         '-timeout', $timeout, '-authpath', $authpath,
2092                         '-perm', 'Sys.Console'];
2093
2094                 if ($param->{websocket}) {
2095                     $ENV{PVE_VNC_TICKET} = $password; # pass ticket to vncterm
2096                     push @$cmd, '-notls', '-listen', 'localhost';
2097                 }
2098
2099                 push @$cmd, '-c', @$remcmd, @$termcmd;
2100
2101                 PVE::Tools::run_command($cmd);
2102
2103             } else {
2104
2105                 $ENV{LC_PVE_TICKET} = $password if $websocket; # set ticket with "qm vncproxy"
2106
2107                 $cmd = [@$remcmd, "/usr/sbin/qm", 'vncproxy', $vmid];
2108
2109                 my $sock = IO::Socket::IP->new(
2110                     ReuseAddr => 1,
2111                     Listen => 1,
2112                     LocalPort => $port,
2113                     Proto => 'tcp',
2114                     GetAddrInfoFlags => 0,
2115                 ) or die "failed to create socket: $!\n";
2116                 # Inside the worker we shouldn't have any previous alarms
2117                 # running anyway...:
2118                 alarm(0);
2119                 local $SIG{ALRM} = sub { die "connection timed out\n" };
2120                 alarm $timeout;
2121                 accept(my $cli, $sock) or die "connection failed: $!\n";
2122                 alarm(0);
2123                 close($sock);
2124                 if (PVE::Tools::run_command($cmd,
2125                     output => '>&'.fileno($cli),
2126                     input => '<&'.fileno($cli),
2127                     noerr => 1) != 0)
2128                 {
2129                     die "Failed to run vncproxy.\n";
2130                 }
2131             }
2132
2133             return;
2134         };
2135
2136         my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd, 1);
2137
2138         PVE::Tools::wait_for_vnc_port($port);
2139
2140         my $res = {
2141             user => $authuser,
2142             ticket => $ticket,
2143             port => $port,
2144             upid => $upid,
2145             cert => $sslcert,
2146         };
2147         $res->{password} = $password if $param->{'generate-password'};
2148
2149         return $res;
2150     }});
2151
2152 __PACKAGE__->register_method({
2153     name => 'termproxy',
2154     path => '{vmid}/termproxy',
2155     method => 'POST',
2156     protected => 1,
2157     permissions => {
2158         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
2159     },
2160     description => "Creates a TCP proxy connections.",
2161     parameters => {
2162         additionalProperties => 0,
2163         properties => {
2164             node => get_standard_option('pve-node'),
2165             vmid => get_standard_option('pve-vmid'),
2166             serial=> {
2167                 optional => 1,
2168                 type => 'string',
2169                 enum => [qw(serial0 serial1 serial2 serial3)],
2170                 description => "opens a serial terminal (defaults to display)",
2171             },
2172         },
2173     },
2174     returns => {
2175         additionalProperties => 0,
2176         properties => {
2177             user => { type => 'string' },
2178             ticket => { type => 'string' },
2179             port => { type => 'integer' },
2180             upid => { type => 'string' },
2181         },
2182     },
2183     code => sub {
2184         my ($param) = @_;
2185
2186         my $rpcenv = PVE::RPCEnvironment::get();
2187
2188         my $authuser = $rpcenv->get_user();
2189
2190         my $vmid = $param->{vmid};
2191         my $node = $param->{node};
2192         my $serial = $param->{serial};
2193
2194         my $conf = PVE::QemuConfig->load_config($vmid, $node); # check if VM exists
2195
2196         if (!defined($serial)) {
2197             if ($conf->{vga}) {
2198                 my $vga = PVE::QemuServer::parse_vga($conf->{vga});
2199                 $serial = $vga->{type} if $vga->{type} =~ m/^serial\d+$/;
2200             }
2201         }
2202
2203         my $authpath = "/vms/$vmid";
2204
2205         my $ticket = PVE::AccessControl::assemble_vnc_ticket($authuser, $authpath);
2206
2207         my $family;
2208         my $remcmd = [];
2209
2210         if ($node ne 'localhost' && $node ne PVE::INotify::nodename()) {
2211             (undef, $family) = PVE::Cluster::remote_node_ip($node);
2212             my $sshinfo = PVE::SSHInfo::get_ssh_info($node);
2213             $remcmd = PVE::SSHInfo::ssh_info_to_command($sshinfo, '-t');
2214             push @$remcmd, '--';
2215         } else {
2216             $family = PVE::Tools::get_host_address_family($node);
2217         }
2218
2219         my $port = PVE::Tools::next_vnc_port($family);
2220
2221         my $termcmd = [ '/usr/sbin/qm', 'terminal', $vmid, '-escape', '0'];
2222         push @$termcmd, '-iface', $serial if $serial;
2223
2224         my $realcmd = sub {
2225             my $upid = shift;
2226
2227             syslog('info', "starting qemu termproxy $upid\n");
2228
2229             my $cmd = ['/usr/bin/termproxy', $port, '--path', $authpath,
2230                        '--perm', 'VM.Console', '--'];
2231             push @$cmd, @$remcmd, @$termcmd;
2232
2233             PVE::Tools::run_command($cmd);
2234         };
2235
2236         my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd, 1);
2237
2238         PVE::Tools::wait_for_vnc_port($port);
2239
2240         return {
2241             user => $authuser,
2242             ticket => $ticket,
2243             port => $port,
2244             upid => $upid,
2245         };
2246     }});
2247
2248 __PACKAGE__->register_method({
2249     name => 'vncwebsocket',
2250     path => '{vmid}/vncwebsocket',
2251     method => 'GET',
2252     permissions => {
2253         description => "You also need to pass a valid ticket (vncticket).",
2254         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
2255     },
2256     description => "Opens a weksocket for VNC traffic.",
2257     parameters => {
2258         additionalProperties => 0,
2259         properties => {
2260             node => get_standard_option('pve-node'),
2261             vmid => get_standard_option('pve-vmid'),
2262             vncticket => {
2263                 description => "Ticket from previous call to vncproxy.",
2264                 type => 'string',
2265                 maxLength => 512,
2266             },
2267             port => {
2268                 description => "Port number returned by previous vncproxy call.",
2269                 type => 'integer',
2270                 minimum => 5900,
2271                 maximum => 5999,
2272             },
2273         },
2274     },
2275     returns => {
2276         type => "object",
2277         properties => {
2278             port => { type => 'string' },
2279         },
2280     },
2281     code => sub {
2282         my ($param) = @_;
2283
2284         my $rpcenv = PVE::RPCEnvironment::get();
2285
2286         my $authuser = $rpcenv->get_user();
2287
2288         my $vmid = $param->{vmid};
2289         my $node = $param->{node};
2290
2291         my $authpath = "/vms/$vmid";
2292
2293         PVE::AccessControl::verify_vnc_ticket($param->{vncticket}, $authuser, $authpath);
2294
2295         my $conf = PVE::QemuConfig->load_config($vmid, $node); # VM exists ?
2296
2297         # Note: VNC ports are acessible from outside, so we do not gain any
2298         # security if we verify that $param->{port} belongs to VM $vmid. This
2299         # check is done by verifying the VNC ticket (inside VNC protocol).
2300
2301         my $port = $param->{port};
2302
2303         return { port => $port };
2304     }});
2305
2306 __PACKAGE__->register_method({
2307     name => 'spiceproxy',
2308     path => '{vmid}/spiceproxy',
2309     method => 'POST',
2310     protected => 1,
2311     proxyto => 'node',
2312     permissions => {
2313         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
2314     },
2315     description => "Returns a SPICE configuration to connect to the VM.",
2316     parameters => {
2317         additionalProperties => 0,
2318         properties => {
2319             node => get_standard_option('pve-node'),
2320             vmid => get_standard_option('pve-vmid'),
2321             proxy => get_standard_option('spice-proxy', { optional => 1 }),
2322         },
2323     },
2324     returns => get_standard_option('remote-viewer-config'),
2325     code => sub {
2326         my ($param) = @_;
2327
2328         my $rpcenv = PVE::RPCEnvironment::get();
2329
2330         my $authuser = $rpcenv->get_user();
2331
2332         my $vmid = $param->{vmid};
2333         my $node = $param->{node};
2334         my $proxy = $param->{proxy};
2335
2336         my $conf = PVE::QemuConfig->load_config($vmid, $node);
2337         my $title = "VM $vmid";
2338         $title .= " - ". $conf->{name} if $conf->{name};
2339
2340         my $port = PVE::QemuServer::spice_port($vmid);
2341
2342         my ($ticket, undef, $remote_viewer_config) =
2343             PVE::AccessControl::remote_viewer_config($authuser, $vmid, $node, $proxy, $title, $port);
2344
2345         mon_cmd($vmid, "set_password", protocol => 'spice', password => $ticket);
2346         mon_cmd($vmid, "expire_password", protocol => 'spice', time => "+30");
2347
2348         return $remote_viewer_config;
2349     }});
2350
2351 __PACKAGE__->register_method({
2352     name => 'vmcmdidx',
2353     path => '{vmid}/status',
2354     method => 'GET',
2355     proxyto => 'node',
2356     description => "Directory index",
2357     permissions => {
2358         user => 'all',
2359     },
2360     parameters => {
2361         additionalProperties => 0,
2362         properties => {
2363             node => get_standard_option('pve-node'),
2364             vmid => get_standard_option('pve-vmid'),
2365         },
2366     },
2367     returns => {
2368         type => 'array',
2369         items => {
2370             type => "object",
2371             properties => {
2372                 subdir => { type => 'string' },
2373             },
2374         },
2375         links => [ { rel => 'child', href => "{subdir}" } ],
2376     },
2377     code => sub {
2378         my ($param) = @_;
2379
2380         # test if VM exists
2381         my $conf = PVE::QemuConfig->load_config($param->{vmid});
2382
2383         my $res = [
2384             { subdir => 'current' },
2385             { subdir => 'start' },
2386             { subdir => 'stop' },
2387             { subdir => 'reset' },
2388             { subdir => 'shutdown' },
2389             { subdir => 'suspend' },
2390             { subdir => 'reboot' },
2391             ];
2392
2393         return $res;
2394     }});
2395
2396 __PACKAGE__->register_method({
2397     name => 'vm_status',
2398     path => '{vmid}/status/current',
2399     method => 'GET',
2400     proxyto => 'node',
2401     protected => 1, # qemu pid files are only readable by root
2402     description => "Get virtual machine status.",
2403     permissions => {
2404         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
2405     },
2406     parameters => {
2407         additionalProperties => 0,
2408         properties => {
2409             node => get_standard_option('pve-node'),
2410             vmid => get_standard_option('pve-vmid'),
2411         },
2412     },
2413     returns => {
2414         type => 'object',
2415         properties => {
2416             %$PVE::QemuServer::vmstatus_return_properties,
2417             ha => {
2418                 description => "HA manager service status.",
2419                 type => 'object',
2420             },
2421             spice => {
2422                 description => "Qemu VGA configuration supports spice.",
2423                 type => 'boolean',
2424                 optional => 1,
2425             },
2426             agent => {
2427                 description => "Qemu GuestAgent enabled in config.",
2428                 type => 'boolean',
2429                 optional => 1,
2430             },
2431         },
2432     },
2433     code => sub {
2434         my ($param) = @_;
2435
2436         # test if VM exists
2437         my $conf = PVE::QemuConfig->load_config($param->{vmid});
2438
2439         my $vmstatus = PVE::QemuServer::vmstatus($param->{vmid}, 1);
2440         my $status = $vmstatus->{$param->{vmid}};
2441
2442         $status->{ha} = PVE::HA::Config::get_service_status("vm:$param->{vmid}");
2443
2444         if ($conf->{vga}) {
2445             my $vga = PVE::QemuServer::parse_vga($conf->{vga});
2446             my $spice = defined($vga->{type}) && $vga->{type} =~ /^virtio/;
2447             $spice ||= PVE::QemuServer::vga_conf_has_spice($conf->{vga});
2448             $status->{spice} = 1 if $spice;
2449         }
2450         $status->{agent} = 1 if PVE::QemuServer::get_qga_key($conf, 'enabled');
2451
2452         return $status;
2453     }});
2454
2455 __PACKAGE__->register_method({
2456     name => 'vm_start',
2457     path => '{vmid}/status/start',
2458     method => 'POST',
2459     protected => 1,
2460     proxyto => 'node',
2461     description => "Start virtual machine.",
2462     permissions => {
2463         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2464     },
2465     parameters => {
2466         additionalProperties => 0,
2467         properties => {
2468             node => get_standard_option('pve-node'),
2469             vmid => get_standard_option('pve-vmid',
2470                                         { completion => \&PVE::QemuServer::complete_vmid_stopped }),
2471             skiplock => get_standard_option('skiplock'),
2472             stateuri => get_standard_option('pve-qm-stateuri'),
2473             migratedfrom => get_standard_option('pve-node',{ optional => 1 }),
2474             migration_type => {
2475                 type => 'string',
2476                 enum => ['secure', 'insecure'],
2477                 description => "Migration traffic is encrypted using an SSH " .
2478                   "tunnel by default. On secure, completely private networks " .
2479                   "this can be disabled to increase performance.",
2480                 optional => 1,
2481             },
2482             migration_network => {
2483                 type => 'string', format => 'CIDR',
2484                 description => "CIDR of the (sub) network that is used for migration.",
2485                 optional => 1,
2486             },
2487             machine => get_standard_option('pve-qemu-machine'),
2488             'force-cpu' => {
2489                 description => "Override QEMU's -cpu argument with the given string.",
2490                 type => 'string',
2491                 optional => 1,
2492             },
2493             targetstorage => get_standard_option('pve-targetstorage'),
2494             timeout => {
2495                 description => "Wait maximal timeout seconds.",
2496                 type => 'integer',
2497                 minimum => 0,
2498                 default => 'max(30, vm memory in GiB)',
2499                 optional => 1,
2500             },
2501         },
2502     },
2503     returns => {
2504         type => 'string',
2505     },
2506     code => sub {
2507         my ($param) = @_;
2508
2509         my $rpcenv = PVE::RPCEnvironment::get();
2510         my $authuser = $rpcenv->get_user();
2511
2512         my $node = extract_param($param, 'node');
2513         my $vmid = extract_param($param, 'vmid');
2514         my $timeout = extract_param($param, 'timeout');
2515         my $machine = extract_param($param, 'machine');
2516
2517         my $get_root_param = sub {
2518             my $value = extract_param($param, $_[0]);
2519             raise_param_exc({ "$_[0]" => "Only root may use this option." })
2520                 if $value && $authuser ne 'root@pam';
2521             return $value;
2522         };
2523
2524         my $stateuri = $get_root_param->('stateuri');
2525         my $skiplock = $get_root_param->('skiplock');
2526         my $migratedfrom = $get_root_param->('migratedfrom');
2527         my $migration_type = $get_root_param->('migration_type');
2528         my $migration_network = $get_root_param->('migration_network');
2529         my $targetstorage = $get_root_param->('targetstorage');
2530         my $force_cpu = $get_root_param->('force-cpu');
2531
2532         my $storagemap;
2533
2534         if ($targetstorage) {
2535             raise_param_exc({ targetstorage => "targetstorage can only by used with migratedfrom." })
2536                 if !$migratedfrom;
2537             $storagemap = eval { PVE::JSONSchema::parse_idmap($targetstorage, 'pve-storage-id') };
2538             raise_param_exc({ targetstorage => "failed to parse storage map: $@" })
2539                 if $@;
2540         }
2541
2542         # read spice ticket from STDIN
2543         my $spice_ticket;
2544         my $nbd_protocol_version = 0;
2545         my $replicated_volumes = {};
2546         my $offline_volumes = {};
2547         if ($stateuri && ($stateuri eq 'tcp' || $stateuri eq 'unix') && $migratedfrom && ($rpcenv->{type} eq 'cli')) {
2548             while (defined(my $line = <STDIN>)) {
2549                 chomp $line;
2550                 if ($line =~ m/^spice_ticket: (.+)$/) {
2551                     $spice_ticket = $1;
2552                 } elsif ($line =~ m/^nbd_protocol_version: (\d+)$/) {
2553                     $nbd_protocol_version = $1;
2554                 } elsif ($line =~ m/^replicated_volume: (.*)$/) {
2555                     $replicated_volumes->{$1} = 1;
2556                 } elsif ($line =~ m/^tpmstate0: (.*)$/) { # Deprecated, use offline_volume instead
2557                     $offline_volumes->{tpmstate0} = $1;
2558                 } elsif ($line =~ m/^offline_volume: ([^:]+): (.*)$/) {
2559                     $offline_volumes->{$1} = $2;
2560                 } elsif (!$spice_ticket) {
2561                     # fallback for old source node
2562                     $spice_ticket = $line;
2563                 } else {
2564                     warn "unknown 'start' parameter on STDIN: '$line'\n";
2565                 }
2566             }
2567         }
2568
2569         PVE::Cluster::check_cfs_quorum();
2570
2571         my $storecfg = PVE::Storage::config();
2572
2573         if (PVE::HA::Config::vm_is_ha_managed($vmid) && !$stateuri &&  $rpcenv->{type} ne 'ha') {
2574             my $hacmd = sub {
2575                 my $upid = shift;
2576
2577                 print "Requesting HA start for VM $vmid\n";
2578
2579                 my $cmd = ['ha-manager', 'set',  "vm:$vmid", '--state', 'started'];
2580                 PVE::Tools::run_command($cmd);
2581                 return;
2582             };
2583
2584             return $rpcenv->fork_worker('hastart', $vmid, $authuser, $hacmd);
2585
2586         } else {
2587
2588             my $realcmd = sub {
2589                 my $upid = shift;
2590
2591                 syslog('info', "start VM $vmid: $upid\n");
2592
2593                 my $migrate_opts = {
2594                     migratedfrom => $migratedfrom,
2595                     spice_ticket => $spice_ticket,
2596                     network => $migration_network,
2597                     type => $migration_type,
2598                     storagemap => $storagemap,
2599                     nbd_proto_version => $nbd_protocol_version,
2600                     replicated_volumes => $replicated_volumes,
2601                     offline_volumes => $offline_volumes,
2602                 };
2603
2604                 my $params = {
2605                     statefile => $stateuri,
2606                     skiplock => $skiplock,
2607                     forcemachine => $machine,
2608                     timeout => $timeout,
2609                     forcecpu => $force_cpu,
2610                 };
2611
2612                 PVE::QemuServer::vm_start($storecfg, $vmid, $params, $migrate_opts);
2613                 return;
2614             };
2615
2616             return $rpcenv->fork_worker('qmstart', $vmid, $authuser, $realcmd);
2617         }
2618     }});
2619
2620 __PACKAGE__->register_method({
2621     name => 'vm_stop',
2622     path => '{vmid}/status/stop',
2623     method => 'POST',
2624     protected => 1,
2625     proxyto => 'node',
2626     description => "Stop virtual machine. The qemu process will exit immediately. This" .
2627         "is akin to pulling the power plug of a running computer and may damage the VM data",
2628     permissions => {
2629         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2630     },
2631     parameters => {
2632         additionalProperties => 0,
2633         properties => {
2634             node => get_standard_option('pve-node'),
2635             vmid => get_standard_option('pve-vmid',
2636                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2637             skiplock => get_standard_option('skiplock'),
2638             migratedfrom => get_standard_option('pve-node', { optional => 1 }),
2639             timeout => {
2640                 description => "Wait maximal timeout seconds.",
2641                 type => 'integer',
2642                 minimum => 0,
2643                 optional => 1,
2644             },
2645             keepActive => {
2646                 description => "Do not deactivate storage volumes.",
2647                 type => 'boolean',
2648                 optional => 1,
2649                 default => 0,
2650             }
2651         },
2652     },
2653     returns => {
2654         type => 'string',
2655     },
2656     code => sub {
2657         my ($param) = @_;
2658
2659         my $rpcenv = PVE::RPCEnvironment::get();
2660         my $authuser = $rpcenv->get_user();
2661
2662         my $node = extract_param($param, 'node');
2663         my $vmid = extract_param($param, 'vmid');
2664
2665         my $skiplock = extract_param($param, 'skiplock');
2666         raise_param_exc({ skiplock => "Only root may use this option." })
2667             if $skiplock && $authuser ne 'root@pam';
2668
2669         my $keepActive = extract_param($param, 'keepActive');
2670         raise_param_exc({ keepActive => "Only root may use this option." })
2671             if $keepActive && $authuser ne 'root@pam';
2672
2673         my $migratedfrom = extract_param($param, 'migratedfrom');
2674         raise_param_exc({ migratedfrom => "Only root may use this option." })
2675             if $migratedfrom && $authuser ne 'root@pam';
2676
2677
2678         my $storecfg = PVE::Storage::config();
2679
2680         if (PVE::HA::Config::vm_is_ha_managed($vmid) && ($rpcenv->{type} ne 'ha') && !defined($migratedfrom)) {
2681
2682             my $hacmd = sub {
2683                 my $upid = shift;
2684
2685                 print "Requesting HA stop for VM $vmid\n";
2686
2687                 my $cmd = ['ha-manager', 'crm-command', 'stop',  "vm:$vmid", '0'];
2688                 PVE::Tools::run_command($cmd);
2689                 return;
2690             };
2691
2692             return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
2693
2694         } else {
2695             my $realcmd = sub {
2696                 my $upid = shift;
2697
2698                 syslog('info', "stop VM $vmid: $upid\n");
2699
2700                 PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
2701                                          $param->{timeout}, 0, 1, $keepActive, $migratedfrom);
2702                 return;
2703             };
2704
2705             return $rpcenv->fork_worker('qmstop', $vmid, $authuser, $realcmd);
2706         }
2707     }});
2708
2709 __PACKAGE__->register_method({
2710     name => 'vm_reset',
2711     path => '{vmid}/status/reset',
2712     method => 'POST',
2713     protected => 1,
2714     proxyto => 'node',
2715     description => "Reset virtual machine.",
2716     permissions => {
2717         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2718     },
2719     parameters => {
2720         additionalProperties => 0,
2721         properties => {
2722             node => get_standard_option('pve-node'),
2723             vmid => get_standard_option('pve-vmid',
2724                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2725             skiplock => get_standard_option('skiplock'),
2726         },
2727     },
2728     returns => {
2729         type => 'string',
2730     },
2731     code => sub {
2732         my ($param) = @_;
2733
2734         my $rpcenv = PVE::RPCEnvironment::get();
2735
2736         my $authuser = $rpcenv->get_user();
2737
2738         my $node = extract_param($param, 'node');
2739
2740         my $vmid = extract_param($param, 'vmid');
2741
2742         my $skiplock = extract_param($param, 'skiplock');
2743         raise_param_exc({ skiplock => "Only root may use this option." })
2744             if $skiplock && $authuser ne 'root@pam';
2745
2746         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
2747
2748         my $realcmd = sub {
2749             my $upid = shift;
2750
2751             PVE::QemuServer::vm_reset($vmid, $skiplock);
2752
2753             return;
2754         };
2755
2756         return $rpcenv->fork_worker('qmreset', $vmid, $authuser, $realcmd);
2757     }});
2758
2759 __PACKAGE__->register_method({
2760     name => 'vm_shutdown',
2761     path => '{vmid}/status/shutdown',
2762     method => 'POST',
2763     protected => 1,
2764     proxyto => 'node',
2765     description => "Shutdown virtual machine. This is similar to pressing the power button on a physical machine." .
2766         "This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.",
2767     permissions => {
2768         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2769     },
2770     parameters => {
2771         additionalProperties => 0,
2772         properties => {
2773             node => get_standard_option('pve-node'),
2774             vmid => get_standard_option('pve-vmid',
2775                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2776             skiplock => get_standard_option('skiplock'),
2777             timeout => {
2778                 description => "Wait maximal timeout seconds.",
2779                 type => 'integer',
2780                 minimum => 0,
2781                 optional => 1,
2782             },
2783             forceStop => {
2784                 description => "Make sure the VM stops.",
2785                 type => 'boolean',
2786                 optional => 1,
2787                 default => 0,
2788             },
2789             keepActive => {
2790                 description => "Do not deactivate storage volumes.",
2791                 type => 'boolean',
2792                 optional => 1,
2793                 default => 0,
2794             }
2795         },
2796     },
2797     returns => {
2798         type => 'string',
2799     },
2800     code => sub {
2801         my ($param) = @_;
2802
2803         my $rpcenv = PVE::RPCEnvironment::get();
2804         my $authuser = $rpcenv->get_user();
2805
2806         my $node = extract_param($param, 'node');
2807         my $vmid = extract_param($param, 'vmid');
2808
2809         my $skiplock = extract_param($param, 'skiplock');
2810         raise_param_exc({ skiplock => "Only root may use this option." })
2811             if $skiplock && $authuser ne 'root@pam';
2812
2813         my $keepActive = extract_param($param, 'keepActive');
2814         raise_param_exc({ keepActive => "Only root may use this option." })
2815             if $keepActive && $authuser ne 'root@pam';
2816
2817         my $storecfg = PVE::Storage::config();
2818
2819         my $shutdown = 1;
2820
2821         # if vm is paused, do not shutdown (but stop if forceStop = 1)
2822         # otherwise, we will infer a shutdown command, but run into the timeout,
2823         # then when the vm is resumed, it will instantly shutdown
2824         #
2825         # checking the qmp status here to get feedback to the gui/cli/api
2826         # and the status query should not take too long
2827         if (PVE::QemuServer::vm_is_paused($vmid)) {
2828             if ($param->{forceStop}) {
2829                 warn "VM is paused - stop instead of shutdown\n";
2830                 $shutdown = 0;
2831             } else {
2832                 die "VM is paused - cannot shutdown\n";
2833             }
2834         }
2835
2836         if (PVE::HA::Config::vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
2837
2838             my $timeout = $param->{timeout} // 60;
2839             my $hacmd = sub {
2840                 my $upid = shift;
2841
2842                 print "Requesting HA stop for VM $vmid\n";
2843
2844                 my $cmd = ['ha-manager', 'crm-command', 'stop', "vm:$vmid", "$timeout"];
2845                 PVE::Tools::run_command($cmd);
2846                 return;
2847             };
2848
2849             return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
2850
2851         } else {
2852
2853             my $realcmd = sub {
2854                 my $upid = shift;
2855
2856                 syslog('info', "shutdown VM $vmid: $upid\n");
2857
2858                 PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0, $param->{timeout},
2859                                          $shutdown, $param->{forceStop}, $keepActive);
2860                 return;
2861             };
2862
2863             return $rpcenv->fork_worker('qmshutdown', $vmid, $authuser, $realcmd);
2864         }
2865     }});
2866
2867 __PACKAGE__->register_method({
2868     name => 'vm_reboot',
2869     path => '{vmid}/status/reboot',
2870     method => 'POST',
2871     protected => 1,
2872     proxyto => 'node',
2873     description => "Reboot the VM by shutting it down, and starting it again. Applies pending changes.",
2874     permissions => {
2875         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2876     },
2877     parameters => {
2878         additionalProperties => 0,
2879         properties => {
2880             node => get_standard_option('pve-node'),
2881             vmid => get_standard_option('pve-vmid',
2882                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2883             timeout => {
2884                 description => "Wait maximal timeout seconds for the shutdown.",
2885                 type => 'integer',
2886                 minimum => 0,
2887                 optional => 1,
2888             },
2889         },
2890     },
2891     returns => {
2892         type => 'string',
2893     },
2894     code => sub {
2895         my ($param) = @_;
2896
2897         my $rpcenv = PVE::RPCEnvironment::get();
2898         my $authuser = $rpcenv->get_user();
2899
2900         my $node = extract_param($param, 'node');
2901         my $vmid = extract_param($param, 'vmid');
2902
2903         die "VM is paused - cannot shutdown\n" if PVE::QemuServer::vm_is_paused($vmid);
2904
2905         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
2906
2907         my $realcmd = sub {
2908             my $upid = shift;
2909
2910             syslog('info', "requesting reboot of VM $vmid: $upid\n");
2911             PVE::QemuServer::vm_reboot($vmid, $param->{timeout});
2912             return;
2913         };
2914
2915         return $rpcenv->fork_worker('qmreboot', $vmid, $authuser, $realcmd);
2916     }});
2917
2918 __PACKAGE__->register_method({
2919     name => 'vm_suspend',
2920     path => '{vmid}/status/suspend',
2921     method => 'POST',
2922     protected => 1,
2923     proxyto => 'node',
2924     description => "Suspend virtual machine.",
2925     permissions => {
2926         description => "You need 'VM.PowerMgmt' on /vms/{vmid}, and if you have set 'todisk',".
2927             " you need also 'VM.Config.Disk' on /vms/{vmid} and 'Datastore.AllocateSpace'".
2928             " on the storage for the vmstate.",
2929         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2930     },
2931     parameters => {
2932         additionalProperties => 0,
2933         properties => {
2934             node => get_standard_option('pve-node'),
2935             vmid => get_standard_option('pve-vmid',
2936                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2937             skiplock => get_standard_option('skiplock'),
2938             todisk => {
2939                 type => 'boolean',
2940                 default => 0,
2941                 optional => 1,
2942                 description => 'If set, suspends the VM to disk. Will be resumed on next VM start.',
2943             },
2944             statestorage => get_standard_option('pve-storage-id', {
2945                 description => "The storage for the VM state",
2946                 requires => 'todisk',
2947                 optional => 1,
2948                 completion => \&PVE::Storage::complete_storage_enabled,
2949             }),
2950         },
2951     },
2952     returns => {
2953         type => 'string',
2954     },
2955     code => sub {
2956         my ($param) = @_;
2957
2958         my $rpcenv = PVE::RPCEnvironment::get();
2959         my $authuser = $rpcenv->get_user();
2960
2961         my $node = extract_param($param, 'node');
2962         my $vmid = extract_param($param, 'vmid');
2963
2964         my $todisk = extract_param($param, 'todisk') // 0;
2965
2966         my $statestorage = extract_param($param, 'statestorage');
2967
2968         my $skiplock = extract_param($param, 'skiplock');
2969         raise_param_exc({ skiplock => "Only root may use this option." })
2970             if $skiplock && $authuser ne 'root@pam';
2971
2972         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
2973
2974         die "Cannot suspend HA managed VM to disk\n"
2975             if $todisk && PVE::HA::Config::vm_is_ha_managed($vmid);
2976
2977         # early check for storage permission, for better user feedback
2978         if ($todisk) {
2979             $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
2980
2981             if (!$statestorage) {
2982                 # get statestorage from config if none is given
2983                 my $conf = PVE::QemuConfig->load_config($vmid);
2984                 my $storecfg = PVE::Storage::config();
2985                 $statestorage = PVE::QemuServer::find_vmstate_storage($conf, $storecfg);
2986             }
2987
2988             $rpcenv->check($authuser, "/storage/$statestorage", ['Datastore.AllocateSpace']);
2989         }
2990
2991         my $realcmd = sub {
2992             my $upid = shift;
2993
2994             syslog('info', "suspend VM $vmid: $upid\n");
2995
2996             PVE::QemuServer::vm_suspend($vmid, $skiplock, $todisk, $statestorage);
2997
2998             return;
2999         };
3000
3001         my $taskname = $todisk ? 'qmsuspend' : 'qmpause';
3002         return $rpcenv->fork_worker($taskname, $vmid, $authuser, $realcmd);
3003     }});
3004
3005 __PACKAGE__->register_method({
3006     name => 'vm_resume',
3007     path => '{vmid}/status/resume',
3008     method => 'POST',
3009     protected => 1,
3010     proxyto => 'node',
3011     description => "Resume virtual machine.",
3012     permissions => {
3013         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
3014     },
3015     parameters => {
3016         additionalProperties => 0,
3017         properties => {
3018             node => get_standard_option('pve-node'),
3019             vmid => get_standard_option('pve-vmid',
3020                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
3021             skiplock => get_standard_option('skiplock'),
3022             nocheck => { type => 'boolean', optional => 1 },
3023
3024         },
3025     },
3026     returns => {
3027         type => 'string',
3028     },
3029     code => sub {
3030         my ($param) = @_;
3031
3032         my $rpcenv = PVE::RPCEnvironment::get();
3033
3034         my $authuser = $rpcenv->get_user();
3035
3036         my $node = extract_param($param, 'node');
3037
3038         my $vmid = extract_param($param, 'vmid');
3039
3040         my $skiplock = extract_param($param, 'skiplock');
3041         raise_param_exc({ skiplock => "Only root may use this option." })
3042             if $skiplock && $authuser ne 'root@pam';
3043
3044         my $nocheck = extract_param($param, 'nocheck');
3045         raise_param_exc({ nocheck => "Only root may use this option." })
3046             if $nocheck && $authuser ne 'root@pam';
3047
3048         my $to_disk_suspended;
3049         eval {
3050             PVE::QemuConfig->lock_config($vmid, sub {
3051                 my $conf = PVE::QemuConfig->load_config($vmid);
3052                 $to_disk_suspended = PVE::QemuConfig->has_lock($conf, 'suspended');
3053             });
3054         };
3055
3056         die "VM $vmid not running\n"
3057             if !$to_disk_suspended && !PVE::QemuServer::check_running($vmid, $nocheck);
3058
3059         my $realcmd = sub {
3060             my $upid = shift;
3061
3062             syslog('info', "resume VM $vmid: $upid\n");
3063
3064             if (!$to_disk_suspended) {
3065                 PVE::QemuServer::vm_resume($vmid, $skiplock, $nocheck);
3066             } else {
3067                 my $storecfg = PVE::Storage::config();
3068                 PVE::QemuServer::vm_start($storecfg, $vmid, { skiplock => $skiplock });
3069             }
3070
3071             return;
3072         };
3073
3074         return $rpcenv->fork_worker('qmresume', $vmid, $authuser, $realcmd);
3075     }});
3076
3077 __PACKAGE__->register_method({
3078     name => 'vm_sendkey',
3079     path => '{vmid}/sendkey',
3080     method => 'PUT',
3081     protected => 1,
3082     proxyto => 'node',
3083     description => "Send key event to virtual machine.",
3084     permissions => {
3085         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
3086     },
3087     parameters => {
3088         additionalProperties => 0,
3089         properties => {
3090             node => get_standard_option('pve-node'),
3091             vmid => get_standard_option('pve-vmid',
3092                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
3093             skiplock => get_standard_option('skiplock'),
3094             key => {
3095                 description => "The key (qemu monitor encoding).",
3096                 type => 'string'
3097             }
3098         },
3099     },
3100     returns => { type => 'null'},
3101     code => sub {
3102         my ($param) = @_;
3103
3104         my $rpcenv = PVE::RPCEnvironment::get();
3105
3106         my $authuser = $rpcenv->get_user();
3107
3108         my $node = extract_param($param, 'node');
3109
3110         my $vmid = extract_param($param, 'vmid');
3111
3112         my $skiplock = extract_param($param, 'skiplock');
3113         raise_param_exc({ skiplock => "Only root may use this option." })
3114             if $skiplock && $authuser ne 'root@pam';
3115
3116         PVE::QemuServer::vm_sendkey($vmid, $skiplock, $param->{key});
3117
3118         return;
3119     }});
3120
3121 __PACKAGE__->register_method({
3122     name => 'vm_feature',
3123     path => '{vmid}/feature',
3124     method => 'GET',
3125     proxyto => 'node',
3126     protected => 1,
3127     description => "Check if feature for virtual machine is available.",
3128     permissions => {
3129         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
3130     },
3131     parameters => {
3132         additionalProperties => 0,
3133         properties => {
3134             node => get_standard_option('pve-node'),
3135             vmid => get_standard_option('pve-vmid'),
3136             feature => {
3137                 description => "Feature to check.",
3138                 type => 'string',
3139                 enum => [ 'snapshot', 'clone', 'copy' ],
3140             },
3141             snapname => get_standard_option('pve-snapshot-name', {
3142                 optional => 1,
3143             }),
3144         },
3145     },
3146     returns => {
3147         type => "object",
3148         properties => {
3149             hasFeature => { type => 'boolean' },
3150             nodes => {
3151                 type => 'array',
3152                 items => { type => 'string' },
3153             }
3154         },
3155     },
3156     code => sub {
3157         my ($param) = @_;
3158
3159         my $node = extract_param($param, 'node');
3160
3161         my $vmid = extract_param($param, 'vmid');
3162
3163         my $snapname = extract_param($param, 'snapname');
3164
3165         my $feature = extract_param($param, 'feature');
3166
3167         my $running = PVE::QemuServer::check_running($vmid);
3168
3169         my $conf = PVE::QemuConfig->load_config($vmid);
3170
3171         if($snapname){
3172             my $snap = $conf->{snapshots}->{$snapname};
3173             die "snapshot '$snapname' does not exist\n" if !defined($snap);
3174             $conf = $snap;
3175         }
3176         my $storecfg = PVE::Storage::config();
3177
3178         my $nodelist = PVE::QemuServer::shared_nodes($conf, $storecfg);
3179         my $hasFeature = PVE::QemuConfig->has_feature($feature, $conf, $storecfg, $snapname, $running);
3180
3181         return {
3182             hasFeature => $hasFeature,
3183             nodes => [ keys %$nodelist ],
3184         };
3185     }});
3186
3187 __PACKAGE__->register_method({
3188     name => 'clone_vm',
3189     path => '{vmid}/clone',
3190     method => 'POST',
3191     protected => 1,
3192     proxyto => 'node',
3193     description => "Create a copy of virtual machine/template.",
3194     permissions => {
3195         description => "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions " .
3196             "on /vms/{newid} (or on the VM pool /pool/{pool}). You also need " .
3197             "'Datastore.AllocateSpace' on any used storage.",
3198         check =>
3199         [ 'and',
3200           ['perm', '/vms/{vmid}', [ 'VM.Clone' ]],
3201           [ 'or',
3202             [ 'perm', '/vms/{newid}', ['VM.Allocate']],
3203             [ 'perm', '/pool/{pool}', ['VM.Allocate'], require_param => 'pool'],
3204           ],
3205         ]
3206     },
3207     parameters => {
3208         additionalProperties => 0,
3209         properties => {
3210             node => get_standard_option('pve-node'),
3211             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3212             newid => get_standard_option('pve-vmid', {
3213                 completion => \&PVE::Cluster::complete_next_vmid,
3214                 description => 'VMID for the clone.' }),
3215             name => {
3216                 optional => 1,
3217                 type => 'string', format => 'dns-name',
3218                 description => "Set a name for the new VM.",
3219             },
3220             description => {
3221                 optional => 1,
3222                 type => 'string',
3223                 description => "Description for the new VM.",
3224             },
3225             pool => {
3226                 optional => 1,
3227                 type => 'string', format => 'pve-poolid',
3228                 description => "Add the new VM to the specified pool.",
3229             },
3230             snapname => get_standard_option('pve-snapshot-name', {
3231                 optional => 1,
3232             }),
3233             storage => get_standard_option('pve-storage-id', {
3234                 description => "Target storage for full clone.",
3235                 optional => 1,
3236             }),
3237             'format' => {
3238                 description => "Target format for file storage. Only valid for full clone.",
3239                 type => 'string',
3240                 optional => 1,
3241                 enum => [ 'raw', 'qcow2', 'vmdk'],
3242             },
3243             full => {
3244                 optional => 1,
3245                 type => 'boolean',
3246                 description => "Create a full copy of all disks. This is always done when " .
3247                     "you clone a normal VM. For VM templates, we try to create a linked clone by default.",
3248             },
3249             target => get_standard_option('pve-node', {
3250                 description => "Target node. Only allowed if the original VM is on shared storage.",
3251                 optional => 1,
3252             }),
3253             bwlimit => {
3254                 description => "Override I/O bandwidth limit (in KiB/s).",
3255                 optional => 1,
3256                 type => 'integer',
3257                 minimum => '0',
3258                 default => 'clone limit from datacenter or storage config',
3259             },
3260         },
3261     },
3262     returns => {
3263         type => 'string',
3264     },
3265     code => sub {
3266         my ($param) = @_;
3267
3268         my $rpcenv = PVE::RPCEnvironment::get();
3269         my $authuser = $rpcenv->get_user();
3270
3271         my $node = extract_param($param, 'node');
3272         my $vmid = extract_param($param, 'vmid');
3273         my $newid = extract_param($param, 'newid');
3274         my $pool = extract_param($param, 'pool');
3275
3276         my $snapname = extract_param($param, 'snapname');
3277         my $storage = extract_param($param, 'storage');
3278         my $format = extract_param($param, 'format');
3279         my $target = extract_param($param, 'target');
3280
3281         my $localnode = PVE::INotify::nodename();
3282
3283         if ($target && ($target eq $localnode || $target eq 'localhost')) {
3284             undef $target;
3285         }
3286
3287         my $running = PVE::QemuServer::check_running($vmid) || 0;
3288
3289         my $load_and_check = sub {
3290             $rpcenv->check_pool_exist($pool) if defined($pool);
3291             PVE::Cluster::check_node_exists($target) if $target;
3292
3293             my $storecfg = PVE::Storage::config();
3294
3295             if ($storage) {
3296                 # check if storage is enabled on local node
3297                 PVE::Storage::storage_check_enabled($storecfg, $storage);
3298                 if ($target) {
3299                     # check if storage is available on target node
3300                     PVE::Storage::storage_check_enabled($storecfg, $storage, $target);
3301                     # clone only works if target storage is shared
3302                     my $scfg = PVE::Storage::storage_config($storecfg, $storage);
3303                     die "can't clone to non-shared storage '$storage'\n"
3304                         if !$scfg->{shared};
3305                 }
3306             }
3307
3308             PVE::Cluster::check_cfs_quorum();
3309
3310             my $conf = PVE::QemuConfig->load_config($vmid);
3311             PVE::QemuConfig->check_lock($conf);
3312
3313             my $verify_running = PVE::QemuServer::check_running($vmid) || 0;
3314             die "unexpected state change\n" if $verify_running != $running;
3315
3316             die "snapshot '$snapname' does not exist\n"
3317                 if $snapname && !defined( $conf->{snapshots}->{$snapname});
3318
3319             my $full = $param->{full} // !PVE::QemuConfig->is_template($conf);
3320
3321             die "parameter 'storage' not allowed for linked clones\n"
3322                 if defined($storage) && !$full;
3323
3324             die "parameter 'format' not allowed for linked clones\n"
3325                 if defined($format) && !$full;
3326
3327             my $oldconf = $snapname ? $conf->{snapshots}->{$snapname} : $conf;
3328
3329             my $sharedvm = &$check_storage_access_clone($rpcenv, $authuser, $storecfg, $oldconf, $storage);
3330
3331             die "can't clone VM to node '$target' (VM uses local storage)\n"
3332                 if $target && !$sharedvm;
3333
3334             my $conffile = PVE::QemuConfig->config_file($newid);
3335             die "unable to create VM $newid: config file already exists\n"
3336                 if -f $conffile;
3337
3338             my $newconf = { lock => 'clone' };
3339             my $drives = {};
3340             my $fullclone = {};
3341             my $vollist = [];
3342
3343             foreach my $opt (keys %$oldconf) {
3344                 my $value = $oldconf->{$opt};
3345
3346                 # do not copy snapshot related info
3347                 next if $opt eq 'snapshots' ||  $opt eq 'parent' || $opt eq 'snaptime' ||
3348                     $opt eq 'vmstate' || $opt eq 'snapstate';
3349
3350                 # no need to copy unused images, because VMID(owner) changes anyways
3351                 next if $opt =~ m/^unused\d+$/;
3352
3353                 die "cannot clone TPM state while VM is running\n"
3354                     if $full && $running && !$snapname && $opt eq 'tpmstate0';
3355
3356                 # always change MAC! address
3357                 if ($opt =~ m/^net(\d+)$/) {
3358                     my $net = PVE::QemuServer::parse_net($value);
3359                     my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
3360                     $net->{macaddr} =  PVE::Tools::random_ether_addr($dc->{mac_prefix});
3361                     $newconf->{$opt} = PVE::QemuServer::print_net($net);
3362                 } elsif (PVE::QemuServer::is_valid_drivename($opt)) {
3363                     my $drive = PVE::QemuServer::parse_drive($opt, $value);
3364                     die "unable to parse drive options for '$opt'\n" if !$drive;
3365                     if (PVE::QemuServer::drive_is_cdrom($drive, 1)) {
3366                         $newconf->{$opt} = $value; # simply copy configuration
3367                     } else {
3368                         if ($full || PVE::QemuServer::drive_is_cloudinit($drive)) {
3369                             die "Full clone feature is not supported for drive '$opt'\n"
3370                                 if !PVE::Storage::volume_has_feature($storecfg, 'copy', $drive->{file}, $snapname, $running);
3371                             $fullclone->{$opt} = 1;
3372                         } else {
3373                             # not full means clone instead of copy
3374                             die "Linked clone feature is not supported for drive '$opt'\n"
3375                                 if !PVE::Storage::volume_has_feature($storecfg, 'clone', $drive->{file}, $snapname, $running);
3376                         }
3377                         $drives->{$opt} = $drive;
3378                         next if PVE::QemuServer::drive_is_cloudinit($drive);
3379                         push @$vollist, $drive->{file};
3380                     }
3381                 } else {
3382                     # copy everything else
3383                     $newconf->{$opt} = $value;
3384                 }
3385             }
3386
3387             return ($conffile, $newconf, $oldconf, $vollist, $drives, $fullclone);
3388         };
3389
3390         my $clonefn = sub {
3391             my ($conffile, $newconf, $oldconf, $vollist, $drives, $fullclone) = $load_and_check->();
3392             my $storecfg = PVE::Storage::config();
3393
3394             # auto generate a new uuid
3395             my $smbios1 = PVE::QemuServer::parse_smbios1($newconf->{smbios1} || '');
3396             $smbios1->{uuid} = PVE::QemuServer::generate_uuid();
3397             $newconf->{smbios1} = PVE::QemuServer::print_smbios1($smbios1);
3398             # auto generate a new vmgenid only if the option was set for template
3399             if ($newconf->{vmgenid}) {
3400                 $newconf->{vmgenid} = PVE::QemuServer::generate_uuid();
3401             }
3402
3403             delete $newconf->{template};
3404
3405             if ($param->{name}) {
3406                 $newconf->{name} = $param->{name};
3407             } else {
3408                 $newconf->{name} = "Copy-of-VM-" . ($oldconf->{name} // $vmid);
3409             }
3410
3411             if ($param->{description}) {
3412                 $newconf->{description} = $param->{description};
3413             }
3414
3415             # create empty/temp config - this fails if VM already exists on other node
3416             # FIXME use PVE::QemuConfig->create_and_lock_config and adapt code
3417             PVE::Tools::file_set_contents($conffile, "# qmclone temporary file\nlock: clone\n");
3418
3419             PVE::Firewall::clone_vmfw_conf($vmid, $newid);
3420
3421             my $newvollist = [];
3422             my $jobs = {};
3423
3424             eval {
3425                 local $SIG{INT} =
3426                     local $SIG{TERM} =
3427                     local $SIG{QUIT} =
3428                     local $SIG{HUP} = sub { die "interrupted by signal\n"; };
3429
3430                 PVE::Storage::activate_volumes($storecfg, $vollist, $snapname);
3431
3432                 my $bwlimit = extract_param($param, 'bwlimit');
3433
3434                 my $total_jobs = scalar(keys %{$drives});
3435                 my $i = 1;
3436
3437                 foreach my $opt (sort keys %$drives) {
3438                     my $drive = $drives->{$opt};
3439                     my $skipcomplete = ($total_jobs != $i); # finish after last drive
3440                     my $completion = $skipcomplete ? 'skip' : 'complete';
3441
3442                     my $src_sid = PVE::Storage::parse_volume_id($drive->{file});
3443                     my $storage_list = [ $src_sid ];
3444                     push @$storage_list, $storage if defined($storage);
3445                     my $clonelimit = PVE::Storage::get_bandwidth_limit('clone', $storage_list, $bwlimit);
3446
3447                     my $source_info = {
3448                         vmid => $vmid,
3449                         running => $running,
3450                         drivename => $opt,
3451                         drive => $drive,
3452                         snapname => $snapname,
3453                     };
3454
3455                     my $dest_info = {
3456                         vmid => $newid,
3457                         drivename => $opt,
3458                         storage => $storage,
3459                         format => $format,
3460                     };
3461
3462                     $dest_info->{efisize} = PVE::QemuServer::get_efivars_size($oldconf)
3463                         if $opt eq 'efidisk0';
3464
3465                     my $newdrive = PVE::QemuServer::clone_disk(
3466                         $storecfg,
3467                         $source_info,
3468                         $dest_info,
3469                         $fullclone->{$opt},
3470                         $newvollist,
3471                         $jobs,
3472                         $completion,
3473                         $oldconf->{agent},
3474                         $clonelimit,
3475                     );
3476
3477                     $newconf->{$opt} = PVE::QemuServer::print_drive($newdrive);
3478
3479                     PVE::QemuConfig->write_config($newid, $newconf);
3480                     $i++;
3481                 }
3482
3483                 delete $newconf->{lock};
3484
3485                 # do not write pending changes
3486                 if (my @changes = keys %{$newconf->{pending}}) {
3487                     my $pending = join(',', @changes);
3488                     warn "found pending changes for '$pending', discarding for clone\n";
3489                     delete $newconf->{pending};
3490                 }
3491
3492                 PVE::QemuConfig->write_config($newid, $newconf);
3493
3494                 if ($target) {
3495                     # always deactivate volumes - avoid lvm LVs to be active on several nodes
3496                     PVE::Storage::deactivate_volumes($storecfg, $vollist, $snapname) if !$running;
3497                     PVE::Storage::deactivate_volumes($storecfg, $newvollist);
3498
3499                     my $newconffile = PVE::QemuConfig->config_file($newid, $target);
3500                     die "Failed to move config to node '$target' - rename failed: $!\n"
3501                         if !rename($conffile, $newconffile);
3502                 }
3503
3504                 PVE::AccessControl::add_vm_to_pool($newid, $pool) if $pool;
3505             };
3506             if (my $err = $@) {
3507                 eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
3508                 sleep 1; # some storage like rbd need to wait before release volume - really?
3509
3510                 foreach my $volid (@$newvollist) {
3511                     eval { PVE::Storage::vdisk_free($storecfg, $volid); };
3512                     warn $@ if $@;
3513                 }
3514
3515                 PVE::Firewall::remove_vmfw_conf($newid);
3516
3517                 unlink $conffile; # avoid races -> last thing before die
3518
3519                 die "clone failed: $err";
3520             }
3521
3522             return;
3523         };
3524
3525         # Aquire exclusive lock lock for $newid
3526         my $lock_target_vm = sub {
3527             return PVE::QemuConfig->lock_config_full($newid, 1, $clonefn);
3528         };
3529
3530         my $lock_source_vm = sub {
3531             # exclusive lock if VM is running - else shared lock is enough;
3532             if ($running) {
3533                 return PVE::QemuConfig->lock_config_full($vmid, 1, $lock_target_vm);
3534             } else {
3535                 return PVE::QemuConfig->lock_config_shared($vmid, 1, $lock_target_vm);
3536             }
3537         };
3538
3539         $load_and_check->(); # early checks before forking/locking
3540
3541         return $rpcenv->fork_worker('qmclone', $vmid, $authuser, $lock_source_vm);
3542     }});
3543
3544 __PACKAGE__->register_method({
3545     name => 'move_vm_disk',
3546     path => '{vmid}/move_disk',
3547     method => 'POST',
3548     protected => 1,
3549     proxyto => 'node',
3550     description => "Move volume to different storage or to a different VM.",
3551     permissions => {
3552         description => "You need 'VM.Config.Disk' permissions on /vms/{vmid}, " .
3553             "and 'Datastore.AllocateSpace' permissions on the storage. To move ".
3554             "a disk to another VM, you need the permissions on the target VM as well.",
3555         check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
3556     },
3557     parameters => {
3558         additionalProperties => 0,
3559         properties => {
3560             node => get_standard_option('pve-node'),
3561             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3562             'target-vmid' => get_standard_option('pve-vmid', {
3563                 completion => \&PVE::QemuServer::complete_vmid,
3564                 optional => 1,
3565             }),
3566             disk => {
3567                 type => 'string',
3568                 description => "The disk you want to move.",
3569                 enum => [PVE::QemuServer::Drive::valid_drive_names_with_unused()],
3570             },
3571             storage => get_standard_option('pve-storage-id', {
3572                 description => "Target storage.",
3573                 completion => \&PVE::QemuServer::complete_storage,
3574                 optional => 1,
3575             }),
3576             'format' => {
3577                 type => 'string',
3578                 description => "Target Format.",
3579                 enum => [ 'raw', 'qcow2', 'vmdk' ],
3580                 optional => 1,
3581             },
3582             delete => {
3583                 type => 'boolean',
3584                 description => "Delete the original disk after successful copy. By default the"
3585                     ." original disk is kept as unused disk.",
3586                 optional => 1,
3587                 default => 0,
3588             },
3589             digest => {
3590                 type => 'string',
3591                 description => 'Prevent changes if current configuration file has different SHA1"
3592                     ." digest. This can be used to prevent concurrent modifications.',
3593                 maxLength => 40,
3594                 optional => 1,
3595             },
3596             bwlimit => {
3597                 description => "Override I/O bandwidth limit (in KiB/s).",
3598                 optional => 1,
3599                 type => 'integer',
3600                 minimum => '0',
3601                 default => 'move limit from datacenter or storage config',
3602             },
3603             'target-disk' => {
3604                 type => 'string',
3605                 description => "The config key the disk will be moved to on the target VM"
3606                     ." (for example, ide0 or scsi1). Default is the source disk key.",
3607                 enum => [PVE::QemuServer::Drive::valid_drive_names_with_unused()],
3608                 optional => 1,
3609             },
3610             'target-digest' => {
3611                 type => 'string',
3612                 description => 'Prevent changes if the current config file of the target VM has a"
3613                     ." different SHA1 digest. This can be used to detect concurrent modifications.',
3614                 maxLength => 40,
3615                 optional => 1,
3616             },
3617         },
3618     },
3619     returns => {
3620         type => 'string',
3621         description => "the task ID.",
3622     },
3623     code => sub {
3624         my ($param) = @_;
3625
3626         my $rpcenv = PVE::RPCEnvironment::get();
3627         my $authuser = $rpcenv->get_user();
3628
3629         my $node = extract_param($param, 'node');
3630         my $vmid = extract_param($param, 'vmid');
3631         my $target_vmid = extract_param($param, 'target-vmid');
3632         my $digest = extract_param($param, 'digest');
3633         my $target_digest = extract_param($param, 'target-digest');
3634         my $disk = extract_param($param, 'disk');
3635         my $target_disk = extract_param($param, 'target-disk') // $disk;
3636         my $storeid = extract_param($param, 'storage');
3637         my $format = extract_param($param, 'format');
3638
3639         my $storecfg = PVE::Storage::config();
3640
3641         my $load_and_check_move = sub {
3642             my $conf = PVE::QemuConfig->load_config($vmid);
3643             PVE::QemuConfig->check_lock($conf);
3644
3645             PVE::Tools::assert_if_modified($digest, $conf->{digest});
3646
3647             die "disk '$disk' does not exist\n" if !$conf->{$disk};
3648
3649             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
3650
3651             die "disk '$disk' has no associated volume\n" if !$drive->{file};
3652             die "you can't move a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive, 1);
3653
3654             my $old_volid = $drive->{file};
3655             my $oldfmt;
3656             my ($oldstoreid, $oldvolname) = PVE::Storage::parse_volume_id($old_volid);
3657             if ($oldvolname =~ m/\.(raw|qcow2|vmdk)$/){
3658                 $oldfmt = $1;
3659             }
3660
3661             die "you can't move to the same storage with same format\n"
3662                 if $oldstoreid eq $storeid && (!$format || !$oldfmt || $oldfmt eq $format);
3663
3664             # this only checks snapshots because $disk is passed!
3665             my $snapshotted = PVE::QemuServer::Drive::is_volume_in_use(
3666                 $storecfg,
3667                 $conf,
3668                 $disk,
3669                 $old_volid
3670             );
3671             die "you can't move a disk with snapshots and delete the source\n"
3672                 if $snapshotted && $param->{delete};
3673
3674             return ($conf, $drive, $oldstoreid, $snapshotted);
3675         };
3676
3677         my $move_updatefn = sub {
3678             my ($conf, $drive, $oldstoreid, $snapshotted) = $load_and_check_move->();
3679             my $old_volid = $drive->{file};
3680
3681             PVE::Cluster::log_msg(
3682                 'info',
3683                 $authuser,
3684                 "move disk VM $vmid: move --disk $disk --storage $storeid"
3685             );
3686
3687             my $running = PVE::QemuServer::check_running($vmid);
3688
3689             PVE::Storage::activate_volumes($storecfg, [ $drive->{file} ]);
3690
3691             my $newvollist = [];
3692
3693             eval {
3694                 local $SIG{INT} =
3695                     local $SIG{TERM} =
3696                     local $SIG{QUIT} =
3697                     local $SIG{HUP} = sub { die "interrupted by signal\n"; };
3698
3699                 warn "moving disk with snapshots, snapshots will not be moved!\n"
3700                     if $snapshotted;
3701
3702                 my $bwlimit = extract_param($param, 'bwlimit');
3703                 my $movelimit = PVE::Storage::get_bandwidth_limit(
3704                     'move',
3705                     [$oldstoreid, $storeid],
3706                     $bwlimit
3707                 );
3708
3709                 my $source_info = {
3710                     vmid => $vmid,
3711                     running => $running,
3712                     drivename => $disk,
3713                     drive => $drive,
3714                     snapname => undef,
3715                 };
3716
3717                 my $dest_info = {
3718                     vmid => $vmid,
3719                     drivename => $disk,
3720                     storage => $storeid,
3721                     format => $format,
3722                 };
3723
3724                 $dest_info->{efisize} = PVE::QemuServer::get_efivars_size($conf)
3725                     if $disk eq 'efidisk0';
3726
3727                 my $newdrive = PVE::QemuServer::clone_disk(
3728                     $storecfg,
3729                     $source_info,
3730                     $dest_info,
3731                     1,
3732                     $newvollist,
3733                     undef,
3734                     undef,
3735                     undef,
3736                     $movelimit,
3737                 );
3738                 $conf->{$disk} = PVE::QemuServer::print_drive($newdrive);
3739
3740                 PVE::QemuConfig->add_unused_volume($conf, $old_volid) if !$param->{delete};
3741
3742                 # convert moved disk to base if part of template
3743                 PVE::QemuServer::template_create($vmid, $conf, $disk)
3744                     if PVE::QemuConfig->is_template($conf);
3745
3746                 PVE::QemuConfig->write_config($vmid, $conf);
3747
3748                 my $do_trim = PVE::QemuServer::get_qga_key($conf, 'fstrim_cloned_disks');
3749                 if ($running && $do_trim && PVE::QemuServer::qga_check_running($vmid)) {
3750                     eval { mon_cmd($vmid, "guest-fstrim") };
3751                 }
3752
3753                 eval {
3754                     # try to deactivate volumes - avoid lvm LVs to be active on several nodes
3755                     PVE::Storage::deactivate_volumes($storecfg, [ $newdrive->{file} ])
3756                         if !$running;
3757                 };
3758                 warn $@ if $@;
3759             };
3760             if (my $err = $@) {
3761                 foreach my $volid (@$newvollist) {
3762                     eval { PVE::Storage::vdisk_free($storecfg, $volid) };
3763                     warn $@ if $@;
3764                 }
3765                 die "storage migration failed: $err";
3766             }
3767
3768             if ($param->{delete}) {
3769                 eval {
3770                     PVE::Storage::deactivate_volumes($storecfg, [$old_volid]);
3771                     PVE::Storage::vdisk_free($storecfg, $old_volid);
3772                 };
3773                 warn $@ if $@;
3774             }
3775         };
3776
3777         my $load_and_check_reassign_configs = sub {
3778             my $vmlist = PVE::Cluster::get_vmlist()->{ids};
3779
3780             die "could not find VM ${vmid}\n" if !exists($vmlist->{$vmid});
3781             die "could not find target VM ${target_vmid}\n" if !exists($vmlist->{$target_vmid});
3782
3783             my $source_node = $vmlist->{$vmid}->{node};
3784             my $target_node = $vmlist->{$target_vmid}->{node};
3785
3786             die "Both VMs need to be on the same node ($source_node != $target_node)\n"
3787                 if $source_node ne $target_node;
3788
3789             my $source_conf = PVE::QemuConfig->load_config($vmid);
3790             PVE::QemuConfig->check_lock($source_conf);
3791             my $target_conf = PVE::QemuConfig->load_config($target_vmid);
3792             PVE::QemuConfig->check_lock($target_conf);
3793
3794             die "Can't move disks from or to template VMs\n"
3795                 if ($source_conf->{template} || $target_conf->{template});
3796
3797             if ($digest) {
3798                 eval { PVE::Tools::assert_if_modified($digest, $source_conf->{digest}) };
3799                 die "VM ${vmid}: $@" if $@;
3800             }
3801
3802             if ($target_digest) {
3803                 eval { PVE::Tools::assert_if_modified($target_digest, $target_conf->{digest}) };
3804                 die "VM ${target_vmid}: $@" if $@;
3805             }
3806
3807             die "Disk '${disk}' for VM '$vmid' does not exist\n" if !defined($source_conf->{$disk});
3808
3809             die "Target disk key '${target_disk}' is already in use for VM '$target_vmid'\n"
3810                 if $target_conf->{$target_disk};
3811
3812             my $drive = PVE::QemuServer::parse_drive(
3813                 $disk,
3814                 $source_conf->{$disk},
3815             );
3816             die "failed to parse source disk - $@\n" if !$drive;
3817
3818             my $source_volid = $drive->{file};
3819
3820             die "disk '${disk}' has no associated volume\n" if !$source_volid;
3821             die "CD drive contents can't be moved to another VM\n"
3822                 if PVE::QemuServer::drive_is_cdrom($drive, 1);
3823
3824             my $storeid = PVE::Storage::parse_volume_id($source_volid, 1);
3825             die "Volume '$source_volid' not managed by PVE\n" if !defined($storeid);
3826
3827             die "Can't move disk used by a snapshot to another VM\n"
3828                 if PVE::QemuServer::Drive::is_volume_in_use($storecfg, $source_conf, $disk, $source_volid);
3829             die "Storage does not support moving of this disk to another VM\n"
3830                 if (!PVE::Storage::volume_has_feature($storecfg, 'rename', $source_volid));
3831             die "Cannot move disk to another VM while the source VM is running - detach first\n"
3832                 if PVE::QemuServer::check_running($vmid) && $disk !~ m/^unused\d+$/;
3833
3834             # now re-parse using target disk slot format
3835             if ($target_disk =~ /^unused\d+$/) {
3836                 $drive = PVE::QemuServer::parse_drive(
3837                     $target_disk,
3838                     $source_volid,
3839                 );
3840             } else {
3841                 $drive = PVE::QemuServer::parse_drive(
3842                     $target_disk,
3843                     $source_conf->{$disk},
3844                 );
3845             }
3846             die "failed to parse source disk for target disk format - $@\n" if !$drive;
3847
3848             my $repl_conf = PVE::ReplicationConfig->new();
3849             if ($repl_conf->check_for_existing_jobs($target_vmid, 1)) {
3850                 my $format = (PVE::Storage::parse_volname($storecfg, $source_volid))[6];
3851                 die "Cannot move disk to a replicated VM. Storage does not support replication!\n"
3852                     if !PVE::Storage::storage_can_replicate($storecfg, $storeid, $format);
3853             }
3854
3855             return ($source_conf, $target_conf, $drive);
3856         };
3857
3858         my $logfunc = sub {
3859             my ($msg) = @_;
3860             print STDERR "$msg\n";
3861         };
3862
3863         my $disk_reassignfn = sub {
3864             return PVE::QemuConfig->lock_config($vmid, sub {
3865                 return PVE::QemuConfig->lock_config($target_vmid, sub {
3866                     my ($source_conf, $target_conf, $drive) = &$load_and_check_reassign_configs();
3867
3868                     my $source_volid = $drive->{file};
3869
3870                     print "moving disk '$disk' from VM '$vmid' to '$target_vmid'\n";
3871                     my ($storeid, $source_volname) = PVE::Storage::parse_volume_id($source_volid);
3872
3873                     my $fmt = (PVE::Storage::parse_volname($storecfg, $source_volid))[6];
3874
3875                     my $new_volid = PVE::Storage::rename_volume(
3876                         $storecfg,
3877                         $source_volid,
3878                         $target_vmid,
3879                     );
3880
3881                     $drive->{file} = $new_volid;
3882
3883                     my $boot_order = PVE::QemuServer::device_bootorder($source_conf);
3884                     if (defined(delete $boot_order->{$disk})) {
3885                         print "removing disk '$disk' from boot order config\n";
3886                         my $boot_devs = [ sort { $boot_order->{$a} <=> $boot_order->{$b} } keys %$boot_order ];
3887                         $source_conf->{boot} = PVE::QemuServer::print_bootorder($boot_devs);
3888                     }
3889
3890                     delete $source_conf->{$disk};
3891                     print "removing disk '${disk}' from VM '${vmid}' config\n";
3892                     PVE::QemuConfig->write_config($vmid, $source_conf);
3893
3894                     my $drive_string = PVE::QemuServer::print_drive($drive);
3895
3896                     if ($target_disk =~ /^unused\d+$/) {
3897                         $target_conf->{$target_disk} = $drive_string;
3898                         PVE::QemuConfig->write_config($target_vmid, $target_conf);
3899                     } else {
3900                         &$update_vm_api(
3901                             {
3902                                 node => $node,
3903                                 vmid => $target_vmid,
3904                                 digest => $target_digest,
3905                                 $target_disk => $drive_string,
3906                             },
3907                             1,
3908                         );
3909                     }
3910
3911                     # remove possible replication snapshots
3912                     if (PVE::Storage::volume_has_feature(
3913                             $storecfg,
3914                             'replicate',
3915                             $source_volid),
3916                     ) {
3917                         eval {
3918                             PVE::Replication::prepare(
3919                                 $storecfg,
3920                                 [$new_volid],
3921                                 undef,
3922                                 1,
3923                                 undef,
3924                                 $logfunc,
3925                             )
3926                         };
3927                         if (my $err = $@) {
3928                             print "Failed to remove replication snapshots on moved disk " .
3929                                 "'$target_disk'. Manual cleanup could be necessary.\n";
3930                         }
3931                     }
3932                 });
3933             });
3934         };
3935
3936         if ($target_vmid && $storeid) {
3937             my $msg = "either set 'storage' or 'target-vmid', but not both";
3938             raise_param_exc({ 'target-vmid' => $msg, 'storage' => $msg });
3939         } elsif ($target_vmid) {
3940             $rpcenv->check_vm_perm($authuser, $target_vmid, undef, ['VM.Config.Disk'])
3941                 if $authuser ne 'root@pam';
3942
3943             raise_param_exc({ 'target-vmid' => "must be different than source VMID to reassign disk" })
3944                 if $vmid eq $target_vmid;
3945
3946             my (undef, undef, $drive) = &$load_and_check_reassign_configs();
3947             my $storage = PVE::Storage::parse_volume_id($drive->{file});
3948             $rpcenv->check($authuser, "/storage/$storage", ['Datastore.AllocateSpace']);
3949
3950             return $rpcenv->fork_worker(
3951                 'qmmove',
3952                 "${vmid}-${disk}>${target_vmid}-${target_disk}",
3953                 $authuser,
3954                 $disk_reassignfn
3955             );
3956         } elsif ($storeid) {
3957             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
3958
3959             die "cannot move disk '$disk', only configured disks can be moved to another storage\n"
3960                 if $disk =~ m/^unused\d+$/;
3961
3962             $load_and_check_move->(); # early checks before forking/locking
3963
3964             my $realcmd = sub {
3965                 PVE::QemuConfig->lock_config($vmid, $move_updatefn);
3966             };
3967
3968             return $rpcenv->fork_worker('qmmove', $vmid, $authuser, $realcmd);
3969         } else {
3970             my $msg = "both 'storage' and 'target-vmid' missing, either needs to be set";
3971             raise_param_exc({ 'target-vmid' => $msg, 'storage' => $msg });
3972         }
3973     }});
3974
3975 my $check_vm_disks_local = sub {
3976     my ($storecfg, $vmconf, $vmid) = @_;
3977
3978     my $local_disks = {};
3979
3980     # add some more information to the disks e.g. cdrom
3981     PVE::QemuServer::foreach_volid($vmconf, sub {
3982         my ($volid, $attr) = @_;
3983
3984         my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
3985         if ($storeid) {
3986             my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
3987             return if $scfg->{shared};
3988         }
3989         # The shared attr here is just a special case where the vdisk
3990         # is marked as shared manually
3991         return if $attr->{shared};
3992         return if $attr->{cdrom} and $volid eq "none";
3993
3994         if (exists $local_disks->{$volid}) {
3995             @{$local_disks->{$volid}}{keys %$attr} = values %$attr
3996         } else {
3997             $local_disks->{$volid} = $attr;
3998             # ensure volid is present in case it's needed
3999             $local_disks->{$volid}->{volid} = $volid;
4000         }
4001     });
4002
4003     return $local_disks;
4004 };
4005
4006 __PACKAGE__->register_method({
4007     name => 'migrate_vm_precondition',
4008     path => '{vmid}/migrate',
4009     method => 'GET',
4010     protected => 1,
4011     proxyto => 'node',
4012     description => "Get preconditions for migration.",
4013     permissions => {
4014         check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
4015     },
4016     parameters => {
4017         additionalProperties => 0,
4018         properties => {
4019             node => get_standard_option('pve-node'),
4020             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4021             target => get_standard_option('pve-node', {
4022                 description => "Target node.",
4023                 completion =>  \&PVE::Cluster::complete_migration_target,
4024                 optional => 1,
4025             }),
4026         },
4027     },
4028     returns => {
4029         type => "object",
4030         properties => {
4031             running => { type => 'boolean' },
4032             allowed_nodes => {
4033                 type => 'array',
4034                 optional => 1,
4035                 description => "List nodes allowed for offline migration, only passed if VM is offline"
4036             },
4037             not_allowed_nodes => {
4038                 type => 'object',
4039                 optional => 1,
4040                 description => "List not allowed nodes with additional informations, only passed if VM is offline"
4041             },
4042             local_disks => {
4043                 type => 'array',
4044                 description => "List local disks including CD-Rom, unsused and not referenced disks"
4045             },
4046             local_resources => {
4047                 type => 'array',
4048                 description => "List local resources e.g. pci, usb"
4049             }
4050         },
4051     },
4052     code => sub {
4053         my ($param) = @_;
4054
4055         my $rpcenv = PVE::RPCEnvironment::get();
4056
4057         my $authuser = $rpcenv->get_user();
4058
4059         PVE::Cluster::check_cfs_quorum();
4060
4061         my $res = {};
4062
4063         my $vmid = extract_param($param, 'vmid');
4064         my $target = extract_param($param, 'target');
4065         my $localnode = PVE::INotify::nodename();
4066
4067
4068         # test if VM exists
4069         my $vmconf = PVE::QemuConfig->load_config($vmid);
4070         my $storecfg = PVE::Storage::config();
4071
4072
4073         # try to detect errors early
4074         PVE::QemuConfig->check_lock($vmconf);
4075
4076         $res->{running} = PVE::QemuServer::check_running($vmid) ? 1:0;
4077
4078         # if vm is not running, return target nodes where local storage is available
4079         # for offline migration
4080         if (!$res->{running}) {
4081             $res->{allowed_nodes} = [];
4082             my $checked_nodes = PVE::QemuServer::check_local_storage_availability($vmconf, $storecfg);
4083             delete $checked_nodes->{$localnode};
4084
4085             foreach my $node (keys %$checked_nodes) {
4086                 if (!defined $checked_nodes->{$node}->{unavailable_storages}) {
4087                     push @{$res->{allowed_nodes}}, $node;
4088                 }
4089
4090             }
4091             $res->{not_allowed_nodes} = $checked_nodes;
4092         }
4093
4094
4095         my $local_disks = &$check_vm_disks_local($storecfg, $vmconf, $vmid);
4096         $res->{local_disks} = [ values %$local_disks ];;
4097
4098         my $local_resources =  PVE::QemuServer::check_local_resources($vmconf, 1);
4099
4100         $res->{local_resources} = $local_resources;
4101
4102         return $res;
4103
4104
4105     }});
4106
4107 __PACKAGE__->register_method({
4108     name => 'migrate_vm',
4109     path => '{vmid}/migrate',
4110     method => 'POST',
4111     protected => 1,
4112     proxyto => 'node',
4113     description => "Migrate virtual machine. Creates a new migration task.",
4114     permissions => {
4115         check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
4116     },
4117     parameters => {
4118         additionalProperties => 0,
4119         properties => {
4120             node => get_standard_option('pve-node'),
4121             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4122             target => get_standard_option('pve-node', {
4123                 description => "Target node.",
4124                 completion =>  \&PVE::Cluster::complete_migration_target,
4125             }),
4126             online => {
4127                 type => 'boolean',
4128                 description => "Use online/live migration if VM is running. Ignored if VM is stopped.",
4129                 optional => 1,
4130             },
4131             force => {
4132                 type => 'boolean',
4133                 description => "Allow to migrate VMs which use local devices. Only root may use this option.",
4134                 optional => 1,
4135             },
4136             migration_type => {
4137                 type => 'string',
4138                 enum => ['secure', 'insecure'],
4139                 description => "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
4140                 optional => 1,
4141             },
4142             migration_network => {
4143                 type => 'string', format => 'CIDR',
4144                 description => "CIDR of the (sub) network that is used for migration.",
4145                 optional => 1,
4146             },
4147             "with-local-disks" => {
4148                 type => 'boolean',
4149                 description => "Enable live storage migration for local disk",
4150                 optional => 1,
4151             },
4152             targetstorage => get_standard_option('pve-targetstorage', {
4153                 completion => \&PVE::QemuServer::complete_migration_storage,
4154             }),
4155             bwlimit => {
4156                 description => "Override I/O bandwidth limit (in KiB/s).",
4157                 optional => 1,
4158                 type => 'integer',
4159                 minimum => '0',
4160                 default => 'migrate limit from datacenter or storage config',
4161             },
4162         },
4163     },
4164     returns => {
4165         type => 'string',
4166         description => "the task ID.",
4167     },
4168     code => sub {
4169         my ($param) = @_;
4170
4171         my $rpcenv = PVE::RPCEnvironment::get();
4172         my $authuser = $rpcenv->get_user();
4173
4174         my $target = extract_param($param, 'target');
4175
4176         my $localnode = PVE::INotify::nodename();
4177         raise_param_exc({ target => "target is local node."}) if $target eq $localnode;
4178
4179         PVE::Cluster::check_cfs_quorum();
4180
4181         PVE::Cluster::check_node_exists($target);
4182
4183         my $targetip = PVE::Cluster::remote_node_ip($target);
4184
4185         my $vmid = extract_param($param, 'vmid');
4186
4187         raise_param_exc({ force => "Only root may use this option." })
4188             if $param->{force} && $authuser ne 'root@pam';
4189
4190         raise_param_exc({ migration_type => "Only root may use this option." })
4191             if $param->{migration_type} && $authuser ne 'root@pam';
4192
4193         # allow root only until better network permissions are available
4194         raise_param_exc({ migration_network => "Only root may use this option." })
4195             if $param->{migration_network} && $authuser ne 'root@pam';
4196
4197         # test if VM exists
4198         my $conf = PVE::QemuConfig->load_config($vmid);
4199
4200         # try to detect errors early
4201
4202         PVE::QemuConfig->check_lock($conf);
4203
4204         if (PVE::QemuServer::check_running($vmid)) {
4205             die "can't migrate running VM without --online\n" if !$param->{online};
4206
4207             my $repl_conf = PVE::ReplicationConfig->new();
4208             my $is_replicated = $repl_conf->check_for_existing_jobs($vmid, 1);
4209             my $is_replicated_to_target = defined($repl_conf->find_local_replication_job($vmid, $target));
4210             if (!$param->{force} && $is_replicated && !$is_replicated_to_target) {
4211                 die "Cannot live-migrate replicated VM to node '$target' - not a replication " .
4212                     "target. Use 'force' to override.\n";
4213             }
4214         } else {
4215             warn "VM isn't running. Doing offline migration instead.\n" if $param->{online};
4216             $param->{online} = 0;
4217         }
4218
4219         my $storecfg = PVE::Storage::config();
4220         if (my $targetstorage = $param->{targetstorage}) {
4221             my $storagemap = eval { PVE::JSONSchema::parse_idmap($targetstorage, 'pve-storage-id') };
4222             raise_param_exc({ targetstorage => "failed to parse storage map: $@" })
4223                 if $@;
4224
4225             $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk'])
4226                 if !defined($storagemap->{identity});
4227
4228             foreach my $target_sid (values %{$storagemap->{entries}}) {
4229                 $check_storage_access_migrate->($rpcenv, $authuser, $storecfg, $target_sid, $target);
4230             }
4231
4232             $check_storage_access_migrate->($rpcenv, $authuser, $storecfg, $storagemap->{default}, $target)
4233                 if $storagemap->{default};
4234
4235             PVE::QemuServer::check_storage_availability($storecfg, $conf, $target)
4236                 if $storagemap->{identity};
4237
4238             $param->{storagemap} = $storagemap;
4239         } else {
4240             PVE::QemuServer::check_storage_availability($storecfg, $conf, $target);
4241         }
4242
4243         if (PVE::HA::Config::vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
4244
4245             my $hacmd = sub {
4246                 my $upid = shift;
4247
4248                 print "Requesting HA migration for VM $vmid to node $target\n";
4249
4250                 my $cmd = ['ha-manager', 'migrate', "vm:$vmid", $target];
4251                 PVE::Tools::run_command($cmd);
4252                 return;
4253             };
4254
4255             return $rpcenv->fork_worker('hamigrate', $vmid, $authuser, $hacmd);
4256
4257         } else {
4258
4259             my $realcmd = sub {
4260                 PVE::QemuMigrate->migrate($target, $targetip, $vmid, $param);
4261             };
4262
4263             my $worker = sub {
4264                 return PVE::GuestHelpers::guest_migration_lock($vmid, 10, $realcmd);
4265             };
4266
4267             return $rpcenv->fork_worker('qmigrate', $vmid, $authuser, $worker);
4268         }
4269
4270     }});
4271
4272 __PACKAGE__->register_method({
4273     name => 'monitor',
4274     path => '{vmid}/monitor',
4275     method => 'POST',
4276     protected => 1,
4277     proxyto => 'node',
4278     description => "Execute Qemu monitor commands.",
4279     permissions => {
4280         description => "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')",
4281         check => ['perm', '/vms/{vmid}', [ 'VM.Monitor' ]],
4282     },
4283     parameters => {
4284         additionalProperties => 0,
4285         properties => {
4286             node => get_standard_option('pve-node'),
4287             vmid => get_standard_option('pve-vmid'),
4288             command => {
4289                 type => 'string',
4290                 description => "The monitor command.",
4291             }
4292         },
4293     },
4294     returns => { type => 'string'},
4295     code => sub {
4296         my ($param) = @_;
4297
4298         my $rpcenv = PVE::RPCEnvironment::get();
4299         my $authuser = $rpcenv->get_user();
4300
4301         my $is_ro = sub {
4302             my $command = shift;
4303             return $command =~ m/^\s*info(\s+|$)/
4304                 || $command =~ m/^\s*help\s*$/;
4305         };
4306
4307         $rpcenv->check_full($authuser, "/", ['Sys.Modify'])
4308             if !&$is_ro($param->{command});
4309
4310         my $vmid = $param->{vmid};
4311
4312         my $conf = PVE::QemuConfig->load_config ($vmid); # check if VM exists
4313
4314         my $res = '';
4315         eval {
4316             $res = PVE::QemuServer::Monitor::hmp_cmd($vmid, $param->{command});
4317         };
4318         $res = "ERROR: $@" if $@;
4319
4320         return $res;
4321     }});
4322
4323 __PACKAGE__->register_method({
4324     name => 'resize_vm',
4325     path => '{vmid}/resize',
4326     method => 'PUT',
4327     protected => 1,
4328     proxyto => 'node',
4329     description => "Extend volume size.",
4330     permissions => {
4331         check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
4332     },
4333     parameters => {
4334         additionalProperties => 0,
4335         properties => {
4336             node => get_standard_option('pve-node'),
4337             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4338             skiplock => get_standard_option('skiplock'),
4339             disk => {
4340                 type => 'string',
4341                 description => "The disk you want to resize.",
4342                 enum => [PVE::QemuServer::Drive::valid_drive_names()],
4343             },
4344             size => {
4345                 type => 'string',
4346                 pattern => '\+?\d+(\.\d+)?[KMGT]?',
4347                 description => "The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.",
4348             },
4349             digest => {
4350                 type => 'string',
4351                 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
4352                 maxLength => 40,
4353                 optional => 1,
4354             },
4355         },
4356     },
4357     returns => { type => 'null'},
4358     code => sub {
4359         my ($param) = @_;
4360
4361         my $rpcenv = PVE::RPCEnvironment::get();
4362
4363         my $authuser = $rpcenv->get_user();
4364
4365         my $node = extract_param($param, 'node');
4366
4367         my $vmid = extract_param($param, 'vmid');
4368
4369         my $digest = extract_param($param, 'digest');
4370
4371         my $disk = extract_param($param, 'disk');
4372
4373         my $sizestr = extract_param($param, 'size');
4374
4375         my $skiplock = extract_param($param, 'skiplock');
4376         raise_param_exc({ skiplock => "Only root may use this option." })
4377             if $skiplock && $authuser ne 'root@pam';
4378
4379         my $storecfg = PVE::Storage::config();
4380
4381         my $updatefn =  sub {
4382
4383             my $conf = PVE::QemuConfig->load_config($vmid);
4384
4385             die "checksum missmatch (file change by other user?)\n"
4386                 if $digest && $digest ne $conf->{digest};
4387             PVE::QemuConfig->check_lock($conf) if !$skiplock;
4388
4389             die "disk '$disk' does not exist\n" if !$conf->{$disk};
4390
4391             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
4392
4393             my (undef, undef, undef, undef, undef, undef, $format) =
4394                 PVE::Storage::parse_volname($storecfg, $drive->{file});
4395
4396             die "can't resize volume: $disk if snapshot exists\n"
4397                 if %{$conf->{snapshots}} && $format eq 'qcow2';
4398
4399             my $volid = $drive->{file};
4400
4401             die "disk '$disk' has no associated volume\n" if !$volid;
4402
4403             die "you can't resize a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
4404
4405             my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
4406
4407             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
4408
4409             PVE::Storage::activate_volumes($storecfg, [$volid]);
4410             my $size = PVE::Storage::volume_size_info($storecfg, $volid, 5);
4411
4412             die "Could not determine current size of volume '$volid'\n" if !defined($size);
4413
4414             die "internal error" if $sizestr !~ m/^(\+)?(\d+(\.\d+)?)([KMGT])?$/;
4415             my ($ext, $newsize, $unit) = ($1, $2, $4);
4416             if ($unit) {
4417                 if ($unit eq 'K') {
4418                     $newsize = $newsize * 1024;
4419                 } elsif ($unit eq 'M') {
4420                     $newsize = $newsize * 1024 * 1024;
4421                 } elsif ($unit eq 'G') {
4422                     $newsize = $newsize * 1024 * 1024 * 1024;
4423                 } elsif ($unit eq 'T') {
4424                     $newsize = $newsize * 1024 * 1024 * 1024 * 1024;
4425                 }
4426             }
4427             $newsize += $size if $ext;
4428             $newsize = int($newsize);
4429
4430             die "shrinking disks is not supported\n" if $newsize < $size;
4431
4432             return if $size == $newsize;
4433
4434             PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: resize --disk $disk --size $sizestr");
4435
4436             PVE::QemuServer::qemu_block_resize($vmid, "drive-$disk", $storecfg, $volid, $newsize);
4437
4438             $drive->{size} = $newsize;
4439             $conf->{$disk} = PVE::QemuServer::print_drive($drive);
4440
4441             PVE::QemuConfig->write_config($vmid, $conf);
4442         };
4443
4444         PVE::QemuConfig->lock_config($vmid, $updatefn);
4445         return;
4446     }});
4447
4448 __PACKAGE__->register_method({
4449     name => 'snapshot_list',
4450     path => '{vmid}/snapshot',
4451     method => 'GET',
4452     description => "List all snapshots.",
4453     permissions => {
4454         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
4455     },
4456     proxyto => 'node',
4457     protected => 1, # qemu pid files are only readable by root
4458     parameters => {
4459         additionalProperties => 0,
4460         properties => {
4461             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4462             node => get_standard_option('pve-node'),
4463         },
4464     },
4465     returns => {
4466         type => 'array',
4467         items => {
4468             type => "object",
4469             properties => {
4470                 name => {
4471                     description => "Snapshot identifier. Value 'current' identifies the current VM.",
4472                     type => 'string',
4473                 },
4474                 vmstate => {
4475                     description => "Snapshot includes RAM.",
4476                     type => 'boolean',
4477                     optional => 1,
4478                 },
4479                 description => {
4480                     description => "Snapshot description.",
4481                     type => 'string',
4482                 },
4483                 snaptime => {
4484                     description => "Snapshot creation time",
4485                     type => 'integer',
4486                     renderer => 'timestamp',
4487                     optional => 1,
4488                 },
4489                 parent => {
4490                     description => "Parent snapshot identifier.",
4491                     type => 'string',
4492                     optional => 1,
4493                 },
4494             },
4495         },
4496         links => [ { rel => 'child', href => "{name}" } ],
4497     },
4498     code => sub {
4499         my ($param) = @_;
4500
4501         my $vmid = $param->{vmid};
4502
4503         my $conf = PVE::QemuConfig->load_config($vmid);
4504         my $snaphash = $conf->{snapshots} || {};
4505
4506         my $res = [];
4507
4508         foreach my $name (keys %$snaphash) {
4509             my $d = $snaphash->{$name};
4510             my $item = {
4511                 name => $name,
4512                 snaptime => $d->{snaptime} || 0,
4513                 vmstate => $d->{vmstate} ? 1 : 0,
4514                 description => $d->{description} || '',
4515             };
4516             $item->{parent} = $d->{parent} if $d->{parent};
4517             $item->{snapstate} = $d->{snapstate} if $d->{snapstate};
4518             push @$res, $item;
4519         }
4520
4521         my $running = PVE::QemuServer::check_running($vmid, 1) ? 1 : 0;
4522         my $current = {
4523             name => 'current',
4524             digest => $conf->{digest},
4525             running => $running,
4526             description => "You are here!",
4527         };
4528         $current->{parent} = $conf->{parent} if $conf->{parent};
4529
4530         push @$res, $current;
4531
4532         return $res;
4533     }});
4534
4535 __PACKAGE__->register_method({
4536     name => 'snapshot',
4537     path => '{vmid}/snapshot',
4538     method => 'POST',
4539     protected => 1,
4540     proxyto => 'node',
4541     description => "Snapshot a VM.",
4542     permissions => {
4543         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
4544     },
4545     parameters => {
4546         additionalProperties => 0,
4547         properties => {
4548             node => get_standard_option('pve-node'),
4549             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4550             snapname => get_standard_option('pve-snapshot-name'),
4551             vmstate => {
4552                 optional => 1,
4553                 type => 'boolean',
4554                 description => "Save the vmstate",
4555             },
4556             description => {
4557                 optional => 1,
4558                 type => 'string',
4559                 description => "A textual description or comment.",
4560             },
4561         },
4562     },
4563     returns => {
4564         type => 'string',
4565         description => "the task ID.",
4566     },
4567     code => sub {
4568         my ($param) = @_;
4569
4570         my $rpcenv = PVE::RPCEnvironment::get();
4571
4572         my $authuser = $rpcenv->get_user();
4573
4574         my $node = extract_param($param, 'node');
4575
4576         my $vmid = extract_param($param, 'vmid');
4577
4578         my $snapname = extract_param($param, 'snapname');
4579
4580         die "unable to use snapshot name 'current' (reserved name)\n"
4581             if $snapname eq 'current';
4582
4583         die "unable to use snapshot name 'pending' (reserved name)\n"
4584             if lc($snapname) eq 'pending';
4585
4586         my $realcmd = sub {
4587             PVE::Cluster::log_msg('info', $authuser, "snapshot VM $vmid: $snapname");
4588             PVE::QemuConfig->snapshot_create($vmid, $snapname, $param->{vmstate},
4589                                              $param->{description});
4590         };
4591
4592         return $rpcenv->fork_worker('qmsnapshot', $vmid, $authuser, $realcmd);
4593     }});
4594
4595 __PACKAGE__->register_method({
4596     name => 'snapshot_cmd_idx',
4597     path => '{vmid}/snapshot/{snapname}',
4598     description => '',
4599     method => 'GET',
4600     permissions => {
4601         user => 'all',
4602     },
4603     parameters => {
4604         additionalProperties => 0,
4605         properties => {
4606             vmid => get_standard_option('pve-vmid'),
4607             node => get_standard_option('pve-node'),
4608             snapname => get_standard_option('pve-snapshot-name'),
4609         },
4610     },
4611     returns => {
4612         type => 'array',
4613         items => {
4614             type => "object",
4615             properties => {},
4616         },
4617         links => [ { rel => 'child', href => "{cmd}" } ],
4618     },
4619     code => sub {
4620         my ($param) = @_;
4621
4622         my $res = [];
4623
4624         push @$res, { cmd => 'rollback' };
4625         push @$res, { cmd => 'config' };
4626
4627         return $res;
4628     }});
4629
4630 __PACKAGE__->register_method({
4631     name => 'update_snapshot_config',
4632     path => '{vmid}/snapshot/{snapname}/config',
4633     method => 'PUT',
4634     protected => 1,
4635     proxyto => 'node',
4636     description => "Update snapshot metadata.",
4637     permissions => {
4638         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
4639     },
4640     parameters => {
4641         additionalProperties => 0,
4642         properties => {
4643             node => get_standard_option('pve-node'),
4644             vmid => get_standard_option('pve-vmid'),
4645             snapname => get_standard_option('pve-snapshot-name'),
4646             description => {
4647                 optional => 1,
4648                 type => 'string',
4649                 description => "A textual description or comment.",
4650             },
4651         },
4652     },
4653     returns => { type => 'null' },
4654     code => sub {
4655         my ($param) = @_;
4656
4657         my $rpcenv = PVE::RPCEnvironment::get();
4658
4659         my $authuser = $rpcenv->get_user();
4660
4661         my $vmid = extract_param($param, 'vmid');
4662
4663         my $snapname = extract_param($param, 'snapname');
4664
4665         return if !defined($param->{description});
4666
4667         my $updatefn =  sub {
4668
4669             my $conf = PVE::QemuConfig->load_config($vmid);
4670
4671             PVE::QemuConfig->check_lock($conf);
4672
4673             my $snap = $conf->{snapshots}->{$snapname};
4674
4675             die "snapshot '$snapname' does not exist\n" if !defined($snap);
4676
4677             $snap->{description} = $param->{description} if defined($param->{description});
4678
4679              PVE::QemuConfig->write_config($vmid, $conf);
4680         };
4681
4682         PVE::QemuConfig->lock_config($vmid, $updatefn);
4683
4684         return;
4685     }});
4686
4687 __PACKAGE__->register_method({
4688     name => 'get_snapshot_config',
4689     path => '{vmid}/snapshot/{snapname}/config',
4690     method => 'GET',
4691     proxyto => 'node',
4692     description => "Get snapshot configuration",
4693     permissions => {
4694         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot', 'VM.Snapshot.Rollback', 'VM.Audit' ], any => 1],
4695     },
4696     parameters => {
4697         additionalProperties => 0,
4698         properties => {
4699             node => get_standard_option('pve-node'),
4700             vmid => get_standard_option('pve-vmid'),
4701             snapname => get_standard_option('pve-snapshot-name'),
4702         },
4703     },
4704     returns => { type => "object" },
4705     code => sub {
4706         my ($param) = @_;
4707
4708         my $rpcenv = PVE::RPCEnvironment::get();
4709
4710         my $authuser = $rpcenv->get_user();
4711
4712         my $vmid = extract_param($param, 'vmid');
4713
4714         my $snapname = extract_param($param, 'snapname');
4715
4716         my $conf = PVE::QemuConfig->load_config($vmid);
4717
4718         my $snap = $conf->{snapshots}->{$snapname};
4719
4720         die "snapshot '$snapname' does not exist\n" if !defined($snap);
4721
4722         return $snap;
4723     }});
4724
4725 __PACKAGE__->register_method({
4726     name => 'rollback',
4727     path => '{vmid}/snapshot/{snapname}/rollback',
4728     method => 'POST',
4729     protected => 1,
4730     proxyto => 'node',
4731     description => "Rollback VM state to specified snapshot.",
4732     permissions => {
4733         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot', 'VM.Snapshot.Rollback' ], any => 1],
4734     },
4735     parameters => {
4736         additionalProperties => 0,
4737         properties => {
4738             node => get_standard_option('pve-node'),
4739             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4740             snapname => get_standard_option('pve-snapshot-name'),
4741         },
4742     },
4743     returns => {
4744         type => 'string',
4745         description => "the task ID.",
4746     },
4747     code => sub {
4748         my ($param) = @_;
4749
4750         my $rpcenv = PVE::RPCEnvironment::get();
4751
4752         my $authuser = $rpcenv->get_user();
4753
4754         my $node = extract_param($param, 'node');
4755
4756         my $vmid = extract_param($param, 'vmid');
4757
4758         my $snapname = extract_param($param, 'snapname');
4759
4760         my $realcmd = sub {
4761             PVE::Cluster::log_msg('info', $authuser, "rollback snapshot VM $vmid: $snapname");
4762             PVE::QemuConfig->snapshot_rollback($vmid, $snapname);
4763         };
4764
4765         my $worker = sub {
4766             # hold migration lock, this makes sure that nobody create replication snapshots
4767             return PVE::GuestHelpers::guest_migration_lock($vmid, 10, $realcmd);
4768         };
4769
4770         return $rpcenv->fork_worker('qmrollback', $vmid, $authuser, $worker);
4771     }});
4772
4773 __PACKAGE__->register_method({
4774     name => 'delsnapshot',
4775     path => '{vmid}/snapshot/{snapname}',
4776     method => 'DELETE',
4777     protected => 1,
4778     proxyto => 'node',
4779     description => "Delete a VM snapshot.",
4780     permissions => {
4781         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
4782     },
4783     parameters => {
4784         additionalProperties => 0,
4785         properties => {
4786             node => get_standard_option('pve-node'),
4787             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4788             snapname => get_standard_option('pve-snapshot-name'),
4789             force => {
4790                 optional => 1,
4791                 type => 'boolean',
4792                 description => "For removal from config file, even if removing disk snapshots fails.",
4793             },
4794         },
4795     },
4796     returns => {
4797         type => 'string',
4798         description => "the task ID.",
4799     },
4800     code => sub {
4801         my ($param) = @_;
4802
4803         my $rpcenv = PVE::RPCEnvironment::get();
4804
4805         my $authuser = $rpcenv->get_user();
4806
4807         my $node = extract_param($param, 'node');
4808
4809         my $vmid = extract_param($param, 'vmid');
4810
4811         my $snapname = extract_param($param, 'snapname');
4812
4813         my $lock_obtained;
4814         my $do_delete = sub {
4815             $lock_obtained = 1;
4816             PVE::Cluster::log_msg('info', $authuser, "delete snapshot VM $vmid: $snapname");
4817             PVE::QemuConfig->snapshot_delete($vmid, $snapname, $param->{force});
4818         };
4819
4820         my $realcmd = sub {
4821             if ($param->{force}) {
4822                 $do_delete->();
4823             } else {
4824                 eval { PVE::GuestHelpers::guest_migration_lock($vmid, 10, $do_delete); };
4825                 if (my $err = $@) {
4826                     die $err if $lock_obtained;
4827                     die "Failed to obtain guest migration lock - replication running?\n";
4828                 }
4829             }
4830         };
4831
4832         return $rpcenv->fork_worker('qmdelsnapshot', $vmid, $authuser, $realcmd);
4833     }});
4834
4835 __PACKAGE__->register_method({
4836     name => 'template',
4837     path => '{vmid}/template',
4838     method => 'POST',
4839     protected => 1,
4840     proxyto => 'node',
4841     description => "Create a Template.",
4842     permissions => {
4843         description => "You need 'VM.Allocate' permissions on /vms/{vmid}",
4844         check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
4845     },
4846     parameters => {
4847         additionalProperties => 0,
4848         properties => {
4849             node => get_standard_option('pve-node'),
4850             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid_stopped }),
4851             disk => {
4852                 optional => 1,
4853                 type => 'string',
4854                 description => "If you want to convert only 1 disk to base image.",
4855                 enum => [PVE::QemuServer::Drive::valid_drive_names()],
4856             },
4857
4858         },
4859     },
4860     returns => {
4861         type => 'string',
4862         description => "the task ID.",
4863     },
4864     code => sub {
4865         my ($param) = @_;
4866
4867         my $rpcenv = PVE::RPCEnvironment::get();
4868
4869         my $authuser = $rpcenv->get_user();
4870
4871         my $node = extract_param($param, 'node');
4872
4873         my $vmid = extract_param($param, 'vmid');
4874
4875         my $disk = extract_param($param, 'disk');
4876
4877         my $load_and_check = sub {
4878             my $conf = PVE::QemuConfig->load_config($vmid);
4879
4880             PVE::QemuConfig->check_lock($conf);
4881
4882             die "unable to create template, because VM contains snapshots\n"
4883                 if $conf->{snapshots} && scalar(keys %{$conf->{snapshots}});
4884
4885             die "you can't convert a template to a template\n"
4886                 if PVE::QemuConfig->is_template($conf) && !$disk;
4887
4888             die "you can't convert a VM to template if VM is running\n"
4889                 if PVE::QemuServer::check_running($vmid);
4890
4891             return $conf;
4892         };
4893
4894         $load_and_check->();
4895
4896         my $realcmd = sub {
4897             PVE::QemuConfig->lock_config($vmid, sub {
4898                 my $conf = $load_and_check->();
4899
4900                 $conf->{template} = 1;
4901                 PVE::QemuConfig->write_config($vmid, $conf);
4902
4903                 PVE::QemuServer::template_create($vmid, $conf, $disk);
4904             });
4905         };
4906
4907         return $rpcenv->fork_worker('qmtemplate', $vmid, $authuser, $realcmd);
4908     }});
4909
4910 __PACKAGE__->register_method({
4911     name => 'cloudinit_generated_config_dump',
4912     path => '{vmid}/cloudinit/dump',
4913     method => 'GET',
4914     proxyto => 'node',
4915     description => "Get automatically generated cloudinit config.",
4916     permissions => {
4917         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
4918     },
4919     parameters => {
4920         additionalProperties => 0,
4921         properties => {
4922             node => get_standard_option('pve-node'),
4923             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4924             type => {
4925                 description => 'Config type.',
4926                 type => 'string',
4927                 enum => ['user', 'network', 'meta'],
4928             },
4929         },
4930     },
4931     returns => {
4932         type => 'string',
4933     },
4934     code => sub {
4935         my ($param) = @_;
4936
4937         my $conf = PVE::QemuConfig->load_config($param->{vmid});
4938
4939         return PVE::QemuServer::Cloudinit::dump_cloudinit_config($conf, $param->{vmid}, $param->{type});
4940     }});
4941
4942 1;