]> git.proxmox.com Git - qemu-server.git/blobdiff - PVE/CLI/qm.pm
fix #3754: encode JSON as utf8 for CLI
[qemu-server.git] / PVE / CLI / qm.pm
index 59a38611ef80d8d5e4433447a20e0099ef55af1e..6a2e1618c1514c0ce52df26fa1a9f88fbead36b6 100755 (executable)
@@ -27,8 +27,12 @@ use PVE::Tools qw(extract_param);
 
 use PVE::API2::Qemu::Agent;
 use PVE::API2::Qemu;
+use PVE::QemuConfig;
+use PVE::QemuServer::Drive;
+use PVE::QemuServer::Helpers;
 use PVE::QemuServer::Agent qw(agent_available);
 use PVE::QemuServer::ImportDisk;
+use PVE::QemuServer::Monitor qw(mon_cmd);
 use PVE::QemuServer::OVF;
 use PVE::QemuServer;
 
@@ -38,7 +42,7 @@ use base qw(PVE::CLIHandler);
 my $upid_exit = sub {
     my $upid = shift;
     my $status = PVE::Tools::upid_read_status($upid);
-    exit($status eq 'OK' ? 0 : -1);
+    exit(PVE::Tools::upid_status_is_error($status) ? -1 : 0);
 };
 
 my $nodename = PVE::INotify::nodename();
@@ -57,7 +61,7 @@ sub run_vnc_proxy {
 
     die "unable to connect to socket '$path' - $!" if !$s;
 
-    my $select = new IO::Select;
+    my $select = IO::Select->new();
 
     $select->add(\*STDIN);
     $select->add($s);
@@ -96,17 +100,17 @@ sub print_recursive_hash {
        if (defined($key)) {
            print "$prefix$key:\n";
        }
-       foreach my $itemkey (keys %$hash) {
+       for my $itemkey (sort keys %$hash) {
            print_recursive_hash("\t$prefix", $hash->{$itemkey}, $itemkey);
        }
     } elsif (ref($hash) eq 'ARRAY') {
        if (defined($key)) {
            print "$prefix$key:\n";
        }
-       foreach my $item (@$hash) {
+       for my $item (@$hash) {
            print_recursive_hash("\t$prefix", $item);
        }
-    } elsif (!ref($hash) && defined($hash)) {
+    } elsif ((!ref($hash) && defined($hash)) || ref($hash) eq 'JSON::PP::Boolean') {
        if (defined($key)) {
            print "$prefix$key: $hash\n";
        } else {
@@ -151,7 +155,7 @@ __PACKAGE__->register_method ({
 
        print "$cmdline\n";
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -190,7 +194,7 @@ __PACKAGE__->register_method ({
            print "status: $status\n";
        }
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -209,20 +213,19 @@ __PACKAGE__->register_method ({
        my ($param) = @_;
 
        my $vmid = $param->{vmid};
-       my $vnc_socket = PVE::QemuServer::vnc_socket($vmid);
+       PVE::QemuConfig::assert_config_exists_on_node($vmid);
+       my $vnc_socket = PVE::QemuServer::Helpers::vnc_socket($vmid);
 
        if (my $ticket = $ENV{LC_PVE_TICKET}) {  # NOTE: ssh on debian only pass LC_* variables
-           PVE::QemuServer::vm_mon_cmd($vmid, "change", device => 'vnc', target => "unix:$vnc_socket,password");
-           PVE::QemuServer::vm_mon_cmd($vmid, "set_password", protocol => 'vnc', password => $ticket);
-           PVE::QemuServer::vm_mon_cmd($vmid, "expire_password", protocol => 'vnc', time => "+30");
+           mon_cmd($vmid, "set_password", protocol => 'vnc', password => $ticket);
+           mon_cmd($vmid, "expire_password", protocol => 'vnc', time => "+30");
        } else {
-           # FIXME: remove or allow to add tls-creds object, as x509 vnc param is removed with qemu 4??
-           PVE::QemuServer::vm_mon_cmd($vmid, "change", device => 'vnc', target => "unix:$vnc_socket,password");
+           die "LC_PVE_TICKET not set, VNC proxy without password is forbidden\n";
        }
 
        run_vnc_proxy($vnc_socket);
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -249,7 +252,7 @@ __PACKAGE__->register_method ({
            PVE::QemuConfig->write_config($vmid, $conf);
        });
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -269,9 +272,10 @@ __PACKAGE__->register_method ({
 
        my $vmid = $param->{vmid};
 
-       PVE::QemuServer::nbd_stop($vmid);
+       eval { PVE::QemuServer::nbd_stop($vmid) };
+       warn $@ if $@;
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -289,7 +293,7 @@ __PACKAGE__->register_method ({
 
        if (!PVE::Cluster::check_cfs_quorum(1)) {
            print "no quorum\n";
-           return undef;
+           return;
        }
 
        my $tunnel_write = sub {
@@ -322,7 +326,7 @@ __PACKAGE__->register_method ({
            }
        }
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -362,7 +366,7 @@ __PACKAGE__->register_method ({
 
        die "wait failed - got timeout\n" if PVE::QemuServer::check_running ($vmid);
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -386,23 +390,18 @@ __PACKAGE__->register_method ({
 
        print "Entering Qemu Monitor for VM $vmid - type 'help' for help\n";
 
-       my $term = new Term::ReadLine ('qm');
+       my $term = Term::ReadLine->new('qm');
 
-       my $input;
-       while (defined ($input = $term->readline('qm> '))) {
+       while (defined(my $input = $term->readline('qm> '))) {
            chomp $input;
-
            next if $input =~ m/^\s*$/;
-
            last if $input =~ m/^\s*q(uit)?\s*$/;
 
-           eval {
-               print PVE::QemuServer::vm_human_monitor_command ($vmid, $input);
-           };
+           eval { print PVE::QemuServer::Monitor::hmp_cmd($vmid, $input) };
            print "ERROR: $@" if $@;
        }
 
-       return undef;
+       return;
 
     }});
 
@@ -436,7 +435,7 @@ __PACKAGE__->register_method ({
 
        PVE::QemuServer::rescan($param->{vmid}, 0, $dryrun);
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -491,7 +490,7 @@ __PACKAGE__->register_method ({
        my ($drive_id, $volid) = PVE::QemuServer::ImportDisk::do_import($source, $vmid, $storeid, { format => $format });
        print "Successfully imported disk as '$drive_id:$volid'\n";
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -568,7 +567,7 @@ __PACKAGE__->register_method ({
 
        system($cmd);
 
-       return undef;
+       return;
     }});
 
 __PACKAGE__->register_method ({
@@ -633,6 +632,7 @@ __PACKAGE__->register_method ({
        $conf->{memory} = $parsed->{qm}->{memory} if defined($parsed->{qm}->{memory});
        $conf->{cores} = $parsed->{qm}->{cores} if defined($parsed->{qm}->{cores});
 
+       my $imported_disks = [];
        eval {
            # order matters, as do_import() will load_config() internally
            $conf->{vmgenid} = PVE::QemuServer::generate_uuid();
@@ -641,32 +641,37 @@ __PACKAGE__->register_method ({
 
            foreach my $disk (@{ $parsed->{disks} }) {
                my ($file, $drive) = ($disk->{backing_file}, $disk->{disk_address});
-               PVE::QemuServer::ImportDisk::do_import($file, $vmid, $storeid, {
+               my ($name, $volid) = PVE::QemuServer::ImportDisk::do_import($file, $vmid, $storeid, {
                    drive_name => $drive,
                    format => $format,
                    skiplock => 1,
                });
+               # for cleanup on (later) error
+               push @$imported_disks, $volid;
            }
 
            # reload after disks entries have been created
            $conf = PVE::QemuConfig->load_config($vmid);
-           my $firstdisk = PVE::QemuServer::resolve_first_disk($conf);
-           $conf->{bootdisk} = $firstdisk if $firstdisk;
+           my $devs = PVE::QemuServer::get_default_bootdevices($conf);
+           $conf->{boot} = PVE::QemuServer::print_bootorder($devs);
            PVE::QemuConfig->write_config($vmid, $conf);
        };
 
-       my $err = $@;
-       if ($err) {
+       if (my $err = $@) {
            my $skiplock = 1;
-           # eval for additional safety in error path
-           eval { PVE::QemuServer::destroy_vm($storecfg, $vmid, undef, $skiplock) };
+           warn "error during import, cleaning up created resources...\n";
+           for my $volid (@$imported_disks) {
+               eval { PVE::Storage::vdisk_free($storecfg, $volid) };
+               warn "cleanup of $volid failed: $@\n" if $@;
+           }
+           eval { PVE::QemuServer::destroy_vm($storecfg, $vmid, $skiplock) };
            warn "Could not destroy VM $vmid: $@" if "$@";
            die "import failed - $err";
        }
 
        PVE::QemuConfig->remove_lock($vmid, "create");
 
-       return undef;
+       return;
 
     }
 });
@@ -696,6 +701,12 @@ __PACKAGE__->register_method({
                optional => 1,
                default => 30,
            },
+           'pass-stdin' => {
+               type => 'boolean',
+               description => "When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB.",
+               optional => 1,
+               default => 0,
+           },
            'extra-args' => get_standard_option('extra-args'),
        },
     },
@@ -707,14 +718,28 @@ __PACKAGE__->register_method({
 
        my $vmid = $param->{vmid};
        my $sync = $param->{synchronous} // 1;
-       if (!$param->{'extra-args'} || !@{$param->{'extra-args'}}) {
-           raise_param_exc( { 'extra-args' => "No command given" });
-       }
+       my $pass_stdin = $param->{'pass-stdin'};
        if (defined($param->{timeout}) && !$sync) {
            raise_param_exc({ synchronous => "needs to be set for 'timeout'"});
        }
 
-       my $res = PVE::QemuServer::Agent::qemu_exec($vmid, $param->{'extra-args'});
+       my $input_data = undef;
+       if ($pass_stdin) {
+           $input_data = '';
+           while (my $line = <STDIN>) {
+               $input_data .= $line;
+               if (length($input_data) > 1024*1024) {
+                   # not sure how QEMU handles large amounts of data being
+                   # passed into the QMP socket, so limit to be safe
+                   die "'input-data' (STDIN) is limited to 1 MiB, aborting\n";
+               }
+           }
+       }
+
+       my $args = $param->{'extra-args'};
+       $args = undef if !$args || !@$args;
+
+       my $res = PVE::QemuServer::Agent::qemu_exec($vmid, $input_data, $args);
 
        if ($sync) {
            my $pid = $res->{pid};
@@ -810,7 +835,7 @@ __PACKAGE__->register_method({
            });
        }
 
-       return undef;
+       return;
     }});
 
 my $print_agent_result = sub {
@@ -832,7 +857,7 @@ my $print_agent_result = sub {
        return;
     }
 
-    print to_json($result, { pretty => 1, canonical => 1});
+    print to_json($result, { pretty => 1, canonical => 1, utf8 => 1});
 };
 
 sub param_mapping {
@@ -853,30 +878,25 @@ sub param_mapping {
 }
 
 our $cmddef = {
-    list => [ "PVE::API2::Qemu", 'vmlist', [],
-            { node => $nodename }, sub {
-                my $vmlist = shift;
-
-                exit 0 if (!scalar(@$vmlist));
-
-                printf "%10s %-20s %-10s %-10s %12s %-10s\n",
-                qw(VMID NAME STATUS MEM(MB) BOOTDISK(GB) PID);
+    list=> [ "PVE::API2::Qemu", 'vmlist', [], { node => $nodename }, sub {
+       my $vmlist = shift;
 
-                foreach my $rec (sort { $a->{vmid} <=> $b->{vmid} } @$vmlist) {
-                    printf "%10s %-20s %-10s %-10s %12.2f %-10s\n", $rec->{vmid}, $rec->{name},
-                    $rec->{qmpstatus} || $rec->{status},
-                    ($rec->{maxmem} || 0)/(1024*1024),
-                    ($rec->{maxdisk} || 0)/(1024*1024*1024),
-                    $rec->{pid}||0;
-                }
+       exit 0 if (!scalar(@$vmlist));
 
+       printf "%10s %-20s %-10s %-10s %12s %-10s\n",
+       qw(VMID NAME STATUS MEM(MB) BOOTDISK(GB) PID);
 
-             } ],
+       foreach my $rec (sort { $a->{vmid} <=> $b->{vmid} } @$vmlist) {
+           printf "%10s %-20s %-10s %-10s %12.2f %-10s\n", $rec->{vmid}, $rec->{name},
+               $rec->{qmpstatus} || $rec->{status},
+               ($rec->{maxmem} || 0)/(1024*1024),
+               ($rec->{maxdisk} || 0)/(1024*1024*1024),
+               $rec->{pid} || 0;
+       }
+    }],
 
     create => [ "PVE::API2::Qemu", 'create_vm', ['vmid'], { node => $nodename }, $upid_exit ],
-
     destroy => [ "PVE::API2::Qemu", 'destroy_vm', ['vmid'], { node => $nodename }, $upid_exit ],
-
     clone => [ "PVE::API2::Qemu", 'clone_vm', ['vmid', 'newid'], { node => $nodename }, $upid_exit ],
 
     migrate => [ "PVE::API2::Qemu", 'migrate_vm', ['vmid', 'target'], { node => $nodename }, $upid_exit ],
@@ -885,28 +905,29 @@ our $cmddef = {
 
     resize => [ "PVE::API2::Qemu", 'resize_vm', ['vmid', 'disk', 'size'], { node => $nodename } ],
 
-    move_disk => [ "PVE::API2::Qemu", 'move_vm_disk', ['vmid', 'disk', 'storage'], { node => $nodename }, $upid_exit ],
+    'move-disk' => [ "PVE::API2::Qemu", 'move_vm_disk', ['vmid', 'disk', 'storage'], { node => $nodename }, $upid_exit ],
+    move_disk => { alias => 'move-disk' },
 
     unlink => [ "PVE::API2::Qemu", 'unlink', ['vmid'], { node => $nodename } ],
 
-    config => [ "PVE::API2::Qemu", 'vm_config', ['vmid'],
-               { node => $nodename }, sub {
-                   my $config = shift;
-                   foreach my $k (sort (keys %$config)) {
-                       next if $k eq 'digest';
-                       my $v = $config->{$k};
-                       if ($k eq 'description') {
-                           $v = PVE::Tools::encode_text($v);
-                       }
-                       print "$k: $v\n";
-                   }
-               }],
+    config => [ "PVE::API2::Qemu", 'vm_config', ['vmid'], { node => $nodename }, sub {
+       my $config = shift;
+       foreach my $k (sort (keys %$config)) {
+           next if $k eq 'digest';
+           my $v = $config->{$k};
+           if ($k eq 'description') {
+               $v = PVE::Tools::encode_text($v);
+           }
+           print "$k: $v\n";
+       }
+    }],
 
     pending => [ "PVE::API2::Qemu", 'vm_pending', ['vmid'], { node => $nodename }, \&PVE::GuestHelpers::format_pending ],
     showcmd => [ __PACKAGE__, 'showcmd', ['vmid']],
 
     status => [ __PACKAGE__, 'status', ['vmid']],
 
+    # FIXME: for 8.0 move to command group snapshot { create, list, destroy, rollback }
     snapshot => [ "PVE::API2::Qemu", 'snapshot', ['vmid', 'snapname'], { node => $nodename } , $upid_exit ],
 
     delsnapshot => [ "PVE::API2::Qemu", 'delsnapshot', ['vmid', 'snapname'], { node => $nodename } , $upid_exit ],
@@ -917,18 +938,13 @@ our $cmddef = {
 
     template => [ "PVE::API2::Qemu", 'template', ['vmid'], { node => $nodename }],
 
+    # FIXME: should be in a power command group?
     start => [ "PVE::API2::Qemu", 'vm_start', ['vmid'], { node => $nodename } , $upid_exit ],
-
     stop => [ "PVE::API2::Qemu", 'vm_stop', ['vmid'], { node => $nodename }, $upid_exit ],
-
     reset => [ "PVE::API2::Qemu", 'vm_reset', ['vmid'], { node => $nodename }, $upid_exit ],
-
     shutdown => [ "PVE::API2::Qemu", 'vm_shutdown', ['vmid'], { node => $nodename }, $upid_exit ],
-
     reboot => [ "PVE::API2::Qemu", 'vm_reboot', ['vmid'], { node => $nodename }, $upid_exit ],
-
     suspend => [ "PVE::API2::Qemu", 'vm_suspend', ['vmid'], { node => $nodename }, $upid_exit ],
-
     resume => [ "PVE::API2::Qemu", 'vm_resume', ['vmid'], { node => $nodename }, $upid_exit ],
 
     sendkey => [ "PVE::API2::Qemu", 'vm_sendkey', ['vmid', 'key'], { node => $nodename } ],
@@ -939,6 +955,7 @@ our $cmddef = {
 
     unlock => [ __PACKAGE__, 'unlock', ['vmid']],
 
+    # FIXME: should this be in a 'disk' command group with move and resize and import?
     rescan  => [ __PACKAGE__, 'rescan', []],
 
     monitor  => [ __PACKAGE__, 'monitor', ['vmid']],