PVE/API2/Qemu.pm

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