PVE/API2/Qemu.pm

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