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         if ($stateuri && ($stateuri eq 'tcp' || $stateuri eq 'unix') && $migratedfrom && ($rpcenv->{type} eq 'cli')) {
2076             if (defined(my $line = <STDIN>)) {
2077                 chomp $line;
2078                 $spice_ticket = $line;
2079             }
2080         }
2081
2082         PVE::Cluster::check_cfs_quorum();
2083
2084         my $storecfg = PVE::Storage::config();
2085
2086         if (PVE::HA::Config::vm_is_ha_managed($vmid) && !$stateuri &&  $rpcenv->{type} ne 'ha') {
2087             my $hacmd = sub {
2088                 my $upid = shift;
2089
2090                 print "Requesting HA start for VM $vmid\n";
2091
2092                 my $cmd = ['ha-manager', 'set',  "vm:$vmid", '--state', 'started'];
2093                 PVE::Tools::run_command($cmd);
2094                 return;
2095             };
2096
2097             return $rpcenv->fork_worker('hastart', $vmid, $authuser, $hacmd);
2098
2099         } else {
2100
2101             my $realcmd = sub {
2102                 my $upid = shift;
2103
2104                 syslog('info', "start VM $vmid: $upid\n");
2105
2106                 PVE::QemuServer::vm_start($storecfg, $vmid, $stateuri, $skiplock, $migratedfrom, undef, $machine,
2107                                           $spice_ticket, $migration_network, $migration_type, $targetstorage, $timeout);
2108                 return;
2109             };
2110
2111             return $rpcenv->fork_worker('qmstart', $vmid, $authuser, $realcmd);
2112         }
2113     }});
2114
2115 __PACKAGE__->register_method({
2116     name => 'vm_stop',
2117     path => '{vmid}/status/stop',
2118     method => 'POST',
2119     protected => 1,
2120     proxyto => 'node',
2121     description => "Stop virtual machine. The qemu process will exit immediately. This" .
2122         "is akin to pulling the power plug of a running computer and may damage the VM data",
2123     permissions => {
2124         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2125     },
2126     parameters => {
2127         additionalProperties => 0,
2128         properties => {
2129             node => get_standard_option('pve-node'),
2130             vmid => get_standard_option('pve-vmid',
2131                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2132             skiplock => get_standard_option('skiplock'),
2133             migratedfrom => get_standard_option('pve-node', { optional => 1 }),
2134             timeout => {
2135                 description => "Wait maximal timeout seconds.",
2136                 type => 'integer',
2137                 minimum => 0,
2138                 optional => 1,
2139             },
2140             keepActive => {
2141                 description => "Do not deactivate storage volumes.",
2142                 type => 'boolean',
2143                 optional => 1,
2144                 default => 0,
2145             }
2146         },
2147     },
2148     returns => {
2149         type => 'string',
2150     },
2151     code => sub {
2152         my ($param) = @_;
2153
2154         my $rpcenv = PVE::RPCEnvironment::get();
2155         my $authuser = $rpcenv->get_user();
2156
2157         my $node = extract_param($param, 'node');
2158         my $vmid = extract_param($param, 'vmid');
2159
2160         my $skiplock = extract_param($param, 'skiplock');
2161         raise_param_exc({ skiplock => "Only root may use this option." })
2162             if $skiplock && $authuser ne 'root@pam';
2163
2164         my $keepActive = extract_param($param, 'keepActive');
2165         raise_param_exc({ keepActive => "Only root may use this option." })
2166             if $keepActive && $authuser ne 'root@pam';
2167
2168         my $migratedfrom = extract_param($param, 'migratedfrom');
2169         raise_param_exc({ migratedfrom => "Only root may use this option." })
2170             if $migratedfrom && $authuser ne 'root@pam';
2171
2172
2173         my $storecfg = PVE::Storage::config();
2174
2175         if (PVE::HA::Config::vm_is_ha_managed($vmid) && ($rpcenv->{type} ne 'ha') && !defined($migratedfrom)) {
2176
2177             my $hacmd = sub {
2178                 my $upid = shift;
2179
2180                 print "Requesting HA stop for VM $vmid\n";
2181
2182                 my $cmd = ['ha-manager', 'crm-command', 'stop',  "vm:$vmid", '0'];
2183                 PVE::Tools::run_command($cmd);
2184                 return;
2185             };
2186
2187             return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
2188
2189         } else {
2190             my $realcmd = sub {
2191                 my $upid = shift;
2192
2193                 syslog('info', "stop VM $vmid: $upid\n");
2194
2195                 PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
2196                                          $param->{timeout}, 0, 1, $keepActive, $migratedfrom);
2197                 return;
2198             };
2199
2200             return $rpcenv->fork_worker('qmstop', $vmid, $authuser, $realcmd);
2201         }
2202     }});
2203
2204 __PACKAGE__->register_method({
2205     name => 'vm_reset',
2206     path => '{vmid}/status/reset',
2207     method => 'POST',
2208     protected => 1,
2209     proxyto => 'node',
2210     description => "Reset virtual machine.",
2211     permissions => {
2212         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2213     },
2214     parameters => {
2215         additionalProperties => 0,
2216         properties => {
2217             node => get_standard_option('pve-node'),
2218             vmid => get_standard_option('pve-vmid',
2219                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2220             skiplock => get_standard_option('skiplock'),
2221         },
2222     },
2223     returns => {
2224         type => 'string',
2225     },
2226     code => sub {
2227         my ($param) = @_;
2228
2229         my $rpcenv = PVE::RPCEnvironment::get();
2230
2231         my $authuser = $rpcenv->get_user();
2232
2233         my $node = extract_param($param, 'node');
2234
2235         my $vmid = extract_param($param, 'vmid');
2236
2237         my $skiplock = extract_param($param, 'skiplock');
2238         raise_param_exc({ skiplock => "Only root may use this option." })
2239             if $skiplock && $authuser ne 'root@pam';
2240
2241         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
2242
2243         my $realcmd = sub {
2244             my $upid = shift;
2245
2246             PVE::QemuServer::vm_reset($vmid, $skiplock);
2247
2248             return;
2249         };
2250
2251         return $rpcenv->fork_worker('qmreset', $vmid, $authuser, $realcmd);
2252     }});
2253
2254 __PACKAGE__->register_method({
2255     name => 'vm_shutdown',
2256     path => '{vmid}/status/shutdown',
2257     method => 'POST',
2258     protected => 1,
2259     proxyto => 'node',
2260     description => "Shutdown virtual machine. This is similar to pressing the power button on a physical machine." .
2261         "This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.",
2262     permissions => {
2263         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2264     },
2265     parameters => {
2266         additionalProperties => 0,
2267         properties => {
2268             node => get_standard_option('pve-node'),
2269             vmid => get_standard_option('pve-vmid',
2270                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2271             skiplock => get_standard_option('skiplock'),
2272             timeout => {
2273                 description => "Wait maximal timeout seconds.",
2274                 type => 'integer',
2275                 minimum => 0,
2276                 optional => 1,
2277             },
2278             forceStop => {
2279                 description => "Make sure the VM stops.",
2280                 type => 'boolean',
2281                 optional => 1,
2282                 default => 0,
2283             },
2284             keepActive => {
2285                 description => "Do not deactivate storage volumes.",
2286                 type => 'boolean',
2287                 optional => 1,
2288                 default => 0,
2289             }
2290         },
2291     },
2292     returns => {
2293         type => 'string',
2294     },
2295     code => sub {
2296         my ($param) = @_;
2297
2298         my $rpcenv = PVE::RPCEnvironment::get();
2299         my $authuser = $rpcenv->get_user();
2300
2301         my $node = extract_param($param, 'node');
2302         my $vmid = extract_param($param, 'vmid');
2303
2304         my $skiplock = extract_param($param, 'skiplock');
2305         raise_param_exc({ skiplock => "Only root may use this option." })
2306             if $skiplock && $authuser ne 'root@pam';
2307
2308         my $keepActive = extract_param($param, 'keepActive');
2309         raise_param_exc({ keepActive => "Only root may use this option." })
2310             if $keepActive && $authuser ne 'root@pam';
2311
2312         my $storecfg = PVE::Storage::config();
2313
2314         my $shutdown = 1;
2315
2316         # if vm is paused, do not shutdown (but stop if forceStop = 1)
2317         # otherwise, we will infer a shutdown command, but run into the timeout,
2318         # then when the vm is resumed, it will instantly shutdown
2319         #
2320         # checking the qmp status here to get feedback to the gui/cli/api
2321         # and the status query should not take too long
2322         my $qmpstatus = eval {
2323             PVE::QemuConfig::assert_config_exists_on_node($vmid);
2324             mon_cmd($vmid, "query-status");
2325         };
2326         my $err = $@ if $@;
2327
2328         if (!$err && $qmpstatus->{status} eq "paused") {
2329             if ($param->{forceStop}) {
2330                 warn "VM is paused - stop instead of shutdown\n";
2331                 $shutdown = 0;
2332             } else {
2333                 die "VM is paused - cannot shutdown\n";
2334             }
2335         }
2336
2337         if (PVE::HA::Config::vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
2338
2339             my $timeout = $param->{timeout} // 60;
2340             my $hacmd = sub {
2341                 my $upid = shift;
2342
2343                 print "Requesting HA stop for VM $vmid\n";
2344
2345                 my $cmd = ['ha-manager', 'crm-command', 'stop', "vm:$vmid", "$timeout"];
2346                 PVE::Tools::run_command($cmd);
2347                 return;
2348             };
2349
2350             return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
2351
2352         } else {
2353
2354             my $realcmd = sub {
2355                 my $upid = shift;
2356
2357                 syslog('info', "shutdown VM $vmid: $upid\n");
2358
2359                 PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0, $param->{timeout},
2360                                          $shutdown, $param->{forceStop}, $keepActive);
2361                 return;
2362             };
2363
2364             return $rpcenv->fork_worker('qmshutdown', $vmid, $authuser, $realcmd);
2365         }
2366     }});
2367
2368 __PACKAGE__->register_method({
2369     name => 'vm_reboot',
2370     path => '{vmid}/status/reboot',
2371     method => 'POST',
2372     protected => 1,
2373     proxyto => 'node',
2374     description => "Reboot the VM by shutting it down, and starting it again. Applies pending changes.",
2375     permissions => {
2376         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2377     },
2378     parameters => {
2379         additionalProperties => 0,
2380         properties => {
2381             node => get_standard_option('pve-node'),
2382             vmid => get_standard_option('pve-vmid',
2383                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2384             timeout => {
2385                 description => "Wait maximal timeout seconds for the shutdown.",
2386                 type => 'integer',
2387                 minimum => 0,
2388                 optional => 1,
2389             },
2390         },
2391     },
2392     returns => {
2393         type => 'string',
2394     },
2395     code => sub {
2396         my ($param) = @_;
2397
2398         my $rpcenv = PVE::RPCEnvironment::get();
2399         my $authuser = $rpcenv->get_user();
2400
2401         my $node = extract_param($param, 'node');
2402         my $vmid = extract_param($param, 'vmid');
2403
2404         my $qmpstatus = eval {
2405             PVE::QemuConfig::assert_config_exists_on_node($vmid);
2406             mon_cmd($vmid, "query-status");
2407         };
2408         my $err = $@ if $@;
2409
2410         if (!$err && $qmpstatus->{status} eq "paused") {
2411             die "VM is paused - cannot shutdown\n";
2412         }
2413
2414         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
2415
2416         my $realcmd = sub {
2417             my $upid = shift;
2418
2419             syslog('info', "requesting reboot of VM $vmid: $upid\n");
2420             PVE::QemuServer::vm_reboot($vmid, $param->{timeout});
2421             return;
2422         };
2423
2424         return $rpcenv->fork_worker('qmreboot', $vmid, $authuser, $realcmd);
2425     }});
2426
2427 __PACKAGE__->register_method({
2428     name => 'vm_suspend',
2429     path => '{vmid}/status/suspend',
2430     method => 'POST',
2431     protected => 1,
2432     proxyto => 'node',
2433     description => "Suspend virtual machine.",
2434     permissions => {
2435         description => "You need 'VM.PowerMgmt' on /vms/{vmid}, and if you have set 'todisk',".
2436             " you need also 'VM.Config.Disk' on /vms/{vmid} and 'Datastore.AllocateSpace'".
2437             " on the storage for the vmstate.",
2438         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2439     },
2440     parameters => {
2441         additionalProperties => 0,
2442         properties => {
2443             node => get_standard_option('pve-node'),
2444             vmid => get_standard_option('pve-vmid',
2445                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2446             skiplock => get_standard_option('skiplock'),
2447             todisk => {
2448                 type => 'boolean',
2449                 default => 0,
2450                 optional => 1,
2451                 description => 'If set, suspends the VM to disk. Will be resumed on next VM start.',
2452             },
2453             statestorage => get_standard_option('pve-storage-id', {
2454                 description => "The storage for the VM state",
2455                 requires => 'todisk',
2456                 optional => 1,
2457                 completion => \&PVE::Storage::complete_storage_enabled,
2458             }),
2459         },
2460     },
2461     returns => {
2462         type => 'string',
2463     },
2464     code => sub {
2465         my ($param) = @_;
2466
2467         my $rpcenv = PVE::RPCEnvironment::get();
2468         my $authuser = $rpcenv->get_user();
2469
2470         my $node = extract_param($param, 'node');
2471         my $vmid = extract_param($param, 'vmid');
2472
2473         my $todisk = extract_param($param, 'todisk') // 0;
2474
2475         my $statestorage = extract_param($param, 'statestorage');
2476
2477         my $skiplock = extract_param($param, 'skiplock');
2478         raise_param_exc({ skiplock => "Only root may use this option." })
2479             if $skiplock && $authuser ne 'root@pam';
2480
2481         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
2482
2483         die "Cannot suspend HA managed VM to disk\n"
2484             if $todisk && PVE::HA::Config::vm_is_ha_managed($vmid);
2485
2486         # early check for storage permission, for better user feedback
2487         if ($todisk) {
2488             $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
2489
2490             if (!$statestorage) {
2491                 # get statestorage from config if none is given
2492                 my $conf = PVE::QemuConfig->load_config($vmid);
2493                 my $storecfg = PVE::Storage::config();
2494                 $statestorage = PVE::QemuServer::find_vmstate_storage($conf, $storecfg);
2495             }
2496
2497             $rpcenv->check($authuser, "/storage/$statestorage", ['Datastore.AllocateSpace']);
2498         }
2499
2500         my $realcmd = sub {
2501             my $upid = shift;
2502
2503             syslog('info', "suspend VM $vmid: $upid\n");
2504
2505             PVE::QemuServer::vm_suspend($vmid, $skiplock, $todisk, $statestorage);
2506
2507             return;
2508         };
2509
2510         my $taskname = $todisk ? 'qmsuspend' : 'qmpause';
2511         return $rpcenv->fork_worker($taskname, $vmid, $authuser, $realcmd);
2512     }});
2513
2514 __PACKAGE__->register_method({
2515     name => 'vm_resume',
2516     path => '{vmid}/status/resume',
2517     method => 'POST',
2518     protected => 1,
2519     proxyto => 'node',
2520     description => "Resume virtual machine.",
2521     permissions => {
2522         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2523     },
2524     parameters => {
2525         additionalProperties => 0,
2526         properties => {
2527             node => get_standard_option('pve-node'),
2528             vmid => get_standard_option('pve-vmid',
2529                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2530             skiplock => get_standard_option('skiplock'),
2531             nocheck => { type => 'boolean', optional => 1 },
2532
2533         },
2534     },
2535     returns => {
2536         type => 'string',
2537     },
2538     code => sub {
2539         my ($param) = @_;
2540
2541         my $rpcenv = PVE::RPCEnvironment::get();
2542
2543         my $authuser = $rpcenv->get_user();
2544
2545         my $node = extract_param($param, 'node');
2546
2547         my $vmid = extract_param($param, 'vmid');
2548
2549         my $skiplock = extract_param($param, 'skiplock');
2550         raise_param_exc({ skiplock => "Only root may use this option." })
2551             if $skiplock && $authuser ne 'root@pam';
2552
2553         my $nocheck = extract_param($param, 'nocheck');
2554
2555         my $to_disk_suspended;
2556         eval {
2557             PVE::QemuConfig->lock_config($vmid, sub {
2558                 my $conf = PVE::QemuConfig->load_config($vmid);
2559                 $to_disk_suspended = PVE::QemuConfig->has_lock($conf, 'suspended');
2560             });
2561         };
2562
2563         die "VM $vmid not running\n"
2564             if !$to_disk_suspended && !PVE::QemuServer::check_running($vmid, $nocheck);
2565
2566         my $realcmd = sub {
2567             my $upid = shift;
2568
2569             syslog('info', "resume VM $vmid: $upid\n");
2570
2571             if (!$to_disk_suspended) {
2572                 PVE::QemuServer::vm_resume($vmid, $skiplock, $nocheck);
2573             } else {
2574                 my $storecfg = PVE::Storage::config();
2575                 PVE::QemuServer::vm_start($storecfg, $vmid, undef, $skiplock);
2576             }
2577
2578             return;
2579         };
2580
2581         return $rpcenv->fork_worker('qmresume', $vmid, $authuser, $realcmd);
2582     }});
2583
2584 __PACKAGE__->register_method({
2585     name => 'vm_sendkey',
2586     path => '{vmid}/sendkey',
2587     method => 'PUT',
2588     protected => 1,
2589     proxyto => 'node',
2590     description => "Send key event to virtual machine.",
2591     permissions => {
2592         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
2593     },
2594     parameters => {
2595         additionalProperties => 0,
2596         properties => {
2597             node => get_standard_option('pve-node'),
2598             vmid => get_standard_option('pve-vmid',
2599                                         { completion => \&PVE::QemuServer::complete_vmid_running }),
2600             skiplock => get_standard_option('skiplock'),
2601             key => {
2602                 description => "The key (qemu monitor encoding).",
2603                 type => 'string'
2604             }
2605         },
2606     },
2607     returns => { type => 'null'},
2608     code => sub {
2609         my ($param) = @_;
2610
2611         my $rpcenv = PVE::RPCEnvironment::get();
2612
2613         my $authuser = $rpcenv->get_user();
2614
2615         my $node = extract_param($param, 'node');
2616
2617         my $vmid = extract_param($param, 'vmid');
2618
2619         my $skiplock = extract_param($param, 'skiplock');
2620         raise_param_exc({ skiplock => "Only root may use this option." })
2621             if $skiplock && $authuser ne 'root@pam';
2622
2623         PVE::QemuServer::vm_sendkey($vmid, $skiplock, $param->{key});
2624
2625         return;
2626     }});
2627
2628 __PACKAGE__->register_method({
2629     name => 'vm_feature',
2630     path => '{vmid}/feature',
2631     method => 'GET',
2632     proxyto => 'node',
2633     protected => 1,
2634     description => "Check if feature for virtual machine is available.",
2635     permissions => {
2636         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
2637     },
2638     parameters => {
2639         additionalProperties => 0,
2640         properties => {
2641             node => get_standard_option('pve-node'),
2642             vmid => get_standard_option('pve-vmid'),
2643             feature => {
2644                 description => "Feature to check.",
2645                 type => 'string',
2646                 enum => [ 'snapshot', 'clone', 'copy' ],
2647             },
2648             snapname => get_standard_option('pve-snapshot-name', {
2649                 optional => 1,
2650             }),
2651         },
2652     },
2653     returns => {
2654         type => "object",
2655         properties => {
2656             hasFeature => { type => 'boolean' },
2657             nodes => {
2658                 type => 'array',
2659                 items => { type => 'string' },
2660             }
2661         },
2662     },
2663     code => sub {
2664         my ($param) = @_;
2665
2666         my $node = extract_param($param, 'node');
2667
2668         my $vmid = extract_param($param, 'vmid');
2669
2670         my $snapname = extract_param($param, 'snapname');
2671
2672         my $feature = extract_param($param, 'feature');
2673
2674         my $running = PVE::QemuServer::check_running($vmid);
2675
2676         my $conf = PVE::QemuConfig->load_config($vmid);
2677
2678         if($snapname){
2679             my $snap = $conf->{snapshots}->{$snapname};
2680             die "snapshot '$snapname' does not exist\n" if !defined($snap);
2681             $conf = $snap;
2682         }
2683         my $storecfg = PVE::Storage::config();
2684
2685         my $nodelist = PVE::QemuServer::shared_nodes($conf, $storecfg);
2686         my $hasFeature = PVE::QemuConfig->has_feature($feature, $conf, $storecfg, $snapname, $running);
2687
2688         return {
2689             hasFeature => $hasFeature,
2690             nodes => [ keys %$nodelist ],
2691         };
2692     }});
2693
2694 __PACKAGE__->register_method({
2695     name => 'clone_vm',
2696     path => '{vmid}/clone',
2697     method => 'POST',
2698     protected => 1,
2699     proxyto => 'node',
2700     description => "Create a copy of virtual machine/template.",
2701     permissions => {
2702         description => "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions " .
2703             "on /vms/{newid} (or on the VM pool /pool/{pool}). You also need " .
2704             "'Datastore.AllocateSpace' on any used storage.",
2705         check =>
2706         [ 'and',
2707           ['perm', '/vms/{vmid}', [ 'VM.Clone' ]],
2708           [ 'or',
2709             [ 'perm', '/vms/{newid}', ['VM.Allocate']],
2710             [ 'perm', '/pool/{pool}', ['VM.Allocate'], require_param => 'pool'],
2711           ],
2712         ]
2713     },
2714     parameters => {
2715         additionalProperties => 0,
2716         properties => {
2717             node => get_standard_option('pve-node'),
2718             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
2719             newid => get_standard_option('pve-vmid', {
2720                 completion => \&PVE::Cluster::complete_next_vmid,
2721                 description => 'VMID for the clone.' }),
2722             name => {
2723                 optional => 1,
2724                 type => 'string', format => 'dns-name',
2725                 description => "Set a name for the new VM.",
2726             },
2727             description => {
2728                 optional => 1,
2729                 type => 'string',
2730                 description => "Description for the new VM.",
2731             },
2732             pool => {
2733                 optional => 1,
2734                 type => 'string', format => 'pve-poolid',
2735                 description => "Add the new VM to the specified pool.",
2736             },
2737             snapname => get_standard_option('pve-snapshot-name', {
2738                 optional => 1,
2739             }),
2740             storage => get_standard_option('pve-storage-id', {
2741                 description => "Target storage for full clone.",
2742                 optional => 1,
2743             }),
2744             'format' => {
2745                 description => "Target format for file storage. Only valid for full clone.",
2746                 type => 'string',
2747                 optional => 1,
2748                 enum => [ 'raw', 'qcow2', 'vmdk'],
2749             },
2750             full => {
2751                 optional => 1,
2752                 type => 'boolean',
2753                 description => "Create a full copy of all disks. This is always done when " .
2754                     "you clone a normal VM. For VM templates, we try to create a linked clone by default.",
2755             },
2756             target => get_standard_option('pve-node', {
2757                 description => "Target node. Only allowed if the original VM is on shared storage.",
2758                 optional => 1,
2759             }),
2760             bwlimit => {
2761                 description => "Override I/O bandwidth limit (in KiB/s).",
2762                 optional => 1,
2763                 type => 'integer',
2764                 minimum => '0',
2765                 default => 'clone limit from datacenter or storage config',
2766             },
2767         },
2768     },
2769     returns => {
2770         type => 'string',
2771     },
2772     code => sub {
2773         my ($param) = @_;
2774
2775         my $rpcenv = PVE::RPCEnvironment::get();
2776         my $authuser = $rpcenv->get_user();
2777
2778         my $node = extract_param($param, 'node');
2779         my $vmid = extract_param($param, 'vmid');
2780         my $newid = extract_param($param, 'newid');
2781         my $pool = extract_param($param, 'pool');
2782         $rpcenv->check_pool_exist($pool) if defined($pool);
2783
2784         my $snapname = extract_param($param, 'snapname');
2785         my $storage = extract_param($param, 'storage');
2786         my $format = extract_param($param, 'format');
2787         my $target = extract_param($param, 'target');
2788
2789         my $localnode = PVE::INotify::nodename();
2790
2791         if ($target && ($target eq $localnode || $target eq 'localhost')) {
2792             undef $target;
2793         }
2794
2795         PVE::Cluster::check_node_exists($target) if $target;
2796
2797         my $storecfg = PVE::Storage::config();
2798
2799         if ($storage) {
2800             # check if storage is enabled on local node
2801             PVE::Storage::storage_check_enabled($storecfg, $storage);
2802             if ($target) {
2803                 # check if storage is available on target node
2804                 PVE::Storage::storage_check_node($storecfg, $storage, $target);
2805                 # clone only works if target storage is shared
2806                 my $scfg = PVE::Storage::storage_config($storecfg, $storage);
2807                 die "can't clone to non-shared storage '$storage'\n" if !$scfg->{shared};
2808             }
2809         }
2810
2811         PVE::Cluster::check_cfs_quorum();
2812
2813         my $running = PVE::QemuServer::check_running($vmid) || 0;
2814
2815         # exclusive lock if VM is running - else shared lock is enough;
2816         my $shared_lock = $running ? 0 : 1;
2817
2818         my $clonefn = sub {
2819             # do all tests after lock but before forking worker - if possible
2820
2821             my $conf = PVE::QemuConfig->load_config($vmid);
2822             PVE::QemuConfig->check_lock($conf);
2823
2824             my $verify_running = PVE::QemuServer::check_running($vmid) || 0;
2825             die "unexpected state change\n" if $verify_running != $running;
2826
2827             die "snapshot '$snapname' does not exist\n"
2828                 if $snapname && !defined( $conf->{snapshots}->{$snapname});
2829
2830             my $full = extract_param($param, 'full') // !PVE::QemuConfig->is_template($conf);
2831
2832             die "parameter 'storage' not allowed for linked clones\n"
2833                 if defined($storage) && !$full;
2834
2835             die "parameter 'format' not allowed for linked clones\n"
2836                 if defined($format) && !$full;
2837
2838             my $oldconf = $snapname ? $conf->{snapshots}->{$snapname} : $conf;
2839
2840             my $sharedvm = &$check_storage_access_clone($rpcenv, $authuser, $storecfg, $oldconf, $storage);
2841
2842             die "can't clone VM to node '$target' (VM uses local storage)\n"
2843                 if $target && !$sharedvm;
2844
2845             my $conffile = PVE::QemuConfig->config_file($newid);
2846             die "unable to create VM $newid: config file already exists\n"
2847                 if -f $conffile;
2848
2849             my $newconf = { lock => 'clone' };
2850             my $drives = {};
2851             my $fullclone = {};
2852             my $vollist = [];
2853
2854             foreach my $opt (keys %$oldconf) {
2855                 my $value = $oldconf->{$opt};
2856
2857                 # do not copy snapshot related info
2858                 next if $opt eq 'snapshots' ||  $opt eq 'parent' || $opt eq 'snaptime' ||
2859                     $opt eq 'vmstate' || $opt eq 'snapstate';
2860
2861                 # no need to copy unused images, because VMID(owner) changes anyways
2862                 next if $opt =~ m/^unused\d+$/;
2863
2864                 # always change MAC! address
2865                 if ($opt =~ m/^net(\d+)$/) {
2866                     my $net = PVE::QemuServer::parse_net($value);
2867                     my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
2868                     $net->{macaddr} =  PVE::Tools::random_ether_addr($dc->{mac_prefix});
2869                     $newconf->{$opt} = PVE::QemuServer::print_net($net);
2870                 } elsif (PVE::QemuServer::is_valid_drivename($opt)) {
2871                     my $drive = PVE::QemuServer::parse_drive($opt, $value);
2872                     die "unable to parse drive options for '$opt'\n" if !$drive;
2873                     if (PVE::QemuServer::drive_is_cdrom($drive, 1)) {
2874                         $newconf->{$opt} = $value; # simply copy configuration
2875                     } else {
2876                         if ($full || PVE::QemuServer::drive_is_cloudinit($drive)) {
2877                             die "Full clone feature is not supported for drive '$opt'\n"
2878                                 if !PVE::Storage::volume_has_feature($storecfg, 'copy', $drive->{file}, $snapname, $running);
2879                             $fullclone->{$opt} = 1;
2880                         } else {
2881                             # not full means clone instead of copy
2882                             die "Linked clone feature is not supported for drive '$opt'\n"
2883                                 if !PVE::Storage::volume_has_feature($storecfg, 'clone', $drive->{file}, $snapname, $running);
2884                         }
2885                         $drives->{$opt} = $drive;
2886                         push @$vollist, $drive->{file};
2887                     }
2888                 } else {
2889                     # copy everything else
2890                     $newconf->{$opt} = $value;
2891                 }
2892             }
2893
2894             # auto generate a new uuid
2895             my $smbios1 = PVE::QemuServer::parse_smbios1($newconf->{smbios1} || '');
2896             $smbios1->{uuid} = PVE::QemuServer::generate_uuid();
2897             $newconf->{smbios1} = PVE::QemuServer::print_smbios1($smbios1);
2898             # auto generate a new vmgenid only if the option was set for template
2899             if ($newconf->{vmgenid}) {
2900                 $newconf->{vmgenid} = PVE::QemuServer::generate_uuid();
2901             }
2902
2903             delete $newconf->{template};
2904
2905             if ($param->{name}) {
2906                 $newconf->{name} = $param->{name};
2907             } else {
2908                 $newconf->{name} = "Copy-of-VM-" . ($oldconf->{name} // $vmid);
2909             }
2910
2911             if ($param->{description}) {
2912                 $newconf->{description} = $param->{description};
2913             }
2914
2915             # create empty/temp config - this fails if VM already exists on other node
2916             # FIXME use PVE::QemuConfig->create_and_lock_config and adapt code
2917             PVE::Tools::file_set_contents($conffile, "# qmclone temporary file\nlock: clone\n");
2918
2919             my $realcmd = sub {
2920                 my $upid = shift;
2921
2922                 my $newvollist = [];
2923                 my $jobs = {};
2924
2925                 eval {
2926                     local $SIG{INT} =
2927                         local $SIG{TERM} =
2928                         local $SIG{QUIT} =
2929                         local $SIG{HUP} = sub { die "interrupted by signal\n"; };
2930
2931                     PVE::Storage::activate_volumes($storecfg, $vollist, $snapname);
2932
2933                     my $bwlimit = extract_param($param, 'bwlimit');
2934
2935                     my $total_jobs = scalar(keys %{$drives});
2936                     my $i = 1;
2937
2938                     foreach my $opt (keys %$drives) {
2939                         my $drive = $drives->{$opt};
2940                         my $skipcomplete = ($total_jobs != $i); # finish after last drive
2941
2942                         my $src_sid = PVE::Storage::parse_volume_id($drive->{file});
2943                         my $storage_list = [ $src_sid ];
2944                         push @$storage_list, $storage if defined($storage);
2945                         my $clonelimit = PVE::Storage::get_bandwidth_limit('clone', $storage_list, $bwlimit);
2946
2947                         my $newdrive = PVE::QemuServer::clone_disk($storecfg, $vmid, $running, $opt, $drive, $snapname,
2948                                                                    $newid, $storage, $format, $fullclone->{$opt}, $newvollist,
2949                                                                    $jobs, $skipcomplete, $oldconf->{agent}, $clonelimit);
2950
2951                         $newconf->{$opt} = PVE::QemuServer::print_drive($newdrive);
2952
2953                         PVE::QemuConfig->write_config($newid, $newconf);
2954                         $i++;
2955                     }
2956
2957                     delete $newconf->{lock};
2958
2959                     # do not write pending changes
2960                     if (my @changes = keys %{$newconf->{pending}}) {
2961                         my $pending = join(',', @changes);
2962                         warn "found pending changes for '$pending', discarding for clone\n";
2963                         delete $newconf->{pending};
2964                     }
2965
2966                     PVE::QemuConfig->write_config($newid, $newconf);
2967
2968                     if ($target) {
2969                         # always deactivate volumes - avoid lvm LVs to be active on several nodes
2970                         PVE::Storage::deactivate_volumes($storecfg, $vollist, $snapname) if !$running;
2971                         PVE::Storage::deactivate_volumes($storecfg, $newvollist);
2972
2973                         my $newconffile = PVE::QemuConfig->config_file($newid, $target);
2974                         die "Failed to move config to node '$target' - rename failed: $!\n"
2975                             if !rename($conffile, $newconffile);
2976                     }
2977
2978                     PVE::AccessControl::add_vm_to_pool($newid, $pool) if $pool;
2979                 };
2980                 if (my $err = $@) {
2981                     eval { PVE::QemuServer::qemu_blockjobs_cancel($vmid, $jobs) };
2982                     sleep 1; # some storage like rbd need to wait before release volume - really?
2983
2984                     foreach my $volid (@$newvollist) {
2985                         eval { PVE::Storage::vdisk_free($storecfg, $volid); };
2986                         warn $@ if $@;
2987                     }
2988
2989                     PVE::Firewall::remove_vmfw_conf($newid);
2990
2991                     unlink $conffile; # avoid races -> last thing before die
2992
2993                     die "clone failed: $err";
2994                 }
2995
2996                 return;
2997             };
2998
2999             PVE::Firewall::clone_vmfw_conf($vmid, $newid);
3000
3001             return $rpcenv->fork_worker('qmclone', $vmid, $authuser, $realcmd);
3002         };
3003
3004         return PVE::QemuConfig->lock_config_mode($vmid, 1, $shared_lock, sub {
3005             # Aquire exclusive lock lock for $newid
3006             return PVE::QemuConfig->lock_config_full($newid, 1, $clonefn);
3007         });
3008
3009     }});
3010
3011 __PACKAGE__->register_method({
3012     name => 'move_vm_disk',
3013     path => '{vmid}/move_disk',
3014     method => 'POST',
3015     protected => 1,
3016     proxyto => 'node',
3017     description => "Move volume to different storage.",
3018     permissions => {
3019         description => "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage.",
3020         check => [ 'and',
3021                    ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
3022                    ['perm', '/storage/{storage}', [ 'Datastore.AllocateSpace' ]],
3023             ],
3024     },
3025     parameters => {
3026         additionalProperties => 0,
3027         properties => {
3028             node => get_standard_option('pve-node'),
3029             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3030             disk => {
3031                 type => 'string',
3032                 description => "The disk you want to move.",
3033                 enum => [PVE::QemuServer::Drive::valid_drive_names()],
3034             },
3035             storage => get_standard_option('pve-storage-id', {
3036                 description => "Target storage.",
3037                 completion => \&PVE::QemuServer::complete_storage,
3038             }),
3039             'format' => {
3040                 type => 'string',
3041                 description => "Target Format.",
3042                 enum => [ 'raw', 'qcow2', 'vmdk' ],
3043                 optional => 1,
3044             },
3045             delete => {
3046                 type => 'boolean',
3047                 description => "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
3048                 optional => 1,
3049                 default => 0,
3050             },
3051             digest => {
3052                 type => 'string',
3053                 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
3054                 maxLength => 40,
3055                 optional => 1,
3056             },
3057             bwlimit => {
3058                 description => "Override I/O bandwidth limit (in KiB/s).",
3059                 optional => 1,
3060                 type => 'integer',
3061                 minimum => '0',
3062                 default => 'move limit from datacenter or storage config',
3063             },
3064         },
3065     },
3066     returns => {
3067         type => 'string',
3068         description => "the task ID.",
3069     },
3070     code => sub {
3071         my ($param) = @_;
3072
3073         my $rpcenv = PVE::RPCEnvironment::get();
3074         my $authuser = $rpcenv->get_user();
3075
3076         my $node = extract_param($param, 'node');
3077         my $vmid = extract_param($param, 'vmid');
3078         my $digest = extract_param($param, 'digest');
3079         my $disk = extract_param($param, 'disk');
3080         my $storeid = extract_param($param, 'storage');
3081         my $format = extract_param($param, 'format');
3082
3083         my $storecfg = PVE::Storage::config();
3084
3085         my $updatefn =  sub {
3086             my $conf = PVE::QemuConfig->load_config($vmid);
3087             PVE::QemuConfig->check_lock($conf);
3088
3089             die "VM config checksum missmatch (file change by other user?)\n"
3090                 if $digest && $digest ne $conf->{digest};
3091
3092             die "disk '$disk' does not exist\n" if !$conf->{$disk};
3093
3094             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
3095
3096             die "disk '$disk' has no associated volume\n" if !$drive->{file};
3097             die "you can't move a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive, 1);
3098
3099             my $old_volid = $drive->{file};
3100             my $oldfmt;
3101             my ($oldstoreid, $oldvolname) = PVE::Storage::parse_volume_id($old_volid);
3102             if ($oldvolname =~ m/\.(raw|qcow2|vmdk)$/){
3103                 $oldfmt = $1;
3104             }
3105
3106             die "you can't move to the same storage with same format\n" if $oldstoreid eq $storeid &&
3107                 (!$format || !$oldfmt || $oldfmt eq $format);
3108
3109             # this only checks snapshots because $disk is passed!
3110             my $snapshotted = PVE::QemuServer::Drive::is_volume_in_use($storecfg, $conf, $disk, $old_volid);
3111             die "you can't move a disk with snapshots and delete the source\n"
3112                 if $snapshotted && $param->{delete};
3113
3114             PVE::Cluster::log_msg('info', $authuser, "move disk VM $vmid: move --disk $disk --storage $storeid");
3115
3116             my $running = PVE::QemuServer::check_running($vmid);
3117
3118             PVE::Storage::activate_volumes($storecfg, [ $drive->{file} ]);
3119
3120             my $realcmd = sub {
3121                 my $newvollist = [];
3122
3123                 eval {
3124                     local $SIG{INT} =
3125                         local $SIG{TERM} =
3126                         local $SIG{QUIT} =
3127                         local $SIG{HUP} = sub { die "interrupted by signal\n"; };
3128
3129                     warn "moving disk with snapshots, snapshots will not be moved!\n"
3130                         if $snapshotted;
3131
3132                     my $bwlimit = extract_param($param, 'bwlimit');
3133                     my $movelimit = PVE::Storage::get_bandwidth_limit('move', [$oldstoreid, $storeid], $bwlimit);
3134
3135                     my $newdrive = PVE::QemuServer::clone_disk($storecfg, $vmid, $running, $disk, $drive, undef,
3136                                                                $vmid, $storeid, $format, 1, $newvollist, undef, undef, undef, $movelimit);
3137
3138                     $conf->{$disk} = PVE::QemuServer::print_drive($newdrive);
3139
3140                     PVE::QemuConfig->add_unused_volume($conf, $old_volid) if !$param->{delete};
3141
3142                     # convert moved disk to base if part of template
3143                     PVE::QemuServer::template_create($vmid, $conf, $disk)
3144                         if PVE::QemuConfig->is_template($conf);
3145
3146                     PVE::QemuConfig->write_config($vmid, $conf);
3147
3148                     my $do_trim = PVE::QemuServer::parse_guest_agent($conf)->{fstrim_cloned_disks};
3149                     if ($running && $do_trim && PVE::QemuServer::qga_check_running($vmid)) {
3150                         eval { mon_cmd($vmid, "guest-fstrim") };
3151                     }
3152
3153                     eval {
3154                         # try to deactivate volumes - avoid lvm LVs to be active on several nodes
3155                         PVE::Storage::deactivate_volumes($storecfg, [ $newdrive->{file} ])
3156                             if !$running;
3157                     };
3158                     warn $@ if $@;
3159                 };
3160                 if (my $err = $@) {
3161                     foreach my $volid (@$newvollist) {
3162                         eval { PVE::Storage::vdisk_free($storecfg, $volid) };
3163                         warn $@ if $@;
3164                     }
3165                     die "storage migration failed: $err";
3166                 }
3167
3168                 if ($param->{delete}) {
3169                     eval {
3170                         PVE::Storage::deactivate_volumes($storecfg, [$old_volid]);
3171                         PVE::Storage::vdisk_free($storecfg, $old_volid);
3172                     };
3173                     warn $@ if $@;
3174                 }
3175             };
3176
3177             return $rpcenv->fork_worker('qmmove', $vmid, $authuser, $realcmd);
3178         };
3179
3180         return PVE::QemuConfig->lock_config($vmid, $updatefn);
3181     }});
3182
3183 my $check_vm_disks_local = sub {
3184     my ($storecfg, $vmconf, $vmid) = @_;
3185
3186     my $local_disks = {};
3187
3188     # add some more information to the disks e.g. cdrom
3189     PVE::QemuServer::foreach_volid($vmconf, sub {
3190         my ($volid, $attr) = @_;
3191
3192         my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
3193         if ($storeid) {
3194             my $scfg = PVE::Storage::storage_config($storecfg, $storeid);
3195             return if $scfg->{shared};
3196         }
3197         # The shared attr here is just a special case where the vdisk
3198         # is marked as shared manually
3199         return if $attr->{shared};
3200         return if $attr->{cdrom} and $volid eq "none";
3201
3202         if (exists $local_disks->{$volid}) {
3203             @{$local_disks->{$volid}}{keys %$attr} = values %$attr
3204         } else {
3205             $local_disks->{$volid} = $attr;
3206             # ensure volid is present in case it's needed
3207             $local_disks->{$volid}->{volid} = $volid;
3208         }
3209     });
3210
3211     return $local_disks;
3212 };
3213
3214 __PACKAGE__->register_method({
3215     name => 'migrate_vm_precondition',
3216     path => '{vmid}/migrate',
3217     method => 'GET',
3218     protected => 1,
3219     proxyto => 'node',
3220     description => "Get preconditions for migration.",
3221     permissions => {
3222         check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
3223     },
3224     parameters => {
3225         additionalProperties => 0,
3226         properties => {
3227             node => get_standard_option('pve-node'),
3228             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3229             target => get_standard_option('pve-node', {
3230                 description => "Target node.",
3231                 completion =>  \&PVE::Cluster::complete_migration_target,
3232                 optional => 1,
3233             }),
3234         },
3235     },
3236     returns => {
3237         type => "object",
3238         properties => {
3239             running => { type => 'boolean' },
3240             allowed_nodes => {
3241                 type => 'array',
3242                 optional => 1,
3243                 description => "List nodes allowed for offline migration, only passed if VM is offline"
3244             },
3245             not_allowed_nodes => {
3246                 type => 'object',
3247                 optional => 1,
3248                 description => "List not allowed nodes with additional informations, only passed if VM is offline"
3249             },
3250             local_disks => {
3251                 type => 'array',
3252                 description => "List local disks including CD-Rom, unsused and not referenced disks"
3253             },
3254             local_resources => {
3255                 type => 'array',
3256                 description => "List local resources e.g. pci, usb"
3257             }
3258         },
3259     },
3260     code => sub {
3261         my ($param) = @_;
3262
3263         my $rpcenv = PVE::RPCEnvironment::get();
3264
3265         my $authuser = $rpcenv->get_user();
3266
3267         PVE::Cluster::check_cfs_quorum();
3268
3269         my $res = {};
3270
3271         my $vmid = extract_param($param, 'vmid');
3272         my $target = extract_param($param, 'target');
3273         my $localnode = PVE::INotify::nodename();
3274
3275
3276         # test if VM exists
3277         my $vmconf = PVE::QemuConfig->load_config($vmid);
3278         my $storecfg = PVE::Storage::config();
3279
3280
3281         # try to detect errors early
3282         PVE::QemuConfig->check_lock($vmconf);
3283
3284         $res->{running} = PVE::QemuServer::check_running($vmid) ? 1:0;
3285
3286         # if vm is not running, return target nodes where local storage is available
3287         # for offline migration
3288         if (!$res->{running}) {
3289             $res->{allowed_nodes} = [];
3290             my $checked_nodes = PVE::QemuServer::check_local_storage_availability($vmconf, $storecfg);
3291             delete $checked_nodes->{$localnode};
3292
3293             foreach my $node (keys %$checked_nodes) {
3294                 if (!defined $checked_nodes->{$node}->{unavailable_storages}) {
3295                     push @{$res->{allowed_nodes}}, $node;
3296                 }
3297
3298             }
3299             $res->{not_allowed_nodes} = $checked_nodes;
3300         }
3301
3302
3303         my $local_disks = &$check_vm_disks_local($storecfg, $vmconf, $vmid);
3304         $res->{local_disks} = [ values %$local_disks ];;
3305
3306         my $local_resources =  PVE::QemuServer::check_local_resources($vmconf, 1);
3307
3308         $res->{local_resources} = $local_resources;
3309
3310         return $res;
3311
3312
3313     }});
3314
3315 __PACKAGE__->register_method({
3316     name => 'migrate_vm',
3317     path => '{vmid}/migrate',
3318     method => 'POST',
3319     protected => 1,
3320     proxyto => 'node',
3321     description => "Migrate virtual machine. Creates a new migration task.",
3322     permissions => {
3323         check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
3324     },
3325     parameters => {
3326         additionalProperties => 0,
3327         properties => {
3328             node => get_standard_option('pve-node'),
3329             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3330             target => get_standard_option('pve-node', {
3331                 description => "Target node.",
3332                 completion =>  \&PVE::Cluster::complete_migration_target,
3333             }),
3334             online => {
3335                 type => 'boolean',
3336                 description => "Use online/live migration if VM is running. Ignored if VM is stopped.",
3337                 optional => 1,
3338             },
3339             force => {
3340                 type => 'boolean',
3341                 description => "Allow to migrate VMs which use local devices. Only root may use this option.",
3342                 optional => 1,
3343             },
3344             migration_type => {
3345                 type => 'string',
3346                 enum => ['secure', 'insecure'],
3347                 description => "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
3348                 optional => 1,
3349             },
3350             migration_network => {
3351                 type => 'string', format => 'CIDR',
3352                 description => "CIDR of the (sub) network that is used for migration.",
3353                 optional => 1,
3354             },
3355             "with-local-disks" => {
3356                 type => 'boolean',
3357                 description => "Enable live storage migration for local disk",
3358                 optional => 1,
3359             },
3360             targetstorage => get_standard_option('pve-storage-id', {
3361                 description => "Default target storage.",
3362                 optional => 1,
3363                 completion => \&PVE::QemuServer::complete_migration_storage,
3364             }),
3365             bwlimit => {
3366                 description => "Override I/O bandwidth limit (in KiB/s).",
3367                 optional => 1,
3368                 type => 'integer',
3369                 minimum => '0',
3370                 default => 'migrate limit from datacenter or storage config',
3371             },
3372         },
3373     },
3374     returns => {
3375         type => 'string',
3376         description => "the task ID.",
3377     },
3378     code => sub {
3379         my ($param) = @_;
3380
3381         my $rpcenv = PVE::RPCEnvironment::get();
3382         my $authuser = $rpcenv->get_user();
3383
3384         my $target = extract_param($param, 'target');
3385
3386         my $localnode = PVE::INotify::nodename();
3387         raise_param_exc({ target => "target is local node."}) if $target eq $localnode;
3388
3389         PVE::Cluster::check_cfs_quorum();
3390
3391         PVE::Cluster::check_node_exists($target);
3392
3393         my $targetip = PVE::Cluster::remote_node_ip($target);
3394
3395         my $vmid = extract_param($param, 'vmid');
3396
3397         raise_param_exc({ force => "Only root may use this option." })
3398             if $param->{force} && $authuser ne 'root@pam';
3399
3400         raise_param_exc({ migration_type => "Only root may use this option." })
3401             if $param->{migration_type} && $authuser ne 'root@pam';
3402
3403         # allow root only until better network permissions are available
3404         raise_param_exc({ migration_network => "Only root may use this option." })
3405             if $param->{migration_network} && $authuser ne 'root@pam';
3406
3407         # test if VM exists
3408         my $conf = PVE::QemuConfig->load_config($vmid);
3409
3410         # try to detect errors early
3411
3412         PVE::QemuConfig->check_lock($conf);
3413
3414         if (PVE::QemuServer::check_running($vmid)) {
3415             die "can't migrate running VM without --online\n" if !$param->{online};
3416         } else {
3417             warn "VM isn't running. Doing offline migration instead.\n" if $param->{online};
3418             $param->{online} = 0;
3419         }
3420
3421         raise_param_exc({ targetstorage => "Live storage migration can only be done online." })
3422             if !$param->{online} && $param->{targetstorage};
3423
3424         my $storecfg = PVE::Storage::config();
3425
3426         if( $param->{targetstorage}) {
3427             PVE::Storage::storage_check_node($storecfg, $param->{targetstorage}, $target);
3428         } else {
3429             PVE::QemuServer::check_storage_availability($storecfg, $conf, $target);
3430         }
3431
3432         if (PVE::HA::Config::vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
3433
3434             my $hacmd = sub {
3435                 my $upid = shift;
3436
3437                 print "Requesting HA migration for VM $vmid to node $target\n";
3438
3439                 my $cmd = ['ha-manager', 'migrate', "vm:$vmid", $target];
3440                 PVE::Tools::run_command($cmd);
3441                 return;
3442             };
3443
3444             return $rpcenv->fork_worker('hamigrate', $vmid, $authuser, $hacmd);
3445
3446         } else {
3447
3448             my $realcmd = sub {
3449                 PVE::QemuMigrate->migrate($target, $targetip, $vmid, $param);
3450             };
3451
3452             my $worker = sub {
3453                 return PVE::GuestHelpers::guest_migration_lock($vmid, 10, $realcmd);
3454             };
3455
3456             return $rpcenv->fork_worker('qmigrate', $vmid, $authuser, $worker);
3457         }
3458
3459     }});
3460
3461 __PACKAGE__->register_method({
3462     name => 'monitor',
3463     path => '{vmid}/monitor',
3464     method => 'POST',
3465     protected => 1,
3466     proxyto => 'node',
3467     description => "Execute Qemu monitor commands.",
3468     permissions => {
3469         description => "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')",
3470         check => ['perm', '/vms/{vmid}', [ 'VM.Monitor' ]],
3471     },
3472     parameters => {
3473         additionalProperties => 0,
3474         properties => {
3475             node => get_standard_option('pve-node'),
3476             vmid => get_standard_option('pve-vmid'),
3477             command => {
3478                 type => 'string',
3479                 description => "The monitor command.",
3480             }
3481         },
3482     },
3483     returns => { type => 'string'},
3484     code => sub {
3485         my ($param) = @_;
3486
3487         my $rpcenv = PVE::RPCEnvironment::get();
3488         my $authuser = $rpcenv->get_user();
3489
3490         my $is_ro = sub {
3491             my $command = shift;
3492             return $command =~ m/^\s*info(\s+|$)/
3493                 || $command =~ m/^\s*help\s*$/;
3494         };
3495
3496         $rpcenv->check_full($authuser, "/", ['Sys.Modify'])
3497             if !&$is_ro($param->{command});
3498
3499         my $vmid = $param->{vmid};
3500
3501         my $conf = PVE::QemuConfig->load_config ($vmid); # check if VM exists
3502
3503         my $res = '';
3504         eval {
3505             $res = PVE::QemuServer::Monitor::hmp_cmd($vmid, $param->{command});
3506         };
3507         $res = "ERROR: $@" if $@;
3508
3509         return $res;
3510     }});
3511
3512 __PACKAGE__->register_method({
3513     name => 'resize_vm',
3514     path => '{vmid}/resize',
3515     method => 'PUT',
3516     protected => 1,
3517     proxyto => 'node',
3518     description => "Extend volume size.",
3519     permissions => {
3520         check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
3521     },
3522     parameters => {
3523         additionalProperties => 0,
3524         properties => {
3525             node => get_standard_option('pve-node'),
3526             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3527             skiplock => get_standard_option('skiplock'),
3528             disk => {
3529                 type => 'string',
3530                 description => "The disk you want to resize.",
3531                 enum => [PVE::QemuServer::Drive::valid_drive_names()],
3532             },
3533             size => {
3534                 type => 'string',
3535                 pattern => '\+?\d+(\.\d+)?[KMGT]?',
3536                 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.",
3537             },
3538             digest => {
3539                 type => 'string',
3540                 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
3541                 maxLength => 40,
3542                 optional => 1,
3543             },
3544         },
3545     },
3546     returns => { type => 'null'},
3547     code => sub {
3548         my ($param) = @_;
3549
3550         my $rpcenv = PVE::RPCEnvironment::get();
3551
3552         my $authuser = $rpcenv->get_user();
3553
3554         my $node = extract_param($param, 'node');
3555
3556         my $vmid = extract_param($param, 'vmid');
3557
3558         my $digest = extract_param($param, 'digest');
3559
3560         my $disk = extract_param($param, 'disk');
3561
3562         my $sizestr = extract_param($param, 'size');
3563
3564         my $skiplock = extract_param($param, 'skiplock');
3565         raise_param_exc({ skiplock => "Only root may use this option." })
3566             if $skiplock && $authuser ne 'root@pam';
3567
3568         my $storecfg = PVE::Storage::config();
3569
3570         my $updatefn =  sub {
3571
3572             my $conf = PVE::QemuConfig->load_config($vmid);
3573
3574             die "checksum missmatch (file change by other user?)\n"
3575                 if $digest && $digest ne $conf->{digest};
3576             PVE::QemuConfig->check_lock($conf) if !$skiplock;
3577
3578             die "disk '$disk' does not exist\n" if !$conf->{$disk};
3579
3580             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
3581
3582             my (undef, undef, undef, undef, undef, undef, $format) =
3583                 PVE::Storage::parse_volname($storecfg, $drive->{file});
3584
3585             die "can't resize volume: $disk if snapshot exists\n"
3586                 if %{$conf->{snapshots}} && $format eq 'qcow2';
3587
3588             my $volid = $drive->{file};
3589
3590             die "disk '$disk' has no associated volume\n" if !$volid;
3591
3592             die "you can't resize a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
3593
3594             my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
3595
3596             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
3597
3598             PVE::Storage::activate_volumes($storecfg, [$volid]);
3599             my $size = PVE::Storage::volume_size_info($storecfg, $volid, 5);
3600
3601             die "Could not determine current size of volume '$volid'\n" if !defined($size);
3602
3603             die "internal error" if $sizestr !~ m/^(\+)?(\d+(\.\d+)?)([KMGT])?$/;
3604             my ($ext, $newsize, $unit) = ($1, $2, $4);
3605             if ($unit) {
3606                 if ($unit eq 'K') {
3607                     $newsize = $newsize * 1024;
3608                 } elsif ($unit eq 'M') {
3609                     $newsize = $newsize * 1024 * 1024;
3610                 } elsif ($unit eq 'G') {
3611                     $newsize = $newsize * 1024 * 1024 * 1024;
3612                 } elsif ($unit eq 'T') {
3613                     $newsize = $newsize * 1024 * 1024 * 1024 * 1024;
3614                 }
3615             }
3616             $newsize += $size if $ext;
3617             $newsize = int($newsize);
3618
3619             die "shrinking disks is not supported\n" if $newsize < $size;
3620
3621             return if $size == $newsize;
3622
3623             PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: resize --disk $disk --size $sizestr");
3624
3625             PVE::QemuServer::qemu_block_resize($vmid, "drive-$disk", $storecfg, $volid, $newsize);
3626
3627             my $effective_size = eval { PVE::Storage::volume_size_info($storecfg, $volid, 3); };
3628             $drive->{size} = $effective_size // $newsize;
3629             $conf->{$disk} = PVE::QemuServer::print_drive($drive);
3630
3631             PVE::QemuConfig->write_config($vmid, $conf);
3632         };
3633
3634         PVE::QemuConfig->lock_config($vmid, $updatefn);
3635         return undef;
3636     }});
3637
3638 __PACKAGE__->register_method({
3639     name => 'snapshot_list',
3640     path => '{vmid}/snapshot',
3641     method => 'GET',
3642     description => "List all snapshots.",
3643     permissions => {
3644         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
3645     },
3646     proxyto => 'node',
3647     protected => 1, # qemu pid files are only readable by root
3648     parameters => {
3649         additionalProperties => 0,
3650         properties => {
3651             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3652             node => get_standard_option('pve-node'),
3653         },
3654     },
3655     returns => {
3656         type => 'array',
3657         items => {
3658             type => "object",
3659             properties => {
3660                 name => {
3661                     description => "Snapshot identifier. Value 'current' identifies the current VM.",
3662                     type => 'string',
3663                 },
3664                 vmstate => {
3665                     description => "Snapshot includes RAM.",
3666                     type => 'boolean',
3667                     optional => 1,
3668                 },
3669                 description => {
3670                     description => "Snapshot description.",
3671                     type => 'string',
3672                 },
3673                 snaptime => {
3674                     description => "Snapshot creation time",
3675                     type => 'integer',
3676                     renderer => 'timestamp',
3677                     optional => 1,
3678                 },
3679                 parent => {
3680                     description => "Parent snapshot identifier.",
3681                     type => 'string',
3682                     optional => 1,
3683                 },
3684             },
3685         },
3686         links => [ { rel => 'child', href => "{name}" } ],
3687     },
3688     code => sub {
3689         my ($param) = @_;
3690
3691         my $vmid = $param->{vmid};
3692
3693         my $conf = PVE::QemuConfig->load_config($vmid);
3694         my $snaphash = $conf->{snapshots} || {};
3695
3696         my $res = [];
3697
3698         foreach my $name (keys %$snaphash) {
3699             my $d = $snaphash->{$name};
3700             my $item = {
3701                 name => $name,
3702                 snaptime => $d->{snaptime} || 0,
3703                 vmstate => $d->{vmstate} ? 1 : 0,
3704                 description => $d->{description} || '',
3705             };
3706             $item->{parent} = $d->{parent} if $d->{parent};
3707             $item->{snapstate} = $d->{snapstate} if $d->{snapstate};
3708             push @$res, $item;
3709         }
3710
3711         my $running = PVE::QemuServer::check_running($vmid, 1) ? 1 : 0;
3712         my $current = {
3713             name => 'current',
3714             digest => $conf->{digest},
3715             running => $running,
3716             description => "You are here!",
3717         };
3718         $current->{parent} = $conf->{parent} if $conf->{parent};
3719
3720         push @$res, $current;
3721
3722         return $res;
3723     }});
3724
3725 __PACKAGE__->register_method({
3726     name => 'snapshot',
3727     path => '{vmid}/snapshot',
3728     method => 'POST',
3729     protected => 1,
3730     proxyto => 'node',
3731     description => "Snapshot a VM.",
3732     permissions => {
3733         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3734     },
3735     parameters => {
3736         additionalProperties => 0,
3737         properties => {
3738             node => get_standard_option('pve-node'),
3739             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3740             snapname => get_standard_option('pve-snapshot-name'),
3741             vmstate => {
3742                 optional => 1,
3743                 type => 'boolean',
3744                 description => "Save the vmstate",
3745             },
3746             description => {
3747                 optional => 1,
3748                 type => 'string',
3749                 description => "A textual description or comment.",
3750             },
3751         },
3752     },
3753     returns => {
3754         type => 'string',
3755         description => "the task ID.",
3756     },
3757     code => sub {
3758         my ($param) = @_;
3759
3760         my $rpcenv = PVE::RPCEnvironment::get();
3761
3762         my $authuser = $rpcenv->get_user();
3763
3764         my $node = extract_param($param, 'node');
3765
3766         my $vmid = extract_param($param, 'vmid');
3767
3768         my $snapname = extract_param($param, 'snapname');
3769
3770         die "unable to use snapshot name 'current' (reserved name)\n"
3771             if $snapname eq 'current';
3772
3773         die "unable to use snapshot name 'pending' (reserved name)\n"
3774             if lc($snapname) eq 'pending';
3775
3776         my $realcmd = sub {
3777             PVE::Cluster::log_msg('info', $authuser, "snapshot VM $vmid: $snapname");
3778             PVE::QemuConfig->snapshot_create($vmid, $snapname, $param->{vmstate},
3779                                              $param->{description});
3780         };
3781
3782         return $rpcenv->fork_worker('qmsnapshot', $vmid, $authuser, $realcmd);
3783     }});
3784
3785 __PACKAGE__->register_method({
3786     name => 'snapshot_cmd_idx',
3787     path => '{vmid}/snapshot/{snapname}',
3788     description => '',
3789     method => 'GET',
3790     permissions => {
3791         user => 'all',
3792     },
3793     parameters => {
3794         additionalProperties => 0,
3795         properties => {
3796             vmid => get_standard_option('pve-vmid'),
3797             node => get_standard_option('pve-node'),
3798             snapname => get_standard_option('pve-snapshot-name'),
3799         },
3800     },
3801     returns => {
3802         type => 'array',
3803         items => {
3804             type => "object",
3805             properties => {},
3806         },
3807         links => [ { rel => 'child', href => "{cmd}" } ],
3808     },
3809     code => sub {
3810         my ($param) = @_;
3811
3812         my $res = [];
3813
3814         push @$res, { cmd => 'rollback' };
3815         push @$res, { cmd => 'config' };
3816
3817         return $res;
3818     }});
3819
3820 __PACKAGE__->register_method({
3821     name => 'update_snapshot_config',
3822     path => '{vmid}/snapshot/{snapname}/config',
3823     method => 'PUT',
3824     protected => 1,
3825     proxyto => 'node',
3826     description => "Update snapshot metadata.",
3827     permissions => {
3828         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3829     },
3830     parameters => {
3831         additionalProperties => 0,
3832         properties => {
3833             node => get_standard_option('pve-node'),
3834             vmid => get_standard_option('pve-vmid'),
3835             snapname => get_standard_option('pve-snapshot-name'),
3836             description => {
3837                 optional => 1,
3838                 type => 'string',
3839                 description => "A textual description or comment.",
3840             },
3841         },
3842     },
3843     returns => { type => 'null' },
3844     code => sub {
3845         my ($param) = @_;
3846
3847         my $rpcenv = PVE::RPCEnvironment::get();
3848
3849         my $authuser = $rpcenv->get_user();
3850
3851         my $vmid = extract_param($param, 'vmid');
3852
3853         my $snapname = extract_param($param, 'snapname');
3854
3855         return undef if !defined($param->{description});
3856
3857         my $updatefn =  sub {
3858
3859             my $conf = PVE::QemuConfig->load_config($vmid);
3860
3861             PVE::QemuConfig->check_lock($conf);
3862
3863             my $snap = $conf->{snapshots}->{$snapname};
3864
3865             die "snapshot '$snapname' does not exist\n" if !defined($snap);
3866
3867             $snap->{description} = $param->{description} if defined($param->{description});
3868
3869              PVE::QemuConfig->write_config($vmid, $conf);
3870         };
3871
3872         PVE::QemuConfig->lock_config($vmid, $updatefn);
3873
3874         return undef;
3875     }});
3876
3877 __PACKAGE__->register_method({
3878     name => 'get_snapshot_config',
3879     path => '{vmid}/snapshot/{snapname}/config',
3880     method => 'GET',
3881     proxyto => 'node',
3882     description => "Get snapshot configuration",
3883     permissions => {
3884         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot', 'VM.Snapshot.Rollback', 'VM.Audit' ], any => 1],
3885     },
3886     parameters => {
3887         additionalProperties => 0,
3888         properties => {
3889             node => get_standard_option('pve-node'),
3890             vmid => get_standard_option('pve-vmid'),
3891             snapname => get_standard_option('pve-snapshot-name'),
3892         },
3893     },
3894     returns => { type => "object" },
3895     code => sub {
3896         my ($param) = @_;
3897
3898         my $rpcenv = PVE::RPCEnvironment::get();
3899
3900         my $authuser = $rpcenv->get_user();
3901
3902         my $vmid = extract_param($param, 'vmid');
3903
3904         my $snapname = extract_param($param, 'snapname');
3905
3906         my $conf = PVE::QemuConfig->load_config($vmid);
3907
3908         my $snap = $conf->{snapshots}->{$snapname};
3909
3910         die "snapshot '$snapname' does not exist\n" if !defined($snap);
3911
3912         return $snap;
3913     }});
3914
3915 __PACKAGE__->register_method({
3916     name => 'rollback',
3917     path => '{vmid}/snapshot/{snapname}/rollback',
3918     method => 'POST',
3919     protected => 1,
3920     proxyto => 'node',
3921     description => "Rollback VM state to specified snapshot.",
3922     permissions => {
3923         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot', 'VM.Snapshot.Rollback' ], any => 1],
3924     },
3925     parameters => {
3926         additionalProperties => 0,
3927         properties => {
3928             node => get_standard_option('pve-node'),
3929             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3930             snapname => get_standard_option('pve-snapshot-name'),
3931         },
3932     },
3933     returns => {
3934         type => 'string',
3935         description => "the task ID.",
3936     },
3937     code => sub {
3938         my ($param) = @_;
3939
3940         my $rpcenv = PVE::RPCEnvironment::get();
3941
3942         my $authuser = $rpcenv->get_user();
3943
3944         my $node = extract_param($param, 'node');
3945
3946         my $vmid = extract_param($param, 'vmid');
3947
3948         my $snapname = extract_param($param, 'snapname');
3949
3950         my $realcmd = sub {
3951             PVE::Cluster::log_msg('info', $authuser, "rollback snapshot VM $vmid: $snapname");
3952             PVE::QemuConfig->snapshot_rollback($vmid, $snapname);
3953         };
3954
3955         my $worker = sub {
3956             # hold migration lock, this makes sure that nobody create replication snapshots
3957             return PVE::GuestHelpers::guest_migration_lock($vmid, 10, $realcmd);
3958         };
3959
3960         return $rpcenv->fork_worker('qmrollback', $vmid, $authuser, $worker);
3961     }});
3962
3963 __PACKAGE__->register_method({
3964     name => 'delsnapshot',
3965     path => '{vmid}/snapshot/{snapname}',
3966     method => 'DELETE',
3967     protected => 1,
3968     proxyto => 'node',
3969     description => "Delete a VM snapshot.",
3970     permissions => {
3971         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3972     },
3973     parameters => {
3974         additionalProperties => 0,
3975         properties => {
3976             node => get_standard_option('pve-node'),
3977             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
3978             snapname => get_standard_option('pve-snapshot-name'),
3979             force => {
3980                 optional => 1,
3981                 type => 'boolean',
3982                 description => "For removal from config file, even if removing disk snapshots fails.",
3983             },
3984         },
3985     },
3986     returns => {
3987         type => 'string',
3988         description => "the task ID.",
3989     },
3990     code => sub {
3991         my ($param) = @_;
3992
3993         my $rpcenv = PVE::RPCEnvironment::get();
3994
3995         my $authuser = $rpcenv->get_user();
3996
3997         my $node = extract_param($param, 'node');
3998
3999         my $vmid = extract_param($param, 'vmid');
4000
4001         my $snapname = extract_param($param, 'snapname');
4002
4003         my $realcmd = sub {
4004             PVE::Cluster::log_msg('info', $authuser, "delete snapshot VM $vmid: $snapname");
4005             PVE::QemuConfig->snapshot_delete($vmid, $snapname, $param->{force});
4006         };
4007
4008         return $rpcenv->fork_worker('qmdelsnapshot', $vmid, $authuser, $realcmd);
4009     }});
4010
4011 __PACKAGE__->register_method({
4012     name => 'template',
4013     path => '{vmid}/template',
4014     method => 'POST',
4015     protected => 1,
4016     proxyto => 'node',
4017     description => "Create a Template.",
4018     permissions => {
4019         description => "You need 'VM.Allocate' permissions on /vms/{vmid}",
4020         check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
4021     },
4022     parameters => {
4023         additionalProperties => 0,
4024         properties => {
4025             node => get_standard_option('pve-node'),
4026             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid_stopped }),
4027             disk => {
4028                 optional => 1,
4029                 type => 'string',
4030                 description => "If you want to convert only 1 disk to base image.",
4031                 enum => [PVE::QemuServer::Drive::valid_drive_names()],
4032             },
4033
4034         },
4035     },
4036     returns => { type => 'null'},
4037     code => sub {
4038         my ($param) = @_;
4039
4040         my $rpcenv = PVE::RPCEnvironment::get();
4041
4042         my $authuser = $rpcenv->get_user();
4043
4044         my $node = extract_param($param, 'node');
4045
4046         my $vmid = extract_param($param, 'vmid');
4047
4048         my $disk = extract_param($param, 'disk');
4049
4050         my $updatefn =  sub {
4051
4052             my $conf = PVE::QemuConfig->load_config($vmid);
4053
4054             PVE::QemuConfig->check_lock($conf);
4055
4056             die "unable to create template, because VM contains snapshots\n"
4057                 if $conf->{snapshots} && scalar(keys %{$conf->{snapshots}});
4058
4059             die "you can't convert a template to a template\n"
4060                 if PVE::QemuConfig->is_template($conf) && !$disk;
4061
4062             die "you can't convert a VM to template if VM is running\n"
4063                 if PVE::QemuServer::check_running($vmid);
4064
4065             my $realcmd = sub {
4066                 PVE::QemuServer::template_create($vmid, $conf, $disk);
4067             };
4068
4069             $conf->{template} = 1;
4070             PVE::QemuConfig->write_config($vmid, $conf);
4071
4072             return $rpcenv->fork_worker('qmtemplate', $vmid, $authuser, $realcmd);
4073         };
4074
4075         PVE::QemuConfig->lock_config($vmid, $updatefn);
4076         return undef;
4077     }});
4078
4079 __PACKAGE__->register_method({
4080     name => 'cloudinit_generated_config_dump',
4081     path => '{vmid}/cloudinit/dump',
4082     method => 'GET',
4083     proxyto => 'node',
4084     description => "Get automatically generated cloudinit config.",
4085     permissions => {
4086         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
4087     },
4088     parameters => {
4089         additionalProperties => 0,
4090         properties => {
4091             node => get_standard_option('pve-node'),
4092             vmid => get_standard_option('pve-vmid', { completion => \&PVE::QemuServer::complete_vmid }),
4093             type => {
4094                 description => 'Config type.',
4095                 type => 'string',
4096                 enum => ['user', 'network', 'meta'],
4097             },
4098         },
4099     },
4100     returns => {
4101         type => 'string',
4102     },
4103     code => sub {
4104         my ($param) = @_;
4105
4106         my $conf = PVE::QemuConfig->load_config($param->{vmid});
4107
4108         return PVE::QemuServer::Cloudinit::dump_cloudinit_config($conf, $param->{vmid}, $param->{type});
4109     }});
4110
4111 1;