1 package PVE
::API2
::Qemu
;
12 use PVE
::Cluster qw
(cfs_read_file cfs_write_file
);;
14 use PVE
::Tools
qw(extract_param);
15 use PVE
::Exception
qw(raise raise_param_exc raise_perm_exc);
17 use PVE
::JSONSchema
qw(get_standard_option);
19 use PVE
::ReplicationConfig
;
20 use PVE
::GuestHelpers
;
24 use PVE
::RPCEnvironment
;
25 use PVE
::AccessControl
;
29 use PVE
::API2
::Firewall
::VM
;
30 use PVE
::API2
::Qemu
::Agent
;
33 if (!$ENV{PVE_GENERATING_DOCS
}) {
34 require PVE
::HA
::Env
::PVE2
;
35 import PVE
::HA
::Env
::PVE2
;
36 require PVE
::HA
::Config
;
37 import PVE
::HA
::Config
;
41 use Data
::Dumper
; # fixme: remove
43 use base
qw(PVE::RESTHandler);
45 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.";
47 my $resolve_cdrom_alias = sub {
50 if (my $value = $param->{cdrom
}) {
51 $value .= ",media=cdrom" if $value !~ m/media=/;
52 $param->{ide2
} = $value;
53 delete $param->{cdrom
};
57 my $NEW_DISK_RE = qr!^(([^/:\s]+):)?(\d+(\.\d+)?)$!;
58 my $check_storage_access = sub {
59 my ($rpcenv, $authuser, $storecfg, $vmid, $settings, $default_storage) = @_;
61 PVE
::QemuServer
::foreach_drive
($settings, sub {
62 my ($ds, $drive) = @_;
64 my $isCDROM = PVE
::QemuServer
::drive_is_cdrom
($drive);
66 my $volid = $drive->{file
};
68 if (!$volid || ($volid eq 'none' || $volid eq 'cloudinit')) {
70 } elsif ($volid =~ m/^(([^:\s]+):)?(cloudinit)$/) {
72 } elsif ($isCDROM && ($volid eq 'cdrom')) {
73 $rpcenv->check($authuser, "/", ['Sys.Console']);
74 } elsif (!$isCDROM && ($volid =~ $NEW_DISK_RE)) {
75 my ($storeid, $size) = ($2 || $default_storage, $3);
76 die "no storage ID specified (and no default storage)\n" if !$storeid;
77 $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
78 my $scfg = PVE
::Storage
::storage_config
($storecfg, $storeid);
79 raise_param_exc
({ storage
=> "storage '$storeid' does not support vm images"})
80 if !$scfg->{content
}->{images
};
82 PVE
::Storage
::check_volume_access
($rpcenv, $authuser, $storecfg, $vmid, $volid);
86 $rpcenv->check($authuser, "/storage/$settings->{vmstatestorage}", ['Datastore.AllocateSpace'])
87 if defined($settings->{vmstatestorage
});
90 my $check_storage_access_clone = sub {
91 my ($rpcenv, $authuser, $storecfg, $conf, $storage) = @_;
95 PVE
::QemuServer
::foreach_drive
($conf, sub {
96 my ($ds, $drive) = @_;
98 my $isCDROM = PVE
::QemuServer
::drive_is_cdrom
($drive);
100 my $volid = $drive->{file
};
102 return if !$volid || $volid eq 'none';
105 if ($volid eq 'cdrom') {
106 $rpcenv->check($authuser, "/", ['Sys.Console']);
108 # we simply allow access
109 my ($sid, $volname) = PVE
::Storage
::parse_volume_id
($volid);
110 my $scfg = PVE
::Storage
::storage_config
($storecfg, $sid);
111 $sharedvm = 0 if !$scfg->{shared
};
115 my ($sid, $volname) = PVE
::Storage
::parse_volume_id
($volid);
116 my $scfg = PVE
::Storage
::storage_config
($storecfg, $sid);
117 $sharedvm = 0 if !$scfg->{shared
};
119 $sid = $storage if $storage;
120 $rpcenv->check($authuser, "/storage/$sid", ['Datastore.AllocateSpace']);
124 $rpcenv->check($authuser, "/storage/$conf->{vmstatestorage}", ['Datastore.AllocateSpace'])
125 if defined($conf->{vmstatestorage
});
130 # Note: $pool is only needed when creating a VM, because pool permissions
131 # are automatically inherited if VM already exists inside a pool.
132 my $create_disks = sub {
133 my ($rpcenv, $authuser, $conf, $arch, $storecfg, $vmid, $pool, $settings, $default_storage) = @_;
140 my ($ds, $disk) = @_;
142 my $volid = $disk->{file
};
144 if (!$volid || $volid eq 'none' || $volid eq 'cdrom') {
145 delete $disk->{size
};
146 $res->{$ds} = PVE
::QemuServer
::print_drive
($vmid, $disk);
147 } elsif ($volid =~ m!^(?:([^/:\s]+):)?cloudinit$!) {
148 my $storeid = $1 || $default_storage;
149 die "no storage ID specified (and no default storage)\n" if !$storeid;
150 my $scfg = PVE
::Storage
::storage_config
($storecfg, $storeid);
151 my $name = "vm-$vmid-cloudinit";
159 # FIXME: Reasonable size? qcow2 shouldn't grow if the space isn't used anyway?
160 my $cloudinit_iso_size = 5; # in MB
161 my $volid = PVE
::Storage
::vdisk_alloc
($storecfg, $storeid, $vmid,
162 $fmt, $name, $cloudinit_iso_size*1024);
163 $disk->{file
} = $volid;
164 $disk->{media
} = 'cdrom';
165 push @$vollist, $volid;
166 delete $disk->{format
}; # no longer needed
167 $res->{$ds} = PVE
::QemuServer
::print_drive
($vmid, $disk);
168 } elsif ($volid =~ $NEW_DISK_RE) {
169 my ($storeid, $size) = ($2 || $default_storage, $3);
170 die "no storage ID specified (and no default storage)\n" if !$storeid;
171 my $defformat = PVE
::Storage
::storage_default_format
($storecfg, $storeid);
172 my $fmt = $disk->{format
} || $defformat;
174 $size = PVE
::Tools
::convert_size
($size, 'gb' => 'kb'); # vdisk_alloc uses kb
177 if ($ds eq 'efidisk0') {
178 ($volid, $size) = PVE
::QemuServer
::create_efidisk
($storecfg, $storeid, $vmid, $fmt, $arch);
180 $volid = PVE
::Storage
::vdisk_alloc
($storecfg, $storeid, $vmid, $fmt, undef, $size);
182 push @$vollist, $volid;
183 $disk->{file
} = $volid;
184 $disk->{size
} = PVE
::Tools
::convert_size
($size, 'kb' => 'b');
185 delete $disk->{format
}; # no longer needed
186 $res->{$ds} = PVE
::QemuServer
::print_drive
($vmid, $disk);
189 PVE
::Storage
::check_volume_access
($rpcenv, $authuser, $storecfg, $vmid, $volid);
191 my $volid_is_new = 1;
194 my $olddrive = PVE
::QemuServer
::parse_drive
($ds, $conf->{$ds});
195 $volid_is_new = undef if $olddrive->{file
} && $olddrive->{file
} eq $volid;
200 my ($storeid, $volname) = PVE
::Storage
::parse_volume_id
($volid, 1);
202 PVE
::Storage
::activate_volumes
($storecfg, [ $volid ]) if $storeid;
204 my $size = PVE
::Storage
::volume_size_info
($storecfg, $volid);
206 die "volume $volid does not exists\n" if !$size;
208 $disk->{size
} = $size;
211 $res->{$ds} = PVE
::QemuServer
::print_drive
($vmid, $disk);
215 eval { PVE
::QemuServer
::foreach_drive
($settings, $code); };
217 # free allocated images on error
219 syslog
('err', "VM $vmid creating disks failed");
220 foreach my $volid (@$vollist) {
221 eval { PVE
::Storage
::vdisk_free
($storecfg, $volid); };
227 # modify vm config if everything went well
228 foreach my $ds (keys %$res) {
229 $conf->{$ds} = $res->{$ds};
246 my $memoryoptions = {
252 my $hwtypeoptions = {
264 my $generaloptions = {
271 'migrate_downtime' => 1,
272 'migrate_speed' => 1,
284 my $vmpoweroptions = {
291 'vmstatestorage' => 1,
294 my $cloudinitoptions = {
304 my $check_vm_modify_config_perm = sub {
305 my ($rpcenv, $authuser, $vmid, $pool, $key_list) = @_;
307 return 1 if $authuser eq 'root@pam';
309 foreach my $opt (@$key_list) {
310 # disk checks need to be done somewhere else
311 next if PVE
::QemuServer
::is_valid_drivename
($opt);
312 next if $opt eq 'cdrom';
313 next if $opt =~ m/^unused\d+$/;
315 if ($cpuoptions->{$opt} || $opt =~ m/^numa\d+$/) {
316 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.CPU']);
317 } elsif ($memoryoptions->{$opt}) {
318 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Memory']);
319 } elsif ($hwtypeoptions->{$opt}) {
320 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.HWType']);
321 } elsif ($generaloptions->{$opt}) {
322 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Options']);
323 # special case for startup since it changes host behaviour
324 if ($opt eq 'startup') {
325 $rpcenv->check_full($authuser, "/", ['Sys.Modify']);
327 } elsif ($vmpoweroptions->{$opt}) {
328 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.PowerMgmt']);
329 } elsif ($diskoptions->{$opt}) {
330 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Disk']);
331 } elsif ($cloudinitoptions->{$opt} || ($opt =~ m/^(?:net|ipconfig)\d+$/)) {
332 $rpcenv->check_vm_perm($authuser, $vmid, $pool, ['VM.Config.Network']);
334 # catches usb\d+, hostpci\d+, args, lock, etc.
335 # new options will be checked here
336 die "only root can set '$opt' config\n";
343 __PACKAGE__-
>register_method({
347 description
=> "Virtual machine index (per node).",
349 description
=> "Only list VMs where you have VM.Audit permissons on /vms/<vmid>.",
353 protected
=> 1, # qemu pid files are only readable by root
355 additionalProperties
=> 0,
357 node
=> get_standard_option
('pve-node'),
361 description
=> "Determine the full status of active VMs.",
369 properties
=> $PVE::QemuServer
::vmstatus_return_properties
,
371 links
=> [ { rel
=> 'child', href
=> "{vmid}" } ],
376 my $rpcenv = PVE
::RPCEnvironment
::get
();
377 my $authuser = $rpcenv->get_user();
379 my $vmstatus = PVE
::QemuServer
::vmstatus
(undef, $param->{full
});
382 foreach my $vmid (keys %$vmstatus) {
383 next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Audit' ], 1);
385 my $data = $vmstatus->{$vmid};
394 __PACKAGE__-
>register_method({
398 description
=> "Create or restore a virtual machine.",
400 description
=> "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. " .
401 "For restore (option 'archive'), it is enough if the user has 'VM.Backup' permission and the VM already exists. " .
402 "If you create disks you need 'Datastore.AllocateSpace' on any used storage.",
403 user
=> 'all', # check inside
408 additionalProperties
=> 0,
409 properties
=> PVE
::QemuServer
::json_config_properties
(
411 node
=> get_standard_option
('pve-node'),
412 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::Cluster
::complete_next_vmid
}),
414 description
=> "The backup file.",
418 completion
=> \
&PVE
::QemuServer
::complete_backup_archives
,
420 storage
=> get_standard_option
('pve-storage-id', {
421 description
=> "Default storage.",
423 completion
=> \
&PVE
::QemuServer
::complete_storage
,
428 description
=> "Allow to overwrite existing VM.",
429 requires
=> 'archive',
434 description
=> "Assign a unique random ethernet address.",
435 requires
=> 'archive',
439 type
=> 'string', format
=> 'pve-poolid',
440 description
=> "Add the VM to the specified pool.",
443 description
=> "Override i/o bandwidth limit (in KiB/s).",
452 description
=> "Start VM after it was created successfully.",
462 my $rpcenv = PVE
::RPCEnvironment
::get
();
464 my $authuser = $rpcenv->get_user();
466 my $node = extract_param
($param, 'node');
468 my $vmid = extract_param
($param, 'vmid');
470 my $archive = extract_param
($param, 'archive');
471 my $is_restore = !!$archive;
473 my $storage = extract_param
($param, 'storage');
475 my $force = extract_param
($param, 'force');
477 my $unique = extract_param
($param, 'unique');
479 my $pool = extract_param
($param, 'pool');
481 my $bwlimit = extract_param
($param, 'bwlimit');
483 my $start_after_create = extract_param
($param, 'start');
485 my $filename = PVE
::QemuConfig-
>config_file($vmid);
487 my $storecfg = PVE
::Storage
::config
();
489 if (defined(my $ssh_keys = $param->{sshkeys
})) {
490 $ssh_keys = URI
::Escape
::uri_unescape
($ssh_keys);
491 PVE
::Tools
::validate_ssh_public_keys
($ssh_keys);
494 PVE
::Cluster
::check_cfs_quorum
();
496 if (defined($pool)) {
497 $rpcenv->check_pool_exist($pool);
500 $rpcenv->check($authuser, "/storage/$storage", ['Datastore.AllocateSpace'])
501 if defined($storage);
503 if ($rpcenv->check($authuser, "/vms/$vmid", ['VM.Allocate'], 1)) {
505 } elsif ($pool && $rpcenv->check($authuser, "/pool/$pool", ['VM.Allocate'], 1)) {
507 } elsif ($archive && $force && (-f
$filename) &&
508 $rpcenv->check($authuser, "/vms/$vmid", ['VM.Backup'], 1)) {
509 # OK: user has VM.Backup permissions, and want to restore an existing VM
515 &$resolve_cdrom_alias($param);
517 &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $param, $storage);
519 &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, $pool, [ keys %$param]);
521 foreach my $opt (keys %$param) {
522 if (PVE
::QemuServer
::is_valid_drivename
($opt)) {
523 my $drive = PVE
::QemuServer
::parse_drive
($opt, $param->{$opt});
524 raise_param_exc
({ $opt => "unable to parse drive options" }) if !$drive;
526 PVE
::QemuServer
::cleanup_drive_path
($opt, $storecfg, $drive);
527 $param->{$opt} = PVE
::QemuServer
::print_drive
($vmid, $drive);
531 PVE
::QemuServer
::add_random_macs
($param);
533 my $keystr = join(' ', keys %$param);
534 raise_param_exc
({ archive
=> "option conflicts with other options ($keystr)"}) if $keystr;
536 if ($archive eq '-') {
537 die "pipe requires cli environment\n"
538 if $rpcenv->{type
} ne 'cli';
540 PVE
::Storage
::check_volume_access
($rpcenv, $authuser, $storecfg, $vmid, $archive);
541 $archive = PVE
::Storage
::abs_filesystem_path
($storecfg, $archive);
545 my $emsg = $is_restore ?
"unable to restore VM $vmid -" : "unable to create VM $vmid -";
547 eval { PVE
::QemuConfig-
>create_and_lock_config($vmid, $force) };
548 die "$emsg $@" if $@;
550 my $restorefn = sub {
551 my $conf = PVE
::QemuConfig-
>load_config($vmid);
553 PVE
::QemuConfig-
>check_protection($conf, $emsg);
555 die "$emsg vm is running\n" if PVE
::QemuServer
::check_running
($vmid);
556 die "$emsg vm is a template\n" if PVE
::QemuConfig-
>is_template($conf);
559 PVE
::QemuServer
::restore_archive
($archive, $vmid, $authuser, {
563 bwlimit
=> $bwlimit, });
565 PVE
::AccessControl
::add_vm_to_pool
($vmid, $pool) if $pool;
567 if ($start_after_create) {
568 eval { PVE
::API2
::Qemu-
>vm_start({ vmid
=> $vmid, node
=> $node }) };
573 # ensure no old replication state are exists
574 PVE
::ReplicationState
::delete_guest_states
($vmid);
576 return PVE
::QemuConfig-
>lock_config_full($vmid, 1, $realcmd);
580 # ensure no old replication state are exists
581 PVE
::ReplicationState
::delete_guest_states
($vmid);
589 my ($arch, undef) = PVE
::QemuServer
::get_basic_machine_info
($conf);
593 $vollist = &$create_disks($rpcenv, $authuser, $conf, $arch, $storecfg, $vmid, $pool, $param, $storage);
595 if (!$conf->{bootdisk
}) {
596 my $firstdisk = PVE
::QemuServer
::resolve_first_disk
($conf);
597 $conf->{bootdisk
} = $firstdisk if $firstdisk;
600 # auto generate uuid if user did not specify smbios1 option
601 if (!$conf->{smbios1
}) {
602 $conf->{smbios1
} = PVE
::QemuServer
::generate_smbios1_uuid
();
605 if ((!defined($conf->{vmgenid
}) || $conf->{vmgenid
} eq '1') && $arch ne 'aarch64') {
606 $conf->{vmgenid
} = PVE
::QemuServer
::generate_uuid
();
609 PVE
::QemuConfig-
>write_config($vmid, $conf);
615 foreach my $volid (@$vollist) {
616 eval { PVE
::Storage
::vdisk_free
($storecfg, $volid); };
622 PVE
::AccessControl
::add_vm_to_pool
($vmid, $pool) if $pool;
625 PVE
::QemuConfig-
>lock_config_full($vmid, 1, $realcmd);
627 if ($start_after_create) {
628 print "Execute autostart\n";
629 eval { PVE
::API2
::Qemu-
>vm_start({vmid
=> $vmid, node
=> $node}) };
634 my ($code, $worker_name);
636 $worker_name = 'qmrestore';
638 eval { $restorefn->() };
640 eval { PVE
::QemuConfig-
>remove_lock($vmid, 'create') };
646 $worker_name = 'qmcreate';
648 eval { $createfn->() };
651 my $conffile = PVE
::QemuConfig-
>config_file($vmid);
652 unlink($conffile) or die "failed to remove config file: $!\n";
660 return $rpcenv->fork_worker($worker_name, $vmid, $authuser, $code);
663 __PACKAGE__-
>register_method({
668 description
=> "Directory index",
673 additionalProperties
=> 0,
675 node
=> get_standard_option
('pve-node'),
676 vmid
=> get_standard_option
('pve-vmid'),
684 subdir
=> { type
=> 'string' },
687 links
=> [ { rel
=> 'child', href
=> "{subdir}" } ],
693 { subdir
=> 'config' },
694 { subdir
=> 'pending' },
695 { subdir
=> 'status' },
696 { subdir
=> 'unlink' },
697 { subdir
=> 'vncproxy' },
698 { subdir
=> 'termproxy' },
699 { subdir
=> 'migrate' },
700 { subdir
=> 'resize' },
701 { subdir
=> 'move' },
703 { subdir
=> 'rrddata' },
704 { subdir
=> 'monitor' },
705 { subdir
=> 'agent' },
706 { subdir
=> 'snapshot' },
707 { subdir
=> 'spiceproxy' },
708 { subdir
=> 'sendkey' },
709 { subdir
=> 'firewall' },
715 __PACKAGE__-
>register_method ({
716 subclass
=> "PVE::API2::Firewall::VM",
717 path
=> '{vmid}/firewall',
720 __PACKAGE__-
>register_method ({
721 subclass
=> "PVE::API2::Qemu::Agent",
722 path
=> '{vmid}/agent',
725 __PACKAGE__-
>register_method({
727 path
=> '{vmid}/rrd',
729 protected
=> 1, # fixme: can we avoid that?
731 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
733 description
=> "Read VM RRD statistics (returns PNG)",
735 additionalProperties
=> 0,
737 node
=> get_standard_option
('pve-node'),
738 vmid
=> get_standard_option
('pve-vmid'),
740 description
=> "Specify the time frame you are interested in.",
742 enum
=> [ 'hour', 'day', 'week', 'month', 'year' ],
745 description
=> "The list of datasources you want to display.",
746 type
=> 'string', format
=> 'pve-configid-list',
749 description
=> "The RRD consolidation function",
751 enum
=> [ 'AVERAGE', 'MAX' ],
759 filename
=> { type
=> 'string' },
765 return PVE
::Cluster
::create_rrd_graph
(
766 "pve2-vm/$param->{vmid}", $param->{timeframe
},
767 $param->{ds
}, $param->{cf
});
771 __PACKAGE__-
>register_method({
773 path
=> '{vmid}/rrddata',
775 protected
=> 1, # fixme: can we avoid that?
777 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
779 description
=> "Read VM RRD statistics",
781 additionalProperties
=> 0,
783 node
=> get_standard_option
('pve-node'),
784 vmid
=> get_standard_option
('pve-vmid'),
786 description
=> "Specify the time frame you are interested in.",
788 enum
=> [ 'hour', 'day', 'week', 'month', 'year' ],
791 description
=> "The RRD consolidation function",
793 enum
=> [ 'AVERAGE', 'MAX' ],
808 return PVE
::Cluster
::create_rrd_data
(
809 "pve2-vm/$param->{vmid}", $param->{timeframe
}, $param->{cf
});
813 __PACKAGE__-
>register_method({
815 path
=> '{vmid}/config',
818 description
=> "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API).",
820 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
823 additionalProperties
=> 0,
825 node
=> get_standard_option
('pve-node'),
826 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
828 description
=> "Get current values (instead of pending values).",
833 snapshot
=> get_standard_option
('pve-snapshot-name', {
834 description
=> "Fetch config values from given snapshot.",
837 my ($cmd, $pname, $cur, $args) = @_;
838 PVE
::QemuConfig-
>snapshot_list($args->[0]);
844 description
=> "The current VM configuration.",
846 properties
=> PVE
::QemuServer
::json_config_properties
({
849 description
=> 'SHA1 digest of configuration file. This can be used to prevent concurrent modifications.',
856 my $conf = PVE
::QemuConfig-
>load_config($param->{vmid
});
858 if (my $snapname = $param->{snapshot
}) {
859 my $snapshot = $conf->{snapshots
}->{$snapname};
860 die "snapshot '$snapname' does not exist\n" if !defined($snapshot);
862 $snapshot->{digest
} = $conf->{digest
}; # keep file digest for API
867 delete $conf->{snapshots
};
869 if (!$param->{current
}) {
870 foreach my $opt (keys %{$conf->{pending
}}) {
871 next if $opt eq 'delete';
872 my $value = $conf->{pending
}->{$opt};
873 next if ref($value); # just to be sure
874 $conf->{$opt} = $value;
876 my $pending_delete_hash = PVE
::QemuServer
::split_flagged_list
($conf->{pending
}->{delete});
877 foreach my $opt (keys %$pending_delete_hash) {
878 delete $conf->{$opt} if $conf->{$opt};
882 delete $conf->{pending
};
884 # hide cloudinit password
885 if ($conf->{cipassword
}) {
886 $conf->{cipassword
} = '**********';
892 __PACKAGE__-
>register_method({
893 name
=> 'vm_pending',
894 path
=> '{vmid}/pending',
897 description
=> "Get virtual machine configuration, including pending changes.",
899 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
902 additionalProperties
=> 0,
904 node
=> get_standard_option
('pve-node'),
905 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
914 description
=> "Configuration option name.",
918 description
=> "Current value.",
923 description
=> "Pending value.",
928 description
=> "Indicates a pending delete request if present and not 0. " .
929 "The value 2 indicates a force-delete request.",
941 my $conf = PVE
::QemuConfig-
>load_config($param->{vmid
});
943 my $pending_delete_hash = PVE
::QemuServer
::split_flagged_list
($conf->{pending
}->{delete});
947 foreach my $opt (keys %$conf) {
948 next if ref($conf->{$opt});
949 my $item = { key
=> $opt };
950 $item->{value
} = $conf->{$opt} if defined($conf->{$opt});
951 $item->{pending
} = $conf->{pending
}->{$opt} if defined($conf->{pending
}->{$opt});
952 $item->{delete} = ($pending_delete_hash->{$opt} ?
2 : 1) if exists $pending_delete_hash->{$opt};
954 # hide cloudinit password
955 if ($opt eq 'cipassword') {
956 $item->{value
} = '**********' if defined($item->{value
});
957 # the trailing space so that the pending string is different
958 $item->{pending
} = '********** ' if defined($item->{pending
});
963 foreach my $opt (keys %{$conf->{pending
}}) {
964 next if $opt eq 'delete';
965 next if ref($conf->{pending
}->{$opt}); # just to be sure
966 next if defined($conf->{$opt});
967 my $item = { key
=> $opt };
968 $item->{pending
} = $conf->{pending
}->{$opt};
970 # hide cloudinit password
971 if ($opt eq 'cipassword') {
972 $item->{pending
} = '**********' if defined($item->{pending
});
977 while (my ($opt, $force) = each %$pending_delete_hash) {
978 next if $conf->{pending
}->{$opt}; # just to be sure
979 next if $conf->{$opt};
980 my $item = { key
=> $opt, delete => ($force ?
2 : 1)};
987 # POST/PUT {vmid}/config implementation
989 # The original API used PUT (idempotent) an we assumed that all operations
990 # are fast. But it turned out that almost any configuration change can
991 # involve hot-plug actions, or disk alloc/free. Such actions can take long
992 # time to complete and have side effects (not idempotent).
994 # The new implementation uses POST and forks a worker process. We added
995 # a new option 'background_delay'. If specified we wait up to
996 # 'background_delay' second for the worker task to complete. It returns null
997 # if the task is finished within that time, else we return the UPID.
999 my $update_vm_api = sub {
1000 my ($param, $sync) = @_;
1002 my $rpcenv = PVE
::RPCEnvironment
::get
();
1004 my $authuser = $rpcenv->get_user();
1006 my $node = extract_param
($param, 'node');
1008 my $vmid = extract_param
($param, 'vmid');
1010 my $digest = extract_param
($param, 'digest');
1012 my $background_delay = extract_param
($param, 'background_delay');
1014 if (defined(my $cipassword = $param->{cipassword
})) {
1015 # Same logic as in cloud-init (but with the regex fixed...)
1016 $param->{cipassword
} = PVE
::Tools
::encrypt_pw
($cipassword)
1017 if $cipassword !~ /^\$(?:[156]|2[ay])(\$.+){2}/;
1020 my @paramarr = (); # used for log message
1021 foreach my $key (sort keys %$param) {
1022 my $value = $key eq 'cipassword' ?
'<hidden>' : $param->{$key};
1023 push @paramarr, "-$key", $value;
1026 my $skiplock = extract_param
($param, 'skiplock');
1027 raise_param_exc
({ skiplock
=> "Only root may use this option." })
1028 if $skiplock && $authuser ne 'root@pam';
1030 my $delete_str = extract_param
($param, 'delete');
1032 my $revert_str = extract_param
($param, 'revert');
1034 my $force = extract_param
($param, 'force');
1036 if (defined(my $ssh_keys = $param->{sshkeys
})) {
1037 $ssh_keys = URI
::Escape
::uri_unescape
($ssh_keys);
1038 PVE
::Tools
::validate_ssh_public_keys
($ssh_keys);
1041 die "no options specified\n" if !$delete_str && !$revert_str && !scalar(keys %$param);
1043 my $storecfg = PVE
::Storage
::config
();
1045 my $defaults = PVE
::QemuServer
::load_defaults
();
1047 &$resolve_cdrom_alias($param);
1049 # now try to verify all parameters
1052 foreach my $opt (PVE
::Tools
::split_list
($revert_str)) {
1053 if (!PVE
::QemuServer
::option_exists
($opt)) {
1054 raise_param_exc
({ revert
=> "unknown option '$opt'" });
1057 raise_param_exc
({ delete => "you can't use '-$opt' and " .
1058 "-revert $opt' at the same time" })
1059 if defined($param->{$opt});
1061 $revert->{$opt} = 1;
1065 foreach my $opt (PVE
::Tools
::split_list
($delete_str)) {
1066 $opt = 'ide2' if $opt eq 'cdrom';
1068 raise_param_exc
({ delete => "you can't use '-$opt' and " .
1069 "-delete $opt' at the same time" })
1070 if defined($param->{$opt});
1072 raise_param_exc
({ revert
=> "you can't use '-delete $opt' and " .
1073 "-revert $opt' at the same time" })
1076 if (!PVE
::QemuServer
::option_exists
($opt)) {
1077 raise_param_exc
({ delete => "unknown option '$opt'" });
1083 my $repl_conf = PVE
::ReplicationConfig-
>new();
1084 my $is_replicated = $repl_conf->check_for_existing_jobs($vmid, 1);
1085 my $check_replication = sub {
1087 return if !$is_replicated;
1088 my $volid = $drive->{file
};
1089 return if !$volid || !($drive->{replicate
}//1);
1090 return if PVE
::QemuServer
::drive_is_cdrom
($drive);
1091 my ($storeid, $format);
1092 if ($volid =~ $NEW_DISK_RE) {
1094 $format = $drive->{format
} || PVE
::Storage
::storage_default_format
($storecfg, $storeid);
1096 ($storeid, undef) = PVE
::Storage
::parse_volume_id
($volid, 1);
1097 $format = (PVE
::Storage
::parse_volname
($storecfg, $volid))[6];
1099 return if PVE
::Storage
::storage_can_replicate
($storecfg, $storeid, $format);
1100 my $scfg = PVE
::Storage
::storage_config
($storecfg, $storeid);
1101 return if $scfg->{shared
};
1102 die "cannot add non-replicatable volume to a replicated VM\n";
1105 foreach my $opt (keys %$param) {
1106 if (PVE
::QemuServer
::is_valid_drivename
($opt)) {
1107 # cleanup drive path
1108 my $drive = PVE
::QemuServer
::parse_drive
($opt, $param->{$opt});
1109 raise_param_exc
({ $opt => "unable to parse drive options" }) if !$drive;
1110 PVE
::QemuServer
::cleanup_drive_path
($opt, $storecfg, $drive);
1111 $check_replication->($drive);
1112 $param->{$opt} = PVE
::QemuServer
::print_drive
($vmid, $drive);
1113 } elsif ($opt =~ m/^net(\d+)$/) {
1115 my $net = PVE
::QemuServer
::parse_net
($param->{$opt});
1116 $param->{$opt} = PVE
::QemuServer
::print_net
($net);
1117 } elsif ($opt eq 'vmgenid') {
1118 if ($param->{$opt} eq '1') {
1119 $param->{$opt} = PVE
::QemuServer
::generate_uuid
();
1121 } elsif ($opt eq 'hookscript') {
1122 eval { PVE
::GuestHelpers
::check_hookscript
($param->{$opt}, $storecfg); };
1123 raise_param_exc
({ $opt => $@ }) if $@;
1127 &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, undef, [@delete]);
1129 &$check_vm_modify_config_perm($rpcenv, $authuser, $vmid, undef, [keys %$param]);
1131 &$check_storage_access($rpcenv, $authuser, $storecfg, $vmid, $param);
1133 my $updatefn = sub {
1135 my $conf = PVE
::QemuConfig-
>load_config($vmid);
1137 die "checksum missmatch (file change by other user?)\n"
1138 if $digest && $digest ne $conf->{digest
};
1140 PVE
::QemuConfig-
>check_lock($conf) if !$skiplock;
1142 foreach my $opt (keys %$revert) {
1143 if (defined($conf->{$opt})) {
1144 $param->{$opt} = $conf->{$opt};
1145 } elsif (defined($conf->{pending
}->{$opt})) {
1150 if ($param->{memory
} || defined($param->{balloon
})) {
1151 my $maxmem = $param->{memory
} || $conf->{pending
}->{memory
} || $conf->{memory
} || $defaults->{memory
};
1152 my $balloon = defined($param->{balloon
}) ?
$param->{balloon
} : $conf->{pending
}->{balloon
} || $conf->{balloon
};
1154 die "balloon value too large (must be smaller than assigned memory)\n"
1155 if $balloon && $balloon > $maxmem;
1158 PVE
::Cluster
::log_msg
('info', $authuser, "update VM $vmid: " . join (' ', @paramarr));
1162 print "update VM $vmid: " . join (' ', @paramarr) . "\n";
1164 # write updates to pending section
1166 my $modified = {}; # record what $option we modify
1168 foreach my $opt (@delete) {
1169 $modified->{$opt} = 1;
1170 $conf = PVE
::QemuConfig-
>load_config($vmid); # update/reload
1171 if (!defined($conf->{$opt}) && !defined($conf->{pending
}->{$opt})) {
1172 warn "cannot delete '$opt' - not set in current configuration!\n";
1173 $modified->{$opt} = 0;
1177 if ($opt =~ m/^unused/) {
1178 my $drive = PVE
::QemuServer
::parse_drive
($opt, $conf->{$opt});
1179 PVE
::QemuConfig-
>check_protection($conf, "can't remove unused disk '$drive->{file}'");
1180 $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
1181 if (PVE
::QemuServer
::try_deallocate_drive
($storecfg, $vmid, $conf, $opt, $drive, $rpcenv, $authuser)) {
1182 delete $conf->{$opt};
1183 PVE
::QemuConfig-
>write_config($vmid, $conf);
1185 } elsif (PVE
::QemuServer
::is_valid_drivename
($opt)) {
1186 PVE
::QemuConfig-
>check_protection($conf, "can't remove drive '$opt'");
1187 $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
1188 PVE
::QemuServer
::vmconfig_register_unused_drive
($storecfg, $vmid, $conf, PVE
::QemuServer
::parse_drive
($opt, $conf->{pending
}->{$opt}))
1189 if defined($conf->{pending
}->{$opt});
1190 PVE
::QemuServer
::vmconfig_delete_pending_option
($conf, $opt, $force);
1191 PVE
::QemuConfig-
>write_config($vmid, $conf);
1193 PVE
::QemuServer
::vmconfig_delete_pending_option
($conf, $opt, $force);
1194 PVE
::QemuConfig-
>write_config($vmid, $conf);
1198 foreach my $opt (keys %$param) { # add/change
1199 $modified->{$opt} = 1;
1200 $conf = PVE
::QemuConfig-
>load_config($vmid); # update/reload
1201 next if defined($conf->{pending
}->{$opt}) && ($param->{$opt} eq $conf->{pending
}->{$opt}); # skip if nothing changed
1203 my ($arch, undef) = PVE
::QemuServer
::get_basic_machine_info
($conf);
1205 if (PVE
::QemuServer
::is_valid_drivename
($opt)) {
1206 my $drive = PVE
::QemuServer
::parse_drive
($opt, $param->{$opt});
1207 # FIXME: cloudinit: CDROM or Disk?
1208 if (PVE
::QemuServer
::drive_is_cdrom
($drive)) { # CDROM
1209 $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.CDROM']);
1211 $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Disk']);
1213 PVE
::QemuServer
::vmconfig_register_unused_drive
($storecfg, $vmid, $conf, PVE
::QemuServer
::parse_drive
($opt, $conf->{pending
}->{$opt}))
1214 if defined($conf->{pending
}->{$opt});
1216 &$create_disks($rpcenv, $authuser, $conf->{pending
}, $arch, $storecfg, $vmid, undef, {$opt => $param->{$opt}});
1218 $conf->{pending
}->{$opt} = $param->{$opt};
1220 PVE
::QemuServer
::vmconfig_undelete_pending_option
($conf, $opt);
1221 PVE
::QemuConfig-
>write_config($vmid, $conf);
1224 # remove pending changes when nothing changed
1225 $conf = PVE
::QemuConfig-
>load_config($vmid); # update/reload
1226 my $changes = PVE
::QemuServer
::vmconfig_cleanup_pending
($conf);
1227 PVE
::QemuConfig-
>write_config($vmid, $conf) if $changes;
1229 return if !scalar(keys %{$conf->{pending
}});
1231 my $running = PVE
::QemuServer
::check_running
($vmid);
1233 # apply pending changes
1235 $conf = PVE
::QemuConfig-
>load_config($vmid); # update/reload
1239 PVE
::QemuServer
::vmconfig_hotplug_pending
($vmid, $conf, $storecfg, $modified, $errors);
1240 raise_param_exc
($errors) if scalar(keys %$errors);
1242 PVE
::QemuServer
::vmconfig_apply_pending
($vmid, $conf, $storecfg, $running);
1252 my $upid = $rpcenv->fork_worker('qmconfig', $vmid, $authuser, $worker);
1254 if ($background_delay) {
1256 # Note: It would be better to do that in the Event based HTTPServer
1257 # to avoid blocking call to sleep.
1259 my $end_time = time() + $background_delay;
1261 my $task = PVE
::Tools
::upid_decode
($upid);
1264 while (time() < $end_time) {
1265 $running = PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
});
1267 sleep(1); # this gets interrupted when child process ends
1271 my $status = PVE
::Tools
::upid_read_status
($upid);
1272 return undef if $status eq 'OK';
1281 return PVE
::QemuConfig-
>lock_config($vmid, $updatefn);
1284 my $vm_config_perm_list = [
1289 'VM.Config.Network',
1291 'VM.Config.Options',
1294 __PACKAGE__-
>register_method({
1295 name
=> 'update_vm_async',
1296 path
=> '{vmid}/config',
1300 description
=> "Set virtual machine options (asynchrounous API).",
1302 check
=> ['perm', '/vms/{vmid}', $vm_config_perm_list, any
=> 1],
1305 additionalProperties
=> 0,
1306 properties
=> PVE
::QemuServer
::json_config_properties
(
1308 node
=> get_standard_option
('pve-node'),
1309 vmid
=> get_standard_option
('pve-vmid'),
1310 skiplock
=> get_standard_option
('skiplock'),
1312 type
=> 'string', format
=> 'pve-configid-list',
1313 description
=> "A list of settings you want to delete.",
1317 type
=> 'string', format
=> 'pve-configid-list',
1318 description
=> "Revert a pending change.",
1323 description
=> $opt_force_description,
1325 requires
=> 'delete',
1329 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1333 background_delay
=> {
1335 description
=> "Time to wait for the task to finish. We return 'null' if the task finish within that time.",
1346 code
=> $update_vm_api,
1349 __PACKAGE__-
>register_method({
1350 name
=> 'update_vm',
1351 path
=> '{vmid}/config',
1355 description
=> "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.",
1357 check
=> ['perm', '/vms/{vmid}', $vm_config_perm_list, any
=> 1],
1360 additionalProperties
=> 0,
1361 properties
=> PVE
::QemuServer
::json_config_properties
(
1363 node
=> get_standard_option
('pve-node'),
1364 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
1365 skiplock
=> get_standard_option
('skiplock'),
1367 type
=> 'string', format
=> 'pve-configid-list',
1368 description
=> "A list of settings you want to delete.",
1372 type
=> 'string', format
=> 'pve-configid-list',
1373 description
=> "Revert a pending change.",
1378 description
=> $opt_force_description,
1380 requires
=> 'delete',
1384 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1390 returns
=> { type
=> 'null' },
1393 &$update_vm_api($param, 1);
1399 __PACKAGE__-
>register_method({
1400 name
=> 'destroy_vm',
1405 description
=> "Destroy the vm (also delete all used/owned volumes).",
1407 check
=> [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
1410 additionalProperties
=> 0,
1412 node
=> get_standard_option
('pve-node'),
1413 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid_stopped
}),
1414 skiplock
=> get_standard_option
('skiplock'),
1423 my $rpcenv = PVE
::RPCEnvironment
::get
();
1425 my $authuser = $rpcenv->get_user();
1427 my $vmid = $param->{vmid
};
1429 my $skiplock = $param->{skiplock
};
1430 raise_param_exc
({ skiplock
=> "Only root may use this option." })
1431 if $skiplock && $authuser ne 'root@pam';
1434 my $conf = PVE
::QemuConfig-
>load_config($vmid);
1436 my $storecfg = PVE
::Storage
::config
();
1438 PVE
::QemuConfig-
>check_protection($conf, "can't remove VM $vmid");
1440 die "unable to remove VM $vmid - used in HA resources\n"
1441 if PVE
::HA
::Config
::vm_is_ha_managed
($vmid);
1443 # do not allow destroy if there are replication jobs
1444 my $repl_conf = PVE
::ReplicationConfig-
>new();
1445 $repl_conf->check_for_existing_jobs($vmid);
1447 # early tests (repeat after locking)
1448 die "VM $vmid is running - destroy failed\n"
1449 if PVE
::QemuServer
::check_running
($vmid);
1454 syslog
('info', "destroy VM $vmid: $upid\n");
1456 PVE
::QemuServer
::vm_destroy
($storecfg, $vmid, $skiplock);
1458 PVE
::AccessControl
::remove_vm_access
($vmid);
1460 PVE
::Firewall
::remove_vmfw_conf
($vmid);
1463 return $rpcenv->fork_worker('qmdestroy', $vmid, $authuser, $realcmd);
1466 __PACKAGE__-
>register_method({
1468 path
=> '{vmid}/unlink',
1472 description
=> "Unlink/delete disk images.",
1474 check
=> [ 'perm', '/vms/{vmid}', ['VM.Config.Disk']],
1477 additionalProperties
=> 0,
1479 node
=> get_standard_option
('pve-node'),
1480 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
1482 type
=> 'string', format
=> 'pve-configid-list',
1483 description
=> "A list of disk IDs you want to delete.",
1487 description
=> $opt_force_description,
1492 returns
=> { type
=> 'null'},
1496 $param->{delete} = extract_param
($param, 'idlist');
1498 __PACKAGE__-
>update_vm($param);
1505 __PACKAGE__-
>register_method({
1507 path
=> '{vmid}/vncproxy',
1511 check
=> ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1513 description
=> "Creates a TCP VNC proxy connections.",
1515 additionalProperties
=> 0,
1517 node
=> get_standard_option
('pve-node'),
1518 vmid
=> get_standard_option
('pve-vmid'),
1522 description
=> "starts websockify instead of vncproxy",
1527 additionalProperties
=> 0,
1529 user
=> { type
=> 'string' },
1530 ticket
=> { type
=> 'string' },
1531 cert
=> { type
=> 'string' },
1532 port
=> { type
=> 'integer' },
1533 upid
=> { type
=> 'string' },
1539 my $rpcenv = PVE
::RPCEnvironment
::get
();
1541 my $authuser = $rpcenv->get_user();
1543 my $vmid = $param->{vmid
};
1544 my $node = $param->{node
};
1545 my $websocket = $param->{websocket
};
1547 my $conf = PVE
::QemuConfig-
>load_config($vmid, $node); # check if VM exists
1548 my $use_serial = ($conf->{vga
} && ($conf->{vga
} =~ m/^serial\d+$/));
1550 my $authpath = "/vms/$vmid";
1552 my $ticket = PVE
::AccessControl
::assemble_vnc_ticket
($authuser, $authpath);
1554 $sslcert = PVE
::Tools
::file_get_contents
("/etc/pve/pve-root-ca.pem", 8192)
1560 if ($node ne 'localhost' && $node ne PVE
::INotify
::nodename
()) {
1561 (undef, $family) = PVE
::Cluster
::remote_node_ip
($node);
1562 my $sshinfo = PVE
::Cluster
::get_ssh_info
($node);
1563 # NOTE: kvm VNC traffic is already TLS encrypted or is known unsecure
1564 $remcmd = PVE
::Cluster
::ssh_info_to_command
($sshinfo, $use_serial ?
'-t' : '-T');
1566 $family = PVE
::Tools
::get_host_address_family
($node);
1569 my $port = PVE
::Tools
::next_vnc_port
($family);
1576 syslog
('info', "starting vnc proxy $upid\n");
1582 my $termcmd = [ '/usr/sbin/qm', 'terminal', $vmid, '-iface', $conf->{vga
}, '-escape', '0' ];
1584 $cmd = ['/usr/bin/vncterm', '-rfbport', $port,
1585 '-timeout', $timeout, '-authpath', $authpath,
1586 '-perm', 'Sys.Console'];
1588 if ($param->{websocket
}) {
1589 $ENV{PVE_VNC_TICKET
} = $ticket; # pass ticket to vncterm
1590 push @$cmd, '-notls', '-listen', 'localhost';
1593 push @$cmd, '-c', @$remcmd, @$termcmd;
1595 PVE
::Tools
::run_command
($cmd);
1599 $ENV{LC_PVE_TICKET
} = $ticket if $websocket; # set ticket with "qm vncproxy"
1601 $cmd = [@$remcmd, "/usr/sbin/qm", 'vncproxy', $vmid];
1603 my $sock = IO
::Socket
::IP-
>new(
1608 GetAddrInfoFlags
=> 0,
1609 ) or die "failed to create socket: $!\n";
1610 # Inside the worker we shouldn't have any previous alarms
1611 # running anyway...:
1613 local $SIG{ALRM
} = sub { die "connection timed out\n" };
1615 accept(my $cli, $sock) or die "connection failed: $!\n";
1618 if (PVE
::Tools
::run_command
($cmd,
1619 output
=> '>&'.fileno($cli),
1620 input
=> '<&'.fileno($cli),
1623 die "Failed to run vncproxy.\n";
1630 my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd, 1);
1632 PVE
::Tools
::wait_for_vnc_port
($port);
1643 __PACKAGE__-
>register_method({
1644 name
=> 'termproxy',
1645 path
=> '{vmid}/termproxy',
1649 check
=> ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1651 description
=> "Creates a TCP proxy connections.",
1653 additionalProperties
=> 0,
1655 node
=> get_standard_option
('pve-node'),
1656 vmid
=> get_standard_option
('pve-vmid'),
1660 enum
=> [qw(serial0 serial1 serial2 serial3)],
1661 description
=> "opens a serial terminal (defaults to display)",
1666 additionalProperties
=> 0,
1668 user
=> { type
=> 'string' },
1669 ticket
=> { type
=> 'string' },
1670 port
=> { type
=> 'integer' },
1671 upid
=> { type
=> 'string' },
1677 my $rpcenv = PVE
::RPCEnvironment
::get
();
1679 my $authuser = $rpcenv->get_user();
1681 my $vmid = $param->{vmid
};
1682 my $node = $param->{node
};
1683 my $serial = $param->{serial
};
1685 my $conf = PVE
::QemuConfig-
>load_config($vmid, $node); # check if VM exists
1687 if (!defined($serial)) {
1688 if ($conf->{vga
} && $conf->{vga
} =~ m/^serial\d+$/) {
1689 $serial = $conf->{vga
};
1693 my $authpath = "/vms/$vmid";
1695 my $ticket = PVE
::AccessControl
::assemble_vnc_ticket
($authuser, $authpath);
1700 if ($node ne 'localhost' && $node ne PVE
::INotify
::nodename
()) {
1701 (undef, $family) = PVE
::Cluster
::remote_node_ip
($node);
1702 my $sshinfo = PVE
::Cluster
::get_ssh_info
($node);
1703 $remcmd = PVE
::Cluster
::ssh_info_to_command
($sshinfo, '-t');
1704 push @$remcmd, '--';
1706 $family = PVE
::Tools
::get_host_address_family
($node);
1709 my $port = PVE
::Tools
::next_vnc_port
($family);
1711 my $termcmd = [ '/usr/sbin/qm', 'terminal', $vmid, '-escape', '0'];
1712 push @$termcmd, '-iface', $serial if $serial;
1717 syslog
('info', "starting qemu termproxy $upid\n");
1719 my $cmd = ['/usr/bin/termproxy', $port, '--path', $authpath,
1720 '--perm', 'VM.Console', '--'];
1721 push @$cmd, @$remcmd, @$termcmd;
1723 PVE
::Tools
::run_command
($cmd);
1726 my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd, 1);
1728 PVE
::Tools
::wait_for_vnc_port
($port);
1738 __PACKAGE__-
>register_method({
1739 name
=> 'vncwebsocket',
1740 path
=> '{vmid}/vncwebsocket',
1743 description
=> "You also need to pass a valid ticket (vncticket).",
1744 check
=> ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1746 description
=> "Opens a weksocket for VNC traffic.",
1748 additionalProperties
=> 0,
1750 node
=> get_standard_option
('pve-node'),
1751 vmid
=> get_standard_option
('pve-vmid'),
1753 description
=> "Ticket from previous call to vncproxy.",
1758 description
=> "Port number returned by previous vncproxy call.",
1768 port
=> { type
=> 'string' },
1774 my $rpcenv = PVE
::RPCEnvironment
::get
();
1776 my $authuser = $rpcenv->get_user();
1778 my $vmid = $param->{vmid
};
1779 my $node = $param->{node
};
1781 my $authpath = "/vms/$vmid";
1783 PVE
::AccessControl
::verify_vnc_ticket
($param->{vncticket
}, $authuser, $authpath);
1785 my $conf = PVE
::QemuConfig-
>load_config($vmid, $node); # VM exists ?
1787 # Note: VNC ports are acessible from outside, so we do not gain any
1788 # security if we verify that $param->{port} belongs to VM $vmid. This
1789 # check is done by verifying the VNC ticket (inside VNC protocol).
1791 my $port = $param->{port
};
1793 return { port
=> $port };
1796 __PACKAGE__-
>register_method({
1797 name
=> 'spiceproxy',
1798 path
=> '{vmid}/spiceproxy',
1803 check
=> ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1805 description
=> "Returns a SPICE configuration to connect to the VM.",
1807 additionalProperties
=> 0,
1809 node
=> get_standard_option
('pve-node'),
1810 vmid
=> get_standard_option
('pve-vmid'),
1811 proxy
=> get_standard_option
('spice-proxy', { optional
=> 1 }),
1814 returns
=> get_standard_option
('remote-viewer-config'),
1818 my $rpcenv = PVE
::RPCEnvironment
::get
();
1820 my $authuser = $rpcenv->get_user();
1822 my $vmid = $param->{vmid
};
1823 my $node = $param->{node
};
1824 my $proxy = $param->{proxy
};
1826 my $conf = PVE
::QemuConfig-
>load_config($vmid, $node);
1827 my $title = "VM $vmid";
1828 $title .= " - ". $conf->{name
} if $conf->{name
};
1830 my $port = PVE
::QemuServer
::spice_port
($vmid);
1832 my ($ticket, undef, $remote_viewer_config) =
1833 PVE
::AccessControl
::remote_viewer_config
($authuser, $vmid, $node, $proxy, $title, $port);
1835 PVE
::QemuServer
::vm_mon_cmd
($vmid, "set_password", protocol
=> 'spice', password
=> $ticket);
1836 PVE
::QemuServer
::vm_mon_cmd
($vmid, "expire_password", protocol
=> 'spice', time => "+30");
1838 return $remote_viewer_config;
1841 __PACKAGE__-
>register_method({
1843 path
=> '{vmid}/status',
1846 description
=> "Directory index",
1851 additionalProperties
=> 0,
1853 node
=> get_standard_option
('pve-node'),
1854 vmid
=> get_standard_option
('pve-vmid'),
1862 subdir
=> { type
=> 'string' },
1865 links
=> [ { rel
=> 'child', href
=> "{subdir}" } ],
1871 my $conf = PVE
::QemuConfig-
>load_config($param->{vmid
});
1874 { subdir
=> 'current' },
1875 { subdir
=> 'start' },
1876 { subdir
=> 'stop' },
1882 __PACKAGE__-
>register_method({
1883 name
=> 'vm_status',
1884 path
=> '{vmid}/status/current',
1887 protected
=> 1, # qemu pid files are only readable by root
1888 description
=> "Get virtual machine status.",
1890 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1893 additionalProperties
=> 0,
1895 node
=> get_standard_option
('pve-node'),
1896 vmid
=> get_standard_option
('pve-vmid'),
1902 %$PVE::QemuServer
::vmstatus_return_properties
,
1904 description
=> "HA manager service status.",
1908 description
=> "Qemu VGA configuration supports spice.",
1913 description
=> "Qemu GuestAgent enabled in config.",
1923 my $conf = PVE
::QemuConfig-
>load_config($param->{vmid
});
1925 my $vmstatus = PVE
::QemuServer
::vmstatus
($param->{vmid
}, 1);
1926 my $status = $vmstatus->{$param->{vmid
}};
1928 $status->{ha
} = PVE
::HA
::Config
::get_service_status
("vm:$param->{vmid}");
1930 $status->{spice
} = 1 if PVE
::QemuServer
::vga_conf_has_spice
($conf->{vga
});
1931 $status->{agent
} = 1 if (PVE
::QemuServer
::parse_guest_agent
($conf)->{enabled
});
1936 __PACKAGE__-
>register_method({
1938 path
=> '{vmid}/status/start',
1942 description
=> "Start virtual machine.",
1944 check
=> ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
1947 additionalProperties
=> 0,
1949 node
=> get_standard_option
('pve-node'),
1950 vmid
=> get_standard_option
('pve-vmid',
1951 { completion
=> \
&PVE
::QemuServer
::complete_vmid_stopped
}),
1952 skiplock
=> get_standard_option
('skiplock'),
1953 stateuri
=> get_standard_option
('pve-qm-stateuri'),
1954 migratedfrom
=> get_standard_option
('pve-node',{ optional
=> 1 }),
1957 enum
=> ['secure', 'insecure'],
1958 description
=> "Migration traffic is encrypted using an SSH " .
1959 "tunnel by default. On secure, completely private networks " .
1960 "this can be disabled to increase performance.",
1963 migration_network
=> {
1964 type
=> 'string', format
=> 'CIDR',
1965 description
=> "CIDR of the (sub) network that is used for migration.",
1968 machine
=> get_standard_option
('pve-qm-machine'),
1970 description
=> "Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)",
1982 my $rpcenv = PVE
::RPCEnvironment
::get
();
1984 my $authuser = $rpcenv->get_user();
1986 my $node = extract_param
($param, 'node');
1988 my $vmid = extract_param
($param, 'vmid');
1990 my $machine = extract_param
($param, 'machine');
1992 my $stateuri = extract_param
($param, 'stateuri');
1993 raise_param_exc
({ stateuri
=> "Only root may use this option." })
1994 if $stateuri && $authuser ne 'root@pam';
1996 my $skiplock = extract_param
($param, 'skiplock');
1997 raise_param_exc
({ skiplock
=> "Only root may use this option." })
1998 if $skiplock && $authuser ne 'root@pam';
2000 my $migratedfrom = extract_param
($param, 'migratedfrom');
2001 raise_param_exc
({ migratedfrom
=> "Only root may use this option." })
2002 if $migratedfrom && $authuser ne 'root@pam';
2004 my $migration_type = extract_param
($param, 'migration_type');
2005 raise_param_exc
({ migration_type
=> "Only root may use this option." })
2006 if $migration_type && $authuser ne 'root@pam';
2008 my $migration_network = extract_param
($param, 'migration_network');
2009 raise_param_exc
({ migration_network
=> "Only root may use this option." })
2010 if $migration_network && $authuser ne 'root@pam';
2012 my $targetstorage = extract_param
($param, 'targetstorage');
2013 raise_param_exc
({ targetstorage
=> "Only root may use this option." })
2014 if $targetstorage && $authuser ne 'root@pam';
2016 raise_param_exc
({ targetstorage
=> "targetstorage can only by used with migratedfrom." })
2017 if $targetstorage && !$migratedfrom;
2019 # read spice ticket from STDIN
2021 if ($stateuri && ($stateuri eq 'tcp') && $migratedfrom && ($rpcenv->{type
} eq 'cli')) {
2022 if (defined(my $line = <STDIN
>)) {
2024 $spice_ticket = $line;
2028 PVE
::Cluster
::check_cfs_quorum
();
2030 my $storecfg = PVE
::Storage
::config
();
2032 if (PVE
::HA
::Config
::vm_is_ha_managed
($vmid) && !$stateuri &&
2033 $rpcenv->{type
} ne 'ha') {
2038 my $service = "vm:$vmid";
2040 my $cmd = ['ha-manager', 'set', $service, '--state', 'started'];
2042 print "Requesting HA start for VM $vmid\n";
2044 PVE
::Tools
::run_command
($cmd);
2049 return $rpcenv->fork_worker('hastart', $vmid, $authuser, $hacmd);
2056 syslog
('info', "start VM $vmid: $upid\n");
2058 PVE
::QemuServer
::vm_start
($storecfg, $vmid, $stateuri, $skiplock, $migratedfrom, undef,
2059 $machine, $spice_ticket, $migration_network, $migration_type, $targetstorage);
2064 return $rpcenv->fork_worker('qmstart', $vmid, $authuser, $realcmd);
2068 __PACKAGE__-
>register_method({
2070 path
=> '{vmid}/status/stop',
2074 description
=> "Stop virtual machine. The qemu process will exit immediately. This" .
2075 "is akin to pulling the power plug of a running computer and may damage the VM data",
2077 check
=> ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2080 additionalProperties
=> 0,
2082 node
=> get_standard_option
('pve-node'),
2083 vmid
=> get_standard_option
('pve-vmid',
2084 { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
2085 skiplock
=> get_standard_option
('skiplock'),
2086 migratedfrom
=> get_standard_option
('pve-node', { optional
=> 1 }),
2088 description
=> "Wait maximal timeout seconds.",
2094 description
=> "Do not deactivate storage volumes.",
2107 my $rpcenv = PVE
::RPCEnvironment
::get
();
2109 my $authuser = $rpcenv->get_user();
2111 my $node = extract_param
($param, 'node');
2113 my $vmid = extract_param
($param, 'vmid');
2115 my $skiplock = extract_param
($param, 'skiplock');
2116 raise_param_exc
({ skiplock
=> "Only root may use this option." })
2117 if $skiplock && $authuser ne 'root@pam';
2119 my $keepActive = extract_param
($param, 'keepActive');
2120 raise_param_exc
({ keepActive
=> "Only root may use this option." })
2121 if $keepActive && $authuser ne 'root@pam';
2123 my $migratedfrom = extract_param
($param, 'migratedfrom');
2124 raise_param_exc
({ migratedfrom
=> "Only root may use this option." })
2125 if $migratedfrom && $authuser ne 'root@pam';
2128 my $storecfg = PVE
::Storage
::config
();
2130 if (PVE
::HA
::Config
::vm_is_ha_managed
($vmid) && ($rpcenv->{type
} ne 'ha') && !defined($migratedfrom)) {
2135 my $service = "vm:$vmid";
2137 my $cmd = ['ha-manager', 'set', $service, '--state', 'stopped'];
2139 print "Requesting HA stop for VM $vmid\n";
2141 PVE
::Tools
::run_command
($cmd);
2146 return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
2152 syslog
('info', "stop VM $vmid: $upid\n");
2154 PVE
::QemuServer
::vm_stop
($storecfg, $vmid, $skiplock, 0,
2155 $param->{timeout
}, 0, 1, $keepActive, $migratedfrom);
2160 return $rpcenv->fork_worker('qmstop', $vmid, $authuser, $realcmd);
2164 __PACKAGE__-
>register_method({
2166 path
=> '{vmid}/status/reset',
2170 description
=> "Reset virtual machine.",
2172 check
=> ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2175 additionalProperties
=> 0,
2177 node
=> get_standard_option
('pve-node'),
2178 vmid
=> get_standard_option
('pve-vmid',
2179 { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
2180 skiplock
=> get_standard_option
('skiplock'),
2189 my $rpcenv = PVE
::RPCEnvironment
::get
();
2191 my $authuser = $rpcenv->get_user();
2193 my $node = extract_param
($param, 'node');
2195 my $vmid = extract_param
($param, 'vmid');
2197 my $skiplock = extract_param
($param, 'skiplock');
2198 raise_param_exc
({ skiplock
=> "Only root may use this option." })
2199 if $skiplock && $authuser ne 'root@pam';
2201 die "VM $vmid not running\n" if !PVE
::QemuServer
::check_running
($vmid);
2206 PVE
::QemuServer
::vm_reset
($vmid, $skiplock);
2211 return $rpcenv->fork_worker('qmreset', $vmid, $authuser, $realcmd);
2214 __PACKAGE__-
>register_method({
2215 name
=> 'vm_shutdown',
2216 path
=> '{vmid}/status/shutdown',
2220 description
=> "Shutdown virtual machine. This is similar to pressing the power button on a physical machine." .
2221 "This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.",
2223 check
=> ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2226 additionalProperties
=> 0,
2228 node
=> get_standard_option
('pve-node'),
2229 vmid
=> get_standard_option
('pve-vmid',
2230 { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
2231 skiplock
=> get_standard_option
('skiplock'),
2233 description
=> "Wait maximal timeout seconds.",
2239 description
=> "Make sure the VM stops.",
2245 description
=> "Do not deactivate storage volumes.",
2258 my $rpcenv = PVE
::RPCEnvironment
::get
();
2260 my $authuser = $rpcenv->get_user();
2262 my $node = extract_param
($param, 'node');
2264 my $vmid = extract_param
($param, 'vmid');
2266 my $skiplock = extract_param
($param, 'skiplock');
2267 raise_param_exc
({ skiplock
=> "Only root may use this option." })
2268 if $skiplock && $authuser ne 'root@pam';
2270 my $keepActive = extract_param
($param, 'keepActive');
2271 raise_param_exc
({ keepActive
=> "Only root may use this option." })
2272 if $keepActive && $authuser ne 'root@pam';
2274 my $storecfg = PVE
::Storage
::config
();
2278 # if vm is paused, do not shutdown (but stop if forceStop = 1)
2279 # otherwise, we will infer a shutdown command, but run into the timeout,
2280 # then when the vm is resumed, it will instantly shutdown
2282 # checking the qmp status here to get feedback to the gui/cli/api
2283 # and the status query should not take too long
2286 $qmpstatus = PVE
::QemuServer
::vm_qmp_command
($vmid, { execute
=> "query-status" }, 0);
2290 if (!$err && $qmpstatus->{status
} eq "paused") {
2291 if ($param->{forceStop
}) {
2292 warn "VM is paused - stop instead of shutdown\n";
2295 die "VM is paused - cannot shutdown\n";
2299 if (PVE
::HA
::Config
::vm_is_ha_managed
($vmid) &&
2300 ($rpcenv->{type
} ne 'ha')) {
2305 my $service = "vm:$vmid";
2307 my $cmd = ['ha-manager', 'set', $service, '--state', 'stopped'];
2309 print "Requesting HA stop for VM $vmid\n";
2311 PVE
::Tools
::run_command
($cmd);
2316 return $rpcenv->fork_worker('hastop', $vmid, $authuser, $hacmd);
2323 syslog
('info', "shutdown VM $vmid: $upid\n");
2325 PVE
::QemuServer
::vm_stop
($storecfg, $vmid, $skiplock, 0, $param->{timeout
},
2326 $shutdown, $param->{forceStop
}, $keepActive);
2331 return $rpcenv->fork_worker('qmshutdown', $vmid, $authuser, $realcmd);
2335 __PACKAGE__-
>register_method({
2336 name
=> 'vm_suspend',
2337 path
=> '{vmid}/status/suspend',
2341 description
=> "Suspend virtual machine.",
2343 check
=> ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2346 additionalProperties
=> 0,
2348 node
=> get_standard_option
('pve-node'),
2349 vmid
=> get_standard_option
('pve-vmid',
2350 { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
2351 skiplock
=> get_standard_option
('skiplock'),
2356 description
=> 'If set, suspends the VM to disk. Will be resumed on next VM start.',
2366 my $rpcenv = PVE
::RPCEnvironment
::get
();
2368 my $authuser = $rpcenv->get_user();
2370 my $node = extract_param
($param, 'node');
2372 my $vmid = extract_param
($param, 'vmid');
2374 my $todisk = extract_param
($param, 'todisk') // 0;
2376 my $skiplock = extract_param
($param, 'skiplock');
2377 raise_param_exc
({ skiplock
=> "Only root may use this option." })
2378 if $skiplock && $authuser ne 'root@pam';
2380 die "VM $vmid not running\n" if !PVE
::QemuServer
::check_running
($vmid);
2382 die "Cannot suspend HA managed VM to disk\n"
2383 if $todisk && PVE
::HA
::Config
::vm_is_ha_managed
($vmid);
2388 syslog
('info', "suspend VM $vmid: $upid\n");
2390 PVE
::QemuServer
::vm_suspend
($vmid, $skiplock, $todisk);
2395 return $rpcenv->fork_worker('qmsuspend', $vmid, $authuser, $realcmd);
2398 __PACKAGE__-
>register_method({
2399 name
=> 'vm_resume',
2400 path
=> '{vmid}/status/resume',
2404 description
=> "Resume virtual machine.",
2406 check
=> ['perm', '/vms/{vmid}', [ 'VM.PowerMgmt' ]],
2409 additionalProperties
=> 0,
2411 node
=> get_standard_option
('pve-node'),
2412 vmid
=> get_standard_option
('pve-vmid',
2413 { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
2414 skiplock
=> get_standard_option
('skiplock'),
2415 nocheck
=> { type
=> 'boolean', optional
=> 1 },
2425 my $rpcenv = PVE
::RPCEnvironment
::get
();
2427 my $authuser = $rpcenv->get_user();
2429 my $node = extract_param
($param, 'node');
2431 my $vmid = extract_param
($param, 'vmid');
2433 my $skiplock = extract_param
($param, 'skiplock');
2434 raise_param_exc
({ skiplock
=> "Only root may use this option." })
2435 if $skiplock && $authuser ne 'root@pam';
2437 my $nocheck = extract_param
($param, 'nocheck');
2439 die "VM $vmid not running\n" if !PVE
::QemuServer
::check_running
($vmid, $nocheck);
2444 syslog
('info', "resume VM $vmid: $upid\n");
2446 PVE
::QemuServer
::vm_resume
($vmid, $skiplock, $nocheck);
2451 return $rpcenv->fork_worker('qmresume', $vmid, $authuser, $realcmd);
2454 __PACKAGE__-
>register_method({
2455 name
=> 'vm_sendkey',
2456 path
=> '{vmid}/sendkey',
2460 description
=> "Send key event to virtual machine.",
2462 check
=> ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
2465 additionalProperties
=> 0,
2467 node
=> get_standard_option
('pve-node'),
2468 vmid
=> get_standard_option
('pve-vmid',
2469 { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
2470 skiplock
=> get_standard_option
('skiplock'),
2472 description
=> "The key (qemu monitor encoding).",
2477 returns
=> { type
=> 'null'},
2481 my $rpcenv = PVE
::RPCEnvironment
::get
();
2483 my $authuser = $rpcenv->get_user();
2485 my $node = extract_param
($param, 'node');
2487 my $vmid = extract_param
($param, 'vmid');
2489 my $skiplock = extract_param
($param, 'skiplock');
2490 raise_param_exc
({ skiplock
=> "Only root may use this option." })
2491 if $skiplock && $authuser ne 'root@pam';
2493 PVE
::QemuServer
::vm_sendkey
($vmid, $skiplock, $param->{key
});
2498 __PACKAGE__-
>register_method({
2499 name
=> 'vm_feature',
2500 path
=> '{vmid}/feature',
2504 description
=> "Check if feature for virtual machine is available.",
2506 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
2509 additionalProperties
=> 0,
2511 node
=> get_standard_option
('pve-node'),
2512 vmid
=> get_standard_option
('pve-vmid'),
2514 description
=> "Feature to check.",
2516 enum
=> [ 'snapshot', 'clone', 'copy' ],
2518 snapname
=> get_standard_option
('pve-snapshot-name', {
2526 hasFeature
=> { type
=> 'boolean' },
2529 items
=> { type
=> 'string' },
2536 my $node = extract_param
($param, 'node');
2538 my $vmid = extract_param
($param, 'vmid');
2540 my $snapname = extract_param
($param, 'snapname');
2542 my $feature = extract_param
($param, 'feature');
2544 my $running = PVE
::QemuServer
::check_running
($vmid);
2546 my $conf = PVE
::QemuConfig-
>load_config($vmid);
2549 my $snap = $conf->{snapshots
}->{$snapname};
2550 die "snapshot '$snapname' does not exist\n" if !defined($snap);
2553 my $storecfg = PVE
::Storage
::config
();
2555 my $nodelist = PVE
::QemuServer
::shared_nodes
($conf, $storecfg);
2556 my $hasFeature = PVE
::QemuConfig-
>has_feature($feature, $conf, $storecfg, $snapname, $running);
2559 hasFeature
=> $hasFeature,
2560 nodes
=> [ keys %$nodelist ],
2564 __PACKAGE__-
>register_method({
2566 path
=> '{vmid}/clone',
2570 description
=> "Create a copy of virtual machine/template.",
2572 description
=> "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions " .
2573 "on /vms/{newid} (or on the VM pool /pool/{pool}). You also need " .
2574 "'Datastore.AllocateSpace' on any used storage.",
2577 ['perm', '/vms/{vmid}', [ 'VM.Clone' ]],
2579 [ 'perm', '/vms/{newid}', ['VM.Allocate']],
2580 [ 'perm', '/pool/{pool}', ['VM.Allocate'], require_param
=> 'pool'],
2585 additionalProperties
=> 0,
2587 node
=> get_standard_option
('pve-node'),
2588 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
2589 newid
=> get_standard_option
('pve-vmid', {
2590 completion
=> \
&PVE
::Cluster
::complete_next_vmid
,
2591 description
=> 'VMID for the clone.' }),
2594 type
=> 'string', format
=> 'dns-name',
2595 description
=> "Set a name for the new VM.",
2600 description
=> "Description for the new VM.",
2604 type
=> 'string', format
=> 'pve-poolid',
2605 description
=> "Add the new VM to the specified pool.",
2607 snapname
=> get_standard_option
('pve-snapshot-name', {
2610 storage
=> get_standard_option
('pve-storage-id', {
2611 description
=> "Target storage for full clone.",
2615 description
=> "Target format for file storage. Only valid for full clone.",
2618 enum
=> [ 'raw', 'qcow2', 'vmdk'],
2623 description
=> "Create a full copy of all disks. This is always done when " .
2624 "you clone a normal VM. For VM templates, we try to create a linked clone by default.",
2626 target
=> get_standard_option
('pve-node', {
2627 description
=> "Target node. Only allowed if the original VM is on shared storage.",
2638 my $rpcenv = PVE
::RPCEnvironment
::get
();
2640 my $authuser = $rpcenv->get_user();
2642 my $node = extract_param
($param, 'node');
2644 my $vmid = extract_param
($param, 'vmid');
2646 my $newid = extract_param
($param, 'newid');
2648 my $pool = extract_param
($param, 'pool');
2650 if (defined($pool)) {
2651 $rpcenv->check_pool_exist($pool);
2654 my $snapname = extract_param
($param, 'snapname');
2656 my $storage = extract_param
($param, 'storage');
2658 my $format = extract_param
($param, 'format');
2660 my $target = extract_param
($param, 'target');
2662 my $localnode = PVE
::INotify
::nodename
();
2664 undef $target if $target && ($target eq $localnode || $target eq 'localhost');
2666 PVE
::Cluster
::check_node_exists
($target) if $target;
2668 my $storecfg = PVE
::Storage
::config
();
2671 # check if storage is enabled on local node
2672 PVE
::Storage
::storage_check_enabled
($storecfg, $storage);
2674 # check if storage is available on target node
2675 PVE
::Storage
::storage_check_node
($storecfg, $storage, $target);
2676 # clone only works if target storage is shared
2677 my $scfg = PVE
::Storage
::storage_config
($storecfg, $storage);
2678 die "can't clone to non-shared storage '$storage'\n" if !$scfg->{shared
};
2682 PVE
::Cluster
::check_cfs_quorum
();
2684 my $running = PVE
::QemuServer
::check_running
($vmid) || 0;
2686 # exclusive lock if VM is running - else shared lock is enough;
2687 my $shared_lock = $running ?
0 : 1;
2691 # do all tests after lock
2692 # we also try to do all tests before we fork the worker
2694 my $conf = PVE
::QemuConfig-
>load_config($vmid);
2696 PVE
::QemuConfig-
>check_lock($conf);
2698 my $verify_running = PVE
::QemuServer
::check_running
($vmid) || 0;
2700 die "unexpected state change\n" if $verify_running != $running;
2702 die "snapshot '$snapname' does not exist\n"
2703 if $snapname && !defined( $conf->{snapshots
}->{$snapname});
2705 my $full = extract_param
($param, 'full');
2706 if (!defined($full)) {
2707 $full = !PVE
::QemuConfig-
>is_template($conf);
2710 die "parameter 'storage' not allowed for linked clones\n"
2711 if defined($storage) && !$full;
2713 die "parameter 'format' not allowed for linked clones\n"
2714 if defined($format) && !$full;
2716 my $oldconf = $snapname ?
$conf->{snapshots
}->{$snapname} : $conf;
2718 my $sharedvm = &$check_storage_access_clone($rpcenv, $authuser, $storecfg, $oldconf, $storage);
2720 die "can't clone VM to node '$target' (VM uses local storage)\n" if $target && !$sharedvm;
2722 my $conffile = PVE
::QemuConfig-
>config_file($newid);
2724 die "unable to create VM $newid: config file already exists\n"
2727 my $newconf = { lock => 'clone' };
2732 foreach my $opt (keys %$oldconf) {
2733 my $value = $oldconf->{$opt};
2735 # do not copy snapshot related info
2736 next if $opt eq 'snapshots' || $opt eq 'parent' || $opt eq 'snaptime' ||
2737 $opt eq 'vmstate' || $opt eq 'snapstate';
2739 # no need to copy unused images, because VMID(owner) changes anyways
2740 next if $opt =~ m/^unused\d+$/;
2742 # always change MAC! address
2743 if ($opt =~ m/^net(\d+)$/) {
2744 my $net = PVE
::QemuServer
::parse_net
($value);
2745 my $dc = PVE
::Cluster
::cfs_read_file
('datacenter.cfg');
2746 $net->{macaddr
} = PVE
::Tools
::random_ether_addr
($dc->{mac_prefix
});
2747 $newconf->{$opt} = PVE
::QemuServer
::print_net
($net);
2748 } elsif (PVE
::QemuServer
::is_valid_drivename
($opt)) {
2749 my $drive = PVE
::QemuServer
::parse_drive
($opt, $value);
2750 die "unable to parse drive options for '$opt'\n" if !$drive;
2751 if (PVE
::QemuServer
::drive_is_cdrom
($drive, 1)) {
2752 $newconf->{$opt} = $value; # simply copy configuration
2754 if ($full || PVE
::QemuServer
::drive_is_cloudinit
($drive)) {
2755 die "Full clone feature is not supported for drive '$opt'\n"
2756 if !PVE
::Storage
::volume_has_feature
($storecfg, 'copy', $drive->{file
}, $snapname, $running);
2757 $fullclone->{$opt} = 1;
2759 # not full means clone instead of copy
2760 die "Linked clone feature is not supported for drive '$opt'\n"
2761 if !PVE
::Storage
::volume_has_feature
($storecfg, 'clone', $drive->{file
}, $snapname, $running);
2763 $drives->{$opt} = $drive;
2764 push @$vollist, $drive->{file
};
2767 # copy everything else
2768 $newconf->{$opt} = $value;
2772 # auto generate a new uuid
2773 my $smbios1 = PVE
::QemuServer
::parse_smbios1
($newconf->{smbios1
} || '');
2774 $smbios1->{uuid
} = PVE
::QemuServer
::generate_uuid
();
2775 $newconf->{smbios1
} = PVE
::QemuServer
::print_smbios1
($smbios1);
2777 # auto generate a new vmgenid if the option was set
2778 if ($newconf->{vmgenid
}) {
2779 $newconf->{vmgenid
} = PVE
::QemuServer
::generate_uuid
();
2782 delete $newconf->{template
};
2784 if ($param->{name
}) {
2785 $newconf->{name
} = $param->{name
};
2787 if ($oldconf->{name
}) {
2788 $newconf->{name
} = "Copy-of-$oldconf->{name}";
2790 $newconf->{name
} = "Copy-of-VM-$vmid";
2794 if ($param->{description
}) {
2795 $newconf->{description
} = $param->{description
};
2798 # create empty/temp config - this fails if VM already exists on other node
2799 PVE
::Tools
::file_set_contents
($conffile, "# qmclone temporary file\nlock: clone\n");
2804 my $newvollist = [];
2811 local $SIG{HUP
} = sub { die "interrupted by signal\n"; };
2813 PVE
::Storage
::activate_volumes
($storecfg, $vollist, $snapname);
2815 my $total_jobs = scalar(keys %{$drives});
2818 foreach my $opt (keys %$drives) {
2819 my $drive = $drives->{$opt};
2820 my $skipcomplete = ($total_jobs != $i); # finish after last drive
2822 my $newdrive = PVE
::QemuServer
::clone_disk
($storecfg, $vmid, $running, $opt, $drive, $snapname,
2823 $newid, $storage, $format, $fullclone->{$opt}, $newvollist,
2824 $jobs, $skipcomplete, $oldconf->{agent
});
2826 $newconf->{$opt} = PVE
::QemuServer
::print_drive
($vmid, $newdrive);
2828 PVE
::QemuConfig-
>write_config($newid, $newconf);
2832 delete $newconf->{lock};
2834 # do not write pending changes
2835 if (my @changes = keys %{$newconf->{pending
}}) {
2836 my $pending = join(',', @changes);
2837 warn "found pending changes for '$pending', discarding for clone\n";
2838 delete $newconf->{pending
};
2841 PVE
::QemuConfig-
>write_config($newid, $newconf);
2844 # always deactivate volumes - avoid lvm LVs to be active on several nodes
2845 PVE
::Storage
::deactivate_volumes
($storecfg, $vollist, $snapname) if !$running;
2846 PVE
::Storage
::deactivate_volumes
($storecfg, $newvollist);
2848 my $newconffile = PVE
::QemuConfig-
>config_file($newid, $target);
2849 die "Failed to move config to node '$target' - rename failed: $!\n"
2850 if !rename($conffile, $newconffile);
2853 PVE
::AccessControl
::add_vm_to_pool
($newid, $pool) if $pool;
2858 eval { PVE
::QemuServer
::qemu_blockjobs_cancel
($vmid, $jobs) };
2860 sleep 1; # some storage like rbd need to wait before release volume - really?
2862 foreach my $volid (@$newvollist) {
2863 eval { PVE
::Storage
::vdisk_free
($storecfg, $volid); };
2866 die "clone failed: $err";
2872 PVE
::Firewall
::clone_vmfw_conf
($vmid, $newid);
2874 return $rpcenv->fork_worker('qmclone', $vmid, $authuser, $realcmd);
2877 return PVE
::QemuConfig-
>lock_config_mode($vmid, 1, $shared_lock, sub {
2878 # Aquire exclusive lock lock for $newid
2879 return PVE
::QemuConfig-
>lock_config_full($newid, 1, $clonefn);
2884 __PACKAGE__-
>register_method({
2885 name
=> 'move_vm_disk',
2886 path
=> '{vmid}/move_disk',
2890 description
=> "Move volume to different storage.",
2892 description
=> "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage.",
2894 ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
2895 ['perm', '/storage/{storage}', [ 'Datastore.AllocateSpace' ]],
2899 additionalProperties
=> 0,
2901 node
=> get_standard_option
('pve-node'),
2902 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
2905 description
=> "The disk you want to move.",
2906 enum
=> [ PVE
::QemuServer
::valid_drive_names
() ],
2908 storage
=> get_standard_option
('pve-storage-id', {
2909 description
=> "Target storage.",
2910 completion
=> \
&PVE
::QemuServer
::complete_storage
,
2914 description
=> "Target Format.",
2915 enum
=> [ 'raw', 'qcow2', 'vmdk' ],
2920 description
=> "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
2926 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
2934 description
=> "the task ID.",
2939 my $rpcenv = PVE
::RPCEnvironment
::get
();
2941 my $authuser = $rpcenv->get_user();
2943 my $node = extract_param
($param, 'node');
2945 my $vmid = extract_param
($param, 'vmid');
2947 my $digest = extract_param
($param, 'digest');
2949 my $disk = extract_param
($param, 'disk');
2951 my $storeid = extract_param
($param, 'storage');
2953 my $format = extract_param
($param, 'format');
2955 my $storecfg = PVE
::Storage
::config
();
2957 my $updatefn = sub {
2959 my $conf = PVE
::QemuConfig-
>load_config($vmid);
2961 PVE
::QemuConfig-
>check_lock($conf);
2963 die "checksum missmatch (file change by other user?)\n"
2964 if $digest && $digest ne $conf->{digest
};
2966 die "disk '$disk' does not exist\n" if !$conf->{$disk};
2968 my $drive = PVE
::QemuServer
::parse_drive
($disk, $conf->{$disk});
2970 my $old_volid = $drive->{file
} || die "disk '$disk' has no associated volume\n";
2972 die "you can't move a cdrom\n" if PVE
::QemuServer
::drive_is_cdrom
($drive, 1);
2975 my ($oldstoreid, $oldvolname) = PVE
::Storage
::parse_volume_id
($old_volid);
2976 if ($oldvolname =~ m/\.(raw|qcow2|vmdk)$/){
2980 die "you can't move on the same storage with same format\n" if $oldstoreid eq $storeid &&
2981 (!$format || !$oldfmt || $oldfmt eq $format);
2983 # this only checks snapshots because $disk is passed!
2984 my $snapshotted = PVE
::QemuServer
::is_volume_in_use
($storecfg, $conf, $disk, $old_volid);
2985 die "you can't move a disk with snapshots and delete the source\n"
2986 if $snapshotted && $param->{delete};
2988 PVE
::Cluster
::log_msg
('info', $authuser, "move disk VM $vmid: move --disk $disk --storage $storeid");
2990 my $running = PVE
::QemuServer
::check_running
($vmid);
2992 PVE
::Storage
::activate_volumes
($storecfg, [ $drive->{file
} ]);
2996 my $newvollist = [];
3002 local $SIG{HUP
} = sub { die "interrupted by signal\n"; };
3004 warn "moving disk with snapshots, snapshots will not be moved!\n"
3007 my $newdrive = PVE
::QemuServer
::clone_disk
($storecfg, $vmid, $running, $disk, $drive, undef,
3008 $vmid, $storeid, $format, 1, $newvollist);
3010 $conf->{$disk} = PVE
::QemuServer
::print_drive
($vmid, $newdrive);
3012 PVE
::QemuConfig-
>add_unused_volume($conf, $old_volid) if !$param->{delete};
3014 # convert moved disk to base if part of template
3015 PVE
::QemuServer
::template_create
($vmid, $conf, $disk)
3016 if PVE
::QemuConfig-
>is_template($conf);
3018 PVE
::QemuConfig-
>write_config($vmid, $conf);
3020 if ($running && PVE
::QemuServer
::parse_guest_agent
($conf)->{fstrim_cloned_disks
} && PVE
::QemuServer
::qga_check_running
($vmid)) {
3021 eval { PVE
::QemuServer
::vm_mon_cmd
($vmid, "guest-fstrim"); };
3025 # try to deactivate volumes - avoid lvm LVs to be active on several nodes
3026 PVE
::Storage
::deactivate_volumes
($storecfg, [ $newdrive->{file
} ])
3033 foreach my $volid (@$newvollist) {
3034 eval { PVE
::Storage
::vdisk_free
($storecfg, $volid); };
3037 die "storage migration failed: $err";
3040 if ($param->{delete}) {
3042 PVE
::Storage
::deactivate_volumes
($storecfg, [$old_volid]);
3043 PVE
::Storage
::vdisk_free
($storecfg, $old_volid);
3049 return $rpcenv->fork_worker('qmmove', $vmid, $authuser, $realcmd);
3052 return PVE
::QemuConfig-
>lock_config($vmid, $updatefn);
3055 __PACKAGE__-
>register_method({
3056 name
=> 'migrate_vm',
3057 path
=> '{vmid}/migrate',
3061 description
=> "Migrate virtual machine. Creates a new migration task.",
3063 check
=> ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
3066 additionalProperties
=> 0,
3068 node
=> get_standard_option
('pve-node'),
3069 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
3070 target
=> get_standard_option
('pve-node', {
3071 description
=> "Target node.",
3072 completion
=> \
&PVE
::Cluster
::complete_migration_target
,
3076 description
=> "Use online/live migration.",
3081 description
=> "Allow to migrate VMs which use local devices. Only root may use this option.",
3086 enum
=> ['secure', 'insecure'],
3087 description
=> "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.",
3090 migration_network
=> {
3091 type
=> 'string', format
=> 'CIDR',
3092 description
=> "CIDR of the (sub) network that is used for migration.",
3095 "with-local-disks" => {
3097 description
=> "Enable live storage migration for local disk",
3100 targetstorage
=> get_standard_option
('pve-storage-id', {
3101 description
=> "Default target storage.",
3103 completion
=> \
&PVE
::QemuServer
::complete_storage
,
3109 description
=> "the task ID.",
3114 my $rpcenv = PVE
::RPCEnvironment
::get
();
3116 my $authuser = $rpcenv->get_user();
3118 my $target = extract_param
($param, 'target');
3120 my $localnode = PVE
::INotify
::nodename
();
3121 raise_param_exc
({ target
=> "target is local node."}) if $target eq $localnode;
3123 PVE
::Cluster
::check_cfs_quorum
();
3125 PVE
::Cluster
::check_node_exists
($target);
3127 my $targetip = PVE
::Cluster
::remote_node_ip
($target);
3129 my $vmid = extract_param
($param, 'vmid');
3131 raise_param_exc
({ targetstorage
=> "Live storage migration can only be done online." })
3132 if !$param->{online
} && $param->{targetstorage
};
3134 raise_param_exc
({ force
=> "Only root may use this option." })
3135 if $param->{force
} && $authuser ne 'root@pam';
3137 raise_param_exc
({ migration_type
=> "Only root may use this option." })
3138 if $param->{migration_type
} && $authuser ne 'root@pam';
3140 # allow root only until better network permissions are available
3141 raise_param_exc
({ migration_network
=> "Only root may use this option." })
3142 if $param->{migration_network
} && $authuser ne 'root@pam';
3145 my $conf = PVE
::QemuConfig-
>load_config($vmid);
3147 # try to detect errors early
3149 PVE
::QemuConfig-
>check_lock($conf);
3151 if (PVE
::QemuServer
::check_running
($vmid)) {
3152 die "cant migrate running VM without --online\n"
3153 if !$param->{online
};
3156 my $storecfg = PVE
::Storage
::config
();
3158 if( $param->{targetstorage
}) {
3159 PVE
::Storage
::storage_check_node
($storecfg, $param->{targetstorage
}, $target);
3161 PVE
::QemuServer
::check_storage_availability
($storecfg, $conf, $target);
3164 if (PVE
::HA
::Config
::vm_is_ha_managed
($vmid) && $rpcenv->{type
} ne 'ha') {
3169 my $service = "vm:$vmid";
3171 my $cmd = ['ha-manager', 'migrate', $service, $target];
3173 print "Requesting HA migration for VM $vmid to node $target\n";
3175 PVE
::Tools
::run_command
($cmd);
3180 return $rpcenv->fork_worker('hamigrate', $vmid, $authuser, $hacmd);
3185 PVE
::QemuMigrate-
>migrate($target, $targetip, $vmid, $param);
3189 return PVE
::GuestHelpers
::guest_migration_lock
($vmid, 10, $realcmd);
3192 return $rpcenv->fork_worker('qmigrate', $vmid, $authuser, $worker);
3197 __PACKAGE__-
>register_method({
3199 path
=> '{vmid}/monitor',
3203 description
=> "Execute Qemu monitor commands.",
3205 description
=> "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')",
3206 check
=> ['perm', '/vms/{vmid}', [ 'VM.Monitor' ]],
3209 additionalProperties
=> 0,
3211 node
=> get_standard_option
('pve-node'),
3212 vmid
=> get_standard_option
('pve-vmid'),
3215 description
=> "The monitor command.",
3219 returns
=> { type
=> 'string'},
3223 my $rpcenv = PVE
::RPCEnvironment
::get
();
3224 my $authuser = $rpcenv->get_user();
3227 my $command = shift;
3228 return $command =~ m/^\s*info(\s+|$)/
3229 || $command =~ m/^\s*help\s*$/;
3232 $rpcenv->check_full($authuser, "/", ['Sys.Modify'])
3233 if !&$is_ro($param->{command
});
3235 my $vmid = $param->{vmid
};
3237 my $conf = PVE
::QemuConfig-
>load_config ($vmid); # check if VM exists
3241 $res = PVE
::QemuServer
::vm_human_monitor_command
($vmid, $param->{command
});
3243 $res = "ERROR: $@" if $@;
3248 __PACKAGE__-
>register_method({
3249 name
=> 'resize_vm',
3250 path
=> '{vmid}/resize',
3254 description
=> "Extend volume size.",
3256 check
=> ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
3259 additionalProperties
=> 0,
3261 node
=> get_standard_option
('pve-node'),
3262 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
3263 skiplock
=> get_standard_option
('skiplock'),
3266 description
=> "The disk you want to resize.",
3267 enum
=> [PVE
::QemuServer
::valid_drive_names
()],
3271 pattern
=> '\+?\d+(\.\d+)?[KMGT]?',
3272 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.",
3276 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
3282 returns
=> { type
=> 'null'},
3286 my $rpcenv = PVE
::RPCEnvironment
::get
();
3288 my $authuser = $rpcenv->get_user();
3290 my $node = extract_param
($param, 'node');
3292 my $vmid = extract_param
($param, 'vmid');
3294 my $digest = extract_param
($param, 'digest');
3296 my $disk = extract_param
($param, 'disk');
3298 my $sizestr = extract_param
($param, 'size');
3300 my $skiplock = extract_param
($param, 'skiplock');
3301 raise_param_exc
({ skiplock
=> "Only root may use this option." })
3302 if $skiplock && $authuser ne 'root@pam';
3304 my $storecfg = PVE
::Storage
::config
();
3306 my $updatefn = sub {
3308 my $conf = PVE
::QemuConfig-
>load_config($vmid);
3310 die "checksum missmatch (file change by other user?)\n"
3311 if $digest && $digest ne $conf->{digest
};
3312 PVE
::QemuConfig-
>check_lock($conf) if !$skiplock;
3314 die "disk '$disk' does not exist\n" if !$conf->{$disk};
3316 my $drive = PVE
::QemuServer
::parse_drive
($disk, $conf->{$disk});
3318 my (undef, undef, undef, undef, undef, undef, $format) =
3319 PVE
::Storage
::parse_volname
($storecfg, $drive->{file
});
3321 die "can't resize volume: $disk if snapshot exists\n"
3322 if %{$conf->{snapshots
}} && $format eq 'qcow2';
3324 my $volid = $drive->{file
};
3326 die "disk '$disk' has no associated volume\n" if !$volid;
3328 die "you can't resize a cdrom\n" if PVE
::QemuServer
::drive_is_cdrom
($drive);
3330 my ($storeid, $volname) = PVE
::Storage
::parse_volume_id
($volid);
3332 $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
3334 PVE
::Storage
::activate_volumes
($storecfg, [$volid]);
3335 my $size = PVE
::Storage
::volume_size_info
($storecfg, $volid, 5);
3337 die "internal error" if $sizestr !~ m/^(\+)?(\d+(\.\d+)?)([KMGT])?$/;
3338 my ($ext, $newsize, $unit) = ($1, $2, $4);
3341 $newsize = $newsize * 1024;
3342 } elsif ($unit eq 'M') {
3343 $newsize = $newsize * 1024 * 1024;
3344 } elsif ($unit eq 'G') {
3345 $newsize = $newsize * 1024 * 1024 * 1024;
3346 } elsif ($unit eq 'T') {
3347 $newsize = $newsize * 1024 * 1024 * 1024 * 1024;
3350 $newsize += $size if $ext;
3351 $newsize = int($newsize);
3353 die "shrinking disks is not supported\n" if $newsize < $size;
3355 return if $size == $newsize;
3357 PVE
::Cluster
::log_msg
('info', $authuser, "update VM $vmid: resize --disk $disk --size $sizestr");
3359 PVE
::QemuServer
::qemu_block_resize
($vmid, "drive-$disk", $storecfg, $volid, $newsize);
3361 $drive->{size
} = $newsize;
3362 $conf->{$disk} = PVE
::QemuServer
::print_drive
($vmid, $drive);
3364 PVE
::QemuConfig-
>write_config($vmid, $conf);
3367 PVE
::QemuConfig-
>lock_config($vmid, $updatefn);
3371 __PACKAGE__-
>register_method({
3372 name
=> 'snapshot_list',
3373 path
=> '{vmid}/snapshot',
3375 description
=> "List all snapshots.",
3377 check
=> ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
3380 protected
=> 1, # qemu pid files are only readable by root
3382 additionalProperties
=> 0,
3384 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
3385 node
=> get_standard_option
('pve-node'),
3394 description
=> "Snapshot identifier. Value 'current' identifies the current VM.",
3398 description
=> "Snapshot includes RAM.",
3403 description
=> "Snapshot description.",
3407 description
=> "Snapshot creation time",
3409 renderer
=> 'timestamp',
3413 description
=> "Parent snapshot identifier.",
3419 links
=> [ { rel
=> 'child', href
=> "{name}" } ],
3424 my $vmid = $param->{vmid
};
3426 my $conf = PVE
::QemuConfig-
>load_config($vmid);
3427 my $snaphash = $conf->{snapshots
} || {};
3431 foreach my $name (keys %$snaphash) {
3432 my $d = $snaphash->{$name};
3435 snaptime
=> $d->{snaptime
} || 0,
3436 vmstate
=> $d->{vmstate
} ?
1 : 0,
3437 description
=> $d->{description
} || '',
3439 $item->{parent
} = $d->{parent
} if $d->{parent
};
3440 $item->{snapstate
} = $d->{snapstate
} if $d->{snapstate
};
3444 my $running = PVE
::QemuServer
::check_running
($vmid, 1) ?
1 : 0;
3447 digest
=> $conf->{digest
},
3448 running
=> $running,
3449 description
=> "You are here!",
3451 $current->{parent
} = $conf->{parent
} if $conf->{parent
};
3453 push @$res, $current;
3458 __PACKAGE__-
>register_method({
3460 path
=> '{vmid}/snapshot',
3464 description
=> "Snapshot a VM.",
3466 check
=> ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3469 additionalProperties
=> 0,
3471 node
=> get_standard_option
('pve-node'),
3472 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
3473 snapname
=> get_standard_option
('pve-snapshot-name'),
3477 description
=> "Save the vmstate",
3482 description
=> "A textual description or comment.",
3488 description
=> "the task ID.",
3493 my $rpcenv = PVE
::RPCEnvironment
::get
();
3495 my $authuser = $rpcenv->get_user();
3497 my $node = extract_param
($param, 'node');
3499 my $vmid = extract_param
($param, 'vmid');
3501 my $snapname = extract_param
($param, 'snapname');
3503 die "unable to use snapshot name 'current' (reserved name)\n"
3504 if $snapname eq 'current';
3507 PVE
::Cluster
::log_msg
('info', $authuser, "snapshot VM $vmid: $snapname");
3508 PVE
::QemuConfig-
>snapshot_create($vmid, $snapname, $param->{vmstate
},
3509 $param->{description
});
3512 return $rpcenv->fork_worker('qmsnapshot', $vmid, $authuser, $realcmd);
3515 __PACKAGE__-
>register_method({
3516 name
=> 'snapshot_cmd_idx',
3517 path
=> '{vmid}/snapshot/{snapname}',
3524 additionalProperties
=> 0,
3526 vmid
=> get_standard_option
('pve-vmid'),
3527 node
=> get_standard_option
('pve-node'),
3528 snapname
=> get_standard_option
('pve-snapshot-name'),
3537 links
=> [ { rel
=> 'child', href
=> "{cmd}" } ],
3544 push @$res, { cmd
=> 'rollback' };
3545 push @$res, { cmd
=> 'config' };
3550 __PACKAGE__-
>register_method({
3551 name
=> 'update_snapshot_config',
3552 path
=> '{vmid}/snapshot/{snapname}/config',
3556 description
=> "Update snapshot metadata.",
3558 check
=> ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3561 additionalProperties
=> 0,
3563 node
=> get_standard_option
('pve-node'),
3564 vmid
=> get_standard_option
('pve-vmid'),
3565 snapname
=> get_standard_option
('pve-snapshot-name'),
3569 description
=> "A textual description or comment.",
3573 returns
=> { type
=> 'null' },
3577 my $rpcenv = PVE
::RPCEnvironment
::get
();
3579 my $authuser = $rpcenv->get_user();
3581 my $vmid = extract_param
($param, 'vmid');
3583 my $snapname = extract_param
($param, 'snapname');
3585 return undef if !defined($param->{description
});
3587 my $updatefn = sub {
3589 my $conf = PVE
::QemuConfig-
>load_config($vmid);
3591 PVE
::QemuConfig-
>check_lock($conf);
3593 my $snap = $conf->{snapshots
}->{$snapname};
3595 die "snapshot '$snapname' does not exist\n" if !defined($snap);
3597 $snap->{description
} = $param->{description
} if defined($param->{description
});
3599 PVE
::QemuConfig-
>write_config($vmid, $conf);
3602 PVE
::QemuConfig-
>lock_config($vmid, $updatefn);
3607 __PACKAGE__-
>register_method({
3608 name
=> 'get_snapshot_config',
3609 path
=> '{vmid}/snapshot/{snapname}/config',
3612 description
=> "Get snapshot configuration",
3614 check
=> ['perm', '/vms/{vmid}', [ 'VM.Snapshot', 'VM.Snapshot.Rollback' ], any
=> 1],
3617 additionalProperties
=> 0,
3619 node
=> get_standard_option
('pve-node'),
3620 vmid
=> get_standard_option
('pve-vmid'),
3621 snapname
=> get_standard_option
('pve-snapshot-name'),
3624 returns
=> { type
=> "object" },
3628 my $rpcenv = PVE
::RPCEnvironment
::get
();
3630 my $authuser = $rpcenv->get_user();
3632 my $vmid = extract_param
($param, 'vmid');
3634 my $snapname = extract_param
($param, 'snapname');
3636 my $conf = PVE
::QemuConfig-
>load_config($vmid);
3638 my $snap = $conf->{snapshots
}->{$snapname};
3640 die "snapshot '$snapname' does not exist\n" if !defined($snap);
3645 __PACKAGE__-
>register_method({
3647 path
=> '{vmid}/snapshot/{snapname}/rollback',
3651 description
=> "Rollback VM state to specified snapshot.",
3653 check
=> ['perm', '/vms/{vmid}', [ 'VM.Snapshot', 'VM.Snapshot.Rollback' ], any
=> 1],
3656 additionalProperties
=> 0,
3658 node
=> get_standard_option
('pve-node'),
3659 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
3660 snapname
=> get_standard_option
('pve-snapshot-name'),
3665 description
=> "the task ID.",
3670 my $rpcenv = PVE
::RPCEnvironment
::get
();
3672 my $authuser = $rpcenv->get_user();
3674 my $node = extract_param
($param, 'node');
3676 my $vmid = extract_param
($param, 'vmid');
3678 my $snapname = extract_param
($param, 'snapname');
3681 PVE
::Cluster
::log_msg
('info', $authuser, "rollback snapshot VM $vmid: $snapname");
3682 PVE
::QemuConfig-
>snapshot_rollback($vmid, $snapname);
3686 # hold migration lock, this makes sure that nobody create replication snapshots
3687 return PVE
::GuestHelpers
::guest_migration_lock
($vmid, 10, $realcmd);
3690 return $rpcenv->fork_worker('qmrollback', $vmid, $authuser, $worker);
3693 __PACKAGE__-
>register_method({
3694 name
=> 'delsnapshot',
3695 path
=> '{vmid}/snapshot/{snapname}',
3699 description
=> "Delete a VM snapshot.",
3701 check
=> ['perm', '/vms/{vmid}', [ 'VM.Snapshot' ]],
3704 additionalProperties
=> 0,
3706 node
=> get_standard_option
('pve-node'),
3707 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
3708 snapname
=> get_standard_option
('pve-snapshot-name'),
3712 description
=> "For removal from config file, even if removing disk snapshots fails.",
3718 description
=> "the task ID.",
3723 my $rpcenv = PVE
::RPCEnvironment
::get
();
3725 my $authuser = $rpcenv->get_user();
3727 my $node = extract_param
($param, 'node');
3729 my $vmid = extract_param
($param, 'vmid');
3731 my $snapname = extract_param
($param, 'snapname');
3734 PVE
::Cluster
::log_msg
('info', $authuser, "delete snapshot VM $vmid: $snapname");
3735 PVE
::QemuConfig-
>snapshot_delete($vmid, $snapname, $param->{force
});
3738 return $rpcenv->fork_worker('qmdelsnapshot', $vmid, $authuser, $realcmd);
3741 __PACKAGE__-
>register_method({
3743 path
=> '{vmid}/template',
3747 description
=> "Create a Template.",
3749 description
=> "You need 'VM.Allocate' permissions on /vms/{vmid}",
3750 check
=> [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
3753 additionalProperties
=> 0,
3755 node
=> get_standard_option
('pve-node'),
3756 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid_stopped
}),
3760 description
=> "If you want to convert only 1 disk to base image.",
3761 enum
=> [PVE
::QemuServer
::valid_drive_names
()],
3766 returns
=> { type
=> 'null'},
3770 my $rpcenv = PVE
::RPCEnvironment
::get
();
3772 my $authuser = $rpcenv->get_user();
3774 my $node = extract_param
($param, 'node');
3776 my $vmid = extract_param
($param, 'vmid');
3778 my $disk = extract_param
($param, 'disk');
3780 my $updatefn = sub {
3782 my $conf = PVE
::QemuConfig-
>load_config($vmid);
3784 PVE
::QemuConfig-
>check_lock($conf);
3786 die "unable to create template, because VM contains snapshots\n"
3787 if $conf->{snapshots
} && scalar(keys %{$conf->{snapshots
}});
3789 die "you can't convert a template to a template\n"
3790 if PVE
::QemuConfig-
>is_template($conf) && !$disk;
3792 die "you can't convert a VM to template if VM is running\n"
3793 if PVE
::QemuServer
::check_running
($vmid);
3796 PVE
::QemuServer
::template_create
($vmid, $conf, $disk);
3799 $conf->{template
} = 1;
3800 PVE
::QemuConfig-
>write_config($vmid, $conf);
3802 return $rpcenv->fork_worker('qmtemplate', $vmid, $authuser, $realcmd);
3805 PVE
::QemuConfig-
>lock_config($vmid, $updatefn);