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