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