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