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