]>
git.proxmox.com Git - qemu-server.git/blob - PVE/CLI/qm.pm
6 # Note: disable '+' prefix for Getopt::Long (for resize command)
7 use Getopt
::Long
qw(:config no_getopt_compat);
14 use PVE
::Tools
qw(extract_param);
18 use PVE
::RPCEnvironment
;
20 use PVE
::QemuServer
::ImportDisk
;
23 use PVE
::JSONSchema
qw(get_standard_option);
28 use base
qw(PVE::CLIHandler);
32 my $status = PVE
::Tools
::upid_read_status
($upid);
33 exit($status eq 'OK' ?
0 : -1);
36 my $nodename = PVE
::INotify
::nodename
();
38 sub setup_environment
{
39 PVE
::RPCEnvironment-
>setup_default_cli_env();
46 while ( ++$c < 10 && !-e
$path ) { sleep(1); }
48 my $s = IO
::Socket
::UNIX-
>new(Peer
=> $path, Timeout
=> 120);
50 die "unable to connect to socket '$path' - $!" if !$s;
52 my $select = new IO
::Select
;
54 $select->add(\
*STDIN
);
57 my $timeout = 60*15; # 15 minutes
60 while ($select->count &&
61 scalar(@handles = $select->can_read ($timeout))) {
62 foreach my $h (@handles) {
64 my $n = $h->sysread($buf, 4096);
74 syswrite(\
*STDOUT
, $buf);
84 sub print_recursive_hash
{
85 my ($prefix, $hash, $key) = @_;
87 if (ref($hash) eq 'HASH') {
89 print "$prefix$key:\n";
91 foreach my $itemkey (keys %$hash) {
92 print_recursive_hash
("\t$prefix", $hash->{$itemkey}, $itemkey);
94 } elsif (ref($hash) eq 'ARRAY') {
96 print "$prefix$key:\n";
98 foreach my $item (@$hash) {
99 print_recursive_hash
("\t$prefix", $item);
101 } elsif (!ref($hash) && defined($hash)) {
103 print "$prefix$key: $hash\n";
105 print "$prefix$hash\n";
110 __PACKAGE__-
>register_method ({
114 description
=> "Show command line which is used to start the VM (debug info).",
116 additionalProperties
=> 0,
118 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
121 returns
=> { type
=> 'null'},
125 my $storecfg = PVE
::Storage
::config
();
126 print PVE
::QemuServer
::vm_commandline
($storecfg, $param->{vmid
}) . "\n";
131 __PACKAGE__-
>register_method ({
135 description
=> "Show VM status.",
137 additionalProperties
=> 0,
139 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
141 description
=> "Verbose output format",
147 returns
=> { type
=> 'null'},
152 my $conf = PVE
::QemuConfig-
>load_config ($param->{vmid
});
154 my $vmstatus = PVE
::QemuServer
::vmstatus
($param->{vmid
}, 1);
155 my $stat = $vmstatus->{$param->{vmid
}};
156 if ($param->{verbose
}) {
157 foreach my $k (sort (keys %$stat)) {
158 next if $k eq 'cpu' || $k eq 'relcpu'; # always 0
160 print_recursive_hash
("", $v, $k);
163 my $status = $stat->{qmpstatus
} || 'unknown';
164 print "status: $status\n";
170 __PACKAGE__-
>register_method ({
174 description
=> "Proxy VM VNC traffic to stdin/stdout",
176 additionalProperties
=> 0,
178 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
181 returns
=> { type
=> 'null'},
185 my $vmid = $param->{vmid
};
186 my $vnc_socket = PVE
::QemuServer
::vnc_socket
($vmid);
188 if (my $ticket = $ENV{LC_PVE_TICKET
}) { # NOTE: ssh on debian only pass LC_* variables
189 PVE
::QemuServer
::vm_mon_cmd
($vmid, "change", device
=> 'vnc', target
=> "unix:$vnc_socket,password");
190 PVE
::QemuServer
::vm_mon_cmd
($vmid, "set_password", protocol
=> 'vnc', password
=> $ticket);
191 PVE
::QemuServer
::vm_mon_cmd
($vmid, "expire_password", protocol
=> 'vnc', time => "+30");
193 PVE
::QemuServer
::vm_mon_cmd
($vmid, "change", device
=> 'vnc', target
=> "unix:$vnc_socket,x509,password");
196 run_vnc_proxy
($vnc_socket);
201 __PACKAGE__-
>register_method ({
205 description
=> "Unlock the VM.",
207 additionalProperties
=> 0,
209 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
212 returns
=> { type
=> 'null'},
216 my $vmid = $param->{vmid
};
218 PVE
::QemuConfig-
>lock_config ($vmid, sub {
219 my $conf = PVE
::QemuConfig-
>load_config($vmid);
220 delete $conf->{lock};
221 delete $conf->{pending
}->{lock} if $conf->{pending
}; # just to be sure
222 PVE
::QemuConfig-
>write_config($vmid, $conf);
228 __PACKAGE__-
>register_method ({
232 description
=> "Stop embedded nbd server.",
234 additionalProperties
=> 0,
236 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
239 returns
=> { type
=> 'null'},
243 my $vmid = $param->{vmid
};
245 PVE
::QemuServer
::nbd_stop
($vmid);
250 __PACKAGE__-
>register_method ({
254 description
=> "Used by qmigrate - do not use manually.",
256 additionalProperties
=> 0,
259 returns
=> { type
=> 'null'},
263 if (!PVE
::Cluster
::check_cfs_quorum
(1)) {
268 print "tunnel online\n";
274 while (my $line = <>) {
276 last if $line =~ m/^quit$/;
282 __PACKAGE__-
>register_method ({
286 description
=> "Wait until the VM is stopped.",
288 additionalProperties
=> 0,
290 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
292 description
=> "Timeout in seconds. Default is to wait forever.",
299 returns
=> { type
=> 'null'},
303 my $vmid = $param->{vmid
};
304 my $timeout = $param->{timeout
};
306 my $pid = PVE
::QemuServer
::check_running
($vmid);
309 print "waiting until VM $vmid stopps (PID $pid)\n";
312 while ((!$timeout || ($count < $timeout)) && PVE
::QemuServer
::check_running
($vmid)) {
317 die "wait failed - got timeout\n" if PVE
::QemuServer
::check_running
($vmid);
322 __PACKAGE__-
>register_method ({
326 description
=> "Enter Qemu Monitor interface.",
328 additionalProperties
=> 0,
330 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
333 returns
=> { type
=> 'null'},
337 my $vmid = $param->{vmid
};
339 my $conf = PVE
::QemuConfig-
>load_config ($vmid); # check if VM exists
341 print "Entering Qemu Monitor for VM $vmid - type 'help' for help\n";
343 my $term = new Term
::ReadLine
('qm');
346 while (defined ($input = $term->readline('qm> '))) {
349 next if $input =~ m/^\s*$/;
351 last if $input =~ m/^\s*q(uit)?\s*$/;
354 print PVE
::QemuServer
::vm_human_monitor_command
($vmid, $input);
356 print "ERROR: $@" if $@;
363 __PACKAGE__-
>register_method ({
367 description
=> "Rescan all storages and update disk sizes and unused disk images.",
369 additionalProperties
=> 0,
371 vmid
=> get_standard_option
('pve-vmid', {
373 completion
=> \
&PVE
::QemuServer
::complete_vmid
,
377 returns
=> { type
=> 'null'},
381 PVE
::QemuServer
::rescan
($param->{vmid
});
386 __PACKAGE__-
>register_method ({
387 name
=> 'importdisk',
388 path
=> 'importdisk',
390 description
=> "Import an external disk image as an unused disk in a VM. The
391 image format has to be supported by qemu-img(1).",
393 additionalProperties
=> 0,
395 vmid
=> get_standard_option
('pve-vmid', {completion
=> \
&PVE
::QemuServer
::complete_vmid
}),
397 description
=> 'Path to the disk image to import',
401 storage
=> get_standard_option
('pve-storage-id', {
402 description
=> 'Target storage ID',
403 completion
=> \
&PVE
::QemuServer
::complete_storage
,
408 description
=> 'Target format',
409 enum
=> [ 'raw', 'qcow2', 'vmdk' ],
414 returns
=> { type
=> 'null'},
418 my $vmid = extract_param
($param, 'vmid');
419 my $source = extract_param
($param, 'source');
420 my $storeid = extract_param
($param, 'storage');
421 my $format = extract_param
($param, 'format');
423 my $vm_conf = PVE
::QemuConfig-
>load_config($vmid);
424 PVE
::QemuConfig-
>check_lock($vm_conf);
425 die "$source: non-existent or non-regular file\n" if (! -f
$source);
427 my $storecfg = PVE
::Storage
::config
();
428 PVE
::Storage
::storage_check_enabled
($storecfg, $storeid);
430 my $target_storage_config =
431 PVE
::Storage
::storage_config
($storecfg, $storeid);
432 die "storage $storeid does not support vm images\n"
433 if !$target_storage_config->{content
}->{images
};
435 PVE
::QemuServer
::ImportDisk
::do_import
($source, $vmid, $storeid, { format
=> $format });
440 __PACKAGE__-
>register_method ({
444 description
=> "Open a terminal using a serial device (The VM need to have a serial device configured, for example 'serial0: socket')",
446 additionalProperties
=> 0,
448 vmid
=> get_standard_option
('pve-vmid', { completion
=> \
&PVE
::QemuServer
::complete_vmid_running
}),
450 description
=> "Select the serial device. By default we simply use the first suitable device.",
453 enum
=> [qw(serial0 serial1 serial2 serial3)],
457 returns
=> { type
=> 'null'},
461 my $vmid = $param->{vmid
};
463 my $conf = PVE
::QemuConfig-
>load_config ($vmid); # check if VM exists
465 my $iface = $param->{iface
};
468 die "serial interface '$iface' is not configured\n" if !$conf->{$iface};
469 die "wrong serial type on interface '$iface'\n" if $conf->{$iface} ne 'socket';
471 foreach my $opt (qw(serial0 serial1 serial2 serial3)) {
472 if ($conf->{$opt} && ($conf->{$opt} eq 'socket')) {
477 die "unable to find a serial interface\n" if !$iface;
480 die "VM $vmid not running\n" if !PVE
::QemuServer
::check_running
($vmid);
482 my $socket = "/var/run/qemu-server/${vmid}.$iface";
484 my $cmd = "socat UNIX-CONNECT:$socket STDIO,raw,echo=0,escape=0x0f";
486 print "starting serial terminal on interface $iface (press control-O to exit)\n";
494 my $print_agent_result = sub {
497 my $result = $data->{result
};
498 return if !defined($result);
500 my $class = ref($result);
504 return if $result =~ m/^\s*$/;
509 if (($class eq 'HASH') && !scalar(keys %$result)) { # empty hash
513 print to_json
($result, { pretty
=> 1, canonical
=> 1});
517 list
=> [ "PVE::API2::Qemu", 'vmlist', [],
518 { node
=> $nodename }, sub {
521 exit 0 if (!scalar(@$vmlist));
523 printf "%10s %-20s %-10s %-10s %12s %-10s\n",
524 qw(VMID NAME STATUS MEM(MB) BOOTDISK
(GB
) PID
);
526 foreach my $rec (sort { $a->{vmid
} <=> $b->{vmid
} } @$vmlist) {
527 printf "%10s %-20s %-10s %-10s %12.2f %-10s\n", $rec->{vmid
}, $rec->{name
},
528 $rec->{qmpstatus
} || $rec->{status
},
529 ($rec->{maxmem
} || 0)/(1024*1024),
530 ($rec->{maxdisk
} || 0)/(1024*1024*1024),
537 create
=> [ "PVE::API2::Qemu", 'create_vm', ['vmid'], { node
=> $nodename }, $upid_exit ],
539 destroy
=> [ "PVE::API2::Qemu", 'destroy_vm', ['vmid'], { node
=> $nodename }, $upid_exit ],
541 clone
=> [ "PVE::API2::Qemu", 'clone_vm', ['vmid', 'newid'], { node
=> $nodename }, $upid_exit ],
543 migrate
=> [ "PVE::API2::Qemu", 'migrate_vm', ['vmid', 'target'], { node
=> $nodename }, $upid_exit ],
545 set
=> [ "PVE::API2::Qemu", 'update_vm', ['vmid'], { node
=> $nodename } ],
547 resize
=> [ "PVE::API2::Qemu", 'resize_vm', ['vmid', 'disk', 'size'], { node
=> $nodename } ],
549 move_disk
=> [ "PVE::API2::Qemu", 'move_vm_disk', ['vmid', 'disk', 'storage'], { node
=> $nodename }, $upid_exit ],
551 unlink => [ "PVE::API2::Qemu", 'unlink', ['vmid'], { node
=> $nodename } ],
553 config
=> [ "PVE::API2::Qemu", 'vm_config', ['vmid'],
554 { node
=> $nodename }, sub {
556 foreach my $k (sort (keys %$config)) {
557 next if $k eq 'digest';
558 my $v = $config->{$k};
559 if ($k eq 'description') {
560 $v = PVE
::Tools
::encode_text
($v);
566 pending
=> [ "PVE::API2::Qemu", 'vm_pending', ['vmid'],
567 { node
=> $nodename }, sub {
569 foreach my $item (sort { $a->{key
} cmp $b->{key
}} @$data) {
570 my $k = $item->{key
};
571 next if $k eq 'digest';
572 my $v = $item->{value
};
573 my $p = $item->{pending
};
574 if ($k eq 'description') {
575 $v = PVE
::Tools
::encode_text
($v) if defined($v);
576 $p = PVE
::Tools
::encode_text
($p) if defined($p);
579 if ($item->{delete}) {
580 print "del $k: $v\n";
581 } elsif (defined($p)) {
582 print "cur $k: $v\n";
583 print "new $k: $p\n";
585 print "cur $k: $v\n";
587 } elsif (defined($p)) {
588 print "new $k: $p\n";
593 showcmd
=> [ __PACKAGE__
, 'showcmd', ['vmid']],
595 status
=> [ __PACKAGE__
, 'status', ['vmid']],
597 snapshot
=> [ "PVE::API2::Qemu", 'snapshot', ['vmid', 'snapname'], { node
=> $nodename } , $upid_exit ],
599 delsnapshot
=> [ "PVE::API2::Qemu", 'delsnapshot', ['vmid', 'snapname'], { node
=> $nodename } , $upid_exit ],
601 listsnapshot
=> [ "PVE::API2::Qemu", 'snapshot_list', ['vmid'], { node
=> $nodename },
604 foreach my $e (@$res) {
605 my $headline = $e->{description
} || 'no-description';
606 $headline =~ s/\n.*//sg;
607 my $parent = $e->{parent
} // 'no-parent';
608 printf("%-20s %-20s %s\n", $e->{name
}, $parent, $headline);
612 rollback
=> [ "PVE::API2::Qemu", 'rollback', ['vmid', 'snapname'], { node
=> $nodename } , $upid_exit ],
614 template
=> [ "PVE::API2::Qemu", 'template', ['vmid'], { node
=> $nodename }],
616 start
=> [ "PVE::API2::Qemu", 'vm_start', ['vmid'], { node
=> $nodename } , $upid_exit ],
618 stop
=> [ "PVE::API2::Qemu", 'vm_stop', ['vmid'], { node
=> $nodename }, $upid_exit ],
620 reset => [ "PVE::API2::Qemu", 'vm_reset', ['vmid'], { node
=> $nodename }, $upid_exit ],
622 shutdown => [ "PVE::API2::Qemu", 'vm_shutdown', ['vmid'], { node
=> $nodename }, $upid_exit ],
624 suspend
=> [ "PVE::API2::Qemu", 'vm_suspend', ['vmid'], { node
=> $nodename }, $upid_exit ],
626 resume
=> [ "PVE::API2::Qemu", 'vm_resume', ['vmid'], { node
=> $nodename }, $upid_exit ],
628 sendkey
=> [ "PVE::API2::Qemu", 'vm_sendkey', ['vmid', 'key'], { node
=> $nodename } ],
630 vncproxy
=> [ __PACKAGE__
, 'vncproxy', ['vmid']],
632 wait => [ __PACKAGE__
, 'wait', ['vmid']],
634 unlock
=> [ __PACKAGE__
, 'unlock', ['vmid']],
636 rescan
=> [ __PACKAGE__
, 'rescan', []],
638 monitor
=> [ __PACKAGE__
, 'monitor', ['vmid']],
640 agent
=> [ "PVE::API2::Qemu", 'agent', ['vmid', 'command'],
641 { node
=> $nodename }, $print_agent_result ],
643 mtunnel
=> [ __PACKAGE__
, 'mtunnel', []],
645 nbdstop
=> [ __PACKAGE__
, 'nbdstop', ['vmid']],
647 terminal
=> [ __PACKAGE__
, 'terminal', ['vmid']],
649 importdisk
=> [ __PACKAGE__
, 'importdisk', ['vmid', 'source', 'storage']],