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