PVE/API2/Qemu.pm

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