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                 my $qmcmd = [@$remcmd, "/usr/sbin/qm", 'vncproxy', $vmid];
1342
1343                 my $qmstr = join(' ', @$qmcmd);
1344
1345                 # also redirect stderr (else we get RFB protocol errors)
1346                 $cmd = ['/bin/nc', '-l', '-p', $port, '-w', $timeout, '-c', "$qmstr 2>/dev/null"];
1347
1348                 if ($websocket) {
1349                     $ENV{LC_PVE_TICKET} = $ticket;
1350                     $cmd = ["/usr/share/novnc-pve/utils/wsproxy.py", '--run-once', "--timeout=$timeout", "--idle-timeout=$timeout", '--ssl-only', '--cert', '/etc/pve/local/pve-ssl.pem', '--key', '/etc/pve/local/pve-ssl.key', $port, '--', @$cmd];
1351                 }
1352             }
1353
1354             PVE::Tools::run_command($cmd);
1355
1356             return;
1357         };
1358
1359         my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd);
1360
1361         PVE::Tools::wait_for_vnc_port($port);
1362
1363         return {
1364             user => $authuser,
1365             ticket => $ticket,
1366             port => $port,
1367             upid => $upid,
1368             cert => $sslcert,
1369         };
1370     }});
1371
1372 __PACKAGE__->register_method({
1373     name => 'spiceproxy',
1374     path => '{vmid}/spiceproxy',
1375     method => 'POST',
1376     protected => 1,
1377     proxyto => 'node',
1378     permissions => {
1379         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1380     },
1381     description => "Returns a SPICE configuration to connect to the VM.",
1382     parameters => {
1383         additionalProperties => 0,
1384         properties => {
1385             node => get_standard_option('pve-node'),
1386             vmid => get_standard_option('pve-vmid'),
1387             proxy => get_standard_option('spice-proxy', { optional => 1 }),
1388         },
1389     },
1390     returns => get_standard_option('remote-viewer-config'),
1391     code => sub {
1392         my ($param) = @_;
1393
1394         my $rpcenv = PVE::RPCEnvironment::get();
1395
1396         my $authuser = $rpcenv->get_user();
1397
1398         my $vmid = $param->{vmid};
1399         my $node = $param->{node};
1400         my $proxy = $param->{proxy};
1401
1402     my $conf = PVE::QemuServer::load_config($vmid, $node);
1403     my $title = "VM $vmid - $conf->{'name'}",
1404
1405         my $port = PVE::QemuServer::spice_port($vmid);
1406
1407         my ($ticket, undef, $remote_viewer_config) =
1408             PVE::AccessControl::remote_viewer_config($authuser, $vmid, $node, $proxy, $title, $port);
1409
1410         PVE::QemuServer::vm_mon_cmd($vmid, "set_password", protocol => 'spice', password => $ticket);
1411         PVE::QemuServer::vm_mon_cmd($vmid, "expire_password", protocol => 'spice', time => "+30");
1412
1413         return $remote_viewer_config;
1414     }});
1415
1416 __PACKAGE__->register_method({
1417     name => 'vmcmdidx',
1418     path => '{vmid}/status',
1419     method => 'GET',
1420     proxyto => 'node',
1421     description => "Directory index",
1422     permissions => {
1423         user => 'all',
1424     },
1425     parameters => {
1426         additionalProperties => 0,
1427         properties => {
1428             node => get_standard_option('pve-node'),
1429             vmid => get_standard_option('pve-vmid'),
1430         },
1431     },
1432     returns => {
1433         type => 'array',
1434         items => {
1435             type => "object",
1436             properties => {
1437                 subdir => { type => 'string' },
1438             },
1439         },
1440         links => [ { rel => 'child', href => "{subdir}" } ],
1441     },
1442     code => sub {
1443         my ($param) = @_;
1444
1445         # test if VM exists
1446         my $conf = PVE::QemuServer::load_config($param->{vmid});
1447
1448         my $res = [
1449             { subdir => 'current' },
1450             { subdir => 'start' },
1451             { subdir => 'stop' },
1452             ];
1453
1454         return $res;
1455     }});
1456
1457 my $vm_is_ha_managed = sub {
1458     my ($vmid) = @_;
1459
1460     my $cc = PVE::Cluster::cfs_read_file('cluster.conf');
1461     if (PVE::Cluster::cluster_conf_lookup_pvevm($cc, 0, $vmid, 1)) {
1462         return 1;
1463     }
1464     return 0;
1465 };
1466
1467 __PACKAGE__->register_method({
1468     name => 'vm_status',
1469     path => '{vmid}/status/current',
1470     method => 'GET',
1471     proxyto => 'node',
1472     protected => 1, # qemu pid files are only readable by root
1473     description => "Get virtual machine status.",
1474     permissions => {
1475         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1476     },
1477     parameters => {
1478         additionalProperties => 0,
1479         properties => {
1480             node => get_standard_option('pve-node'),
1481             vmid => get_standard_option('pve-vmid'),
1482         },
1483     },
1484     returns => { type => 'object' },
1485     code => sub {
1486         my ($param) = @_;
1487
1488         # test if VM exists
1489         my $conf = PVE::QemuServer::load_config($param->{vmid});
1490
1491         my $vmstatus = PVE::QemuServer::vmstatus($param->{vmid}, 1);
1492         my $status = $vmstatus->{$param->{vmid}};
1493
1494         $status->{ha} = &$vm_is_ha_managed($param->{vmid});
1495
1496         $status->{spice} = 1 if PVE::QemuServer::vga_conf_has_spice($conf->{vga});
1497
1498         return $status;
1499     }});
1500
1501 __PACKAGE__->register_method({
1502     name => 'vm_start',
1503     path => '{vmid}/status/start',
1504     method => 'POST',
1505     protected => 1,
1506     proxyto => 'node',
1507     description => "Start virtual machine.",
1508     permissions => {
1509         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1510     },
1511     parameters => {
1512         additionalProperties => 0,
1513         properties => {
1514             node => get_standard_option('pve-node'),
1515             vmid => get_standard_option('pve-vmid'),
1516             skiplock => get_standard_option('skiplock'),
1517             stateuri => get_standard_option('pve-qm-stateuri'),
1518             migratedfrom => get_standard_option('pve-node',{ optional => 1 }),
1519             machine => get_standard_option('pve-qm-machine'),
1520         },
1521     },
1522     returns => {
1523         type => 'string',
1524     },
1525     code => sub {
1526         my ($param) = @_;
1527
1528         my $rpcenv = PVE::RPCEnvironment::get();
1529
1530         my $authuser = $rpcenv->get_user();
1531
1532         my $node = extract_param($param, 'node');
1533
1534         my $vmid = extract_param($param, 'vmid');
1535
1536         my $machine = extract_param($param, 'machine');
1537
1538         my $stateuri = extract_param($param, 'stateuri');
1539         raise_param_exc({ stateuri => "Only root may use this option." })
1540             if $stateuri && $authuser ne 'root@pam';
1541
1542         my $skiplock = extract_param($param, 'skiplock');
1543         raise_param_exc({ skiplock => "Only root may use this option." })
1544             if $skiplock && $authuser ne 'root@pam';
1545
1546         my $migratedfrom = extract_param($param, 'migratedfrom');
1547         raise_param_exc({ migratedfrom => "Only root may use this option." })
1548             if $migratedfrom && $authuser ne 'root@pam';
1549
1550         # read spice ticket from STDIN
1551         my $spice_ticket;
1552         if ($stateuri && ($stateuri eq 'tcp') && $migratedfrom && ($rpcenv->{type} eq 'cli')) {
1553             if (defined(my $line = <>)) {
1554                 chomp $line;
1555                 $spice_ticket = $line;
1556             }
1557         }
1558
1559         my $storecfg = PVE::Storage::config();
1560
1561         if (&$vm_is_ha_managed($vmid) && !$stateuri &&
1562             $rpcenv->{type} ne 'ha') {
1563
1564             my $hacmd = sub {
1565                 my $upid = shift;
1566
1567                 my $service = "pvevm:$vmid";
1568
1569                 my $cmd = ['clusvcadm', '-e', $service, '-m', $node];
1570
1571                 print "Executing HA start for VM $vmid\n";
1572
1573                 PVE::Tools::run_command($cmd);
1574
1575                 return;
1576             };
1577
1578             return $rpcenv->fork_worker('hastart', $vmid, $authuser, $hacmd);
1579
1580         } else {
1581
1582             my $realcmd = sub {
1583                 my $upid = shift;
1584
1585                 syslog('info', "start VM $vmid: $upid\n");
1586
1587                 PVE::QemuServer::vm_start($storecfg, $vmid, $stateuri, $skiplock, $migratedfrom, undef,
1588                                           $machine, $spice_ticket);
1589
1590                 return;
1591             };
1592
1593             return $rpcenv->fork_worker('qmstart', $vmid, $authuser, $realcmd);
1594         }
1595     }});
1596
1597 __PACKAGE__->register_method({
1598     name => 'vm_stop',
1599     path => '{vmid}/status/stop',
1600     method => 'POST',
1601     protected => 1,
1602     proxyto => 'node',
1603     description => "Stop virtual machine.",
1604     permissions => {
1605         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1606     },
1607     parameters => {
1608         additionalProperties => 0,
1609         properties => {
1610             node => get_standard_option('pve-node'),
1611             vmid => get_standard_option('pve-vmid'),
1612             skiplock => get_standard_option('skiplock'),
1613             migratedfrom => get_standard_option('pve-node',{ optional => 1 }),
1614             timeout => {
1615                 description => "Wait maximal timeout seconds.",
1616                 type => 'integer',
1617                 minimum => 0,
1618                 optional => 1,
1619             },
1620             keepActive => {
1621                 description => "Do not decativate storage volumes.",
1622                 type => 'boolean',
1623                 optional => 1,
1624                 default => 0,
1625             }
1626         },
1627     },
1628     returns => {
1629         type => 'string',
1630     },
1631     code => sub {
1632         my ($param) = @_;
1633
1634         my $rpcenv = PVE::RPCEnvironment::get();
1635
1636         my $authuser = $rpcenv->get_user();
1637
1638         my $node = extract_param($param, 'node');
1639
1640         my $vmid = extract_param($param, 'vmid');
1641
1642         my $skiplock = extract_param($param, 'skiplock');
1643         raise_param_exc({ skiplock => "Only root may use this option." })
1644             if $skiplock && $authuser ne 'root@pam';
1645
1646         my $keepActive = extract_param($param, 'keepActive');
1647         raise_param_exc({ keepActive => "Only root may use this option." })
1648             if $keepActive && $authuser ne 'root@pam';
1649
1650         my $migratedfrom = extract_param($param, 'migratedfrom');
1651         raise_param_exc({ migratedfrom => "Only root may use this option." })
1652             if $migratedfrom && $authuser ne 'root@pam';
1653
1654
1655         my $storecfg = PVE::Storage::config();
1656
1657         if (&$vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
1658
1659             my $hacmd = sub {
1660                 my $upid = shift;
1661
1662                 my $service = "pvevm:$vmid";
1663
1664                 my $cmd = ['clusvcadm', '-d', $service];
1665
1666                 print "Executing HA stop for VM $vmid\n";
1667
1668                 PVE::Tools::run_command($cmd);
1669
1670                 return;
1671             };
1672
1673             return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
1674
1675         } else {
1676             my $realcmd = sub {
1677                 my $upid = shift;
1678
1679                 syslog('info', "stop VM $vmid: $upid\n");
1680
1681                 PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
1682                                          $param->{timeout}, 0, 1, $keepActive, $migratedfrom);
1683
1684                 return;
1685             };
1686
1687             return $rpcenv->fork_worker('qmstop', $vmid, $authuser, $realcmd);
1688         }
1689     }});
1690
1691 __PACKAGE__->register_method({
1692     name => 'vm_reset',
1693     path => '{vmid}/status/reset',
1694     method => 'POST',
1695     protected => 1,
1696     proxyto => 'node',
1697     description => "Reset virtual machine.",
1698     permissions => {
1699         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1700     },
1701     parameters => {
1702         additionalProperties => 0,
1703         properties => {
1704             node => get_standard_option('pve-node'),
1705             vmid => get_standard_option('pve-vmid'),
1706             skiplock => get_standard_option('skiplock'),
1707         },
1708     },
1709     returns => {
1710         type => 'string',
1711     },
1712     code => sub {
1713         my ($param) = @_;
1714
1715         my $rpcenv = PVE::RPCEnvironment::get();
1716
1717         my $authuser = $rpcenv->get_user();
1718
1719         my $node = extract_param($param, 'node');
1720
1721         my $vmid = extract_param($param, 'vmid');
1722
1723         my $skiplock = extract_param($param, 'skiplock');
1724         raise_param_exc({ skiplock => "Only root may use this option." })
1725             if $skiplock && $authuser ne 'root@pam';
1726
1727         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
1728
1729         my $realcmd = sub {
1730             my $upid = shift;
1731
1732             PVE::QemuServer::vm_reset($vmid, $skiplock);
1733
1734             return;
1735         };
1736
1737         return $rpcenv->fork_worker('qmreset', $vmid, $authuser, $realcmd);
1738     }});
1739
1740 __PACKAGE__->register_method({
1741     name => 'vm_shutdown',
1742     path => '{vmid}/status/shutdown',
1743     method => 'POST',
1744     protected => 1,
1745     proxyto => 'node',
1746     description => "Shutdown virtual machine.",
1747     permissions => {
1748         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1749     },
1750     parameters => {
1751         additionalProperties => 0,
1752         properties => {
1753             node => get_standard_option('pve-node'),
1754             vmid => get_standard_option('pve-vmid'),
1755             skiplock => get_standard_option('skiplock'),
1756             timeout => {
1757                 description => "Wait maximal timeout seconds.",
1758                 type => 'integer',
1759                 minimum => 0,
1760                 optional => 1,
1761             },
1762             forceStop => {
1763                 description => "Make sure the VM stops.",
1764                 type => 'boolean',
1765                 optional => 1,
1766                 default => 0,
1767             },
1768             keepActive => {
1769                 description => "Do not decativate storage volumes.",
1770                 type => 'boolean',
1771                 optional => 1,
1772                 default => 0,
1773             }
1774         },
1775     },
1776     returns => {
1777         type => 'string',
1778     },
1779     code => sub {
1780         my ($param) = @_;
1781
1782         my $rpcenv = PVE::RPCEnvironment::get();
1783
1784         my $authuser = $rpcenv->get_user();
1785
1786         my $node = extract_param($param, 'node');
1787
1788         my $vmid = extract_param($param, 'vmid');
1789
1790         my $skiplock = extract_param($param, 'skiplock');
1791         raise_param_exc({ skiplock => "Only root may use this option." })
1792             if $skiplock && $authuser ne 'root@pam';
1793
1794         my $keepActive = extract_param($param, 'keepActive');
1795         raise_param_exc({ keepActive => "Only root may use this option." })
1796             if $keepActive && $authuser ne 'root@pam';
1797
1798         my $storecfg = PVE::Storage::config();
1799
1800         my $realcmd = sub {
1801             my $upid = shift;
1802
1803             syslog('info', "shutdown VM $vmid: $upid\n");
1804
1805             PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0, $param->{timeout},
1806                                      1, $param->{forceStop}, $keepActive);
1807
1808             return;
1809         };
1810
1811         return $rpcenv->fork_worker('qmshutdown', $vmid, $authuser, $realcmd);
1812     }});
1813
1814 __PACKAGE__->register_method({
1815     name => 'vm_suspend',
1816     path => '{vmid}/status/suspend',
1817     method => 'POST',
1818     protected => 1,
1819     proxyto => 'node',
1820     description => "Suspend virtual machine.",
1821     permissions => {
1822         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1823     },
1824     parameters => {
1825         additionalProperties => 0,
1826         properties => {
1827             node => get_standard_option('pve-node'),
1828             vmid => get_standard_option('pve-vmid'),
1829             skiplock => get_standard_option('skiplock'),
1830         },
1831     },
1832     returns => {
1833         type => 'string',
1834     },
1835     code => sub {
1836         my ($param) = @_;
1837
1838         my $rpcenv = PVE::RPCEnvironment::get();
1839
1840         my $authuser = $rpcenv->get_user();
1841
1842         my $node = extract_param($param, 'node');
1843
1844         my $vmid = extract_param($param, 'vmid');
1845
1846         my $skiplock = extract_param($param, 'skiplock');
1847         raise_param_exc({ skiplock => "Only root may use this option." })
1848             if $skiplock && $authuser ne 'root@pam';
1849
1850         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
1851
1852         my $realcmd = sub {
1853             my $upid = shift;
1854
1855             syslog('info', "suspend VM $vmid: $upid\n");
1856
1857             PVE::QemuServer::vm_suspend($vmid, $skiplock);
1858
1859             return;
1860         };
1861
1862         return $rpcenv->fork_worker('qmsuspend', $vmid, $authuser, $realcmd);
1863     }});
1864
1865 __PACKAGE__->register_method({
1866     name => 'vm_resume',
1867     path => '{vmid}/status/resume',
1868     method => 'POST',
1869     protected => 1,
1870     proxyto => 'node',
1871     description => "Resume virtual machine.",
1872     permissions => {
1873         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1874     },
1875     parameters => {
1876         additionalProperties => 0,
1877         properties => {
1878             node => get_standard_option('pve-node'),
1879             vmid => get_standard_option('pve-vmid'),
1880             skiplock => get_standard_option('skiplock'),
1881         },
1882     },
1883     returns => {
1884         type => 'string',
1885     },
1886     code => sub {
1887         my ($param) = @_;
1888
1889         my $rpcenv = PVE::RPCEnvironment::get();
1890
1891         my $authuser = $rpcenv->get_user();
1892
1893         my $node = extract_param($param, 'node');
1894
1895         my $vmid = extract_param($param, 'vmid');
1896
1897         my $skiplock = extract_param($param, 'skiplock');
1898         raise_param_exc({ skiplock => "Only root may use this option." })
1899             if $skiplock && $authuser ne 'root@pam';
1900
1901         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
1902
1903         my $realcmd = sub {
1904             my $upid = shift;
1905
1906             syslog('info', "resume VM $vmid: $upid\n");
1907
1908             PVE::QemuServer::vm_resume($vmid, $skiplock);
1909
1910             return;
1911         };
1912
1913         return $rpcenv->fork_worker('qmresume', $vmid, $authuser, $realcmd);
1914     }});
1915
1916 __PACKAGE__->register_method({
1917     name => 'vm_sendkey',
1918     path => '{vmid}/sendkey',
1919     method => 'PUT',
1920     protected => 1,
1921     proxyto => 'node',
1922     description => "Send key event to virtual machine.",
1923     permissions => {
1924         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1925     },
1926     parameters => {
1927         additionalProperties => 0,
1928         properties => {
1929             node => get_standard_option('pve-node'),
1930             vmid => get_standard_option('pve-vmid'),
1931             skiplock => get_standard_option('skiplock'),
1932             key => {
1933                 description => "The key (qemu monitor encoding).",
1934                 type => 'string'
1935             }
1936         },
1937     },
1938     returns => { type => 'null'},
1939     code => sub {
1940         my ($param) = @_;
1941
1942         my $rpcenv = PVE::RPCEnvironment::get();
1943
1944         my $authuser = $rpcenv->get_user();
1945
1946         my $node = extract_param($param, 'node');
1947
1948         my $vmid = extract_param($param, 'vmid');
1949
1950         my $skiplock = extract_param($param, 'skiplock');
1951         raise_param_exc({ skiplock => "Only root may use this option." })
1952             if $skiplock && $authuser ne 'root@pam';
1953
1954         PVE::QemuServer::vm_sendkey($vmid, $skiplock, $param->{key});
1955
1956         return;
1957     }});
1958
1959 __PACKAGE__->register_method({
1960     name => 'vm_feature',
1961     path => '{vmid}/feature',
1962     method => 'GET',
1963     proxyto => 'node',
1964     protected => 1,
1965     description => "Check if feature for virtual machine is available.",
1966     permissions => {
1967         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1968     },
1969     parameters => {
1970         additionalProperties => 0,
1971         properties => {
1972             node => get_standard_option('pve-node'),
1973             vmid => get_standard_option('pve-vmid'),
1974             feature => {
1975                 description => "Feature to check.",
1976                 type => 'string',
1977                 enum => [ 'snapshot', 'clone', 'copy' ],
1978             },
1979             snapname => get_standard_option('pve-snapshot-name', {
1980                 optional => 1,
1981             }),
1982         },
1983     },
1984     returns => {
1985         type => "object",
1986         properties => {
1987             hasFeature => { type => 'boolean' },
1988             nodes => {
1989                 type => 'array',
1990                 items => { type => 'string' },
1991             }
1992         },
1993     },
1994     code => sub {
1995         my ($param) = @_;
1996
1997         my $node = extract_param($param, 'node');
1998
1999         my $vmid = extract_param($param, 'vmid');
2000
2001         my $snapname = extract_param($param, 'snapname');
2002
2003         my $feature = extract_param($param, 'feature');
2004
2005         my $running = PVE::QemuServer::check_running($vmid);
2006
2007         my $conf = PVE::QemuServer::load_config($vmid);
2008
2009         if($snapname){
2010             my $snap = $conf->{snapshots}->{$snapname};
2011             die "snapshot '$snapname' does not exist\n" if !defined($snap);
2012             $conf = $snap;
2013         }
2014         my $storecfg = PVE::Storage::config();
2015
2016         my $nodelist = PVE::QemuServer::shared_nodes($conf, $storecfg);
2017         my $hasFeature = PVE::QemuServer::has_feature($feature, $conf, $storecfg, $snapname, $running);
2018
2019         return {
2020             hasFeature => $hasFeature,
2021             nodes => [ keys %$nodelist ],
2022         };
2023     }});
2024
2025 __PACKAGE__->register_method({
2026     name => 'clone_vm',
2027     path => '{vmid}/clone',
2028     method => 'POST',
2029     protected => 1,
2030     proxyto => 'node',
2031     description => "Create a copy of virtual machine/template.",
2032     permissions => {
2033         description => "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions " .
2034             "on /vms/{newid} (or on the VM pool /pool/{pool}). You also need " .
2035             "'Datastore.AllocateSpace' on any used storage.",
2036         check =>
2037         [ 'and',
2038           ['perm', '/vms/{vmid}', [ 'VM.Clone' ]],
2039           [ 'or',
2040             [ 'perm', '/vms/{newid}', ['VM.Allocate']],
2041             [ 'perm', '/pool/{pool}', ['VM.Allocate'], require_param => 'pool'],
2042           ],
2043         ]
2044     },
2045     parameters => {
2046         additionalProperties => 0,
2047         properties => {
2048             node => get_standard_option('pve-node'),
2049             vmid => get_standard_option('pve-vmid'),
2050             newid => get_standard_option('pve-vmid', { description => 'VMID for the clone.' }),
2051             name => {
2052                 optional => 1,
2053                 type => 'string', format => 'dns-name',
2054                 description => "Set a name for the new VM.",
2055             },
2056             description => {
2057                 optional => 1,
2058                 type => 'string',
2059                 description => "Description for the new VM.",
2060             },
2061             pool => {
2062                 optional => 1,
2063                 type => 'string', format => 'pve-poolid',
2064                 description => "Add the new VM to the specified pool.",
2065             },
2066             snapname => get_standard_option('pve-snapshot-name', {
2067                 requires => 'full',
2068                 optional => 1,
2069             }),
2070             storage => get_standard_option('pve-storage-id', {
2071                 description => "Target storage for full clone.",
2072                 requires => 'full',
2073                 optional => 1,
2074             }),
2075             'format' => {
2076                 description => "Target format for file storage.",
2077                 requires => 'full',
2078                 type => 'string',
2079                 optional => 1,
2080                 enum => [ 'raw', 'qcow2', 'vmdk'],
2081             },
2082             full => {
2083                 optional => 1,
2084                 type => 'boolean',
2085                 description => "Create a full copy of all disk. This is always done when " .
2086                     "you clone a normal VM. For VM templates, we try to create a linked clone by default.",
2087                 default => 0,
2088             },
2089             target => get_standard_option('pve-node', {
2090                 description => "Target node. Only allowed if the original VM is on shared storage.",
2091                 optional => 1,
2092             }),
2093         },
2094     },
2095     returns => {
2096         type => 'string',
2097     },
2098     code => sub {
2099         my ($param) = @_;
2100
2101         my $rpcenv = PVE::RPCEnvironment::get();
2102
2103         my $authuser = $rpcenv->get_user();
2104
2105         my $node = extract_param($param, 'node');
2106
2107         my $vmid = extract_param($param, 'vmid');
2108
2109         my $newid = extract_param($param, 'newid');
2110
2111         my $pool = extract_param($param, 'pool');
2112
2113         if (defined($pool)) {
2114             $rpcenv->check_pool_exist($pool);
2115         }
2116
2117         my $snapname = extract_param($param, 'snapname');
2118
2119         my $storage = extract_param($param, 'storage');
2120
2121         my $format = extract_param($param, 'format');
2122
2123         my $target = extract_param($param, 'target');
2124
2125         my $localnode = PVE::INotify::nodename();
2126
2127         undef $target if $target && ($target eq $localnode || $target eq 'localhost');
2128
2129         PVE::Cluster::check_node_exists($target) if $target;
2130
2131         my $storecfg = PVE::Storage::config();
2132
2133         if ($storage) {
2134             # check if storage is enabled on local node
2135             PVE::Storage::storage_check_enabled($storecfg, $storage);
2136             if ($target) {
2137                 # check if storage is available on target node
2138                 PVE::Storage::storage_check_node($storecfg, $storage, $target);
2139                 # clone only works if target storage is shared
2140                 my $scfg = PVE::Storage::storage_config($storecfg, $storage);
2141                 die "can't clone to non-shared storage '$storage'\n" if !$scfg->{shared};
2142             }
2143         }
2144
2145         PVE::Cluster::check_cfs_quorum();
2146
2147         my $running = PVE::QemuServer::check_running($vmid) || 0;
2148
2149         # exclusive lock if VM is running - else shared lock is enough;
2150         my $shared_lock = $running ? 0 : 1;
2151
2152         my $clonefn = sub {
2153
2154             # do all tests after lock
2155             # we also try to do all tests before we fork the worker
2156
2157             my $conf = PVE::QemuServer::load_config($vmid);
2158
2159             PVE::QemuServer::check_lock($conf);
2160
2161             my $verify_running = PVE::QemuServer::check_running($vmid) || 0;
2162
2163             die "unexpected state change\n" if $verify_running != $running;
2164
2165             die "snapshot '$snapname' does not exist\n"
2166                 if $snapname && !defined( $conf->{snapshots}->{$snapname});
2167
2168             my $oldconf = $snapname ? $conf->{snapshots}->{$snapname} : $conf;
2169
2170             my $sharedvm = &$check_storage_access_clone($rpcenv, $authuser, $storecfg, $oldconf, $storage);
2171
2172             die "can't clone VM to node '$target' (VM uses local storage)\n" if $target && !$sharedvm;
2173
2174             my $conffile = PVE::QemuServer::config_file($newid);
2175
2176             die "unable to create VM $newid: config file already exists\n"
2177                 if -f $conffile;
2178
2179             my $newconf = { lock => 'clone' };
2180             my $drives = {};
2181             my $vollist = [];
2182
2183             foreach my $opt (keys %$oldconf) {
2184                 my $value = $oldconf->{$opt};
2185
2186                 # do not copy snapshot related info
2187                 next if $opt eq 'snapshots' ||  $opt eq 'parent' || $opt eq 'snaptime' ||
2188                     $opt eq 'vmstate' || $opt eq 'snapstate';
2189
2190                 # always change MAC! address
2191                 if ($opt =~ m/^net(\d+)$/) {
2192                     my $net = PVE::QemuServer::parse_net($value);
2193                     $net->{macaddr} =  PVE::Tools::random_ether_addr();
2194                     $newconf->{$opt} = PVE::QemuServer::print_net($net);
2195                 } elsif (PVE::QemuServer::valid_drivename($opt)) {
2196                     my $drive = PVE::QemuServer::parse_drive($opt, $value);
2197                     die "unable to parse drive options for '$opt'\n" if !$drive;
2198                     if (PVE::QemuServer::drive_is_cdrom($drive)) {
2199                         $newconf->{$opt} = $value; # simply copy configuration
2200                     } else {
2201                         if ($param->{full} || !PVE::Storage::volume_is_base($storecfg,  $drive->{file})) {
2202                             die "Full clone feature is not available"
2203                                 if !PVE::Storage::volume_has_feature($storecfg, 'copy', $drive->{file}, $snapname, $running);
2204                             $drive->{full} = 1;
2205                         }
2206                         $drives->{$opt} = $drive;
2207                         push @$vollist, $drive->{file};
2208                     }
2209                 } else {
2210                     # copy everything else
2211                     $newconf->{$opt} = $value;
2212                 }
2213             }
2214
2215             delete $newconf->{template};
2216
2217             if ($param->{name}) {
2218                 $newconf->{name} = $param->{name};
2219             } else {
2220                 if ($oldconf->{name}) {
2221                     $newconf->{name} = "Copy-of-$oldconf->{name}";
2222                 } else {
2223                     $newconf->{name} = "Copy-of-VM-$vmid";
2224                 }
2225             }
2226
2227             if ($param->{description}) {
2228                 $newconf->{description} = $param->{description};
2229             }
2230
2231             # create empty/temp config - this fails if VM already exists on other node
2232             PVE::Tools::file_set_contents($conffile, "# qmclone temporary file\nlock: clone\n");
2233
2234             my $realcmd = sub {
2235                 my $upid = shift;
2236
2237                 my $newvollist = [];
2238
2239                 eval {
2240                     local $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = sub { die "interrupted by signal\n"; };
2241
2242                     PVE::Storage::activate_volumes($storecfg, $vollist);
2243
2244                     foreach my $opt (keys %$drives) {
2245                         my $drive = $drives->{$opt};
2246
2247                         my $newdrive = PVE::QemuServer::clone_disk($storecfg, $vmid, $running, $opt, $drive, $snapname,
2248                                                                    $newid, $storage, $format, $drive->{full}, $newvollist);
2249
2250                         $newconf->{$opt} = PVE::QemuServer::print_drive($vmid, $newdrive);
2251
2252                         PVE::QemuServer::update_config_nolock($newid, $newconf, 1);
2253                     }
2254
2255                     delete $newconf->{lock};
2256                     PVE::QemuServer::update_config_nolock($newid, $newconf, 1);
2257
2258                     if ($target) {
2259                         # always deactivate volumes - avoid lvm LVs to be active on several nodes
2260                         PVE::Storage::deactivate_volumes($storecfg, $vollist);
2261
2262                         my $newconffile = PVE::QemuServer::config_file($newid, $target);
2263                         die "Failed to move config to node '$target' - rename failed: $!\n"
2264                             if !rename($conffile, $newconffile);
2265                     }
2266
2267                     PVE::AccessControl::add_vm_to_pool($newid, $pool) if $pool;
2268                 };
2269                 if (my $err = $@) {
2270                     unlink $conffile;
2271
2272                     sleep 1; # some storage like rbd need to wait before release volume - really?
2273
2274                     foreach my $volid (@$newvollist) {
2275                         eval { PVE::Storage::vdisk_free($storecfg, $volid); };
2276                         warn $@ if $@;
2277                     }
2278                     die "clone failed: $err";
2279                 }
2280
2281                 return;
2282             };
2283
2284             return $rpcenv->fork_worker('qmclone', $vmid, $authuser, $realcmd);
2285         };
2286
2287         return PVE::QemuServer::lock_config_mode($vmid, 1, $shared_lock, sub {
2288             # Aquire exclusive lock lock for $newid
2289             return PVE::QemuServer::lock_config_full($newid, 1, $clonefn);
2290         });
2291
2292     }});
2293
2294 __PACKAGE__->register_method({
2295     name => 'move_vm_disk',
2296     path => '{vmid}/move_disk',
2297     method => 'POST',
2298     protected => 1,
2299     proxyto => 'node',
2300     description => "Move volume to different storage.",
2301     permissions => {
2302         description => "You need 'VM.Config.Disk' permissions on /vms/{vmid}, " .
2303             "and 'Datastore.AllocateSpace' permissions on the storage.",
2304         check =>
2305         [ 'and',
2306           ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
2307           ['perm', '/storage/{storage}', [ 'Datastore.AllocateSpace' ]],
2308         ],
2309     },
2310     parameters => {
2311         additionalProperties => 0,
2312         properties => {
2313             node => get_standard_option('pve-node'),
2314             vmid => get_standard_option('pve-vmid'),
2315             disk => {
2316                 type => 'string',
2317                 description => "The disk you want to move.",
2318                 enum => [ PVE::QemuServer::disknames() ],
2319             },
2320             storage => get_standard_option('pve-storage-id', { description => "Target Storage." }),
2321             'format' => {
2322                 type => 'string',
2323                 description => "Target Format.",
2324                 enum => [ 'raw', 'qcow2', 'vmdk' ],
2325                 optional => 1,
2326             },
2327             delete => {
2328                 type => 'boolean',
2329                 description => "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
2330                 optional => 1,
2331                 default => 0,
2332             },
2333             digest => {
2334                 type => 'string',
2335                 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
2336                 maxLength => 40,
2337                 optional => 1,
2338             },
2339         },
2340     },
2341     returns => {
2342         type => 'string',
2343         description => "the task ID.",
2344     },
2345     code => sub {
2346         my ($param) = @_;
2347
2348         my $rpcenv = PVE::RPCEnvironment::get();
2349
2350         my $authuser = $rpcenv->get_user();
2351
2352         my $node = extract_param($param, 'node');
2353
2354         my $vmid = extract_param($param, 'vmid');
2355
2356         my $digest = extract_param($param, 'digest');
2357
2358         my $disk = extract_param($param, 'disk');
2359
2360         my $storeid = extract_param($param, 'storage');
2361
2362         my $format = extract_param($param, 'format');
2363
2364         my $storecfg = PVE::Storage::config();
2365
2366         my $updatefn =  sub {
2367
2368             my $conf = PVE::QemuServer::load_config($vmid);
2369
2370             die "checksum missmatch (file change by other user?)\n"
2371                 if $digest && $digest ne $conf->{digest};
2372
2373             die "disk '$disk' does not exist\n" if !$conf->{$disk};
2374
2375             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
2376
2377             my $old_volid = $drive->{file} || die "disk '$disk' has no associated volume\n";
2378
2379             die "you can't move a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
2380
2381             my $oldfmt;
2382             my ($oldstoreid, $oldvolname) = PVE::Storage::parse_volume_id($old_volid);
2383             if ($oldvolname =~ m/\.(raw|qcow2|vmdk)$/){
2384                 $oldfmt = $1;
2385             }
2386
2387             die "you can't move on the same storage with same format\n" if $oldstoreid eq $storeid &&
2388                 (!$format || !$oldfmt || $oldfmt eq $format);
2389
2390             PVE::Cluster::log_msg('info', $authuser, "move disk VM $vmid: move --disk $disk --storage $storeid");
2391
2392             my $running = PVE::QemuServer::check_running($vmid);
2393
2394             PVE::Storage::activate_volumes($storecfg, [ $drive->{file} ]);
2395
2396             my $realcmd = sub {
2397
2398                 my $newvollist = [];
2399
2400                 eval {
2401                     local $SIG{INT} = $SIG{TERM} = $SIG{QUIT} = $SIG{HUP} = sub { die "interrupted by signal\n"; };
2402
2403                     my $newdrive = PVE::QemuServer::clone_disk($storecfg, $vmid, $running, $disk, $drive, undef,
2404                                                                $vmid, $storeid, $format, 1, $newvollist);
2405
2406                     $conf->{$disk} = PVE::QemuServer::print_drive($vmid, $newdrive);
2407
2408                     PVE::QemuServer::add_unused_volume($conf, $old_volid) if !$param->{delete};
2409
2410                     PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
2411
2412                     eval {
2413                         # try to deactivate volumes - avoid lvm LVs to be active on several nodes
2414                         PVE::Storage::deactivate_volumes($storecfg, [ $newdrive->{file} ])
2415                             if !$running;
2416                     };
2417                     warn $@ if $@;
2418                 };
2419                 if (my $err = $@) {
2420
2421                    foreach my $volid (@$newvollist) {
2422                         eval { PVE::Storage::vdisk_free($storecfg, $volid); };
2423                         warn $@ if $@;
2424                     }
2425                     die "storage migration failed: $err";
2426                 }
2427
2428                 if ($param->{delete}) {
2429                     my $used_paths = PVE::QemuServer::get_used_paths($vmid, $storecfg, $conf, 1, 1);
2430                     my $path = PVE::Storage::path($storecfg, $old_volid);
2431                     if ($used_paths->{$path}){
2432                         warn "volume $old_volid have snapshots. Can't delete it\n";
2433                         PVE::QemuServer::add_unused_volume($conf, $old_volid);
2434                         PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
2435                     } else {
2436                         eval { PVE::Storage::vdisk_free($storecfg, $old_volid); };
2437                         warn $@ if $@;
2438                     }
2439                 }
2440             };
2441
2442             return $rpcenv->fork_worker('qmmove', $vmid, $authuser, $realcmd);
2443         };
2444
2445         return PVE::QemuServer::lock_config($vmid, $updatefn);
2446     }});
2447
2448 __PACKAGE__->register_method({
2449     name => 'migrate_vm',
2450     path => '{vmid}/migrate',
2451     method => 'POST',
2452     protected => 1,
2453     proxyto => 'node',
2454     description => "Migrate virtual machine. Creates a new migration task.",
2455     permissions => {
2456         check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
2457     },
2458     parameters => {
2459         additionalProperties => 0,
2460         properties => {
2461             node => get_standard_option('pve-node'),
2462             vmid => get_standard_option('pve-vmid'),
2463             target => get_standard_option('pve-node', { description => "Target node." }),
2464             online => {
2465                 type => 'boolean',
2466                 description => "Use online/live migration.",
2467                 optional => 1,
2468             },
2469             force => {
2470                 type => 'boolean',
2471                 description => "Allow to migrate VMs which use local devices. Only root may use this option.",
2472                 optional => 1,
2473             },
2474         },
2475     },
2476     returns => {
2477         type => 'string',
2478         description => "the task ID.",
2479     },
2480     code => sub {
2481         my ($param) = @_;
2482
2483         my $rpcenv = PVE::RPCEnvironment::get();
2484
2485         my $authuser = $rpcenv->get_user();
2486
2487         my $target = extract_param($param, 'target');
2488
2489         my $localnode = PVE::INotify::nodename();
2490         raise_param_exc({ target => "target is local node."}) if $target eq $localnode;
2491
2492         PVE::Cluster::check_cfs_quorum();
2493
2494         PVE::Cluster::check_node_exists($target);
2495
2496         my $targetip = PVE::Cluster::remote_node_ip($target);
2497
2498         my $vmid = extract_param($param, 'vmid');
2499
2500         raise_param_exc({ force => "Only root may use this option." })
2501             if $param->{force} && $authuser ne 'root@pam';
2502
2503         # test if VM exists
2504         my $conf = PVE::QemuServer::load_config($vmid);
2505
2506         # try to detect errors early
2507
2508         PVE::QemuServer::check_lock($conf);
2509
2510         if (PVE::QemuServer::check_running($vmid)) {
2511             die "cant migrate running VM without --online\n"
2512                 if !$param->{online};
2513         }
2514
2515         my $storecfg = PVE::Storage::config();
2516         PVE::QemuServer::check_storage_availability($storecfg, $conf, $target);
2517
2518         if (&$vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
2519
2520             my $hacmd = sub {
2521                 my $upid = shift;
2522
2523                 my $service = "pvevm:$vmid";
2524
2525                 my $cmd = ['clusvcadm', '-M', $service, '-m', $target];
2526
2527                 print "Executing HA migrate for VM $vmid to node $target\n";
2528
2529                 PVE::Tools::run_command($cmd);
2530
2531                 return;
2532             };
2533
2534             return $rpcenv->fork_worker('hamigrate', $vmid, $authuser, $hacmd);
2535
2536         } else {
2537
2538             my $realcmd = sub {
2539                 my $upid = shift;
2540
2541                 PVE::QemuMigrate->migrate($target, $targetip, $vmid, $param);
2542             };
2543
2544             return $rpcenv->fork_worker('qmigrate', $vmid, $authuser, $realcmd);
2545         }
2546
2547     }});
2548
2549 __PACKAGE__->register_method({
2550     name => 'monitor',
2551     path => '{vmid}/monitor',
2552     method => 'POST',
2553     protected => 1,
2554     proxyto => 'node',
2555     description => "Execute Qemu monitor commands.",
2556     permissions => {
2557         check => ['perm', '/vms/{vmid}', [ 'VM.Monitor' ]],
2558     },
2559     parameters => {
2560         additionalProperties => 0,
2561         properties => {
2562             node => get_standard_option('pve-node'),
2563             vmid => get_standard_option('pve-vmid'),
2564             command => {
2565                 type => 'string',
2566                 description => "The monitor command.",
2567             }
2568         },
2569     },
2570     returns => { type => 'string'},
2571     code => sub {
2572         my ($param) = @_;
2573
2574         my $vmid = $param->{vmid};
2575
2576         my $conf = PVE::QemuServer::load_config ($vmid); # check if VM exists
2577
2578         my $res = '';
2579         eval {
2580             $res = PVE::QemuServer::vm_human_monitor_command($vmid, $param->{command});
2581         };
2582         $res = "ERROR: $@" if $@;
2583
2584         return $res;
2585     }});
2586
2587 __PACKAGE__->register_method({
2588     name => 'resize_vm',
2589     path => '{vmid}/resize',
2590     method => 'PUT',
2591     protected => 1,
2592     proxyto => 'node',
2593     description => "Extend volume size.",
2594     permissions => {
2595         check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
2596     },
2597     parameters => {
2598         additionalProperties => 0,
2599         properties => {
2600             node => get_standard_option('pve-node'),
2601             vmid => get_standard_option('pve-vmid'),
2602             skiplock => get_standard_option('skiplock'),
2603             disk => {
2604                 type => 'string',
2605                 description => "The disk you want to resize.",
2606                 enum => [PVE::QemuServer::disknames()],
2607             },
2608             size => {
2609                 type => 'string',
2610                 pattern => '\+?\d+(\.\d+)?[KMGT]?',
2611                 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.",
2612             },
2613             digest => {
2614                 type => 'string',
2615                 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
2616                 maxLength => 40,
2617                 optional => 1,
2618             },
2619         },
2620     },
2621     returns => { type => 'null'},
2622     code => sub {
2623         my ($param) = @_;
2624
2625         my $rpcenv = PVE::RPCEnvironment::get();
2626
2627         my $authuser = $rpcenv->get_user();
2628
2629         my $node = extract_param($param, 'node');
2630
2631         my $vmid = extract_param($param, 'vmid');
2632
2633         my $digest = extract_param($param, 'digest');
2634
2635         my $disk = extract_param($param, 'disk');
2636
2637         my $sizestr = extract_param($param, 'size');
2638
2639         my $skiplock = extract_param($param, 'skiplock');
2640         raise_param_exc({ skiplock => "Only root may use this option." })
2641             if $skiplock && $authuser ne 'root@pam';
2642
2643         my $storecfg = PVE::Storage::config();
2644
2645         my $updatefn =  sub {
2646
2647             my $conf = PVE::QemuServer::load_config($vmid);
2648
2649             die "checksum missmatch (file change by other user?)\n"
2650                 if $digest && $digest ne $conf->{digest};
2651             PVE::QemuServer::check_lock($conf) if !$skiplock;
2652
2653             die "disk '$disk' does not exist\n" if !$conf->{$disk};
2654
2655             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
2656
2657             my $volid = $drive->{file};
2658
2659             die "disk '$disk' has no associated volume\n" if !$volid;
2660
2661             die "you can't resize a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
2662
2663             die "you can't online resize a virtio windows bootdisk\n"
2664                 if PVE::QemuServer::check_running($vmid) && $conf->{bootdisk} eq $disk && $conf->{ostype} =~ m/^w/ && $disk =~ m/^virtio/;
2665
2666             my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
2667
2668             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
2669
2670             my $size = PVE::Storage::volume_size_info($storecfg, $volid, 5);
2671
2672             die "internal error" if $sizestr !~ m/^(\+)?(\d+(\.\d+)?)([KMGT])?$/;
2673             my ($ext, $newsize, $unit) = ($1, $2, $4);
2674             if ($unit) {
2675                 if ($unit eq 'K') {
2676                     $newsize = $newsize * 1024;
2677                 } elsif ($unit eq 'M') {
2678                     $newsize = $newsize * 1024 * 1024;
2679                 } elsif ($unit eq 'G') {
2680                     $newsize = $newsize * 1024 * 1024 * 1024;
2681                 } elsif ($unit eq 'T') {
2682                     $newsize = $newsize * 1024 * 1024 * 1024 * 1024;
2683                 }
2684             }
2685             $newsize += $size if $ext;
2686             $newsize = int($newsize);
2687
2688             die "unable to skrink disk size\n" if $newsize < $size;
2689
2690             return if $size == $newsize;
2691
2692             PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: resize --disk $disk --size $sizestr");
2693
2694             PVE::QemuServer::qemu_block_resize($vmid, "drive-$disk", $storecfg, $volid, $newsize);
2695
2696             $drive->{size} = $newsize;
2697             $conf->{$disk} = PVE::QemuServer::print_drive($vmid, $drive);
2698
2699             PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
2700         };
2701
2702         PVE::QemuServer::lock_config($vmid, $updatefn);
2703         return undef;
2704     }});
2705
2706 __PACKAGE__->register_method({
2707     name => 'snapshot_list',
2708     path => '{vmid}/snapshot',
2709     method => 'GET',
2710     description => "List all snapshots.",
2711     permissions => {
2712         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
2713     },
2714     proxyto => 'node',
2715     protected => 1, # qemu pid files are only readable by root
2716     parameters => {
2717         additionalProperties => 0,
2718         properties => {
2719             vmid => get_standard_option('pve-vmid'),
2720             node => get_standard_option('pve-node'),
2721         },
2722     },
2723     returns => {
2724         type => 'array',
2725         items => {
2726             type => "object",
2727             properties => {},
2728         },
2729         links => [ { rel => 'child', href => "{name}" } ],
2730     },
2731     code => sub {
2732         my ($param) = @_;
2733
2734         my $vmid = $param->{vmid};
2735
2736         my $conf = PVE::QemuServer::load_config($vmid);
2737         my $snaphash = $conf->{snapshots} || {};
2738
2739         my $res = [];
2740
2741         foreach my $name (keys %$snaphash) {
2742             my $d = $snaphash->{$name};
2743             my $item = {
2744                 name => $name,
2745                 snaptime => $d->{snaptime} || 0,
2746                 vmstate => $d->{vmstate} ? 1 : 0,
2747                 description => $d->{description} || '',
2748             };
2749             $item->{parent} = $d->{parent} if $d->{parent};
2750             $item->{snapstate} = $d->{snapstate} if $d->{snapstate};
2751             push @$res, $item;
2752         }
2753
2754         my $running = PVE::QemuServer::check_running($vmid, 1) ? 1 : 0;
2755         my $current = { name => 'current', digest => $conf->{digest}, running => $running };
2756         $current->{parent} = $conf->{parent} if $conf->{parent};
2757
2758         push @$res, $current;
2759
2760         return $res;
2761     }});
2762
2763 __PACKAGE__->register_method({
2764     name => 'snapshot',
2765     path => '{vmid}/snapshot',
2766     method => 'POST',
2767     protected => 1,
2768     proxyto => 'node',
2769     description => "Snapshot a VM.",
2770     permissions => {
2771         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
2772     },
2773     parameters => {
2774         additionalProperties => 0,
2775         properties => {
2776             node => get_standard_option('pve-node'),
2777             vmid => get_standard_option('pve-vmid'),
2778             snapname => get_standard_option('pve-snapshot-name'),
2779             vmstate => {
2780                 optional => 1,
2781                 type => 'boolean',
2782                 description => "Save the vmstate",
2783             },
2784             freezefs => {
2785                 optional => 1,
2786                 type => 'boolean',
2787                 description => "Freeze the filesystem",
2788             },
2789             description => {
2790                 optional => 1,
2791                 type => 'string',
2792                 description => "A textual description or comment.",
2793             },
2794         },
2795     },
2796     returns => {
2797         type => 'string',
2798         description => "the task ID.",
2799     },
2800     code => sub {
2801         my ($param) = @_;
2802
2803         my $rpcenv = PVE::RPCEnvironment::get();
2804
2805         my $authuser = $rpcenv->get_user();
2806
2807         my $node = extract_param($param, 'node');
2808
2809         my $vmid = extract_param($param, 'vmid');
2810
2811         my $snapname = extract_param($param, 'snapname');
2812
2813         die "unable to use snapshot name 'current' (reserved name)\n"
2814             if $snapname eq 'current';
2815
2816         my $realcmd = sub {
2817             PVE::Cluster::log_msg('info', $authuser, "snapshot VM $vmid: $snapname");
2818             PVE::QemuServer::snapshot_create($vmid, $snapname, $param->{vmstate},
2819                                              $param->{freezefs}, $param->{description});
2820         };
2821
2822         return $rpcenv->fork_worker('qmsnapshot', $vmid, $authuser, $realcmd);
2823     }});
2824
2825 __PACKAGE__->register_method({
2826     name => 'snapshot_cmd_idx',
2827     path => '{vmid}/snapshot/{snapname}',
2828     description => '',
2829     method => 'GET',
2830     permissions => {
2831         user => 'all',
2832     },
2833     parameters => {
2834         additionalProperties => 0,
2835         properties => {
2836             vmid => get_standard_option('pve-vmid'),
2837             node => get_standard_option('pve-node'),
2838             snapname => get_standard_option('pve-snapshot-name'),
2839         },
2840     },
2841     returns => {
2842         type => 'array',
2843         items => {
2844             type => "object",
2845             properties => {},
2846         },
2847         links => [ { rel => 'child', href => "{cmd}" } ],
2848     },
2849     code => sub {
2850         my ($param) = @_;
2851
2852         my $res = [];
2853
2854         push @$res, { cmd => 'rollback' };
2855         push @$res, { cmd => 'config' };
2856
2857         return $res;
2858     }});
2859
2860 __PACKAGE__->register_method({
2861     name => 'update_snapshot_config',
2862     path => '{vmid}/snapshot/{snapname}/config',
2863     method => 'PUT',
2864     protected => 1,
2865     proxyto => 'node',
2866     description => "Update snapshot metadata.",
2867     permissions => {
2868         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
2869     },
2870     parameters => {
2871         additionalProperties => 0,
2872         properties => {
2873             node => get_standard_option('pve-node'),
2874             vmid => get_standard_option('pve-vmid'),
2875             snapname => get_standard_option('pve-snapshot-name'),
2876             description => {
2877                 optional => 1,
2878                 type => 'string',
2879                 description => "A textual description or comment.",
2880             },
2881         },
2882     },
2883     returns => { type => 'null' },
2884     code => sub {
2885         my ($param) = @_;
2886
2887         my $rpcenv = PVE::RPCEnvironment::get();
2888
2889         my $authuser = $rpcenv->get_user();
2890
2891         my $vmid = extract_param($param, 'vmid');
2892
2893         my $snapname = extract_param($param, 'snapname');
2894
2895         return undef if !defined($param->{description});
2896
2897         my $updatefn =  sub {
2898
2899             my $conf = PVE::QemuServer::load_config($vmid);
2900
2901             PVE::QemuServer::check_lock($conf);
2902
2903             my $snap = $conf->{snapshots}->{$snapname};
2904
2905             die "snapshot '$snapname' does not exist\n" if !defined($snap);
2906
2907             $snap->{description} = $param->{description} if defined($param->{description});
2908
2909              PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
2910         };
2911
2912         PVE::QemuServer::lock_config($vmid, $updatefn);
2913
2914         return undef;
2915     }});
2916
2917 __PACKAGE__->register_method({
2918     name => 'get_snapshot_config',
2919     path => '{vmid}/snapshot/{snapname}/config',
2920     method => 'GET',
2921     proxyto => 'node',
2922     description => "Get snapshot configuration",
2923     permissions => {
2924         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
2925     },
2926     parameters => {
2927         additionalProperties => 0,
2928         properties => {
2929             node => get_standard_option('pve-node'),
2930             vmid => get_standard_option('pve-vmid'),
2931             snapname => get_standard_option('pve-snapshot-name'),
2932         },
2933     },
2934     returns => { type => "object" },
2935     code => sub {
2936         my ($param) = @_;
2937
2938         my $rpcenv = PVE::RPCEnvironment::get();
2939
2940         my $authuser = $rpcenv->get_user();
2941
2942         my $vmid = extract_param($param, 'vmid');
2943
2944         my $snapname = extract_param($param, 'snapname');
2945
2946         my $conf = PVE::QemuServer::load_config($vmid);
2947
2948         my $snap = $conf->{snapshots}->{$snapname};
2949
2950         die "snapshot '$snapname' does not exist\n" if !defined($snap);
2951
2952         return $snap;
2953     }});
2954
2955 __PACKAGE__->register_method({
2956     name => 'rollback',
2957     path => '{vmid}/snapshot/{snapname}/rollback',
2958     method => 'POST',
2959     protected => 1,
2960     proxyto => 'node',
2961     description => "Rollback VM state to specified snapshot.",
2962     permissions => {
2963         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
2964     },
2965     parameters => {
2966         additionalProperties => 0,
2967         properties => {
2968             node => get_standard_option('pve-node'),
2969             vmid => get_standard_option('pve-vmid'),
2970             snapname => get_standard_option('pve-snapshot-name'),
2971         },
2972     },
2973     returns => {
2974         type => 'string',
2975         description => "the task ID.",
2976     },
2977     code => sub {
2978         my ($param) = @_;
2979
2980         my $rpcenv = PVE::RPCEnvironment::get();
2981
2982         my $authuser = $rpcenv->get_user();
2983
2984         my $node = extract_param($param, 'node');
2985
2986         my $vmid = extract_param($param, 'vmid');
2987
2988         my $snapname = extract_param($param, 'snapname');
2989
2990         my $realcmd = sub {
2991             PVE::Cluster::log_msg('info', $authuser, "rollback snapshot VM $vmid: $snapname");
2992             PVE::QemuServer::snapshot_rollback($vmid, $snapname);
2993         };
2994
2995         return $rpcenv->fork_worker('qmrollback', $vmid, $authuser, $realcmd);
2996     }});
2997
2998 __PACKAGE__->register_method({
2999     name => 'delsnapshot',
3000     path => '{vmid}/snapshot/{snapname}',
3001     method => 'DELETE',
3002     protected => 1,
3003     proxyto => 'node',
3004     description => "Delete a VM snapshot.",
3005     permissions => {
3006         check => ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3007     },
3008     parameters => {
3009         additionalProperties => 0,
3010         properties => {
3011             node => get_standard_option('pve-node'),
3012             vmid => get_standard_option('pve-vmid'),
3013             snapname => get_standard_option('pve-snapshot-name'),
3014             force => {
3015                 optional => 1,
3016                 type => 'boolean',
3017                 description => "For removal from config file, even if removing disk snapshots fails.",
3018             },
3019         },
3020     },
3021     returns => {
3022         type => 'string',
3023         description => "the task ID.",
3024     },
3025     code => sub {
3026         my ($param) = @_;
3027
3028         my $rpcenv = PVE::RPCEnvironment::get();
3029
3030         my $authuser = $rpcenv->get_user();
3031
3032         my $node = extract_param($param, 'node');
3033
3034         my $vmid = extract_param($param, 'vmid');
3035
3036         my $snapname = extract_param($param, 'snapname');
3037
3038         my $realcmd = sub {
3039             PVE::Cluster::log_msg('info', $authuser, "delete snapshot VM $vmid: $snapname");
3040             PVE::QemuServer::snapshot_delete($vmid, $snapname, $param->{force});
3041         };
3042
3043         return $rpcenv->fork_worker('qmdelsnapshot', $vmid, $authuser, $realcmd);
3044     }});
3045
3046 __PACKAGE__->register_method({
3047     name => 'template',
3048     path => '{vmid}/template',
3049     method => 'POST',
3050     protected => 1,
3051     proxyto => 'node',
3052     description => "Create a Template.",
3053     permissions => {
3054         description => "You need 'VM.Allocate' permissions on /vms/{vmid}",
3055         check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
3056     },
3057     parameters => {
3058         additionalProperties => 0,
3059         properties => {
3060             node => get_standard_option('pve-node'),
3061             vmid => get_standard_option('pve-vmid'),
3062             disk => {
3063                 optional => 1,
3064                 type => 'string',
3065                 description => "If you want to convert only 1 disk to base image.",
3066                 enum => [PVE::QemuServer::disknames()],
3067             },
3068
3069         },
3070     },
3071     returns => { type => 'null'},
3072     code => sub {
3073         my ($param) = @_;
3074
3075         my $rpcenv = PVE::RPCEnvironment::get();
3076
3077         my $authuser = $rpcenv->get_user();
3078
3079         my $node = extract_param($param, 'node');
3080
3081         my $vmid = extract_param($param, 'vmid');
3082
3083         my $disk = extract_param($param, 'disk');
3084
3085         my $updatefn =  sub {
3086
3087             my $conf = PVE::QemuServer::load_config($vmid);
3088
3089             PVE::QemuServer::check_lock($conf);
3090
3091             die "unable to create template, because VM contains snapshots\n"
3092                 if $conf->{snapshots} && scalar(keys %{$conf->{snapshots}});
3093
3094             die "you can't convert a template to a template\n"
3095                 if PVE::QemuServer::is_template($conf) && !$disk;
3096
3097             die "you can't convert a VM to template if VM is running\n"
3098                 if PVE::QemuServer::check_running($vmid);
3099
3100             my $realcmd = sub {
3101                 PVE::QemuServer::template_create($vmid, $conf, $disk);
3102             };
3103
3104             $conf->{template} = 1;
3105             PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
3106
3107             return $rpcenv->fork_worker('qmtemplate', $vmid, $authuser, $realcmd);
3108         };
3109
3110         PVE::QemuServer::lock_config($vmid, $updatefn);
3111         return undef;
3112     }});
3113
3114 1;