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