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