]> git.proxmox.com Git - pve-container.git/blame - src/PVE/API2/LXC.pm
api: clone: whitespace/code cleanup
[pve-container.git] / src / PVE / API2 / LXC.pm
CommitLineData
f76a2828
DM
1package PVE::API2::LXC;
2
3use strict;
4use warnings;
5
6use PVE::SafeSyslog;
7use PVE::Tools qw(extract_param run_command);
0620edda 8use PVE::Exception qw(raise raise_param_exc raise_perm_exc);
f76a2828 9use PVE::INotify;
9c2d4ce9 10use PVE::Cluster qw(cfs_read_file);
d949527f 11use PVE::RRD;
8b076579 12use PVE::DataCenterConfig;
f76a2828 13use PVE::AccessControl;
2f9b5ead 14use PVE::Firewall;
f76a2828
DM
15use PVE::Storage;
16use PVE::RESTHandler;
17use PVE::RPCEnvironment;
c5a8e04f 18use PVE::ReplicationConfig;
f76a2828 19use PVE::LXC;
7af97ad5 20use PVE::LXC::Create;
6f42807e 21use PVE::LXC::Migrate;
56462053 22use PVE::GuestHelpers;
c5a09704 23use PVE::VZDump::Plugin;
52389a07
DM
24use PVE::API2::LXC::Config;
25use PVE::API2::LXC::Status;
26use PVE::API2::LXC::Snapshot;
f76a2828
DM
27use PVE::JSONSchema qw(get_standard_option);
28use base qw(PVE::RESTHandler);
29
6c2e9377
WB
30BEGIN {
31 if (!$ENV{PVE_GENERATING_DOCS}) {
32 require PVE::HA::Env::PVE2;
33 import PVE::HA::Env::PVE2;
34 require PVE::HA::Config;
35 import PVE::HA::Config;
36 }
37}
f76a2828 38
52389a07
DM
39__PACKAGE__->register_method ({
40 subclass => "PVE::API2::LXC::Config",
fa91e46f 41 path => '{vmid}/config',
52389a07 42});
f76a2828 43
52389a07
DM
44__PACKAGE__->register_method ({
45 subclass => "PVE::API2::LXC::Status",
46 path => '{vmid}/status',
47});
f76a2828 48
52389a07
DM
49__PACKAGE__->register_method ({
50 subclass => "PVE::API2::LXC::Snapshot",
51 path => '{vmid}/snapshot',
52});
f76a2828 53
52389a07
DM
54__PACKAGE__->register_method ({
55 subclass => "PVE::API2::Firewall::CT",
56 path => '{vmid}/firewall',
57});
1e6c8d5b 58
f76a2828 59__PACKAGE__->register_method({
5c752bbf
DM
60 name => 'vmlist',
61 path => '',
f76a2828
DM
62 method => 'GET',
63 description => "LXC container index (per node).",
64 permissions => {
65 description => "Only list CTs where you have VM.Audit permissons on /vms/<vmid>.",
66 user => 'all',
67 },
68 proxyto => 'node',
69 protected => 1, # /proc files are only readable by root
70 parameters => {
71 additionalProperties => 0,
72 properties => {
73 node => get_standard_option('pve-node'),
74 },
75 },
76 returns => {
77 type => 'array',
78 items => {
79 type => "object",
8233d33d 80 properties => $PVE::LXC::vmstatus_return_properties,
f76a2828
DM
81 },
82 links => [ { rel => 'child', href => "{vmid}" } ],
83 },
84 code => sub {
85 my ($param) = @_;
86
87 my $rpcenv = PVE::RPCEnvironment::get();
88 my $authuser = $rpcenv->get_user();
89
90 my $vmstatus = PVE::LXC::vmstatus();
91
92 my $res = [];
93 foreach my $vmid (keys %$vmstatus) {
94 next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Audit' ], 1);
95
96 my $data = $vmstatus->{$vmid};
f76a2828
DM
97 push @$res, $data;
98 }
99
100 return $res;
5c752bbf 101
f76a2828
DM
102 }});
103
9c2d4ce9 104__PACKAGE__->register_method({
5c752bbf
DM
105 name => 'create_vm',
106 path => '',
9c2d4ce9
DM
107 method => 'POST',
108 description => "Create or restore a container.",
109 permissions => {
110 user => 'all', # check inside
111 description => "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. " .
112 "For restore, it is enough if the user has 'VM.Backup' permission and the VM already exists. " .
113 "You also need 'Datastore.AllocateSpace' permissions on the storage.",
114 },
115 protected => 1,
116 proxyto => 'node',
117 parameters => {
118 additionalProperties => 0,
1b4cf758 119 properties => PVE::LXC::Config->json_config_properties({
9c2d4ce9 120 node => get_standard_option('pve-node'),
781e26b2 121 vmid => get_standard_option('pve-vmid', { completion => \&PVE::Cluster::complete_next_vmid }),
9c2d4ce9
DM
122 ostemplate => {
123 description => "The OS template or backup file.",
5c752bbf 124 type => 'string',
9c2d4ce9 125 maxLength => 255,
68e8f3c5 126 completion => \&PVE::LXC::complete_os_templates,
9c2d4ce9 127 },
5c752bbf
DM
128 password => {
129 optional => 1,
9c2d4ce9
DM
130 type => 'string',
131 description => "Sets root password inside container.",
168d6b07 132 minLength => 5,
9c2d4ce9
DM
133 },
134 storage => get_standard_option('pve-storage-id', {
eb35f9c0 135 description => "Default Storage.",
9c2d4ce9
DM
136 default => 'local',
137 optional => 1,
c5362cda 138 completion => \&PVE::Storage::complete_storage_enabled,
9c2d4ce9
DM
139 }),
140 force => {
5c752bbf 141 optional => 1,
9c2d4ce9
DM
142 type => 'boolean',
143 description => "Allow to overwrite existing container.",
144 },
145 restore => {
5c752bbf 146 optional => 1,
9c2d4ce9
DM
147 type => 'boolean',
148 description => "Mark this as restore task.",
149 },
43912111
CE
150 unique => {
151 optional => 1,
152 type => 'boolean',
153 description => "Assign a unique random ethernet address.",
154 requires => 'restore',
155 },
5c752bbf 156 pool => {
9c2d4ce9
DM
157 optional => 1,
158 type => 'string', format => 'pve-poolid',
159 description => "Add the VM to the specified pool.",
160 },
7c78b6cc
WB
161 'ignore-unpack-errors' => {
162 optional => 1,
163 type => 'boolean',
164 description => "Ignore errors when extracting the template.",
165 },
34ddbf08
FG
166 'ssh-public-keys' => {
167 optional => 1,
168 type => 'string',
169 description => "Setup public SSH keys (one key per line, " .
170 "OpenSSH format).",
171 },
f9b4407e 172 bwlimit => {
8ead60ef 173 description => "Override I/O bandwidth limit (in KiB/s).",
f9b4407e
WB
174 optional => 1,
175 type => 'number',
176 minimum => '0',
41e9b65c 177 default => 'restore limit from datacenter or storage config',
f9b4407e 178 },
9d0225fb
TL
179 start => {
180 optional => 1,
181 type => 'boolean',
182 default => 0,
183 description => "Start the CT after its creation finished successfully.",
184 },
9c2d4ce9
DM
185 }),
186 },
5c752bbf 187 returns => {
9c2d4ce9
DM
188 type => 'string',
189 },
190 code => sub {
191 my ($param) = @_;
192
61783321
TL
193 PVE::Cluster::check_cfs_quorum();
194
9c2d4ce9 195 my $rpcenv = PVE::RPCEnvironment::get();
9c2d4ce9
DM
196 my $authuser = $rpcenv->get_user();
197
198 my $node = extract_param($param, 'node');
9c2d4ce9 199 my $vmid = extract_param($param, 'vmid');
7c78b6cc 200 my $ignore_unpack_errors = extract_param($param, 'ignore-unpack-errors');
f9b4407e 201 my $bwlimit = extract_param($param, 'bwlimit');
9d0225fb
TL
202 my $start_after_create = extract_param($param, 'start');
203
67afe46e 204 my $basecfg_fn = PVE::LXC::Config->config_file($vmid);
9c2d4ce9
DM
205 my $same_container_exists = -f $basecfg_fn;
206
425b62cb
WB
207 # 'unprivileged' is read-only, so we can't pass it to update_pct_config
208 my $unprivileged = extract_param($param, 'unprivileged');
9c2d4ce9 209 my $restore = extract_param($param, 'restore');
43912111 210 my $unique = extract_param($param, 'unique');
9c2d4ce9 211
39170644
FG
212 # used to skip firewall config restore if user lacks permission
213 my $skip_fw_config_restore = 0;
214
148d1cb4
DM
215 if ($restore) {
216 # fixme: limit allowed parameters
148d1cb4 217 }
351bc0c4 218
9c2d4ce9
DM
219 my $force = extract_param($param, 'force');
220
221 if (!($same_container_exists && $restore && $force)) {
222 PVE::Cluster::check_vmid_unused($vmid);
e22af68f 223 } else {
61783321 224 die "can't overwrite running container\n" if PVE::LXC::check_running($vmid);
67afe46e
FG
225 my $conf = PVE::LXC::Config->load_config($vmid);
226 PVE::LXC::Config->check_protection($conf, "unable to restore CT $vmid");
9c2d4ce9 227 }
5c752bbf 228
9c2d4ce9 229 my $password = extract_param($param, 'password');
34ddbf08 230 my $ssh_keys = extract_param($param, 'ssh-public-keys');
2130286f 231 PVE::Tools::validate_ssh_public_keys($ssh_keys) if defined($ssh_keys);
34ddbf08 232
27916659 233 my $pool = extract_param($param, 'pool');
9c2d4ce9
DM
234 if (defined($pool)) {
235 $rpcenv->check_pool_exist($pool);
236 $rpcenv->check_perm_modify($authuser, "/pool/$pool");
5c752bbf 237 }
9c2d4ce9
DM
238
239 if ($rpcenv->check($authuser, "/vms/$vmid", ['VM.Allocate'], 1)) {
240 # OK
241 } elsif ($pool && $rpcenv->check($authuser, "/pool/$pool", ['VM.Allocate'], 1)) {
242 # OK
243 } elsif ($restore && $force && $same_container_exists &&
244 $rpcenv->check($authuser, "/vms/$vmid", ['VM.Backup'], 1)) {
245 # OK: user has VM.Backup permissions, and want to restore an existing VM
39170644
FG
246
247 # we don't want to restore a container-provided FW conf in this case
248 # since the user is lacking permission to configure the container's FW
249 $skip_fw_config_restore = 1;
9c2d4ce9
DM
250 } else {
251 raise_perm_exc();
252 }
253
9eb69152 254 my $ostemplate = extract_param($param, 'ostemplate');
bb6afcb0
DM
255 my $storage = extract_param($param, 'storage') // 'local';
256
9eb69152
FG
257 PVE::LXC::check_ct_modify_config_perm($rpcenv, $authuser, $vmid, $pool, $param, []);
258
bb6afcb0 259 my $storage_cfg = cfs_read_file("storage.cfg");
9c2d4ce9 260
9c2d4ce9 261 my $archive;
9c2d4ce9 262 if ($ostemplate eq '-') {
351bc0c4
TM
263 die "pipe requires cli environment\n"
264 if $rpcenv->{type} ne 'cli';
265 die "pipe can only be used with restore tasks\n"
148d1cb4
DM
266 if !$restore;
267 $archive = '-';
b51a98d4 268 die "restore from pipe requires rootfs parameter\n" if !defined($param->{rootfs});
9c2d4ce9 269 } else {
f26c66e0 270 PVE::Storage::check_volume_access($rpcenv, $authuser, $storage_cfg, $vmid, $ostemplate);
99a0bcb0 271 $archive = $ostemplate;
9c2d4ce9
DM
272 }
273
f9b4407e 274 my %used_storages;
bb6afcb0
DM
275 my $check_and_activate_storage = sub {
276 my ($sid) = @_;
277
278 my $scfg = PVE::Storage::storage_check_node($storage_cfg, $sid, $node);
279
280 raise_param_exc({ storage => "storage '$sid' does not support container directories"})
281 if !$scfg->{content}->{rootdir};
282
283 $rpcenv->check($authuser, "/storage/$sid", ['Datastore.AllocateSpace']);
284
285 PVE::Storage::activate_storage($storage_cfg, $sid);
f9b4407e 286 $used_storages{$sid} = 1;
bb6afcb0
DM
287 };
288
9c2d4ce9 289 my $conf = {};
5b4657d0 290
99132ce0
WB
291 my $is_root = $authuser eq 'root@pam';
292
b51a98d4 293 my $no_disk_param = {};
db18c1e4
FG
294 my $mp_param = {};
295 my $storage_only_mode = 1;
b51a98d4 296 foreach my $opt (keys %$param) {
78ccc99b
DM
297 my $value = $param->{$opt};
298 if ($opt eq 'rootfs' || $opt =~ m/^mp\d+$/) {
299 # allow to use simple numbers (add default storage in that case)
db18c1e4
FG
300 if ($value =~ m/^\d+(\.\d+)?$/) {
301 $mp_param->{$opt} = "$storage:$value";
302 } else {
303 $mp_param->{$opt} = $value;
304 }
305 $storage_only_mode = 0;
a9dd8015
FG
306 } elsif ($opt =~ m/^unused\d+$/) {
307 warn "ignoring '$opt', cannot create/restore with unused volume\n";
308 delete $param->{$opt};
78ccc99b
DM
309 } else {
310 $no_disk_param->{$opt} = $value;
311 }
b51a98d4 312 }
bb6afcb0 313
235dbdf3 314 die "mount points configured, but 'rootfs' not set - aborting\n"
db18c1e4
FG
315 if !$storage_only_mode && !defined($mp_param->{rootfs});
316
bb6afcb0 317 # check storage access, activate storage
db18c1e4 318 my $delayed_mp_param = {};
015740e6 319 PVE::LXC::Config->foreach_volume($mp_param, sub {
bb6afcb0
DM
320 my ($ms, $mountpoint) = @_;
321
322 my $volid = $mountpoint->{volume};
323 my $mp = $mountpoint->{mp};
324
e2007ac2
DM
325 if ($mountpoint->{type} ne 'volume') { # bind or device
326 die "Only root can pass arbitrary filesystem paths.\n"
99132ce0 327 if !$is_root;
e2007ac2
DM
328 } else {
329 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid);
330 &$check_and_activate_storage($sid);
331 }
bb6afcb0
DM
332 });
333
334 # check/activate default storage
db18c1e4 335 &$check_and_activate_storage($storage) if !defined($mp_param->{rootfs});
bb6afcb0 336
1b4cf758 337 PVE::LXC::Config->update_pct_config($vmid, $conf, 0, $no_disk_param);
9c2d4ce9 338
425b62cb
WB
339 $conf->{unprivileged} = 1 if $unprivileged;
340
61783321 341 my $emsg = $restore ? "unable to restore CT $vmid -" : "unable to create CT $vmid -";
bccaa371 342
61783321
TL
343 eval { PVE::LXC::Config->create_and_lock_config($vmid, $force) };
344 die "$emsg $@" if $@;
bccaa371 345
61783321
TL
346 my $code = sub {
347 my $old_conf = PVE::LXC::Config->load_config($vmid);
a2d3e5c3 348 my $was_template;
bccaa371 349
eb35f9c0 350 my $vollist = [];
27916659 351 eval {
5a7a51d0
WB
352 my $orig_mp_param; # only used if $restore
353 if ($restore) {
61783321 354 die "can't overwrite running container\n" if PVE::LXC::check_running($vmid);
32e56bed 355 if ($archive ne '-') {
a48e5562 356 my $orig_conf;
bc871ffb 357 print "recovering backed-up configuration from '$archive'\n";
12aec1d2 358 ($orig_conf, $orig_mp_param) = PVE::LXC::Create::recover_config($storage_cfg, $archive, $vmid);
6597f369 359
a2d3e5c3 360 $was_template = delete $orig_conf->{template};
6597f369 361
a67908f1 362 # When we're root call 'restore_configuration' with restricted=0,
5a7a51d0
WB
363 # causing it to restore the raw lxc entries, among which there may be
364 # 'lxc.idmap' entries. We need to make sure that the extracted contents
365 # of the container match up with the restored configuration afterwards:
32e56bed 366 $conf->{lxc} = $orig_conf->{lxc} if $is_root;
8ffdc116
OB
367
368 $conf->{unprivileged} = $orig_conf->{unprivileged}
369 if !defined($unprivileged) && defined($orig_conf->{unprivileged});
5a7a51d0 370 }
f360d7f1 371 }
db18c1e4 372 if ($storage_only_mode) {
b51a98d4 373 if ($restore) {
a48e5562 374 if (!defined($orig_mp_param)) {
bc871ffb 375 print "recovering backed-up configuration from '$archive'\n";
12aec1d2 376 (undef, $orig_mp_param) = PVE::LXC::Create::recover_config($storage_cfg, $archive, $vmid);
a5246958 377 }
f360d7f1 378 $mp_param = $orig_mp_param;
db18c1e4
FG
379 die "rootfs configuration could not be recovered, please check and specify manually!\n"
380 if !defined($mp_param->{rootfs});
015740e6 381 PVE::LXC::Config->foreach_volume($mp_param, sub {
db18c1e4
FG
382 my ($ms, $mountpoint) = @_;
383 my $type = $mountpoint->{type};
384 if ($type eq 'volume') {
385 die "unable to detect disk size - please specify $ms (size)\n"
386 if !defined($mountpoint->{size});
387 my $disksize = $mountpoint->{size} / (1024 * 1024 * 1024); # create_disks expects GB as unit size
388 delete $mountpoint->{size};
389 $mountpoint->{volume} = "$storage:$disksize";
390 $mp_param->{$ms} = PVE::LXC::Config->print_ct_mountpoint($mountpoint, $ms eq 'rootfs');
391 } else {
15e4d443 392 my $type = $mountpoint->{type};
7e0e7f38
FG
393 die "restoring rootfs to $type mount is only possible by specifying -rootfs manually!\n"
394 if ($ms eq 'rootfs');
20f9339d 395 die "restoring '$ms' to $type mount is only possible for root\n"
99132ce0 396 if !$is_root;
7e0e7f38 397
15e4d443
FG
398 if ($mountpoint->{backup}) {
399 warn "WARNING - unsupported configuration!\n";
235dbdf3
FG
400 warn "backup was enabled for $type mount point $ms ('$mountpoint->{mp}')\n";
401 warn "mount point configuration will be restored after archive extraction!\n";
15e4d443
FG
402 warn "contained files will be restored to wrong directory!\n";
403 }
136040f4 404 delete $mp_param->{$ms}; # actually delay bind/dev mps
db18c1e4
FG
405 $delayed_mp_param->{$ms} = PVE::LXC::Config->print_ct_mountpoint($mountpoint, $ms eq 'rootfs');
406 }
407 });
b51a98d4 408 } else {
db18c1e4 409 $mp_param->{rootfs} = "$storage:4"; # defaults to 4GB
b51a98d4
DM
410 }
411 }
412
db18c1e4
FG
413 $vollist = PVE::LXC::create_disks($storage_cfg, $vmid, $mp_param, $conf);
414
61783321
TL
415 # we always have the 'create' lock so check for more than 1 entry
416 if (scalar(keys %$old_conf) > 1) {
51665c2d 417 # destroy old container volumes
61783321 418 PVE::LXC::destroy_lxc_container($storage_cfg, $vmid, $old_conf, { lock => 'create' });
51665c2d 419 }
51665c2d
FG
420
421 eval {
422 my $rootdir = PVE::LXC::mount_all($vmid, $storage_cfg, $conf, 1);
f9b4407e 423 $bwlimit = PVE::Storage::get_bandwidth_limit('restore', [keys %used_storages], $bwlimit);
bc871ffb
FG
424 print "restoring '$archive' now..\n"
425 if $restore && $archive ne '-';
99a0bcb0 426 PVE::LXC::Create::restore_archive($storage_cfg, $archive, $rootdir, $conf, $ignore_unpack_errors, $bwlimit);
51665c2d
FG
427
428 if ($restore) {
bc871ffb 429 print "merging backed-up and given configuration..\n";
99a0bcb0 430 PVE::LXC::Create::restore_configuration($vmid, $storage_cfg, $archive, $rootdir, $conf, !$is_root, $unique, $skip_fw_config_restore);
4b4bbe55
OB
431 my $lxc_setup = PVE::LXC::Setup->new($conf, $rootdir);
432 $lxc_setup->template_fixup($conf);
51665c2d
FG
433 } else {
434 my $lxc_setup = PVE::LXC::Setup->new($conf, $rootdir); # detect OS
435 PVE::LXC::Config->write_config($vmid, $conf); # safe config (after OS detection)
436 $lxc_setup->post_create_hook($password, $ssh_keys);
437 }
438 };
439 my $err = $@;
440 PVE::LXC::umount_all($vmid, $storage_cfg, $conf, $err ? 1 : 0);
441 PVE::Storage::deactivate_volumes($storage_cfg, PVE::LXC::Config->get_vm_volumes($conf));
442 die $err if $err;
27916659
DM
443 # set some defaults
444 $conf->{hostname} ||= "CT$vmid";
445 $conf->{memory} ||= 512;
446 $conf->{swap} //= 512;
db18c1e4
FG
447 foreach my $mp (keys %$delayed_mp_param) {
448 $conf->{$mp} = $delayed_mp_param->{$mp};
449 }
a2d3e5c3
CE
450 # If the template flag was set, we try to convert again to template after restore
451 if ($was_template) {
452 print STDERR "Convert restored container to template...\n";
4c64d0db
FE
453 PVE::LXC::template_create($vmid, $conf);
454 $conf->{template} = 1;
a2d3e5c3 455 }
67afe46e 456 PVE::LXC::Config->write_config($vmid, $conf);
27916659
DM
457 };
458 if (my $err = $@) {
6c871c36 459 PVE::LXC::destroy_disks($storage_cfg, $vollist);
4eeb9af1 460 eval { PVE::LXC::Config->destroy_config($vmid) };
d7d48be6 461 warn $@ if $@;
61783321 462 die "$emsg $err";
6d098bf4 463 }
87273b2b 464 PVE::AccessControl::add_vm_to_pool($vmid, $pool) if $pool;
9d0225fb
TL
465
466 PVE::API2::LXC::Status->vm_start({ vmid => $vmid, node => $node })
467 if $start_after_create;
9c2d4ce9 468 };
5c752bbf 469
8a6fc617 470 my $workername = $restore ? 'vzrestore' : 'vzcreate';
67afe46e 471 my $realcmd = sub { PVE::LXC::Config->lock_config($vmid, $code); };
9c2d4ce9 472
8a6fc617 473 return $rpcenv->fork_worker($workername, $vmid, $authuser, $realcmd);
9c2d4ce9
DM
474 }});
475
f76a2828
DM
476__PACKAGE__->register_method({
477 name => 'vmdiridx',
5c752bbf 478 path => '{vmid}',
f76a2828
DM
479 method => 'GET',
480 proxyto => 'node',
481 description => "Directory index",
482 permissions => {
483 user => 'all',
484 },
485 parameters => {
486 additionalProperties => 0,
487 properties => {
488 node => get_standard_option('pve-node'),
489 vmid => get_standard_option('pve-vmid'),
490 },
491 },
492 returns => {
493 type => 'array',
494 items => {
495 type => "object",
496 properties => {
497 subdir => { type => 'string' },
498 },
499 },
500 links => [ { rel => 'child', href => "{subdir}" } ],
501 },
502 code => sub {
503 my ($param) = @_;
504
505 # test if VM exists
67afe46e 506 my $conf = PVE::LXC::Config->load_config($param->{vmid});
f76a2828
DM
507
508 my $res = [
509 { subdir => 'config' },
37c2dba8 510 { subdir => 'pending' },
fff3a342
DM
511 { subdir => 'status' },
512 { subdir => 'vncproxy' },
a0226a00 513 { subdir => 'termproxy' },
fff3a342
DM
514 { subdir => 'vncwebsocket' },
515 { subdir => 'spiceproxy' },
516 { subdir => 'migrate' },
c4a33727 517 { subdir => 'clone' },
f76a2828
DM
518# { subdir => 'initlog' },
519 { subdir => 'rrd' },
520 { subdir => 'rrddata' },
521 { subdir => 'firewall' },
cc5392c8 522 { subdir => 'snapshot' },
985b18ed 523 { subdir => 'resize' },
f76a2828 524 ];
5c752bbf 525
f76a2828
DM
526 return $res;
527 }});
528
c4a33727 529
f76a2828 530__PACKAGE__->register_method({
5c752bbf
DM
531 name => 'rrd',
532 path => '{vmid}/rrd',
f76a2828
DM
533 method => 'GET',
534 protected => 1, # fixme: can we avoid that?
535 permissions => {
536 check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
537 },
538 description => "Read VM RRD statistics (returns PNG)",
539 parameters => {
540 additionalProperties => 0,
541 properties => {
542 node => get_standard_option('pve-node'),
543 vmid => get_standard_option('pve-vmid'),
544 timeframe => {
545 description => "Specify the time frame you are interested in.",
546 type => 'string',
547 enum => [ 'hour', 'day', 'week', 'month', 'year' ],
548 },
549 ds => {
550 description => "The list of datasources you want to display.",
551 type => 'string', format => 'pve-configid-list',
552 },
553 cf => {
554 description => "The RRD consolidation function",
555 type => 'string',
556 enum => [ 'AVERAGE', 'MAX' ],
557 optional => 1,
558 },
559 },
560 },
561 returns => {
562 type => "object",
563 properties => {
564 filename => { type => 'string' },
565 },
566 },
567 code => sub {
568 my ($param) = @_;
569
d949527f 570 return PVE::RRD::create_rrd_graph(
5c752bbf 571 "pve2-vm/$param->{vmid}", $param->{timeframe},
f76a2828 572 $param->{ds}, $param->{cf});
5c752bbf 573
f76a2828
DM
574 }});
575
576__PACKAGE__->register_method({
5c752bbf
DM
577 name => 'rrddata',
578 path => '{vmid}/rrddata',
f76a2828
DM
579 method => 'GET',
580 protected => 1, # fixme: can we avoid that?
581 permissions => {
582 check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
583 },
584 description => "Read VM RRD statistics",
585 parameters => {
586 additionalProperties => 0,
587 properties => {
588 node => get_standard_option('pve-node'),
589 vmid => get_standard_option('pve-vmid'),
590 timeframe => {
591 description => "Specify the time frame you are interested in.",
592 type => 'string',
593 enum => [ 'hour', 'day', 'week', 'month', 'year' ],
594 },
595 cf => {
596 description => "The RRD consolidation function",
597 type => 'string',
598 enum => [ 'AVERAGE', 'MAX' ],
599 optional => 1,
600 },
601 },
602 },
603 returns => {
604 type => "array",
605 items => {
606 type => "object",
607 properties => {},
608 },
609 },
610 code => sub {
611 my ($param) = @_;
612
d949527f 613 return PVE::RRD::create_rrd_data(
f76a2828
DM
614 "pve2-vm/$param->{vmid}", $param->{timeframe}, $param->{cf});
615 }});
616
f76a2828 617__PACKAGE__->register_method({
5c752bbf
DM
618 name => 'destroy_vm',
619 path => '{vmid}',
f76a2828
DM
620 method => 'DELETE',
621 protected => 1,
622 proxyto => 'node',
623 description => "Destroy the container (also delete all uses files).",
624 permissions => {
625 check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
626 },
627 parameters => {
628 additionalProperties => 0,
629 properties => {
630 node => get_standard_option('pve-node'),
68e8f3c5 631 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid_stopped }),
d51b84ff
TL
632 force => {
633 type => 'boolean',
634 description => "Force destroy, even if running.",
635 default => 0,
636 optional => 1,
637 },
c5a09704
CE
638 purge => {
639 type => 'boolean',
796e8eee
TL
640 description => "Remove container from all related configurations."
641 ." For example, backup jobs, replication jobs or HA."
642 ." Related ACLs and Firewall entries will *always* be removed.",
643 default => 0,
c5a09704
CE
644 optional => 1,
645 },
3b1c0970
TL
646 'destroy-unreferenced-disks' => {
647 type => 'boolean',
648 description => "If set, destroy additionally all disks with the VMID from all"
649 ." enabled storages which are not referenced in the config.",
650 optional => 1,
651 },
f76a2828
DM
652 },
653 },
5c752bbf 654 returns => {
f76a2828
DM
655 type => 'string',
656 },
657 code => sub {
658 my ($param) = @_;
659
660 my $rpcenv = PVE::RPCEnvironment::get();
f76a2828 661 my $authuser = $rpcenv->get_user();
f76a2828
DM
662 my $vmid = $param->{vmid};
663
664 # test if container exists
0512c360 665
67afe46e 666 my $conf = PVE::LXC::Config->load_config($vmid);
0512c360
FG
667 my $early_checks = sub {
668 my ($conf) = @_;
669 PVE::LXC::Config->check_protection($conf, "can't remove CT $vmid");
670 PVE::LXC::Config->check_lock($conf);
7e806596 671
0512c360 672 my $ha_managed = PVE::HA::Config::service_is_configured("ct:$vmid");
b6e0b774 673
0512c360
FG
674 if (!$param->{purge}) {
675 die "unable to remove CT $vmid - used in HA resources and purge parameter not set.\n"
676 if $ha_managed;
3207b81a 677
0512c360
FG
678 # do not allow destroy if there are replication jobs without purge
679 my $repl_conf = PVE::ReplicationConfig->new();
680 $repl_conf->check_for_existing_jobs($vmid);
681 }
682
683 return $ha_managed;
684 };
685
686 $early_checks->($conf);
c5a8e04f 687
d607c17d 688 my $running_error_msg = "unable to destroy CT $vmid - container is running\n";
d51b84ff 689 die $running_error_msg if !$param->{force} && PVE::LXC::check_running($vmid); # check early
d607c17d 690
611fe3aa 691 my $code = sub {
673cf209 692 # reload config after lock
67afe46e 693 $conf = PVE::LXC::Config->load_config($vmid);
0512c360 694 my $ha_managed = $early_checks->($conf);
673cf209 695
d51b84ff
TL
696 if (PVE::LXC::check_running($vmid)) {
697 die $running_error_msg if !$param->{force};
698 warn "forced to stop CT $vmid before destroying!\n";
699 if (!$ha_managed) {
700 PVE::LXC::vm_stop($vmid, 1);
701 } else {
702 run_command(['ha-manager', 'crm-command', 'stop', "ct:$vmid", '120']);
703 }
704 }
d607c17d 705
0512c360 706 my $storage_cfg = cfs_read_file("storage.cfg");
3b1c0970
TL
707 PVE::LXC::destroy_lxc_container(
708 $storage_cfg,
709 $vmid,
710 $conf,
711 { lock => 'destroyed' },
712 $param->{'destroy-unreferenced-disks'},
713 );
7fc1d9eb 714
be5fc936 715 PVE::AccessControl::remove_vm_access($vmid);
2f9b5ead 716 PVE::Firewall::remove_vmfw_conf($vmid);
c5a09704 717 if ($param->{purge}) {
3207b81a 718 print "purging CT $vmid from related configurations..\n";
c5a09704
CE
719 PVE::ReplicationConfig::remove_vmid_jobs($vmid);
720 PVE::VZDump::Plugin::remove_vmid_from_backup_jobs($vmid);
3207b81a
TL
721
722 if ($ha_managed) {
723 PVE::HA::Config::delete_service_from_config("ct:$vmid");
724 print "NOTE: removed CT $vmid from HA resource configuration.\n";
725 }
c5a09704 726 }
7fc1d9eb
TL
727
728 # only now remove the zombie config, else we can have reuse race
729 PVE::LXC::Config->destroy_config($vmid);
f76a2828
DM
730 };
731
67afe46e 732 my $realcmd = sub { PVE::LXC::Config->lock_config($vmid, $code); };
351bc0c4 733
f76a2828
DM
734 return $rpcenv->fork_worker('vzdestroy', $vmid, $authuser, $realcmd);
735 }});
736
fff3a342
DM
737my $sslcert;
738
739__PACKAGE__->register_method ({
5b4657d0
DM
740 name => 'vncproxy',
741 path => '{vmid}/vncproxy',
fff3a342
DM
742 method => 'POST',
743 protected => 1,
744 permissions => {
745 check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
746 },
747 description => "Creates a TCP VNC proxy connections.",
748 parameters => {
749 additionalProperties => 0,
750 properties => {
751 node => get_standard_option('pve-node'),
752 vmid => get_standard_option('pve-vmid'),
753 websocket => {
754 optional => 1,
755 type => 'boolean',
756 description => "use websocket instead of standard VNC.",
757 },
bd0f4d6d
DC
758 width => {
759 optional => 1,
760 description => "sets the width of the console in pixels.",
761 type => 'integer',
762 minimum => 16,
763 maximum => 4096,
764 },
765 height => {
766 optional => 1,
767 description => "sets the height of the console in pixels.",
768 type => 'integer',
769 minimum => 16,
770 maximum => 2160,
771 },
fff3a342
DM
772 },
773 },
5b4657d0 774 returns => {
fff3a342
DM
775 additionalProperties => 0,
776 properties => {
777 user => { type => 'string' },
778 ticket => { type => 'string' },
779 cert => { type => 'string' },
780 port => { type => 'integer' },
781 upid => { type => 'string' },
782 },
783 },
784 code => sub {
785 my ($param) = @_;
786
787 my $rpcenv = PVE::RPCEnvironment::get();
788
789 my $authuser = $rpcenv->get_user();
790
791 my $vmid = $param->{vmid};
792 my $node = $param->{node};
793
794 my $authpath = "/vms/$vmid";
795
796 my $ticket = PVE::AccessControl::assemble_vnc_ticket($authuser, $authpath);
797
798 $sslcert = PVE::Tools::file_get_contents("/etc/pve/pve-root-ca.pem", 8192)
799 if !$sslcert;
800
ec2c57eb 801 my ($remip, $family);
5b4657d0 802
fff3a342 803 if ($node ne PVE::INotify::nodename()) {
85ae6211 804 ($remip, $family) = PVE::Cluster::remote_node_ip($node);
ec2c57eb
WB
805 } else {
806 $family = PVE::Tools::get_host_address_family($node);
fff3a342
DM
807 }
808
ec2c57eb
WB
809 my $port = PVE::Tools::next_vnc_port($family);
810
fff3a342
DM
811 # NOTE: vncterm VNC traffic is already TLS encrypted,
812 # so we select the fastest chipher here (or 'none'?)
5b4657d0 813 my $remcmd = $remip ?
806eae70 814 ['/usr/bin/ssh', '-e', 'none', '-t', $remip] : [];
fff3a342 815
67afe46e 816 my $conf = PVE::LXC::Config->load_config($vmid, $node);
65213b67 817 my $concmd = PVE::LXC::get_console_command($vmid, $conf, -1);
aca816ad 818
5b4657d0
DM
819 my $shcmd = [ '/usr/bin/dtach', '-A',
820 "/var/run/dtach/vzctlconsole$vmid",
aca816ad 821 '-r', 'winch', '-z', @$concmd];
fff3a342
DM
822
823 my $realcmd = sub {
824 my $upid = shift;
825
5b4657d0 826 syslog ('info', "starting lxc vnc proxy $upid\n");
fff3a342 827
5b4657d0 828 my $timeout = 10;
fff3a342
DM
829
830 my $cmd = ['/usr/bin/vncterm', '-rfbport', $port,
5b4657d0 831 '-timeout', $timeout, '-authpath', $authpath,
fff3a342
DM
832 '-perm', 'VM.Console'];
833
bd0f4d6d
DC
834 if ($param->{width}) {
835 push @$cmd, '-width', $param->{width};
836 }
837
838 if ($param->{height}) {
839 push @$cmd, '-height', $param->{height};
840 }
841
fff3a342 842 if ($param->{websocket}) {
5b4657d0 843 $ENV{PVE_VNC_TICKET} = $ticket; # pass ticket to vncterm
fff3a342
DM
844 push @$cmd, '-notls', '-listen', 'localhost';
845 }
846
847 push @$cmd, '-c', @$remcmd, @$shcmd;
848
37634d3d 849 run_command($cmd, keeplocale => 1);
fff3a342
DM
850
851 return;
852 };
853
854 my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd);
855
856 PVE::Tools::wait_for_vnc_port($port);
857
858 return {
859 user => $authuser,
860 ticket => $ticket,
5b4657d0
DM
861 port => $port,
862 upid => $upid,
863 cert => $sslcert,
fff3a342
DM
864 };
865 }});
866
a0226a00
DC
867__PACKAGE__->register_method ({
868 name => 'termproxy',
869 path => '{vmid}/termproxy',
870 method => 'POST',
871 protected => 1,
872 permissions => {
873 check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
874 },
875 description => "Creates a TCP proxy connection.",
876 parameters => {
877 additionalProperties => 0,
878 properties => {
879 node => get_standard_option('pve-node'),
880 vmid => get_standard_option('pve-vmid'),
881 },
882 },
883 returns => {
884 additionalProperties => 0,
885 properties => {
886 user => { type => 'string' },
887 ticket => { type => 'string' },
888 port => { type => 'integer' },
889 upid => { type => 'string' },
890 },
891 },
892 code => sub {
893 my ($param) = @_;
894
895 my $rpcenv = PVE::RPCEnvironment::get();
896
897 my $authuser = $rpcenv->get_user();
898
899 my $vmid = $param->{vmid};
900 my $node = $param->{node};
901
902 my $authpath = "/vms/$vmid";
903
904 my $ticket = PVE::AccessControl::assemble_vnc_ticket($authuser, $authpath);
905
906 my ($remip, $family);
907
908 if ($node ne 'localhost' && $node ne PVE::INotify::nodename()) {
909 ($remip, $family) = PVE::Cluster::remote_node_ip($node);
910 } else {
911 $family = PVE::Tools::get_host_address_family($node);
912 }
913
914 my $port = PVE::Tools::next_vnc_port($family);
915
916 my $remcmd = $remip ?
917 ['/usr/bin/ssh', '-e', 'none', '-t', $remip, '--'] : [];
918
919 my $conf = PVE::LXC::Config->load_config($vmid, $node);
65213b67 920 my $concmd = PVE::LXC::get_console_command($vmid, $conf, -1);
a0226a00
DC
921
922 my $shcmd = [ '/usr/bin/dtach', '-A',
923 "/var/run/dtach/vzctlconsole$vmid",
924 '-r', 'winch', '-z', @$concmd];
925
926 my $realcmd = sub {
927 my $upid = shift;
928
929 syslog ('info', "starting lxc termproxy $upid\n");
930
931 my $cmd = ['/usr/bin/termproxy', $port, '--path', $authpath,
932 '--perm', 'VM.Console', '--'];
933 push @$cmd, @$remcmd, @$shcmd;
934
935 PVE::Tools::run_command($cmd);
936 };
937
938 my $upid = $rpcenv->fork_worker('vncproxy', $vmid, $authuser, $realcmd, 1);
939
940 PVE::Tools::wait_for_vnc_port($port);
941
942 return {
943 user => $authuser,
944 ticket => $ticket,
945 port => $port,
946 upid => $upid,
947 };
948 }});
949
fff3a342
DM
950__PACKAGE__->register_method({
951 name => 'vncwebsocket',
952 path => '{vmid}/vncwebsocket',
953 method => 'GET',
5b4657d0 954 permissions => {
fff3a342
DM
955 description => "You also need to pass a valid ticket (vncticket).",
956 check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
957 },
958 description => "Opens a weksocket for VNC traffic.",
959 parameters => {
960 additionalProperties => 0,
961 properties => {
962 node => get_standard_option('pve-node'),
963 vmid => get_standard_option('pve-vmid'),
964 vncticket => {
965 description => "Ticket from previous call to vncproxy.",
966 type => 'string',
967 maxLength => 512,
968 },
969 port => {
970 description => "Port number returned by previous vncproxy call.",
971 type => 'integer',
972 minimum => 5900,
973 maximum => 5999,
974 },
975 },
976 },
977 returns => {
978 type => "object",
979 properties => {
980 port => { type => 'string' },
981 },
982 },
983 code => sub {
984 my ($param) = @_;
985
986 my $rpcenv = PVE::RPCEnvironment::get();
987
988 my $authuser = $rpcenv->get_user();
989
990 my $authpath = "/vms/$param->{vmid}";
991
992 PVE::AccessControl::verify_vnc_ticket($param->{vncticket}, $authuser, $authpath);
993
994 my $port = $param->{port};
5b4657d0 995
fff3a342
DM
996 return { port => $port };
997 }});
998
999__PACKAGE__->register_method ({
5b4657d0
DM
1000 name => 'spiceproxy',
1001 path => '{vmid}/spiceproxy',
fff3a342
DM
1002 method => 'POST',
1003 protected => 1,
1004 proxyto => 'node',
1005 permissions => {
1006 check => ['perm', '/vms/{vmid}', [ 'VM.Console' ]],
1007 },
1008 description => "Returns a SPICE configuration to connect to the CT.",
1009 parameters => {
1010 additionalProperties => 0,
1011 properties => {
1012 node => get_standard_option('pve-node'),
1013 vmid => get_standard_option('pve-vmid'),
1014 proxy => get_standard_option('spice-proxy', { optional => 1 }),
1015 },
1016 },
1017 returns => get_standard_option('remote-viewer-config'),
1018 code => sub {
1019 my ($param) = @_;
1020
1021 my $vmid = $param->{vmid};
1022 my $node = $param->{node};
1023 my $proxy = $param->{proxy};
1024
1025 my $authpath = "/vms/$vmid";
1026 my $permissions = 'VM.Console';
1027
67afe46e 1028 my $conf = PVE::LXC::Config->load_config($vmid);
da4db334
TL
1029
1030 die "CT $vmid not running\n" if !PVE::LXC::check_running($vmid);
1031
aca816ad
DM
1032 my $concmd = PVE::LXC::get_console_command($vmid, $conf);
1033
5b4657d0
DM
1034 my $shcmd = ['/usr/bin/dtach', '-A',
1035 "/var/run/dtach/vzctlconsole$vmid",
aca816ad 1036 '-r', 'winch', '-z', @$concmd];
fff3a342
DM
1037
1038 my $title = "CT $vmid";
1039
1040 return PVE::API2Tools::run_spiceterm($authpath, $permissions, $vmid, $node, $proxy, $title, $shcmd);
1041 }});
5c752bbf 1042
5c752bbf
DM
1043
1044__PACKAGE__->register_method({
52389a07
DM
1045 name => 'migrate_vm',
1046 path => '{vmid}/migrate',
5c752bbf
DM
1047 method => 'POST',
1048 protected => 1,
1049 proxyto => 'node',
52389a07 1050 description => "Migrate the container to another node. Creates a new migration task.",
5c752bbf 1051 permissions => {
52389a07 1052 check => ['perm', '/vms/{vmid}', [ 'VM.Migrate' ]],
5c752bbf
DM
1053 },
1054 parameters => {
1055 additionalProperties => 0,
1056 properties => {
1057 node => get_standard_option('pve-node'),
68e8f3c5
DM
1058 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
1059 target => get_standard_option('pve-node', {
1060 description => "Target node.",
39bb88df 1061 completion => \&PVE::Cluster::complete_migration_target,
68e8f3c5 1062 }),
52389a07
DM
1063 online => {
1064 type => 'boolean',
1065 description => "Use online/live migration.",
1066 optional => 1,
1067 },
00d8cdc0
DC
1068 restart => {
1069 type => 'boolean',
1070 description => "Use restart migration",
1071 optional => 1,
1072 },
1073 timeout => {
1074 type => 'integer',
1075 description => "Timeout in seconds for shutdown for restart migration",
1076 optional => 1,
1077 default => 180,
1078 },
9746c095
FG
1079 force => {
1080 type => 'boolean',
1081 description => "Force migration despite local bind / device" .
552e168f 1082 " mounts. NOTE: deprecated, use 'shared' property of mount point instead.",
9746c095
FG
1083 optional => 1,
1084 },
8ead60ef
SI
1085 bwlimit => {
1086 description => "Override I/O bandwidth limit (in KiB/s).",
1087 optional => 1,
1088 type => 'number',
1089 minimum => '0',
41e9b65c 1090 default => 'migrate limit from datacenter or storage config',
8ead60ef 1091 },
5c752bbf
DM
1092 },
1093 },
1094 returns => {
1095 type => 'string',
52389a07 1096 description => "the task ID.",
5c752bbf
DM
1097 },
1098 code => sub {
1099 my ($param) = @_;
1100
1101 my $rpcenv = PVE::RPCEnvironment::get();
1102
1103 my $authuser = $rpcenv->get_user();
1104
52389a07 1105 my $target = extract_param($param, 'target');
bb1ac2de 1106
52389a07
DM
1107 my $localnode = PVE::INotify::nodename();
1108 raise_param_exc({ target => "target is local node."}) if $target eq $localnode;
bb1ac2de 1109
52389a07 1110 PVE::Cluster::check_cfs_quorum();
5c752bbf 1111
52389a07 1112 PVE::Cluster::check_node_exists($target);
27916659 1113
52389a07 1114 my $targetip = PVE::Cluster::remote_node_ip($target);
5c752bbf 1115
52389a07 1116 my $vmid = extract_param($param, 'vmid');
5c752bbf 1117
52389a07 1118 # test if VM exists
67afe46e 1119 PVE::LXC::Config->load_config($vmid);
5c752bbf 1120
52389a07
DM
1121 # try to detect errors early
1122 if (PVE::LXC::check_running($vmid)) {
00d8cdc0
DC
1123 die "can't migrate running container without --online or --restart\n"
1124 if !$param->{online} && !$param->{restart};
5c752bbf 1125 }
5c752bbf
DM
1126
1127 if (PVE::HA::Config::vm_is_ha_managed($vmid) && $rpcenv->{type} ne 'ha') {
1128
1129 my $hacmd = sub {
1130 my $upid = shift;
1131
1132 my $service = "ct:$vmid";
1133
52389a07 1134 my $cmd = ['ha-manager', 'migrate', $service, $target];
5c752bbf 1135
545dd4e1 1136 print "Requesting HA migration for CT $vmid to node $target\n";
5c752bbf
DM
1137
1138 PVE::Tools::run_command($cmd);
1139
1140 return;
1141 };
1142
52389a07 1143 return $rpcenv->fork_worker('hamigrate', $vmid, $authuser, $hacmd);
5c752bbf
DM
1144
1145 } else {
1146
22557519
DM
1147 my $realcmd = sub {
1148 PVE::LXC::Migrate->migrate($target, $targetip, $vmid, $param);
1149 };
56462053 1150
22557519
DM
1151 my $worker = sub {
1152 return PVE::GuestHelpers::guest_migration_lock($vmid, 10, $realcmd);
5c752bbf
DM
1153 };
1154
22557519 1155 return $rpcenv->fork_worker('vzmigrate', $vmid, $authuser, $worker);
5c752bbf
DM
1156 }
1157 }});
1158
cc5392c8
WL
1159__PACKAGE__->register_method({
1160 name => 'vm_feature',
1161 path => '{vmid}/feature',
1162 method => 'GET',
1163 proxyto => 'node',
1164 protected => 1,
1165 description => "Check if feature for virtual machine is available.",
1166 permissions => {
1167 check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1168 },
1169 parameters => {
1170 additionalProperties => 0,
1171 properties => {
1172 node => get_standard_option('pve-node'),
1173 vmid => get_standard_option('pve-vmid'),
1174 feature => {
1175 description => "Feature to check.",
1176 type => 'string',
d53e5c58 1177 enum => [ 'snapshot', 'clone', 'copy' ],
cc5392c8 1178 },
5ec3949c 1179 snapname => get_standard_option('pve-snapshot-name', {
cc5392c8
WL
1180 optional => 1,
1181 }),
1182 },
1183 },
1184 returns => {
1185 type => "object",
1186 properties => {
1187 hasFeature => { type => 'boolean' },
1188 #nodes => {
1189 #type => 'array',
1190 #items => { type => 'string' },
1191 #}
1192 },
1193 },
1194 code => sub {
1195 my ($param) = @_;
1196
1197 my $node = extract_param($param, 'node');
1198
1199 my $vmid = extract_param($param, 'vmid');
1200
1201 my $snapname = extract_param($param, 'snapname');
1202
1203 my $feature = extract_param($param, 'feature');
1204
67afe46e 1205 my $conf = PVE::LXC::Config->load_config($vmid);
cc5392c8
WL
1206
1207 if($snapname){
1208 my $snap = $conf->{snapshots}->{$snapname};
1209 die "snapshot '$snapname' does not exist\n" if !defined($snap);
1210 $conf = $snap;
1211 }
ef241384 1212 my $storage_cfg = PVE::Storage::config();
cc5392c8 1213 #Maybe include later
ef241384 1214 #my $nodelist = PVE::LXC::shared_nodes($conf, $storage_cfg);
4518000b 1215 my $hasFeature = PVE::LXC::Config->has_feature($feature, $conf, $storage_cfg, $snapname);
cc5392c8
WL
1216
1217 return {
1218 hasFeature => $hasFeature,
1219 #nodes => [ keys %$nodelist ],
1220 };
1221 }});
bb1ac2de
DM
1222
1223__PACKAGE__->register_method({
1224 name => 'template',
1225 path => '{vmid}/template',
1226 method => 'POST',
1227 protected => 1,
1228 proxyto => 'node',
1229 description => "Create a Template.",
1230 permissions => {
1231 description => "You need 'VM.Allocate' permissions on /vms/{vmid}",
1232 check => [ 'perm', '/vms/{vmid}', ['VM.Allocate']],
1233 },
1234 parameters => {
1235 additionalProperties => 0,
1236 properties => {
1237 node => get_standard_option('pve-node'),
68e8f3c5 1238 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid_stopped }),
bb1ac2de
DM
1239 },
1240 },
1241 returns => { type => 'null'},
1242 code => sub {
1243 my ($param) = @_;
1244
1245 my $rpcenv = PVE::RPCEnvironment::get();
1246
1247 my $authuser = $rpcenv->get_user();
1248
1249 my $node = extract_param($param, 'node');
1250
1251 my $vmid = extract_param($param, 'vmid');
1252
1253 my $updatefn = sub {
1254
67afe46e
FG
1255 my $conf = PVE::LXC::Config->load_config($vmid);
1256 PVE::LXC::Config->check_lock($conf);
bb1ac2de
DM
1257
1258 die "unable to create template, because CT contains snapshots\n"
1259 if $conf->{snapshots} && scalar(keys %{$conf->{snapshots}});
1260
1261 die "you can't convert a template to a template\n"
67afe46e 1262 if PVE::LXC::Config->is_template($conf);
bb1ac2de
DM
1263
1264 die "you can't convert a CT to template if the CT is running\n"
1265 if PVE::LXC::check_running($vmid);
1266
1267 my $realcmd = sub {
1268 PVE::LXC::template_create($vmid, $conf);
bb1ac2de 1269
c2182c49 1270 $conf->{template} = 1;
bb1ac2de 1271
c2182c49
WL
1272 PVE::LXC::Config->write_config($vmid, $conf);
1273 # and remove lxc config
1274 PVE::LXC::update_lxc_config($vmid, $conf);
1275 };
bb1ac2de
DM
1276
1277 return $rpcenv->fork_worker('vztemplate', $vmid, $authuser, $realcmd);
1278 };
1279
67afe46e 1280 PVE::LXC::Config->lock_config($vmid, $updatefn);
bb1ac2de
DM
1281
1282 return undef;
1283 }});
1284
c4a33727
DM
1285__PACKAGE__->register_method({
1286 name => 'clone_vm',
1287 path => '{vmid}/clone',
1288 method => 'POST',
1289 protected => 1,
1290 proxyto => 'node',
1291 description => "Create a container clone/copy",
1292 permissions => {
1293 description => "You need 'VM.Clone' permissions on /vms/{vmid}, " .
1294 "and 'VM.Allocate' permissions " .
1295 "on /vms/{newid} (or on the VM pool /pool/{pool}). You also need " .
1296 "'Datastore.AllocateSpace' on any used storage.",
1297 check =>
1298 [ 'and',
1299 ['perm', '/vms/{vmid}', [ 'VM.Clone' ]],
1300 [ 'or',
1301 [ 'perm', '/vms/{newid}', ['VM.Allocate']],
1302 [ 'perm', '/pool/{pool}', ['VM.Allocate'], require_param => 'pool'],
1303 ],
1304 ]
1305 },
1306 parameters => {
1307 additionalProperties => 0,
1308 properties => {
1309 node => get_standard_option('pve-node'),
1310 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
1311 newid => get_standard_option('pve-vmid', {
1312 completion => \&PVE::Cluster::complete_next_vmid,
1313 description => 'VMID for the clone.' }),
1314 hostname => {
1315 optional => 1,
1316 type => 'string', format => 'dns-name',
1317 description => "Set a hostname for the new CT.",
1318 },
1319 description => {
1320 optional => 1,
1321 type => 'string',
1322 description => "Description for the new CT.",
1323 },
1324 pool => {
1325 optional => 1,
1326 type => 'string', format => 'pve-poolid',
1327 description => "Add the new CT to the specified pool.",
1328 },
5ec3949c 1329 snapname => get_standard_option('pve-snapshot-name', {
c4a33727
DM
1330 optional => 1,
1331 }),
1332 storage => get_standard_option('pve-storage-id', {
1333 description => "Target storage for full clone.",
c4a33727
DM
1334 optional => 1,
1335 }),
1336 full => {
1337 optional => 1,
1338 type => 'boolean',
c4b4cb83 1339 description => "Create a full copy of all disks. This is always done when " .
c4a33727 1340 "you clone a normal CT. For CT templates, we try to create a linked clone by default.",
c4a33727 1341 },
411ae12c
DM
1342 target => get_standard_option('pve-node', {
1343 description => "Target node. Only allowed if the original VM is on shared storage.",
1344 optional => 1,
1345 }),
8ead60ef
SI
1346 bwlimit => {
1347 description => "Override I/O bandwidth limit (in KiB/s).",
1348 optional => 1,
1349 type => 'number',
1350 minimum => '0',
41e9b65c 1351 default => 'clone limit from datacenter or storage config',
8ead60ef 1352 },
c4a33727
DM
1353 },
1354 },
1355 returns => {
1356 type => 'string',
1357 },
1358 code => sub {
1359 my ($param) = @_;
1360
1361 my $rpcenv = PVE::RPCEnvironment::get();
59b0ce55 1362 my $authuser = $rpcenv->get_user();
c4a33727
DM
1363
1364 my $node = extract_param($param, 'node');
c4a33727 1365 my $vmid = extract_param($param, 'vmid');
c4a33727 1366 my $newid = extract_param($param, 'newid');
c4a33727 1367 my $pool = extract_param($param, 'pool');
c4a33727
DM
1368 if (defined($pool)) {
1369 $rpcenv->check_pool_exist($pool);
1370 }
c4a33727 1371 my $snapname = extract_param($param, 'snapname');
c4a33727 1372 my $storage = extract_param($param, 'storage');
411ae12c 1373 my $target = extract_param($param, 'target');
c4a33727
DM
1374 my $localnode = PVE::INotify::nodename();
1375
59b0ce55 1376 undef $target if $target && ($target eq $localnode || $target eq 'localhost');
411ae12c
DM
1377
1378 PVE::Cluster::check_node_exists($target) if $target;
1379
c4a33727
DM
1380 my $storecfg = PVE::Storage::config();
1381
1382 if ($storage) {
1383 # check if storage is enabled on local node
1384 PVE::Storage::storage_check_enabled($storecfg, $storage);
411ae12c
DM
1385 if ($target) {
1386 # check if storage is available on target node
1387 PVE::Storage::storage_check_node($storecfg, $storage, $target);
1388 # clone only works if target storage is shared
1389 my $scfg = PVE::Storage::storage_config($storecfg, $storage);
1390 die "can't clone to non-shared storage '$storage'\n" if !$scfg->{shared};
1391 }
c4a33727
DM
1392 }
1393
1394 PVE::Cluster::check_cfs_quorum();
1395
db01d674
WB
1396 my $conffile;
1397 my $newconf = {};
1398 my $mountpoints = {};
1399 my $fullclone = {};
1400 my $vollist = [];
411ae12c 1401 my $running;
c4a33727 1402
db01d674
WB
1403 PVE::LXC::Config->lock_config($vmid, sub {
1404 my $src_conf = PVE::LXC::Config->set_lock($vmid, 'disk');
e7d553c7 1405
411ae12c
DM
1406 $running = PVE::LXC::check_running($vmid) || 0;
1407
e7d553c7
DM
1408 my $full = extract_param($param, 'full');
1409 if (!defined($full)) {
1410 $full = !PVE::LXC::Config->is_template($src_conf);
1411 }
1412 die "parameter 'storage' not allowed for linked clones\n" if defined($storage) && !$full;
1413
db01d674
WB
1414 eval {
1415 die "snapshot '$snapname' does not exist\n"
1416 if $snapname && !defined($src_conf->{snapshots}->{$snapname});
c4a33727 1417
db01d674 1418 my $src_conf = $snapname ? $src_conf->{snapshots}->{$snapname} : $src_conf;
c4a33727 1419
db01d674
WB
1420 $conffile = PVE::LXC::Config->config_file($newid);
1421 die "unable to create CT $newid: config file already exists\n"
1422 if -f $conffile;
c4a33727 1423
24f9d440 1424 my $sharedvm = 1;
59b0ce55 1425 for my $opt (sort keys %$src_conf) {
db01d674 1426 next if $opt =~ m/^unused\d+$/;
c4a33727 1427
db01d674 1428 my $value = $src_conf->{$opt};
c4a33727 1429
db01d674 1430 if (($opt eq 'rootfs') || ($opt =~ m/^mp\d+$/)) {
e4034859 1431 my $mp = PVE::LXC::Config->parse_volume($opt, $value);
c4a33727 1432
db01d674
WB
1433 if ($mp->{type} eq 'volume') {
1434 my $volid = $mp->{volume};
09687674
DM
1435
1436 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid);
1437 $sid = $storage if defined($storage);
1438 my $scfg = PVE::Storage::storage_config($storecfg, $sid);
24f9d440
WB
1439 if (!$scfg->{shared}) {
1440 $sharedvm = 0;
1441 warn "found non-shared volume: $volid\n" if $target;
1442 }
09687674
DM
1443
1444 $rpcenv->check($authuser, "/storage/$sid", ['Datastore.AllocateSpace']);
1445
e7d553c7 1446 if ($full) {
db01d674
WB
1447 die "Cannot do full clones on a running container without snapshots\n"
1448 if $running && !defined($snapname);
1449 $fullclone->{$opt} = 1;
1450 } else {
1451 # not full means clone instead of copy
1452 die "Linked clone feature for '$volid' is not available\n"
4a954457 1453 if !PVE::Storage::volume_has_feature($storecfg, 'clone', $volid, $snapname, $running, {'valid_target_formats' => ['raw', 'subvol']});
db01d674 1454 }
c4a33727 1455
db01d674
WB
1456 $mountpoints->{$opt} = $mp;
1457 push @$vollist, $volid;
c4a33727 1458
c4a33727 1459 } else {
db01d674
WB
1460 # TODO: allow bind mounts?
1461 die "unable to clone mountpint '$opt' (type $mp->{type})\n";
c4a33727 1462 }
63231f52
TL
1463 } elsif ($opt =~ m/^net(\d+)$/) {
1464 # always change MAC! address
1465 my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
1466 my $net = PVE::LXC::Config->parse_lxc_network($value);
1467 $net->{hwaddr} = PVE::Tools::random_ether_addr($dc->{mac_prefix});
1468 $newconf->{$opt} = PVE::LXC::Config->print_lxc_network($net);
c4a33727 1469 } else {
db01d674
WB
1470 # copy everything else
1471 $newconf->{$opt} = $value;
c4a33727 1472 }
db01d674 1473 }
24f9d440
WB
1474 die "can't clone CT to node '$target' (CT uses local storage)\n"
1475 if $target && !$sharedvm;
c4a33727 1476
db01d674
WB
1477 # Replace the 'disk' lock with a 'create' lock.
1478 $newconf->{lock} = 'create';
1479
679cd2ff 1480 delete $newconf->{snapshots};
037dc1e2 1481 delete $newconf->{pending};
db01d674
WB
1482 delete $newconf->{template};
1483 if ($param->{hostname}) {
1484 $newconf->{hostname} = $param->{hostname};
c4a33727 1485 }
c4a33727 1486
db01d674
WB
1487 if ($param->{description}) {
1488 $newconf->{description} = $param->{description};
1489 }
c4a33727 1490
db01d674
WB
1491 # create empty/temp config - this fails if CT already exists on other node
1492 PVE::LXC::Config->write_config($newid, $newconf);
1493 };
1494 if (my $err = $@) {
1495 eval { PVE::LXC::Config->remove_lock($vmid, 'disk') };
1496 warn $@ if $@;
1497 die $err;
c4a33727 1498 }
db01d674 1499 });
c4a33727 1500
db01d674
WB
1501 my $update_conf = sub {
1502 my ($key, $value) = @_;
1503 return PVE::LXC::Config->lock_config($newid, sub {
1504 my $conf = PVE::LXC::Config->load_config($newid);
1505 die "Lost 'create' config lock, aborting.\n"
1506 if !PVE::LXC::Config->has_lock($conf, 'create');
1507 $conf->{$key} = $value;
1508 PVE::LXC::Config->write_config($newid, $conf);
1509 });
1510 };
c4a33727 1511
db01d674
WB
1512 my $realcmd = sub {
1513 my ($upid) = @_;
c4a33727 1514
db01d674 1515 my $newvollist = [];
c4a33727 1516
411ae12c
DM
1517 my $verify_running = PVE::LXC::check_running($vmid) || 0;
1518 die "unexpected state change\n" if $verify_running != $running;
1519
db01d674
WB
1520 eval {
1521 local $SIG{INT} =
1522 local $SIG{TERM} =
1523 local $SIG{QUIT} =
1524 local $SIG{HUP} = sub { die "interrupted by signal\n"; };
c4a33727 1525
db01d674 1526 PVE::Storage::activate_volumes($storecfg, $vollist, $snapname);
8ead60ef 1527 my $bwlimit = extract_param($param, 'bwlimit');
c4a33727 1528
db01d674
WB
1529 foreach my $opt (keys %$mountpoints) {
1530 my $mp = $mountpoints->{$opt};
1531 my $volid = $mp->{volume};
c4a33727 1532
db01d674
WB
1533 my $newvolid;
1534 if ($fullclone->{$opt}) {
1535 print "create full clone of mountpoint $opt ($volid)\n";
8ead60ef
SI
1536 my $source_storage = PVE::Storage::parse_volume_id($volid);
1537 my $target_storage = $storage // $source_storage;
1538 my $clonelimit = PVE::Storage::get_bandwidth_limit('clone', [$source_storage, $target_storage], $bwlimit);
1539 $newvolid = PVE::LXC::copy_volume($mp, $newid, $target_storage, $storecfg, $newconf, $snapname, $clonelimit);
db01d674
WB
1540 } else {
1541 print "create linked clone of mount point $opt ($volid)\n";
1542 $newvolid = PVE::Storage::vdisk_clone($storecfg, $volid, $newid, $snapname);
c4a33727
DM
1543 }
1544
db01d674
WB
1545 push @$newvollist, $newvolid;
1546 $mp->{volume} = $newvolid;
c4a33727 1547
db01d674 1548 $update_conf->($opt, PVE::LXC::Config->print_ct_mountpoint($mp, $opt eq 'rootfs'));
c4a33727
DM
1549 }
1550
db01d674
WB
1551 PVE::AccessControl::add_vm_to_pool($newid, $pool) if $pool;
1552 PVE::LXC::Config->remove_lock($newid, 'create');
411ae12c
DM
1553
1554 if ($target) {
1555 # always deactivate volumes - avoid lvm LVs to be active on several nodes
1556 PVE::Storage::deactivate_volumes($storecfg, $vollist, $snapname) if !$running;
1557 PVE::Storage::deactivate_volumes($storecfg, $newvollist);
1558
1559 my $newconffile = PVE::LXC::Config->config_file($newid, $target);
1560 die "Failed to move config to node '$target' - rename failed: $!\n"
1561 if !rename($conffile, $newconffile);
1562 }
c4a33727 1563 };
db01d674 1564 my $err = $@;
c4a33727 1565
db01d674
WB
1566 # Unlock the source config in any case:
1567 eval { PVE::LXC::Config->remove_lock($vmid, 'disk') };
1568 warn $@ if $@;
c4a33727 1569
db01d674
WB
1570 if ($err) {
1571 # Now cleanup the config & disks:
1572 unlink $conffile;
c4a33727 1573
db01d674
WB
1574 sleep 1; # some storages like rbd need to wait before release volume - really?
1575
1576 foreach my $volid (@$newvollist) {
1577 eval { PVE::Storage::vdisk_free($storecfg, $volid); };
1578 warn $@ if $@;
1579 }
1580 die "clone failed: $err";
1581 }
1582
1583 return;
c4a33727
DM
1584 };
1585
db01d674
WB
1586 PVE::Firewall::clone_vmfw_conf($vmid, $newid);
1587 return $rpcenv->fork_worker('vzclone', $vmid, $authuser, $realcmd);
c4a33727
DM
1588 }});
1589
1590
985b18ed
WL
1591__PACKAGE__->register_method({
1592 name => 'resize_vm',
1593 path => '{vmid}/resize',
1594 method => 'PUT',
1595 protected => 1,
1596 proxyto => 'node',
235dbdf3 1597 description => "Resize a container mount point.",
985b18ed
WL
1598 permissions => {
1599 check => ['perm', '/vms/{vmid}', ['VM.Config.Disk'], any => 1],
1600 },
1601 parameters => {
1602 additionalProperties => 0,
b8c5a95f
WB
1603 properties => {
1604 node => get_standard_option('pve-node'),
1605 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
1606 disk => {
1607 type => 'string',
1608 description => "The disk you want to resize.",
5e5d76cf 1609 enum => [PVE::LXC::Config->valid_volume_keys()],
b8c5a95f
WB
1610 },
1611 size => {
1612 type => 'string',
1613 pattern => '\+?\d+(\.\d+)?[KMGT]?',
1614 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.",
1615 },
1616 digest => {
1617 type => 'string',
1618 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1619 maxLength => 40,
1620 optional => 1,
1621 }
1622 },
985b18ed 1623 },
9f3f7963
WL
1624 returns => {
1625 type => 'string',
1626 description => "the task ID.",
1627 },
985b18ed
WL
1628 code => sub {
1629 my ($param) = @_;
1630
1631 my $rpcenv = PVE::RPCEnvironment::get();
1632
1633 my $authuser = $rpcenv->get_user();
1634
1635 my $node = extract_param($param, 'node');
1636
1637 my $vmid = extract_param($param, 'vmid');
1638
1639 my $digest = extract_param($param, 'digest');
1640
1641 my $sizestr = extract_param($param, 'size');
1642 my $ext = ($sizestr =~ s/^\+//);
1643 my $newsize = PVE::JSONSchema::parse_size($sizestr);
1644 die "invalid size string" if !defined($newsize);
1645
1646 die "no options specified\n" if !scalar(keys %$param);
1647
f1ba1a4b 1648 PVE::LXC::check_ct_modify_config_perm($rpcenv, $authuser, $vmid, undef, $param, []);
985b18ed
WL
1649
1650 my $storage_cfg = cfs_read_file("storage.cfg");
1651
985b18ed
WL
1652 my $code = sub {
1653
67afe46e
FG
1654 my $conf = PVE::LXC::Config->load_config($vmid);
1655 PVE::LXC::Config->check_lock($conf);
985b18ed
WL
1656
1657 PVE::Tools::assert_if_modified($digest, $conf->{digest});
1658
1659 my $running = PVE::LXC::check_running($vmid);
1660
1661 my $disk = $param->{disk};
e4034859 1662 my $mp = PVE::LXC::Config->parse_volume($disk, $conf->{$disk});
44a9face 1663
985b18ed
WL
1664 my $volid = $mp->{volume};
1665
1666 my (undef, undef, $owner, undef, undef, undef, $format) =
1667 PVE::Storage::parse_volname($storage_cfg, $volid);
1668
235dbdf3 1669 die "can't resize mount point owned by another container ($owner)"
985b18ed
WL
1670 if $vmid != $owner;
1671
1672 die "can't resize volume: $disk if snapshot exists\n"
1673 if %{$conf->{snapshots}} && $format eq 'qcow2';
1674
1675 my ($storeid, $volname) = PVE::Storage::parse_volume_id($volid);
1676
1677 $rpcenv->check($authuser, "/storage/$storeid", ['Datastore.AllocateSpace']);
1678
4e1e1791
WB
1679 PVE::Storage::activate_volumes($storage_cfg, [$volid]);
1680
985b18ed 1681 my $size = PVE::Storage::volume_size_info($storage_cfg, $volid, 5);
2e8bcfef 1682
16f6c7c6 1683 die "Could not determine current size of volume '$volid'\n" if !defined($size);
2e8bcfef 1684
985b18ed
WL
1685 $newsize += $size if $ext;
1686 $newsize = int($newsize);
1687
1688 die "unable to shrink disk size\n" if $newsize < $size;
1689
5c36822a 1690 die "disk is already at specified size\n" if $size == $newsize;
985b18ed
WL
1691
1692 PVE::Cluster::log_msg('info', $authuser, "update CT $vmid: resize --disk $disk --size $sizestr");
9f3f7963 1693 my $realcmd = sub {
e72c8b0e
DM
1694 # Note: PVE::Storage::volume_resize doesn't do anything if $running=1, so
1695 # we pass 0 here (parameter only makes sense for qemu)
9f3f7963
WL
1696 PVE::Storage::volume_resize($storage_cfg, $volid, $newsize, 0);
1697
1698 $mp->{size} = $newsize;
1b4cf758 1699 $conf->{$disk} = PVE::LXC::Config->print_ct_mountpoint($mp, $disk eq 'rootfs');
9f3f7963 1700
67afe46e 1701 PVE::LXC::Config->write_config($vmid, $conf);
9f3f7963
WL
1702
1703 if ($format eq 'raw') {
46e62d2d
TL
1704 # we need to ensure that the volume is mapped, if not needed this is a NOP
1705 my $path = PVE::Storage::map_volume($storage_cfg, $volid);
1706 $path = PVE::Storage::path($storage_cfg, $volid) if !defined($path);
9f3f7963 1707 if ($running) {
2a993004
WL
1708
1709 $mp->{mp} = '/';
1710 my $use_loopdev = (PVE::LXC::mountpoint_mount_path($mp, $storage_cfg))[1];
21f292ff 1711 $path = PVE::LXC::query_loopdev($path) if $use_loopdev;
235dbdf3 1712 die "internal error: CT running but mount point not attached to a loop device"
2a993004
WL
1713 if !$path;
1714 PVE::Tools::run_command(['losetup', '--set-capacity', $path]) if $use_loopdev;
9f3f7963
WL
1715
1716 # In order for resize2fs to know that we need online-resizing a mountpoint needs
1717 # to be visible to it in its namespace.
1718 # To not interfere with the rest of the system we unshare the current mount namespace,
1719 # mount over /tmp and then run resize2fs.
1720
1721 # interestingly we don't need to e2fsck on mounted systems...
1722 my $quoted = PVE::Tools::shellquote($path);
1723 my $cmd = "mount --make-rprivate / && mount $quoted /tmp && resize2fs $quoted";
ce9e6458
WB
1724 eval {
1725 PVE::Tools::run_command(['unshare', '-m', '--', 'sh', '-c', $cmd]);
1726 };
1727 warn "Failed to update the container's filesystem: $@\n" if $@;
9f3f7963 1728 } else {
ce9e6458
WB
1729 eval {
1730 PVE::Tools::run_command(['e2fsck', '-f', '-y', $path]);
1731 PVE::Tools::run_command(['resize2fs', $path]);
1732 };
1733 warn "Failed to update the container's filesystem: $@\n" if $@;
80440faa 1734
46ea6368
TL
1735 # always un-map if not running, this is a NOP if not needed
1736 PVE::Storage::unmap_volume($storage_cfg, $volid);
9f3f7963 1737 }
985b18ed 1738 }
9f3f7963 1739 };
985b18ed 1740
9f3f7963
WL
1741 return $rpcenv->fork_worker('resize', $vmid, $authuser, $realcmd);
1742 };
985b18ed 1743
67afe46e 1744 return PVE::LXC::Config->lock_config($vmid, $code);;
985b18ed
WL
1745 }});
1746
3c0f6806
WB
1747__PACKAGE__->register_method({
1748 name => 'move_volume',
1749 path => '{vmid}/move_volume',
1750 method => 'POST',
1751 protected => 1,
1752 proxyto => 'node',
1753 description => "Move a rootfs-/mp-volume to a different storage",
1754 permissions => {
1755 description => "You need 'VM.Config.Disk' permissions on /vms/{vmid}, " .
1756 "and 'Datastore.AllocateSpace' permissions on the storage.",
1757 check =>
1758 [ 'and',
1759 ['perm', '/vms/{vmid}', [ 'VM.Config.Disk' ]],
1760 ['perm', '/storage/{storage}', [ 'Datastore.AllocateSpace' ]],
1761 ],
1762 },
1763 parameters => {
1764 additionalProperties => 0,
1765 properties => {
1766 node => get_standard_option('pve-node'),
1767 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
1768 volume => {
1769 type => 'string',
5e5d76cf 1770 enum => [ PVE::LXC::Config->valid_volume_keys() ],
3c0f6806
WB
1771 description => "Volume which will be moved.",
1772 },
1773 storage => get_standard_option('pve-storage-id', {
1774 description => "Target Storage.",
1775 completion => \&PVE::Storage::complete_storage_enabled,
1776 }),
1777 delete => {
1778 type => 'boolean',
1779 description => "Delete the original volume after successful copy. By default the original is kept as an unused volume entry.",
1780 optional => 1,
1781 default => 0,
1782 },
1783 digest => {
1784 type => 'string',
1785 description => 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.',
1786 maxLength => 40,
1787 optional => 1,
8ead60ef
SI
1788 },
1789 bwlimit => {
1790 description => "Override I/O bandwidth limit (in KiB/s).",
1791 optional => 1,
1792 type => 'number',
1793 minimum => '0',
41e9b65c 1794 default => 'clone limit from datacenter or storage config',
8ead60ef 1795 },
3c0f6806
WB
1796 },
1797 },
1798 returns => {
1799 type => 'string',
1800 },
1801 code => sub {
1802 my ($param) = @_;
1803
1804 my $rpcenv = PVE::RPCEnvironment::get();
1805
1806 my $authuser = $rpcenv->get_user();
1807
1808 my $vmid = extract_param($param, 'vmid');
1809
1810 my $storage = extract_param($param, 'storage');
1811
1812 my $mpkey = extract_param($param, 'volume');
1813
1814 my $lockname = 'disk';
1815
1816 my ($mpdata, $old_volid);
1817
1818 PVE::LXC::Config->lock_config($vmid, sub {
1819 my $conf = PVE::LXC::Config->load_config($vmid);
1820 PVE::LXC::Config->check_lock($conf);
1821
1822 die "cannot move volumes of a running container\n" if PVE::LXC::check_running($vmid);
1823
c14508b1 1824 $mpdata = PVE::LXC::Config->parse_volume($mpkey, $conf->{$mpkey});
3c0f6806
WB
1825 $old_volid = $mpdata->{volume};
1826
1827 die "you can't move a volume with snapshots and delete the source\n"
1828 if $param->{delete} && PVE::LXC::Config->is_volume_in_use_by_snapshots($conf, $old_volid);
1829
1830 PVE::Tools::assert_if_modified($param->{digest}, $conf->{digest});
1831
1832 PVE::LXC::Config->set_lock($vmid, $lockname);
1833 });
1834
1835 my $realcmd = sub {
1836 eval {
1837 PVE::Cluster::log_msg('info', $authuser, "move volume CT $vmid: move --volume $mpkey --storage $storage");
1838
1839 my $conf = PVE::LXC::Config->load_config($vmid);
1840 my $storage_cfg = PVE::Storage::config();
1841
1842 my $new_volid;
1843
1844 eval {
1845 PVE::Storage::activate_volumes($storage_cfg, [ $old_volid ]);
8ead60ef
SI
1846 my $bwlimit = extract_param($param, 'bwlimit');
1847 my $source_storage = PVE::Storage::parse_volume_id($old_volid);
1848 my $movelimit = PVE::Storage::get_bandwidth_limit('move', [$source_storage, $storage], $bwlimit);
1849 $new_volid = PVE::LXC::copy_volume($mpdata, $vmid, $storage, $storage_cfg, $conf, undef, $movelimit);
3bfbd900
FE
1850 if (PVE::LXC::Config->is_template($conf)) {
1851 PVE::Storage::activate_volumes($storage_cfg, [ $new_volid ]);
1852 my $template_volid = PVE::Storage::vdisk_create_base($storage_cfg, $new_volid);
1853 $mpdata->{volume} = $template_volid;
1854 } else {
1855 $mpdata->{volume} = $new_volid;
1856 }
3c0f6806
WB
1857
1858 PVE::LXC::Config->lock_config($vmid, sub {
1859 my $digest = $conf->{digest};
1860 $conf = PVE::LXC::Config->load_config($vmid);
1861 PVE::Tools::assert_if_modified($digest, $conf->{digest});
1862
1863 $conf->{$mpkey} = PVE::LXC::Config->print_ct_mountpoint($mpdata, $mpkey eq 'rootfs');
1864
1865 PVE::LXC::Config->add_unused_volume($conf, $old_volid) if !$param->{delete};
1866
1867 PVE::LXC::Config->write_config($vmid, $conf);
1868 });
1869
1870 eval {
1871 # try to deactivate volumes - avoid lvm LVs to be active on several nodes
1872 PVE::Storage::deactivate_volumes($storage_cfg, [ $new_volid ])
1873 };
1874 warn $@ if $@;
1875 };
1876 if (my $err = $@) {
1877 eval {
1878 PVE::Storage::vdisk_free($storage_cfg, $new_volid)
1879 if defined($new_volid);
1880 };
1881 warn $@ if $@;
1882 die $err;
1883 }
1884
1885 if ($param->{delete}) {
1886 eval {
1887 PVE::Storage::deactivate_volumes($storage_cfg, [ $old_volid ]);
1888 PVE::Storage::vdisk_free($storage_cfg, $old_volid);
1889 };
9abb0f8a
FE
1890 if (my $err = $@) {
1891 warn $err;
1892 PVE::LXC::Config->lock_config($vmid, sub {
1893 my $conf = PVE::LXC::Config->load_config($vmid);
1894 PVE::LXC::Config->add_unused_volume($conf, $old_volid);
1895 PVE::LXC::Config->write_config($vmid, $conf);
1896 });
1897 }
3c0f6806
WB
1898 }
1899 };
1900 my $err = $@;
1901 eval { PVE::LXC::Config->remove_lock($vmid, $lockname) };
1902 warn $@ if $@;
1903 die $err if $err;
1904 };
1905 my $task = eval {
1906 $rpcenv->fork_worker('move_volume', $vmid, $authuser, $realcmd);
1907 };
1908 if (my $err = $@) {
1909 eval { PVE::LXC::Config->remove_lock($vmid, $lockname) };
1910 warn $@ if $@;
1911 die $err;
1912 }
1913 return $task;
1914 }});
1915
37c2dba8
OB
1916__PACKAGE__->register_method({
1917 name => 'vm_pending',
1918 path => '{vmid}/pending',
1919 method => 'GET',
1920 proxyto => 'node',
1921 description => 'Get container configuration, including pending changes.',
1922 permissions => {
1923 check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
1924 },
1925 parameters => {
1926 additionalProperties => 0,
1927 properties => {
1928 node => get_standard_option('pve-node'),
1929 vmid => get_standard_option('pve-vmid', { completion => \&PVE::LXC::complete_ctid }),
1930 },
1931 },
1932 returns => {
1933 type => "array",
1934 items => {
1935 type => "object",
1936 properties => {
1937 key => {
1938 description => 'Configuration option name.',
1939 type => 'string',
1940 },
1941 value => {
1942 description => 'Current value.',
1943 type => 'string',
1944 optional => 1,
1945 },
1946 pending => {
1947 description => 'Pending value.',
1948 type => 'string',
1949 optional => 1,
1950 },
1951 delete => {
1952 description => "Indicates a pending delete request if present and not 0.",
1953 type => 'integer',
1954 minimum => 0,
1955 maximum => 2,
1956 optional => 1,
1957 },
1958 },
1959 },
1960 },
1961 code => sub {
1962 my ($param) = @_;
1963
1964 my $conf = PVE::LXC::Config->load_config($param->{vmid});
1965
1966 my $pending_delete_hash = PVE::LXC::Config->parse_pending_delete($conf->{pending}->{delete});
1967
f622e7dc 1968 return PVE::GuestHelpers::config_with_pending_array($conf, $pending_delete_hash);
37c2dba8
OB
1969 }});
1970
f76a2828 19711;