PVE/API2/Qemu.pm

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