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