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