PVE/API2/Qemu.pm

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