PVE/API2/Qemu.pm

   1 package PVE::API2::Qemu;
   2
   3 use strict;
   4 use warnings;
   5 use Cwd 'abs_path';
   6
   7 use PVE::Cluster qw (cfs_read_file cfs_write_file);;
   8 use PVE::SafeSyslog;
   9 use PVE::Tools qw(extract_param);
  10 use PVE::Exception qw(raise raise_param_exc);
  11 use PVE::Storage;
  12 use PVE::JSONSchema qw(get_standard_option);
  13 use PVE::RESTHandler;
  14 use PVE::QemuServer;
  15 use PVE::QemuMigrate;
  16 use PVE::RPCEnvironment;
  17 use PVE::AccessControl;
  18 use PVE::INotify;
  19
  20 use Data::Dumper; # fixme: remove
  21
  22 use base qw(PVE::RESTHandler);
  23
  24 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.";
  25
  26 my $resolve_cdrom_alias = sub {
  27     my $param = shift;
  28
  29     if (my $value = $param->{cdrom}) {
  30         $value .= ",media=cdrom" if $value !~ m/media=/;
  31         $param->{ide2} = $value;
  32         delete $param->{cdrom};
  33     }
  34 };
  35
  36
  37 my $check_storage_access = sub {
  38    my ($rpcenv, $authuser, $storecfg, $vmid, $settings, $default_storage) = @_;
  39
  40    PVE::QemuServer::foreach_drive($settings, sub {
  41         my ($ds, $drive) = @_;
  42
  43         my $isCDROM = PVE::QemuServer::drive_is_cdrom($drive);
  44
  45         my $volid = $drive->{file};
  46
  47         if (!$volid || $volid eq 'none') {
  48             # nothing to check
  49         } elsif ($isCDROM && ($volid eq 'cdrom')) {
  50             $rpcenv->check($authuser, "/", ['Sys.Console']);
  51         } elsif (!$isCDROM && ($volid =~ m/^(([^:\s]+):)?(\d+(\.\d+)?)$/)) {
  52             my ($storeid, $size) = ($2 || $default_storage, $3);
  53             die "no storage ID specified (and no default storage)\n" if !$storeid;
  54             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
  55         } else {
  56             $rpcenv->check_volume_access($authuser, $storecfg, $vmid, $volid);
  57         }
  58     });
  59 };
  60
  61 # Note: $pool is only needed when creating a VM, because pool permissions
  62 # are automatically inherited if VM already exists inside a pool.
  63 my $create_disks = sub {
  64     my ($rpcenv, $authuser, $conf, $storecfg, $vmid, $pool, $settings, $default_storage) = @_;
  65
  66     my $vollist = [];
  67
  68     my $res = {};
  69     PVE::QemuServer::foreach_drive($settings, sub {
  70         my ($ds, $disk) = @_;
  71
  72         my $volid = $disk->{file};
  73
  74         if (!$volid || $volid eq 'none' || $volid eq 'cdrom') {
  75             $res->{$ds} = $settings->{$ds};
  76         } elsif ($volid =~ m/^(([^:\s]+):)?(\d+(\.\d+)?)$/) {
  77             my ($storeid, $size) = ($2 || $default_storage, $3);
  78             die "no storage ID specified (and no default storage)\n" if !$storeid;
  79             my $defformat = PVE::Storage::storage_default_format($storecfg, $storeid);
  80             my $fmt = $disk->{format} || $defformat;
  81             my $volid = PVE::Storage::vdisk_alloc($storecfg, $storeid, $vmid,
  82                                                   $fmt, undef, $size*1024*1024);
  83             $disk->{file} = $volid;
  84             $disk->{size} = $size*1024*1024*1024;
  85             push @$vollist, $volid;
  86             delete $disk->{format}; # no longer needed
  87             $res->{$ds} = PVE::QemuServer::print_drive($vmid, $disk);
  88         } else {
  89
  90             my $path = $rpcenv->check_volume_access($authuser, $storecfg, $vmid, $volid);
  91
  92             my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
  93
  94             my $foundvolid = undef;
  95
  96             if ($storeid) {
  97                 PVE::Storage::activate_volumes($storecfg, [ $volid ]);
  98                 my $dl = PVE::Storage::vdisk_list($storecfg, $storeid, undef);
  99
 100                 PVE::Storage::foreach_volid($dl, sub {
 101                     my ($volumeid) = @_;
 102                     if($volumeid eq $volid) {
 103                         $foundvolid = 1;
 104                         return;
 105                     }
 106                 });
 107             }
 108
 109             die "image '$path' does not exists\n" if (!(-f $path || -b $path || $foundvolid));
 110
 111             my ($size) = PVE::Storage::volume_size_info($storecfg, $volid, 1);
 112             $disk->{size} = $size;
 113             $res->{$ds} = PVE::QemuServer::print_drive($vmid, $disk);
 114         }
 115     });
 116
 117     # free allocated images on error
 118     if (my $err = $@) {
 119         syslog('err', "VM $vmid creating disks failed");
 120         foreach my $volid (@$vollist) {
 121             eval { PVE::Storage::vdisk_free($storecfg, $volid); };
 122             warn $@ if $@;
 123         }
 124         die $err;
 125     }
 126
 127     # modify vm config if everything went well
 128     foreach my $ds (keys %$res) {
 129         $conf->{$ds} = $res->{$ds};
 130     }
 131
 132     return $vollist;
 133 };
 134
 135 my $check_vm_modify_config_perm = sub {
 136     my ($rpcenv, $authuser, $vmid, $pool, $key_list) = @_;
 137
 138     return 1 if $authuser eq 'root@pam';
 139
 140     foreach my $opt (@$key_list) {
 141         # disk checks need to be done somewhere else
 142         next if PVE::QemuServer::valid_drivename($opt);
 143
 144         if ($opt eq 'sockets' || $opt eq 'cores' ||
 145             $opt eq 'cpu' || $opt eq 'smp' ||
 146             $opt eq 'cpulimit' || $opt eq 'cpuunits') {
 147             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.CPU']);
 148         } elsif ($opt eq 'boot' || $opt eq 'bootdisk') {
 149             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Disk']);
 150         } elsif ($opt eq 'memory' || $opt eq 'balloon') {
 151             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Memory']);
 152         } elsif ($opt eq 'args' || $opt eq 'lock') {
 153             die "only root can set '$opt' config\n";
 154         } elsif ($opt eq 'cpu' || $opt eq 'kvm' || $opt eq 'acpi' ||
 155                  $opt eq 'vga' || $opt eq 'watchdog' || $opt eq 'tablet') {
 156             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.HWType']);
 157         } elsif ($opt =~ m/^net\d+$/) {
 158             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Network']);
 159         } else {
 160             $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Options']);
 161         }
 162     }
 163
 164     return 1;
 165 };
 166
 167 __PACKAGE__->register_method({
 168     name => 'vmlist',
 169     path => '',
 170     method => 'GET',
 171     description => "Virtual machine index (per node).",
 172     permissions => {
 173         description => "Only list VMs where you have VM.Audit permissons on /vms/<vmid>.",
 174         user => 'all',
 175     },
 176     proxyto => 'node',
 177     protected => 1, # qemu pid files are only readable by root
 178     parameters => {
 179         additionalProperties => 0,
 180         properties => {
 181             node => get_standard_option('pve-node'),
 182         },
 183     },
 184     returns => {
 185         type => 'array',
 186         items => {
 187             type => "object",
 188             properties => {},
 189         },
 190         links => [ { rel => 'child', href => "{vmid}" } ],
 191     },
 192     code => sub {
 193         my ($param) = @_;
 194
 195         my $rpcenv = PVE::RPCEnvironment::get();
 196         my $authuser = $rpcenv->get_user();
 197
 198         my $vmstatus = PVE::QemuServer::vmstatus();
 199
 200         my $res = [];
 201         foreach my $vmid (keys %$vmstatus) {
 202             next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Audit' ], 1);
 203
 204             my $data = $vmstatus->{$vmid};
 205             $data->{vmid} = $vmid;
 206             push @$res, $data;
 207         }
 208
 209         return $res;
 210     }});
 211
 212 __PACKAGE__->register_method({
 213     name => 'create_vm',
 214     path => '',
 215     method => 'POST',
 216     description => "Create or restore a virtual machine.",
 217     permissions => {
 218         description => "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. If you create disks you need 'Datastore.AllocateSpace' on any used storage.",
 219         check => [ 'or',
 220                    [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
 221                    [ 'perm', '/pool/{pool}', ['VM.Allocate'], require_param => 'pool'],
 222             ],
 223     },
 224     protected => 1,
 225     proxyto => 'node',
 226     parameters => {
 227         additionalProperties => 0,
 228         properties => PVE::QemuServer::json_config_properties(
 229             {
 230                 node => get_standard_option('pve-node'),
 231                 vmid => get_standard_option('pve-vmid'),
 232                 archive => {
 233                     description => "The backup file.",
 234                     type => 'string',
 235                     optional => 1,
 236                     maxLength => 255,
 237                 },
 238                 storage => get_standard_option('pve-storage-id', {
 239                     description => "Default storage.",
 240                     optional => 1,
 241                 }),
 242                 force => {
 243                     optional => 1,
 244                     type => 'boolean',
 245                     description => "Allow to overwrite existing VM.",
 246                     requires => 'archive',
 247                 },
 248                 unique => {
 249                     optional => 1,
 250                     type => 'boolean',
 251                     description => "Assign a unique random ethernet address.",
 252                     requires => 'archive',
 253                 },
 254                 pool => {
 255                     optional => 1,
 256                     type => 'string', format => 'pve-poolid',
 257                     description => "Add the VM to the specified pool.",
 258                 },
 259             }),
 260     },
 261     returns => {
 262         type => 'string',
 263     },
 264     code => sub {
 265         my ($param) = @_;
 266
 267         my $rpcenv = PVE::RPCEnvironment::get();
 268
 269         my $authuser = $rpcenv->get_user();
 270
 271         my $node = extract_param($param, 'node');
 272
 273         my $vmid = extract_param($param, 'vmid');
 274
 275         my $archive = extract_param($param, 'archive');
 276
 277         my $storage = extract_param($param, 'storage');
 278
 279         my $force = extract_param($param, 'force');
 280
 281         my $unique = extract_param($param, 'unique');
 282
 283         my $pool = extract_param($param, 'pool');
 284
 285         my $filename = PVE::QemuServer::config_file($vmid);
 286
 287         my $storecfg = PVE::Storage::config();
 288
 289         PVE::Cluster::check_cfs_quorum();
 290
 291         if (defined($pool)) {
 292             $rpcenv->check_pool_exist($pool);
 293         }
 294
 295         $rpcenv->check($authuser, "/storage/$storage", ['Datastore.AllocateSpace'])
 296             if defined($storage);
 297
 298         if (!$archive) {
 299             &$resolve_cdrom_alias($param);
 300
 301             &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $param, $storage);
 302
 303             &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, $pool, [ keys %$param]);
 304
 305             foreach my $opt (keys %$param) {
 306                 if (PVE::QemuServer::valid_drivename($opt)) {
 307                     my $drive = PVE::QemuServer::parse_drive($opt, $param->{$opt});
 308                     raise_param_exc({ $opt => "unable to parse drive options" }) if !$drive;
 309
 310                     PVE::QemuServer::cleanup_drive_path($opt, $storecfg, $drive);
 311                     $param->{$opt} = PVE::QemuServer::print_drive($vmid, $drive);
 312                 }
 313             }
 314
 315             PVE::QemuServer::add_random_macs($param);
 316         } else {
 317             my $keystr = join(' ', keys %$param);
 318             raise_param_exc({ archive => "option conflicts with other options ($keystr)"}) if $keystr;
 319
 320             if ($archive eq '-') {
 321                 die "pipe requires cli environment\n"
 322                     if $rpcenv->{type} ne 'cli';
 323             } else {
 324                 my $path = $rpcenv->check_volume_access($authuser, $storecfg, $vmid, $archive);
 325
 326                 PVE::Storage::activate_volumes($storecfg, [ $archive ])
 327                     if PVE::Storage::parse_volume_id ($archive, 1);
 328
 329                 die "can't find archive file '$archive'\n" if !($path && -f $path);
 330                 $archive = $path;
 331             }
 332         }
 333
 334         my $addVMtoPoolFn = sub {
 335             my $usercfg = cfs_read_file("user.cfg");
 336             if (my $data = $usercfg->{pools}->{$pool}) {
 337                 $data->{vms}->{$vmid} = 1;
 338                 $usercfg->{vms}->{$vmid} = $pool;
 339                 cfs_write_file("user.cfg", $usercfg);
 340             }
 341         };
 342
 343         my $restorefn = sub {
 344
 345             if (-f $filename) {
 346                 die "unable to restore vm $vmid: config file already exists\n"
 347                     if !$force;
 348
 349                 die "unable to restore vm $vmid: vm is running\n"
 350                     if PVE::QemuServer::check_running($vmid);
 351
 352                 # destroy existing data - keep empty config
 353                 PVE::QemuServer::destroy_vm($storecfg, $vmid, 1);
 354             }
 355
 356             my $realcmd = sub {
 357                 PVE::QemuServer::restore_archive($archive, $vmid, $authuser, {
 358                     storage => $storage,
 359                     pool => $pool,
 360                     unique => $unique });
 361
 362                 PVE::AccessControl::lock_user_config($addVMtoPoolFn, "can't add VM to pool") if $pool;
 363             };
 364
 365             return $rpcenv->fork_worker('qmrestore', $vmid, $authuser, $realcmd);
 366         };
 367
 368         my $createfn = sub {
 369
 370             # test after locking
 371             die "unable to create vm $vmid: config file already exists\n"
 372                 if -f $filename;
 373
 374             my $realcmd = sub {
 375
 376                 my $vollist = [];
 377
 378                 my $conf = $param;
 379
 380                 eval {
 381
 382                     $vollist = &$create_disks($rpcenv, $authuser, $conf, $storecfg, $vmid, $pool, $param, $storage);
 383
 384                     # try to be smart about bootdisk
 385                     my @disks = PVE::QemuServer::disknames();
 386                     my $firstdisk;
 387                     foreach my $ds (reverse @disks) {
 388                         next if !$conf->{$ds};
 389                         my $disk = PVE::QemuServer::parse_drive($ds, $conf->{$ds});
 390                         next if PVE::QemuServer::drive_is_cdrom($disk);
 391                         $firstdisk = $ds;
 392                     }
 393
 394                     if (!$conf->{bootdisk} && $firstdisk) {
 395                         $conf->{bootdisk} = $firstdisk;
 396                     }
 397
 398                     PVE::QemuServer::update_config_nolock($vmid, $conf);
 399
 400                 };
 401                 my $err = $@;
 402
 403                 if ($err) {
 404                     foreach my $volid (@$vollist) {
 405                         eval { PVE::Storage::vdisk_free($storecfg, $volid); };
 406                         warn $@ if $@;
 407                     }
 408                     die "create failed - $err";
 409                 }
 410
 411                 PVE::AccessControl::lock_user_config($addVMtoPoolFn, "can't add VM to pool") if $pool;
 412             };
 413
 414             return $rpcenv->fork_worker('qmcreate', $vmid, $authuser, $realcmd);
 415         };
 416
 417         return PVE::QemuServer::lock_config_full($vmid, 1, $archive ? $restorefn : $createfn);
 418     }});
 419
 420 __PACKAGE__->register_method({
 421     name => 'vmdiridx',
 422     path => '{vmid}',
 423     method => 'GET',
 424     proxyto => 'node',
 425     description => "Directory index",
 426     permissions => {
 427         user => 'all',
 428     },
 429     parameters => {
 430         additionalProperties => 0,
 431         properties => {
 432             node => get_standard_option('pve-node'),
 433             vmid => get_standard_option('pve-vmid'),
 434         },
 435     },
 436     returns => {
 437         type => 'array',
 438         items => {
 439             type => "object",
 440             properties => {
 441                 subdir => { type => 'string' },
 442             },
 443         },
 444         links => [ { rel => 'child', href => "{subdir}" } ],
 445     },
 446     code => sub {
 447         my ($param) = @_;
 448
 449         my $res = [
 450             { subdir => 'config' },
 451             { subdir => 'status' },
 452             { subdir => 'unlink' },
 453             { subdir => 'vncproxy' },
 454             { subdir => 'migrate' },
 455             { subdir => 'resize' },
 456             { subdir => 'rrd' },
 457             { subdir => 'rrddata' },
 458             { subdir => 'monitor' },
 459             ];
 460
 461         return $res;
 462     }});
 463
 464 __PACKAGE__->register_method({
 465     name => 'rrd',
 466     path => '{vmid}/rrd',
 467     method => 'GET',
 468     protected => 1, # fixme: can we avoid that?
 469     permissions => {
 470         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
 471     },
 472     description => "Read VM RRD statistics (returns PNG)",
 473     parameters => {
 474         additionalProperties => 0,
 475         properties => {
 476             node => get_standard_option('pve-node'),
 477             vmid => get_standard_option('pve-vmid'),
 478             timeframe => {
 479                 description => "Specify the time frame you are interested in.",
 480                 type => 'string',
 481                 enum => [ 'hour', 'day', 'week', 'month', 'year' ],
 482             },
 483             ds => {
 484                 description => "The list of datasources you want to display.",
 485                 type => 'string', format => 'pve-configid-list',
 486             },
 487             cf => {
 488                 description => "The RRD consolidation function",
 489                 type => 'string',
 490                 enum => [ 'AVERAGE', 'MAX' ],
 491                 optional => 1,
 492             },
 493         },
 494     },
 495     returns => {
 496         type => "object",
 497         properties => {
 498             filename => { type => 'string' },
 499         },
 500     },
 501     code => sub {
 502         my ($param) = @_;
 503
 504         return PVE::Cluster::create_rrd_graph(
 505             "pve2-vm/$param->{vmid}", $param->{timeframe},
 506             $param->{ds}, $param->{cf});
 507
 508     }});
 509
 510 __PACKAGE__->register_method({
 511     name => 'rrddata',
 512     path => '{vmid}/rrddata',
 513     method => 'GET',
 514     protected => 1, # fixme: can we avoid that?
 515     permissions => {
 516         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
 517     },
 518     description => "Read VM RRD statistics",
 519     parameters => {
 520         additionalProperties => 0,
 521         properties => {
 522             node => get_standard_option('pve-node'),
 523             vmid => get_standard_option('pve-vmid'),
 524             timeframe => {
 525                 description => "Specify the time frame you are interested in.",
 526                 type => 'string',
 527                 enum => [ 'hour', 'day', 'week', 'month', 'year' ],
 528             },
 529             cf => {
 530                 description => "The RRD consolidation function",
 531                 type => 'string',
 532                 enum => [ 'AVERAGE', 'MAX' ],
 533                 optional => 1,
 534             },
 535         },
 536     },
 537     returns => {
 538         type => "array",
 539         items => {
 540             type => "object",
 541             properties => {},
 542         },
 543     },
 544     code => sub {
 545         my ($param) = @_;
 546
 547         return PVE::Cluster::create_rrd_data(
 548             "pve2-vm/$param->{vmid}", $param->{timeframe}, $param->{cf});
 549     }});
 550
 551
 552 __PACKAGE__->register_method({
 553     name => 'vm_config',
 554     path => '{vmid}/config',
 555     method => 'GET',
 556     proxyto => 'node',
 557     description => "Get virtual machine configuration.",
 558     permissions => {
 559         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
 560     },
 561     parameters => {
 562         additionalProperties => 0,
 563         properties => {
 564             node => get_standard_option('pve-node'),
 565             vmid => get_standard_option('pve-vmid'),
 566         },
 567     },
 568     returns => {
 569         type => "object",
 570         properties => {
 571             digest => {
 572                 type => 'string',
 573                 description => 'SHA1 digest of configuration file. This can be used to prevent concurrent modifications.',
 574             }
 575         },
 576     },
 577     code => sub {
 578         my ($param) = @_;
 579
 580         my $conf = PVE::QemuServer::load_config($param->{vmid});
 581
 582         return $conf;
 583     }});
 584
 585 my $vm_is_volid_owner = sub {
 586     my ($storecfg, $vmid, $volid) =@_;
 587
 588     if ($volid !~  m|^/|) {
 589         my ($path, $owner);
 590         eval { ($path, $owner) = PVE::Storage::path($storecfg, $volid); };
 591         if ($owner && ($owner == $vmid)) {
 592             return 1;
 593         }
 594     }
 595
 596     return undef;
 597 };
 598
 599 my $test_deallocate_drive = sub {
 600     my ($storecfg, $vmid, $key, $drive, $force) = @_;
 601
 602     if (!PVE::QemuServer::drive_is_cdrom($drive)) {
 603         my $volid = $drive->{file};
 604         if (&$vm_is_volid_owner($storecfg, $vmid, $volid)) {
 605             if ($force || $key =~ m/^unused/) {
 606                 my $sid = PVE::Storage::parse_volume_id($volid);
 607                 return $sid;
 608             }
 609         }
 610     }
 611
 612     return undef;
 613 };
 614
 615 my $delete_drive = sub {
 616     my ($conf, $storecfg, $vmid, $key, $drive, $force) = @_;
 617
 618     if (!PVE::QemuServer::drive_is_cdrom($drive)) {
 619         my $volid = $drive->{file};
 620         if (&$vm_is_volid_owner($storecfg, $vmid, $volid)) {
 621             if ($force || $key =~ m/^unused/) {
 622                 eval { PVE::Storage::vdisk_free($storecfg, $volid); };
 623                 die $@ if $@;
 624             } else {
 625                 PVE::QemuServer::add_unused_volume($conf, $volid, $vmid);
 626             }
 627         }
 628     }
 629
 630     delete $conf->{$key};
 631 };
 632
 633 my $vmconfig_delete_option = sub {
 634     my ($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $force) = @_;
 635
 636     return if !defined($conf->{$opt});
 637
 638     my $isDisk = PVE::QemuServer::valid_drivename($opt)|| ($opt =~ m/^unused/);
 639
 640     if ($isDisk) {
 641         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
 642
 643         my $drive = PVE::QemuServer::parse_drive($opt, $conf->{$opt});
 644         if (my $sid = &$test_deallocate_drive($storecfg, $vmid, $opt, $drive, $force)) {
 645             $rpcenv->check($authuser, "/storage/$sid", ['Datastore.Allocate']);
 646         }
 647     }
 648
 649     die "error hot-unplug $opt" if !PVE::QemuServer::vm_deviceunplug($vmid, $conf, $opt);
 650
 651     if ($isDisk) {
 652         my $drive = PVE::QemuServer::parse_drive($opt, $conf->{$opt});
 653         &$delete_drive($conf, $storecfg, $vmid, $opt, $drive, $force);
 654     } else {
 655         delete $conf->{$opt};
 656     }
 657
 658     PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
 659 };
 660
 661 my $safe_int_ne = sub {
 662     my ($a, $b) = @_;
 663
 664     return 0 if !defined($a) && !defined($b);
 665     return 1 if !defined($a);
 666     return 1 if !defined($b);
 667
 668     return $a != $b;
 669 };
 670
 671 my $vmconfig_update_disk = sub {
 672     my ($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $value, $force) = @_;
 673
 674     my $drive = PVE::QemuServer::parse_drive($opt, $value);
 675
 676     if (PVE::QemuServer::drive_is_cdrom($drive)) { #cdrom
 677         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.CDROM']);
 678     } else {
 679         $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
 680     }
 681
 682     if ($conf->{$opt}) {
 683
 684         if (my $old_drive = PVE::QemuServer::parse_drive($opt, $conf->{$opt}))  {
 685
 686             my $media = $drive->{media} || 'disk';
 687             my $oldmedia = $old_drive->{media} || 'disk';
 688             die "unable to change media type\n" if $media ne $oldmedia;
 689
 690             if (!PVE::QemuServer::drive_is_cdrom($old_drive) &&
 691                 ($drive->{file} ne $old_drive->{file})) {  # delete old disks
 692
 693                 &$vmconfig_delete_option($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $force);
 694                 $conf = PVE::QemuServer::load_config($vmid); # update/reload
 695             }
 696
 697             if(&$safe_int_ne($drive->{bps}, $old_drive->{bps}) ||
 698                &$safe_int_ne($drive->{bps_rd}, $old_drive->{bps_rd}) ||
 699                &$safe_int_ne($drive->{bps_wr}, $old_drive->{bps_wr}) ||
 700                &$safe_int_ne($drive->{iops}, $old_drive->{iops}) ||
 701                &$safe_int_ne($drive->{iops_rd}, $old_drive->{iops_rd}) ||
 702                &$safe_int_ne($drive->{iops_wr}, $old_drive->{iops_wr})) {
 703                PVE::QemuServer::qemu_block_set_io_throttle($vmid,"drive-$opt",$drive->{bps}, $drive->{bps_rd}, $drive->{bps_wr}, $drive->{iops}, $drive->{iops_rd}, $drive->{iops_wr}) if !PVE::QemuServer::drive_is_cdrom($drive);
 704             }
 705         }
 706     }
 707
 708     &$create_disks($rpcenv, $authuser, $conf, $storecfg, $vmid, undef, {$opt => $value});
 709     PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
 710
 711     $conf = PVE::QemuServer::load_config($vmid); # update/reload
 712     $drive = PVE::QemuServer::parse_drive($opt, $conf->{$opt});
 713
 714     if (PVE::QemuServer::drive_is_cdrom($drive)) { # cdrom
 715
 716         if (PVE::QemuServer::check_running($vmid)) {
 717             if ($drive->{file} eq 'none') {
 718                 PVE::QemuServer::vm_mon_cmd($vmid, "eject",force => JSON::true,device => "drive-$opt");
 719             } else {
 720                 my $path = PVE::QemuServer::get_iso_path($storecfg, $vmid, $drive->{file});
 721                 PVE::QemuServer::vm_mon_cmd($vmid, "eject",force => JSON::true,device => "drive-$opt"); #force eject if locked
 722                 PVE::QemuServer::vm_mon_cmd($vmid, "change",device => "drive-$opt",target => "$path") if $path;
 723             }
 724         }
 725
 726     } else { # hotplug new disks
 727
 728         die "error hotplug $opt" if !PVE::QemuServer::vm_deviceplug($storecfg, $conf, $vmid, $opt, $drive);
 729     }
 730 };
 731
 732 my $vmconfig_update_net = sub {
 733     my ($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $value) = @_;
 734
 735     if ($conf->{$opt}) {
 736         #if online update, then unplug first
 737         die "error hot-unplug $opt for update" if !PVE::QemuServer::vm_deviceunplug($vmid, $conf, $opt);
 738     }
 739
 740     $conf->{$opt} = $value;
 741     PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
 742     $conf = PVE::QemuServer::load_config($vmid); # update/reload
 743
 744     my $net = PVE::QemuServer::parse_net($conf->{$opt});
 745
 746     die "error hotplug $opt" if !PVE::QemuServer::vm_deviceplug($storecfg, $conf, $vmid, $opt, $net);
 747 };
 748
 749 my $vm_config_perm_list = [
 750             'VM.Config.Disk',
 751             'VM.Config.CDROM',
 752             'VM.Config.CPU',
 753             'VM.Config.Memory',
 754             'VM.Config.Network',
 755             'VM.Config.HWType',
 756             'VM.Config.Options',
 757     ];
 758
 759 __PACKAGE__->register_method({
 760     name => 'update_vm',
 761     path => '{vmid}/config',
 762     method => 'PUT',
 763     protected => 1,
 764     proxyto => 'node',
 765     description => "Set virtual machine options.",
 766     permissions => {
 767         check => ['perm', '/vms/{vmid}', $vm_config_perm_list, any => 1],
 768     },
 769     parameters => {
 770         additionalProperties => 0,
 771         properties => PVE::QemuServer::json_config_properties(
 772             {
 773                 node => get_standard_option('pve-node'),
 774                 vmid => get_standard_option('pve-vmid'),
 775                 skiplock => get_standard_option('skiplock'),
 776                 delete => {
 777                     type => 'string', format => 'pve-configid-list',
 778                     description => "A list of settings you want to delete.",
 779                     optional => 1,
 780                 },
 781                 force => {
 782                     type => 'boolean',
 783                     description => $opt_force_description,
 784                     optional => 1,
 785                     requires => 'delete',
 786                 },
 787                 digest => {
 788                     type => 'string',
 789                     description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
 790                     maxLength => 40,
 791                     optional => 1,
 792                 }
 793             }),
 794     },
 795     returns => { type => 'null'},
 796     code => sub {
 797         my ($param) = @_;
 798
 799         my $rpcenv = PVE::RPCEnvironment::get();
 800
 801         my $authuser = $rpcenv->get_user();
 802
 803         my $node = extract_param($param, 'node');
 804
 805         my $vmid = extract_param($param, 'vmid');
 806
 807         my $digest = extract_param($param, 'digest');
 808
 809         my @paramarr = (); # used for log message
 810         foreach my $key (keys %$param) {
 811             push @paramarr, "-$key", $param->{$key};
 812         }
 813
 814         my $skiplock = extract_param($param, 'skiplock');
 815         raise_param_exc({ skiplock => "Only root may use this option." })
 816             if $skiplock && $authuser ne 'root@pam';
 817
 818         my $delete_str = extract_param($param, 'delete');
 819
 820         my $force = extract_param($param, 'force');
 821
 822         die "no options specified\n" if !$delete_str && !scalar(keys %$param);
 823
 824         my $storecfg = PVE::Storage::config();
 825
 826         &$resolve_cdrom_alias($param);
 827
 828         # now try to verify all parameters
 829
 830         my @delete = ();
 831         foreach my $opt (PVE::Tools::split_list($delete_str)) {
 832             $opt = 'ide2' if $opt eq 'cdrom';
 833             raise_param_exc({ delete => "you can't use '-$opt' and " .
 834                                   "-delete $opt' at the same time" })
 835                 if defined($param->{$opt});
 836
 837             if (!PVE::QemuServer::option_exists($opt)) {
 838                 raise_param_exc({ delete => "unknown option '$opt'" });
 839             }
 840
 841             push @delete, $opt;
 842         }
 843
 844         foreach my $opt (keys %$param) {
 845             if (PVE::QemuServer::valid_drivename($opt)) {
 846                 # cleanup drive path
 847                 my $drive = PVE::QemuServer::parse_drive($opt, $param->{$opt});
 848                 PVE::QemuServer::cleanup_drive_path($opt, $storecfg, $drive);
 849                 $param->{$opt} = PVE::QemuServer::print_drive($vmid, $drive);
 850             } elsif ($opt =~ m/^net(\d+)$/) {
 851                 # add macaddr
 852                 my $net = PVE::QemuServer::parse_net($param->{$opt});
 853                 $param->{$opt} = PVE::QemuServer::print_net($net);
 854             }
 855         }
 856
 857         &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, undef, [@delete]);
 858
 859         &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, undef, [keys %$param]);
 860
 861         &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $param);
 862
 863         my $updatefn =  sub {
 864
 865             my $conf = PVE::QemuServer::load_config($vmid);
 866
 867             die "checksum missmatch (file change by other user?)\n"
 868                 if $digest && $digest ne $conf->{digest};
 869
 870             PVE::QemuServer::check_lock($conf) if !$skiplock;
 871
 872             PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: " . join (' ', @paramarr));
 873
 874             foreach my $opt (@delete) { # delete
 875                 $conf = PVE::QemuServer::load_config($vmid); # update/reload
 876                 &$vmconfig_delete_option($rpcenv, $authuser, $conf, $storecfg, $vmid, $opt, $force);
 877             }
 878
 879             foreach my $opt (keys %$param) { # add/change
 880
 881                 $conf = PVE::QemuServer::load_config($vmid); # update/reload
 882
 883                 next if $conf->{$opt} && ($param->{$opt} eq $conf->{$opt}); # skip if nothing changed
 884
 885                 if (PVE::QemuServer::valid_drivename($opt)) {
 886
 887                     &$vmconfig_update_disk($rpcenv, $authuser, $conf, $storecfg, $vmid,
 888                                            $opt, $param->{$opt}, $force);
 889
 890                 } elsif ($opt =~ m/^net(\d+)$/) { #nics
 891
 892                     &$vmconfig_update_net($rpcenv, $authuser, $conf, $storecfg, $vmid,
 893                                           $opt, $param->{$opt});
 894
 895                 } else {
 896
 897                     $conf->{$opt} = $param->{$opt};
 898                     PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
 899                 }
 900             }
 901         };
 902
 903         PVE::QemuServer::lock_config($vmid, $updatefn);
 904
 905         return undef;
 906     }});
 907
 908
 909 __PACKAGE__->register_method({
 910     name => 'destroy_vm',
 911     path => '{vmid}',
 912     method => 'DELETE',
 913     protected => 1,
 914     proxyto => 'node',
 915     description => "Destroy the vm (also delete all used/owned volumes).",
 916     permissions => {
 917         check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
 918     },
 919     parameters => {
 920         additionalProperties => 0,
 921         properties => {
 922             node => get_standard_option('pve-node'),
 923             vmid => get_standard_option('pve-vmid'),
 924             skiplock => get_standard_option('skiplock'),
 925         },
 926     },
 927     returns => {
 928         type => 'string',
 929     },
 930     code => sub {
 931         my ($param) = @_;
 932
 933         my $rpcenv = PVE::RPCEnvironment::get();
 934
 935         my $authuser = $rpcenv->get_user();
 936
 937         my $vmid = $param->{vmid};
 938
 939         my $skiplock = $param->{skiplock};
 940         raise_param_exc({ skiplock => "Only root may use this option." })
 941             if $skiplock && $authuser ne 'root@pam';
 942
 943         # test if VM exists
 944         my $conf = PVE::QemuServer::load_config($vmid);
 945
 946         my $storecfg = PVE::Storage::config();
 947
 948         my $delVMfromPoolFn = sub {
 949             my $usercfg = cfs_read_file("user.cfg");
 950             if (my $pool = $usercfg->{vms}->{$vmid}) {
 951                 if (my $data = $usercfg->{pools}->{$pool}) {
 952                     delete $data->{vms}->{$vmid};
 953                     delete $usercfg->{vms}->{$vmid};
 954                     cfs_write_file("user.cfg", $usercfg);
 955                 }
 956             }
 957         };
 958
 959         my $realcmd = sub {
 960             my $upid = shift;
 961
 962             syslog('info', "destroy VM $vmid: $upid\n");
 963
 964             PVE::QemuServer::vm_destroy($storecfg, $vmid, $skiplock);
 965
 966             PVE::AccessControl::lock_user_config($delVMfromPoolFn, "pool cleanup failed");
 967         };
 968
 969         return $rpcenv->fork_worker('qmdestroy', $vmid, $authuser, $realcmd);
 970     }});
 971
 972 __PACKAGE__->register_method({
 973     name => 'unlink',
 974     path => '{vmid}/unlink',
 975     method => 'PUT',
 976     protected => 1,
 977     proxyto => 'node',
 978     description => "Unlink/delete disk images.",
 979     permissions => {
 980         check => [ 'perm', '/vms/{vmid}', ['VM.Config.Disk']],
 981     },
 982     parameters => {
 983         additionalProperties => 0,
 984         properties => {
 985             node => get_standard_option('pve-node'),
 986             vmid => get_standard_option('pve-vmid'),
 987             idlist => {
 988                 type => 'string', format => 'pve-configid-list',
 989                 description => "A list of disk IDs you want to delete.",
 990             },
 991             force => {
 992                 type => 'boolean',
 993                 description => $opt_force_description,
 994                 optional => 1,
 995             },
 996         },
 997     },
 998     returns => { type => 'null'},
 999     code => sub {
1000         my ($param) = @_;
1001
1002         $param->{delete} = extract_param($param, 'idlist');
1003
1004         __PACKAGE__->update_vm($param);
1005
1006         return undef;
1007     }});
1008
1009 my $sslcert;
1010
1011 __PACKAGE__->register_method({
1012     name => 'vncproxy',
1013     path => '{vmid}/vncproxy',
1014     method => 'POST',
1015     protected => 1,
1016     permissions => {
1017         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1018     },
1019     description => "Creates a TCP VNC proxy connections.",
1020     parameters => {
1021         additionalProperties => 0,
1022         properties => {
1023             node => get_standard_option('pve-node'),
1024             vmid => get_standard_option('pve-vmid'),
1025         },
1026     },
1027     returns => {
1028         additionalProperties => 0,
1029         properties => {
1030             user => { type => 'string' },
1031             ticket => { type => 'string' },
1032             cert => { type => 'string' },
1033             port => { type => 'integer' },
1034             upid => { type => 'string' },
1035         },
1036     },
1037     code => sub {
1038         my ($param) = @_;
1039
1040         my $rpcenv = PVE::RPCEnvironment::get();
1041
1042         my $authuser = $rpcenv->get_user();
1043
1044         my $vmid = $param->{vmid};
1045         my $node = $param->{node};
1046
1047         my $authpath = "/vms/$vmid";
1048
1049         my $ticket = PVE::AccessControl::assemble_vnc_ticket($authuser, $authpath);
1050
1051         $sslcert = PVE::Tools::file_get_contents("/etc/pve/pve-root-ca.pem", 8192)
1052             if !$sslcert;
1053
1054         my $port = PVE::Tools::next_vnc_port();
1055
1056         my $remip;
1057
1058         if ($node ne 'localhost' && $node ne PVE::INotify::nodename()) {
1059             $remip = PVE::Cluster::remote_node_ip($node);
1060         }
1061
1062         # NOTE: kvm VNC traffic is already TLS encrypted,
1063         # so we select the fastest chipher here (or 'none'?)
1064         my $remcmd = $remip ? ['/usr/bin/ssh', '-T', '-o', 'BatchMode=yes',
1065                                '-c', 'blowfish-cbc', $remip] : [];
1066
1067         my $timeout = 10;
1068
1069         my $realcmd = sub {
1070             my $upid = shift;
1071
1072             syslog('info', "starting vnc proxy $upid\n");
1073
1074             my $qmcmd = [@$remcmd, "/usr/sbin/qm", 'vncproxy', $vmid];
1075
1076             my $qmstr = join(' ', @$qmcmd);
1077
1078             # also redirect stderr (else we get RFB protocol errors)
1079             my $cmd = ['/bin/nc', '-l', '-p', $port, '-w', $timeout, '-c', "$qmstr 2>/dev/null"];
1080
1081             PVE::Tools::run_command($cmd);
1082
1083             return;
1084         };
1085
1086         my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd);
1087
1088         return {
1089             user => $authuser,
1090             ticket => $ticket,
1091             port => $port,
1092             upid => $upid,
1093             cert => $sslcert,
1094         };
1095     }});
1096
1097 __PACKAGE__->register_method({
1098     name => 'vmcmdidx',
1099     path => '{vmid}/status',
1100     method => 'GET',
1101     proxyto => 'node',
1102     description => "Directory index",
1103     permissions => {
1104         user => 'all',
1105     },
1106     parameters => {
1107         additionalProperties => 0,
1108         properties => {
1109             node => get_standard_option('pve-node'),
1110             vmid => get_standard_option('pve-vmid'),
1111         },
1112     },
1113     returns => {
1114         type => 'array',
1115         items => {
1116             type => "object",
1117             properties => {
1118                 subdir => { type => 'string' },
1119             },
1120         },
1121         links => [ { rel => 'child', href => "{subdir}" } ],
1122     },
1123     code => sub {
1124         my ($param) = @_;
1125
1126         # test if VM exists
1127         my $conf = PVE::QemuServer::load_config($param->{vmid});
1128
1129         my $res = [
1130             { subdir => 'current' },
1131             { subdir => 'start' },
1132             { subdir => 'stop' },
1133             ];
1134
1135         return $res;
1136     }});
1137
1138 my $vm_is_ha_managed = sub {
1139     my ($vmid) = @_;
1140
1141     my $cc = PVE::Cluster::cfs_read_file('cluster.conf');
1142     if (PVE::Cluster::cluster_conf_lookup_pvevm($cc, 0, $vmid, 1)) {
1143         return 1;
1144     }
1145     return 0;
1146 };
1147
1148 __PACKAGE__->register_method({
1149     name => 'vm_status',
1150     path => '{vmid}/status/current',
1151     method => 'GET',
1152     proxyto => 'node',
1153     protected => 1, # qemu pid files are only readable by root
1154     description => "Get virtual machine status.",
1155     permissions => {
1156         check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1157     },
1158     parameters => {
1159         additionalProperties => 0,
1160         properties => {
1161             node => get_standard_option('pve-node'),
1162             vmid => get_standard_option('pve-vmid'),
1163         },
1164     },
1165     returns => { type => 'object' },
1166     code => sub {
1167         my ($param) = @_;
1168
1169         # test if VM exists
1170         my $conf = PVE::QemuServer::load_config($param->{vmid});
1171
1172         my $vmstatus = PVE::QemuServer::vmstatus($param->{vmid}, 1);
1173         my $status = $vmstatus->{$param->{vmid}};
1174
1175         $status->{ha} = &$vm_is_ha_managed($param->{vmid});
1176
1177         return $status;
1178     }});
1179
1180 __PACKAGE__->register_method({
1181     name => 'vm_start',
1182     path => '{vmid}/status/start',
1183     method => 'POST',
1184     protected => 1,
1185     proxyto => 'node',
1186     description => "Start virtual machine.",
1187     permissions => {
1188         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1189     },
1190     parameters => {
1191         additionalProperties => 0,
1192         properties => {
1193             node => get_standard_option('pve-node'),
1194             vmid => get_standard_option('pve-vmid'),
1195             skiplock => get_standard_option('skiplock'),
1196             stateuri => get_standard_option('pve-qm-stateuri'),
1197         },
1198     },
1199     returns => {
1200         type => 'string',
1201     },
1202     code => sub {
1203         my ($param) = @_;
1204
1205         my $rpcenv = PVE::RPCEnvironment::get();
1206
1207         my $authuser = $rpcenv->get_user();
1208
1209         my $node = extract_param($param, 'node');
1210
1211         my $vmid = extract_param($param, 'vmid');
1212
1213         my $stateuri = extract_param($param, 'stateuri');
1214         raise_param_exc({ stateuri => "Only root may use this option." })
1215             if $stateuri && $authuser ne 'root@pam';
1216
1217         my $skiplock = extract_param($param, 'skiplock');
1218         raise_param_exc({ skiplock => "Only root may use this option." })
1219             if $skiplock && $authuser ne 'root@pam';
1220
1221         my $storecfg = PVE::Storage::config();
1222
1223         if (&$vm_is_ha_managed($vmid) && !$stateuri &&
1224             $rpcenv->{type} ne 'ha') {
1225
1226             my $hacmd = sub {
1227                 my $upid = shift;
1228
1229                 my $service = "pvevm:$vmid";
1230
1231                 my $cmd = ['clusvcadm', '-e', $service, '-m', $node];
1232
1233                 print "Executing HA start for VM $vmid\n";
1234
1235                 PVE::Tools::run_command($cmd);
1236
1237                 return;
1238             };
1239
1240             return $rpcenv->fork_worker('hastart', $vmid, $authuser, $hacmd);
1241
1242         } else {
1243
1244             my $realcmd = sub {
1245                 my $upid = shift;
1246
1247                 syslog('info', "start VM $vmid: $upid\n");
1248
1249                 PVE::QemuServer::vm_start($storecfg, $vmid, $stateuri, $skiplock);
1250
1251                 return;
1252             };
1253
1254             return $rpcenv->fork_worker('qmstart', $vmid, $authuser, $realcmd);
1255         }
1256     }});
1257
1258 __PACKAGE__->register_method({
1259     name => 'vm_stop',
1260     path => '{vmid}/status/stop',
1261     method => 'POST',
1262     protected => 1,
1263     proxyto => 'node',
1264     description => "Stop virtual machine.",
1265     permissions => {
1266         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1267     },
1268     parameters => {
1269         additionalProperties => 0,
1270         properties => {
1271             node => get_standard_option('pve-node'),
1272             vmid => get_standard_option('pve-vmid'),
1273             skiplock => get_standard_option('skiplock'),
1274             timeout => {
1275                 description => "Wait maximal timeout seconds.",
1276                 type => 'integer',
1277                 minimum => 0,
1278                 optional => 1,
1279             },
1280             keepActive => {
1281                 description => "Do not decativate storage volumes.",
1282                 type => 'boolean',
1283                 optional => 1,
1284                 default => 0,
1285             }
1286         },
1287     },
1288     returns => {
1289         type => 'string',
1290     },
1291     code => sub {
1292         my ($param) = @_;
1293
1294         my $rpcenv = PVE::RPCEnvironment::get();
1295
1296         my $authuser = $rpcenv->get_user();
1297
1298         my $node = extract_param($param, 'node');
1299
1300         my $vmid = extract_param($param, 'vmid');
1301
1302         my $skiplock = extract_param($param, 'skiplock');
1303         raise_param_exc({ skiplock => "Only root may use this option." })
1304             if $skiplock && $authuser ne 'root@pam';
1305
1306         my $keepActive = extract_param($param, 'keepActive');
1307         raise_param_exc({ keepActive => "Only root may use this option." })
1308             if $keepActive && $authuser ne 'root@pam';
1309
1310         my $storecfg = PVE::Storage::config();
1311
1312         if (&$vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
1313
1314             my $hacmd = sub {
1315                 my $upid = shift;
1316
1317                 my $service = "pvevm:$vmid";
1318
1319                 my $cmd = ['clusvcadm', '-d', $service];
1320
1321                 print "Executing HA stop for VM $vmid\n";
1322
1323                 PVE::Tools::run_command($cmd);
1324
1325                 return;
1326             };
1327
1328             return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
1329
1330         } else {
1331             my $realcmd = sub {
1332                 my $upid = shift;
1333
1334                 syslog('info', "stop VM $vmid: $upid\n");
1335
1336                 PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0,
1337                                          $param->{timeout}, 0, 1, $keepActive);
1338
1339                 return;
1340             };
1341
1342             return $rpcenv->fork_worker('qmstop', $vmid, $authuser, $realcmd);
1343         }
1344     }});
1345
1346 __PACKAGE__->register_method({
1347     name => 'vm_reset',
1348     path => '{vmid}/status/reset',
1349     method => 'POST',
1350     protected => 1,
1351     proxyto => 'node',
1352     description => "Reset virtual machine.",
1353     permissions => {
1354         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1355     },
1356     parameters => {
1357         additionalProperties => 0,
1358         properties => {
1359             node => get_standard_option('pve-node'),
1360             vmid => get_standard_option('pve-vmid'),
1361             skiplock => get_standard_option('skiplock'),
1362         },
1363     },
1364     returns => {
1365         type => 'string',
1366     },
1367     code => sub {
1368         my ($param) = @_;
1369
1370         my $rpcenv = PVE::RPCEnvironment::get();
1371
1372         my $authuser = $rpcenv->get_user();
1373
1374         my $node = extract_param($param, 'node');
1375
1376         my $vmid = extract_param($param, 'vmid');
1377
1378         my $skiplock = extract_param($param, 'skiplock');
1379         raise_param_exc({ skiplock => "Only root may use this option." })
1380             if $skiplock && $authuser ne 'root@pam';
1381
1382         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
1383
1384         my $realcmd = sub {
1385             my $upid = shift;
1386
1387             PVE::QemuServer::vm_reset($vmid, $skiplock);
1388
1389             return;
1390         };
1391
1392         return $rpcenv->fork_worker('qmreset', $vmid, $authuser, $realcmd);
1393     }});
1394
1395 __PACKAGE__->register_method({
1396     name => 'vm_shutdown',
1397     path => '{vmid}/status/shutdown',
1398     method => 'POST',
1399     protected => 1,
1400     proxyto => 'node',
1401     description => "Shutdown virtual machine.",
1402     permissions => {
1403         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1404     },
1405     parameters => {
1406         additionalProperties => 0,
1407         properties => {
1408             node => get_standard_option('pve-node'),
1409             vmid => get_standard_option('pve-vmid'),
1410             skiplock => get_standard_option('skiplock'),
1411             timeout => {
1412                 description => "Wait maximal timeout seconds.",
1413                 type => 'integer',
1414                 minimum => 0,
1415                 optional => 1,
1416             },
1417             forceStop => {
1418                 description => "Make sure the VM stops.",
1419                 type => 'boolean',
1420                 optional => 1,
1421                 default => 0,
1422             },
1423             keepActive => {
1424                 description => "Do not decativate storage volumes.",
1425                 type => 'boolean',
1426                 optional => 1,
1427                 default => 0,
1428             }
1429         },
1430     },
1431     returns => {
1432         type => 'string',
1433     },
1434     code => sub {
1435         my ($param) = @_;
1436
1437         my $rpcenv = PVE::RPCEnvironment::get();
1438
1439         my $authuser = $rpcenv->get_user();
1440
1441         my $node = extract_param($param, 'node');
1442
1443         my $vmid = extract_param($param, 'vmid');
1444
1445         my $skiplock = extract_param($param, 'skiplock');
1446         raise_param_exc({ skiplock => "Only root may use this option." })
1447             if $skiplock && $authuser ne 'root@pam';
1448
1449         my $keepActive = extract_param($param, 'keepActive');
1450         raise_param_exc({ keepActive => "Only root may use this option." })
1451             if $keepActive && $authuser ne 'root@pam';
1452
1453         my $storecfg = PVE::Storage::config();
1454
1455         my $realcmd = sub {
1456             my $upid = shift;
1457
1458             syslog('info', "shutdown VM $vmid: $upid\n");
1459
1460             PVE::QemuServer::vm_stop($storecfg, $vmid, $skiplock, 0, $param->{timeout},
1461                                      1, $param->{forceStop}, $keepActive);
1462
1463             return;
1464         };
1465
1466         return $rpcenv->fork_worker('qmshutdown', $vmid, $authuser, $realcmd);
1467     }});
1468
1469 __PACKAGE__->register_method({
1470     name => 'vm_suspend',
1471     path => '{vmid}/status/suspend',
1472     method => 'POST',
1473     protected => 1,
1474     proxyto => 'node',
1475     description => "Suspend virtual machine.",
1476     permissions => {
1477         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1478     },
1479     parameters => {
1480         additionalProperties => 0,
1481         properties => {
1482             node => get_standard_option('pve-node'),
1483             vmid => get_standard_option('pve-vmid'),
1484             skiplock => get_standard_option('skiplock'),
1485         },
1486     },
1487     returns => {
1488         type => 'string',
1489     },
1490     code => sub {
1491         my ($param) = @_;
1492
1493         my $rpcenv = PVE::RPCEnvironment::get();
1494
1495         my $authuser = $rpcenv->get_user();
1496
1497         my $node = extract_param($param, 'node');
1498
1499         my $vmid = extract_param($param, 'vmid');
1500
1501         my $skiplock = extract_param($param, 'skiplock');
1502         raise_param_exc({ skiplock => "Only root may use this option." })
1503             if $skiplock && $authuser ne 'root@pam';
1504
1505         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
1506
1507         my $realcmd = sub {
1508             my $upid = shift;
1509
1510             syslog('info', "suspend VM $vmid: $upid\n");
1511
1512             PVE::QemuServer::vm_suspend($vmid, $skiplock);
1513
1514             return;
1515         };
1516
1517         return $rpcenv->fork_worker('qmsuspend', $vmid, $authuser, $realcmd);
1518     }});
1519
1520 __PACKAGE__->register_method({
1521     name => 'vm_resume',
1522     path => '{vmid}/status/resume',
1523     method => 'POST',
1524     protected => 1,
1525     proxyto => 'node',
1526     description => "Resume virtual machine.",
1527     permissions => {
1528         check => ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1529     },
1530     parameters => {
1531         additionalProperties => 0,
1532         properties => {
1533             node => get_standard_option('pve-node'),
1534             vmid => get_standard_option('pve-vmid'),
1535             skiplock => get_standard_option('skiplock'),
1536         },
1537     },
1538     returns => {
1539         type => 'string',
1540     },
1541     code => sub {
1542         my ($param) = @_;
1543
1544         my $rpcenv = PVE::RPCEnvironment::get();
1545
1546         my $authuser = $rpcenv->get_user();
1547
1548         my $node = extract_param($param, 'node');
1549
1550         my $vmid = extract_param($param, 'vmid');
1551
1552         my $skiplock = extract_param($param, 'skiplock');
1553         raise_param_exc({ skiplock => "Only root may use this option." })
1554             if $skiplock && $authuser ne 'root@pam';
1555
1556         die "VM $vmid not running\n" if !PVE::QemuServer::check_running($vmid);
1557
1558         my $realcmd = sub {
1559             my $upid = shift;
1560
1561             syslog('info', "resume VM $vmid: $upid\n");
1562
1563             PVE::QemuServer::vm_resume($vmid, $skiplock);
1564
1565             return;
1566         };
1567
1568         return $rpcenv->fork_worker('qmresume', $vmid, $authuser, $realcmd);
1569     }});
1570
1571 __PACKAGE__->register_method({
1572     name => 'vm_sendkey',
1573     path => '{vmid}/sendkey',
1574     method => 'PUT',
1575     protected => 1,
1576     proxyto => 'node',
1577     description => "Send key event to virtual machine.",
1578     permissions => {
1579         check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1580     },
1581     parameters => {
1582         additionalProperties => 0,
1583         properties => {
1584             node => get_standard_option('pve-node'),
1585             vmid => get_standard_option('pve-vmid'),
1586             skiplock => get_standard_option('skiplock'),
1587             key => {
1588                 description => "The key (qemu monitor encoding).",
1589                 type => 'string'
1590             }
1591         },
1592     },
1593     returns => { type => 'null'},
1594     code => sub {
1595         my ($param) = @_;
1596
1597         my $rpcenv = PVE::RPCEnvironment::get();
1598
1599         my $authuser = $rpcenv->get_user();
1600
1601         my $node = extract_param($param, 'node');
1602
1603         my $vmid = extract_param($param, 'vmid');
1604
1605         my $skiplock = extract_param($param, 'skiplock');
1606         raise_param_exc({ skiplock => "Only root may use this option." })
1607             if $skiplock && $authuser ne 'root@pam';
1608
1609         PVE::QemuServer::vm_sendkey($vmid, $skiplock, $param->{key});
1610
1611         return;
1612     }});
1613
1614 __PACKAGE__->register_method({
1615     name => 'migrate_vm',
1616     path => '{vmid}/migrate',
1617     method => 'POST',
1618     protected => 1,
1619     proxyto => 'node',
1620     description => "Migrate virtual machine. Creates a new migration task.",
1621     permissions => {
1622         check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
1623     },
1624     parameters => {
1625         additionalProperties => 0,
1626         properties => {
1627             node => get_standard_option('pve-node'),
1628             vmid => get_standard_option('pve-vmid'),
1629             target => get_standard_option('pve-node', { description => "Target node." }),
1630             online => {
1631                 type => 'boolean',
1632                 description => "Use online/live migration.",
1633                 optional => 1,
1634             },
1635             force => {
1636                 type => 'boolean',
1637                 description => "Allow to migrate VMs which use local devices. Only root may use this option.",
1638                 optional => 1,
1639             },
1640         },
1641     },
1642     returns => {
1643         type => 'string',
1644         description => "the task ID.",
1645     },
1646     code => sub {
1647         my ($param) = @_;
1648
1649         my $rpcenv = PVE::RPCEnvironment::get();
1650
1651         my $authuser = $rpcenv->get_user();
1652
1653         my $target = extract_param($param, 'target');
1654
1655         my $localnode = PVE::INotify::nodename();
1656         raise_param_exc({ target => "target is local node."}) if $target eq $localnode;
1657
1658         PVE::Cluster::check_cfs_quorum();
1659
1660         PVE::Cluster::check_node_exists($target);
1661
1662         my $targetip = PVE::Cluster::remote_node_ip($target);
1663
1664         my $vmid = extract_param($param, 'vmid');
1665
1666         raise_param_exc({ force => "Only root may use this option." })
1667             if $param->{force} && $authuser ne 'root@pam';
1668
1669         # test if VM exists
1670         my $conf = PVE::QemuServer::load_config($vmid);
1671
1672         # try to detect errors early
1673
1674         PVE::QemuServer::check_lock($conf);
1675
1676         if (PVE::QemuServer::check_running($vmid)) {
1677             die "cant migrate running VM without --online\n"
1678                 if !$param->{online};
1679         }
1680
1681         my $storecfg = PVE::Storage::config();
1682         PVE::QemuServer::check_storage_availability($storecfg, $conf, $target);
1683
1684         if (&$vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
1685
1686             my $hacmd = sub {
1687                 my $upid = shift;
1688
1689                 my $service = "pvevm:$vmid";
1690
1691                 my $cmd = ['clusvcadm', '-M', $service, '-m', $target];
1692
1693                 print "Executing HA migrate for VM $vmid to node $target\n";
1694
1695                 PVE::Tools::run_command($cmd);
1696
1697                 return;
1698             };
1699
1700             return $rpcenv->fork_worker('hamigrate', $vmid, $authuser, $hacmd);
1701
1702         } else {
1703
1704             my $realcmd = sub {
1705                 my $upid = shift;
1706
1707                 PVE::QemuMigrate->migrate($target, $targetip, $vmid, $param);
1708             };
1709
1710             return $rpcenv->fork_worker('qmigrate', $vmid, $authuser, $realcmd);
1711         }
1712
1713     }});
1714
1715 __PACKAGE__->register_method({
1716     name => 'monitor',
1717     path => '{vmid}/monitor',
1718     method => 'POST',
1719     protected => 1,
1720     proxyto => 'node',
1721     description => "Execute Qemu monitor commands.",
1722     permissions => {
1723         check => ['perm', '/vms/{vmid}', [ 'VM.Monitor' ]],
1724     },
1725     parameters => {
1726         additionalProperties => 0,
1727         properties => {
1728             node => get_standard_option('pve-node'),
1729             vmid => get_standard_option('pve-vmid'),
1730             command => {
1731                 type => 'string',
1732                 description => "The monitor command.",
1733             }
1734         },
1735     },
1736     returns => { type => 'string'},
1737     code => sub {
1738         my ($param) = @_;
1739
1740         my $vmid = $param->{vmid};
1741
1742         my $conf = PVE::QemuServer::load_config ($vmid); # check if VM exists
1743
1744         my $res = '';
1745         eval {
1746             $res = PVE::QemuServer::vm_human_monitor_command($vmid, $param->{command});
1747         };
1748         $res = "ERROR: $@" if $@;
1749
1750         return $res;
1751     }});
1752
1753 __PACKAGE__->register_method({
1754     name => 'resize_vm',
1755     path => '{vmid}/resize',
1756     method => 'PUT',
1757     protected => 1,
1758     proxyto => 'node',
1759     description => "Extend volume size.",
1760     permissions => {
1761         check => ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
1762     },
1763     parameters => {
1764         additionalProperties => 0,
1765         properties => {
1766             node => get_standard_option('pve-node'),
1767             vmid => get_standard_option('pve-vmid'),
1768             skiplock => get_standard_option('skiplock'),
1769             disk => {
1770                 type => 'string',
1771                 description => "The disk you want to resize.",
1772                 enum => [PVE::QemuServer::disknames()],
1773             },
1774             size => {
1775                 type => 'string',
1776                 pattern => '\+?\d+(\.\d+)?[KMGT]?',
1777                 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.",
1778             },
1779             digest => {
1780                 type => 'string',
1781                 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1782                 maxLength => 40,
1783                 optional => 1,
1784             },
1785         },
1786     },
1787     returns => { type => 'null'},
1788     code => sub {
1789         my ($param) = @_;
1790
1791         my $rpcenv = PVE::RPCEnvironment::get();
1792
1793         my $authuser = $rpcenv->get_user();
1794
1795         my $node = extract_param($param, 'node');
1796
1797         my $vmid = extract_param($param, 'vmid');
1798
1799         my $digest = extract_param($param, 'digest');
1800
1801         my $disk = extract_param($param, 'disk');
1802
1803         my $sizestr = extract_param($param, 'size');
1804
1805         my $skiplock = extract_param($param, 'skiplock');
1806         raise_param_exc({ skiplock => "Only root may use this option." })
1807             if $skiplock && $authuser ne 'root@pam';
1808
1809         my $storecfg = PVE::Storage::config();
1810
1811         my $updatefn =  sub {
1812
1813             my $conf = PVE::QemuServer::load_config($vmid);
1814
1815             die "checksum missmatch (file change by other user?)\n"
1816                 if $digest && $digest ne $conf->{digest};
1817             PVE::QemuServer::check_lock($conf) if !$skiplock;
1818
1819             die "disk '$disk' does not exist\n" if !$conf->{$disk};
1820
1821             my $drive = PVE::QemuServer::parse_drive($disk, $conf->{$disk});
1822
1823             my $volid = $drive->{file};
1824
1825             die "disk '$disk' has no associated volume\n" if !$volid;
1826
1827             die "you can't resize a cdrom\n" if PVE::QemuServer::drive_is_cdrom($drive);
1828
1829             my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
1830
1831             $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
1832
1833             my $size = PVE::Storage::volume_size_info($storecfg, $volid, 5);
1834
1835             die "internal error" if $sizestr !~ m/^(\+)?(\d+(\.\d+)?)([KMGT])?$/;
1836             my ($ext, $newsize, $unit) = ($1, $2, $4);
1837             if ($unit) {
1838                 if ($unit eq 'K') {
1839                     $newsize = $newsize * 1024;
1840                 } elsif ($unit eq 'M') {
1841                     $newsize = $newsize * 1024 * 1024;
1842                 } elsif ($unit eq 'G') {
1843                     $newsize = $newsize * 1024 * 1024 * 1024;
1844                 } elsif ($unit eq 'T') {
1845                     $newsize = $newsize * 1024 * 1024 * 1024 * 1024;
1846                 }
1847             }
1848             $newsize += $size if $ext;
1849             $newsize = int($newsize);
1850
1851             die "unable to skrink disk size\n" if $newsize < $size;
1852
1853             return if $size == $newsize;
1854
1855             PVE::Cluster::log_msg('info', $authuser, "update VM $vmid: resize --disk $disk --size $sizestr");
1856
1857             PVE::QemuServer::qemu_block_resize($vmid, "drive-$disk", $storecfg, $volid, $newsize);
1858
1859             $drive->{size} = $newsize;
1860             $conf->{$disk} = PVE::QemuServer::print_drive($vmid, $drive);
1861
1862             PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
1863         };
1864
1865         PVE::QemuServer::lock_config($vmid, $updatefn);
1866         return undef;
1867     }});
1868
1869 1;