qm

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4 use Getopt::Long;
   5 use Fcntl ':flock';
   6 use File::Path;
   7 use IO::Socket::UNIX;
   8 use IO::Select;
   9
  10 use PVE::Tools qw(extract_param);
  11 use PVE::Cluster;
  12 use PVE::SafeSyslog;
  13 use PVE::INotify;
  14 use PVE::RPCEnvironment;
  15 use PVE::QemuServer;
  16 use PVE::API2::Qemu;
  17 use PVE::JSONSchema qw(get_standard_option);
  18 use Term::ReadLine;
  19
  20 use PVE::CLIHandler;
  21
  22 use base qw(PVE::CLIHandler);
  23
  24 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
  25
  26 initlog('qm');
  27
  28 die "please run as root\n" if $> != 0;
  29
  30 PVE::INotify::inotify_init();
  31
  32 my $rpcenv = PVE::RPCEnvironment->init('cli');
  33
  34 $rpcenv->init_request();
  35 $rpcenv->set_language($ENV{LANG});
  36 $rpcenv->set_user('root@pam');
  37
  38 my $upid_exit = sub {
  39     my $upid = shift;
  40     my $status = PVE::Tools::upid_read_status($upid);
  41     exit($status eq 'OK' ? 0 : -1);
  42 };
  43
  44 my $nodename = PVE::INotify::nodename();
  45
  46 sub run_vnc_proxy {
  47     my ($vmid) = @_;
  48
  49     my $path = PVE::QemuServer::vnc_socket($vmid);
  50
  51     my $s = IO::Socket::UNIX->new(Peer => $path, Timeout => 120);
  52
  53     die "unable to connect to socket '$path' - $!" if !$s;
  54
  55     my $select = new IO::Select;
  56
  57     $select->add(\*STDIN);
  58     $select->add($s);
  59
  60     my $timeout = 60*15; # 15 minutes
  61
  62     my @handles;
  63     while ($select->count &&
  64            scalar(@handles = $select->can_read ($timeout))) {
  65         foreach my $h (@handles) {
  66             my $buf;
  67             my $n = $h->sysread($buf, 4096);
  68
  69             if ($h == \*STDIN) {
  70                 if ($n) {
  71                     syswrite($s, $buf);
  72                 } else {
  73                     exit(0);
  74                 }
  75             } elsif ($h == $s) {
  76                 if ($n) {
  77                     syswrite(\*STDOUT, $buf);
  78                 } else {
  79                     exit(0);
  80                 }
  81             }
  82         }
  83     }
  84     exit(0);
  85 }
  86
  87 __PACKAGE__->register_method ({
  88     name => 'showcmd',
  89     path => 'showcmd',
  90     method => 'GET',
  91     description => "Show command line which is used to start the VM (debug info).",
  92     parameters => {
  93         additionalProperties => 0,
  94         properties => {
  95             vmid => get_standard_option('pve-vmid'),
  96         },
  97     },
  98     returns => { type => 'null'},
  99     code => sub {
 100         my ($param) = @_;
 101
 102         my $storecfg = PVE::Storage::config();
 103         print PVE::QemuServer::vm_commandline($storecfg, $param->{vmid}) . "\n";
 104
 105         return undef;
 106     }});
 107
 108 __PACKAGE__->register_method ({
 109     name => 'status',
 110     path => 'status',
 111     method => 'GET',
 112     description => "Show VM status.",
 113     parameters => {
 114         additionalProperties => 0,
 115         properties => {
 116             vmid => get_standard_option('pve-vmid'),
 117             verbose => {
 118                 description => "Verbose output format",
 119                 type => 'boolean',
 120                 optional => 1,
 121             }
 122         },
 123     },
 124     returns => { type => 'null'},
 125     code => sub {
 126         my ($param) = @_;
 127
 128         # test if VM exists
 129         my $conf = PVE::QemuServer::load_config ($param->{vmid});
 130
 131         my $vmstatus = PVE::QemuServer::vmstatus($param->{vmid});
 132         my $stat = $vmstatus->{$param->{vmid}};
 133         if ($param->{verbose}) {
 134             foreach my $k (sort (keys %$stat)) {
 135                 next if $k eq 'cpu' || $k eq 'relcpu'; # always 0
 136                 my $v = $stat->{$k};
 137                 next if !defined($v);
 138                 print "$k: $v\n";
 139             }
 140         } else {
 141             my $status = $stat->{status} || 'unknown';
 142             print "status: $status\n";
 143         }
 144
 145         return undef;
 146     }});
 147
 148 __PACKAGE__->register_method ({
 149     name => 'vncproxy',
 150     path => 'vncproxy',
 151     method => 'PUT',
 152     description => "Proxy VM VNC traffic to stdin/stdout",
 153     parameters => {
 154         additionalProperties => 0,
 155         properties => {
 156             vmid => get_standard_option('pve-vmid'),
 157         },
 158     },
 159     returns => { type => 'null'},
 160     code => sub {
 161         my ($param) = @_;
 162
 163         my $vmid = $param->{vmid};
 164
 165         run_vnc_proxy ($vmid);
 166
 167         return undef;
 168     }});
 169
 170 __PACKAGE__->register_method ({
 171     name => 'unlock',
 172     path => 'unlock',
 173     method => 'PUT',
 174     description => "Unlock the VM.",
 175     parameters => {
 176         additionalProperties => 0,
 177         properties => {
 178             vmid => get_standard_option('pve-vmid'),
 179         },
 180     },
 181     returns => { type => 'null'},
 182     code => sub {
 183         my ($param) = @_;
 184
 185         my $vmid = $param->{vmid};
 186
 187         PVE::QemuServer::lock_config ($vmid, sub {
 188             my $conf = PVE::QemuServer::load_config($vmid);
 189             delete $conf->{lock};
 190             PVE::QemuServer::update_config_nolock($vmid, $conf, 1);
 191         });
 192
 193         return undef;
 194     }});
 195
 196 __PACKAGE__->register_method ({
 197     name => 'mtunnel',
 198     path => 'mtunnel',
 199     method => 'POST',
 200     description => "Used by qmigrate - do not use manually.",
 201     parameters => {
 202         additionalProperties => 0,
 203         properties => {},
 204     },
 205     returns => { type => 'null'},
 206     code => sub {
 207         my ($param) = @_;
 208
 209         if (!PVE::Cluster::check_cfs_quorum(1)) {
 210             print "no quorum\n";
 211             return undef;
 212         }
 213
 214         print "tunnel online\n";
 215         *STDOUT->flush();
 216
 217         while (my $line = <>) {
 218             chomp $line;
 219             last if $line =~ m/^quit$/;
 220         }
 221
 222         return undef;
 223     }});
 224
 225 __PACKAGE__->register_method ({
 226     name => 'startall',
 227     path => 'startall',
 228     method => 'POST',
 229     description => "Start all virtual machines (when onboot=1).",
 230     parameters => {
 231         additionalProperties => 0,
 232         properties => {},
 233     },
 234     returns => { type => 'null'},
 235     code => sub {
 236         my ($param) = @_;
 237
 238         # wait up to 10 seconds for quorum
 239         for (my $i = 10; $i >= 0; $i--) {
 240             last if PVE::Cluster::check_cfs_quorum($i != 0 ? 1 : 0);
 241             sleep(1);
 242         }
 243
 244         my $vzlist = PVE::QemuServer::vzlist();
 245         my $storecfg = PVE::Storage::config();
 246
 247         my $count = 0;
 248         foreach my $vmid (keys %$vzlist) {
 249             next if $vzlist->{$vmid}->{pid}; # already running
 250
 251             my $conf;
 252             eval { $conf = PVE::QemuServer::load_config($vmid); };
 253             if (my $err = $@) {
 254                 warn $err;
 255                 next;
 256             }
 257
 258             next if !($conf && $conf->{onboot});
 259
 260             sleep(2) if $count != 0; # reduce load
 261             $count++;
 262
 263             PVE::Cluster::check_cfs_quorum(); # abort when we loose quorum
 264
 265             eval {
 266                 print STDERR "Starting Qemu VM $vmid\n";
 267                 PVE::QemuServer::vm_start($storecfg, $vmid);
 268             };
 269             warn $@ if $@;
 270         }
 271
 272         return undef;
 273     }});
 274
 275 __PACKAGE__->register_method ({
 276     name => 'stopall',
 277     path => 'stopall',
 278     method => 'POST',
 279     description => "Stop all virtual machines.",
 280     parameters => {
 281         additionalProperties => 0,
 282         properties => {
 283             timeout => {
 284                 description => "Timeout in seconds. Default is to wait 3 minutes.",
 285                 type => 'integer',
 286                 minimum => 1,
 287                 optional => 1,
 288             }
 289         },
 290     },
 291     returns => { type => 'null'},
 292     code => sub {
 293         my ($param) = @_;
 294
 295         my $timeout = $param->{timeout};
 296
 297         my $storecfg = PVE::Storage::config();
 298
 299         PVE::QemuServer::vm_stopall($storecfg, $timeout);
 300
 301         return undef;
 302     }});
 303
 304 __PACKAGE__->register_method ({
 305     name => 'wait',
 306     path => 'wait',
 307     method => 'GET',
 308     description => "Wait until the VM is stopped.",
 309     parameters => {
 310         additionalProperties => 0,
 311         properties => {
 312             vmid => get_standard_option('pve-vmid'),
 313             timeout => {
 314                 description => "Timeout in seconds. Default is to wait forever.",
 315                 type => 'integer',
 316                 minimum => 1,
 317                 optional => 1,
 318             }
 319         },
 320     },
 321     returns => { type => 'null'},
 322     code => sub {
 323         my ($param) = @_;
 324
 325         my $vmid = $param->{vmid};
 326         my $timeout = $param->{timeout};
 327
 328         my $pid = PVE::QemuServer::check_running ($vmid);
 329         return if !$pid;
 330
 331         print "waiting until VM $vmid stopps (PID $pid)\n";
 332
 333         my $count = 0;
 334         while ((!$timeout || ($count < $timeout)) && PVE::QemuServer::check_running ($vmid)) {
 335             $count++;
 336             sleep 1;
 337         }
 338
 339         die "wait failed - got timeout\n" if PVE::QemuServer::check_running ($vmid);
 340
 341         return undef;
 342     }});
 343
 344 __PACKAGE__->register_method ({
 345     name => 'monitor',
 346     path => 'monitor',
 347     method => 'POST',
 348     description => "Enter Qemu Monitor interface.",
 349     parameters => {
 350         additionalProperties => 0,
 351         properties => {
 352             vmid => get_standard_option('pve-vmid'),
 353         },
 354     },
 355     returns => { type => 'null'},
 356     code => sub {
 357         my ($param) = @_;
 358
 359         my $vmid = $param->{vmid};
 360
 361         my $conf = PVE::QemuServer::load_config ($vmid); # check if VM exists
 362
 363         print "Entering Qemu Monitor for VM $vmid - type 'help' for help\n";
 364
 365         my $term = new Term::ReadLine ('qm');
 366
 367         my $input;
 368         while (defined ($input = $term->readline('qm> '))) {
 369             chomp $input;
 370
 371             next if $input =~ m/^\s*$/;
 372
 373             last if $input =~ m/^\s*q(uit)?\s*$/;
 374
 375             eval {
 376                 print PVE::QemuServer::vm_monitor_command ($vmid, $input);
 377             };
 378             print "ERROR: $@" if $@;
 379         }
 380
 381         return undef;
 382
 383     }});
 384
 385 my $cmddef = {
 386     list => [ "PVE::API2::Qemu", 'vmlist', [],
 387              { node => $nodename }, sub {
 388                  my $vmlist = shift;
 389
 390                  exit 0 if (!scalar(@$vmlist));
 391
 392                  printf "%10s %-20s %-10s %-10s %12s %-10s\n",
 393                  qw(VMID NAME STATUS MEM(MB) BOOTDISK(GB) PID);
 394
 395                  foreach my $rec (sort { $a->{vmid} <=> $b->{vmid} } @$vmlist) {
 396                      printf "%10s %-20s %-10s %-10s %12.2f %-10s\n", $rec->{vmid}, $rec->{name},
 397                      $rec->{status},
 398                      ($rec->{maxmem} || 0)/(1024*1024),
 399                      ($rec->{maxdisk} || 0)/(1024*1024*1024),
 400                      $rec->{pid}||0;
 401                  }
 402
 403
 404               } ],
 405
 406     create => [ "PVE::API2::Qemu", 'create_vm', ['vmid'], { node => $nodename }, $upid_exit ],
 407
 408     destroy => [ "PVE::API2::Qemu", 'destroy_vm', ['vmid'], { node => $nodename }, $upid_exit ],
 409
 410     migrate => [ "PVE::API2::Qemu", 'migrate_vm', ['vmid', 'target'], { node => $nodename }, $upid_exit ],
 411
 412     set => [ "PVE::API2::Qemu", 'update_vm', ['vmid'], { node => $nodename } ],
 413
 414     unlink => [ "PVE::API2::Qemu", 'unlink', ['vmid', 'idlist'], { node => $nodename } ],
 415
 416     config => [ "PVE::API2::Qemu", 'vm_config', ['vmid'],
 417                 { node => $nodename }, sub {
 418                     my $config = shift;
 419                     foreach my $k (sort (keys %$config)) {
 420                         next if $k eq 'digest';
 421                         my $v = $config->{$k};
 422                         if ($k eq 'description') {
 423                             $v = PVE::Tools::encode_text($v);
 424                         }
 425                         print "$k: $v\n";
 426                     }
 427                 }],
 428
 429     showcmd => [ __PACKAGE__, 'showcmd', ['vmid']],
 430
 431     status => [ __PACKAGE__, 'status', ['vmid']],
 432
 433     start => [ "PVE::API2::Qemu", 'vm_start', ['vmid'], { node => $nodename } , $upid_exit ],
 434
 435     stop => [ "PVE::API2::Qemu", 'vm_stop', ['vmid'], { node => $nodename }, $upid_exit ],
 436
 437     reset => [ "PVE::API2::Qemu", 'vm_reset', ['vmid'], { node => $nodename }, $upid_exit ],
 438
 439     shutdown => [ "PVE::API2::Qemu", 'vm_shutdown', ['vmid'], { node => $nodename }, $upid_exit ],
 440
 441     suspend => [ "PVE::API2::Qemu", 'vm_suspend', ['vmid'], { node => $nodename }, $upid_exit ],
 442
 443     resume => [ "PVE::API2::Qemu", 'vm_resume', ['vmid'], { node => $nodename }, $upid_exit ],
 444
 445     sendkey => [ "PVE::API2::Qemu", 'vm_sendkey', ['vmid', 'key'], { node => $nodename } ],
 446
 447     vncproxy => [ __PACKAGE__, 'vncproxy', ['vmid']],
 448
 449     wait => [ __PACKAGE__, 'wait', ['vmid']],
 450
 451     unlock => [ __PACKAGE__, 'unlock', ['vmid']],
 452
 453     monitor  => [ __PACKAGE__, 'monitor', ['vmid']],
 454
 455     startall => [ __PACKAGE__, 'startall', []],
 456
 457     stopall => [ __PACKAGE__, 'stopall', []],
 458
 459     mtunnel => [ __PACKAGE__, 'mtunnel', []],
 460 };
 461
 462 my $cmd = shift;
 463
 464 PVE::CLIHandler::handle_cmd($cmddef, "qm", $cmd, \@ARGV, undef, $0);
 465
 466 exit 0;
 467
 468 __END__
 469
 470 =head1 NAME
 471
 472 qm - qemu/kvm virtual machine manager
 473
 474 =head1 SYNOPSIS
 475
 476 =include synopsis
 477
 478 =head1 DESCRIPTION
 479
 480 qm is a script to manage virtual machines with qemu/kvm. You can
 481 create and destroy virtual machines, and control execution
 482 (start/stop/suspend/resume). Besides that, you can use qm to set
 483 parameters in the associated config file. It is also possible to
 484 create and delete virtual disks.
 485
 486 =head1 CONFIGURATION
 487
 488 All configuration files consists of lines in the form
 489
 490        PARAMETER: value
 491
 492 See L<vm.conf|vm.conf> for a complete list of options.
 493
 494 Configuration files are stored inside the Proxmox configuration file system, and can be access at F</etc/pve/qemu-server/C<VMID>.conf>.
 495
 496 The default for option 'keyboard' is read from
 497 F</etc/pve/datacenter.conf>.
 498
 499 =head1 Locks
 500
 501 Online migration and backups (vzdump) set a lock to prevent
 502 unintentional action on such VMs. Sometimes you need remove such lock
 503 manually (power failure).
 504
 505  qm unlock <vmid>
 506
 507 =head1 EXAMPLES
 508
 509  # create a new VM with 4 GB ide disk
 510  qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
 511
 512  # start the new VM
 513  qm start 300
 514
 515  # send shutdown, then wait until VM is stopped
 516  qm shutdown 300 && qm wait 300
 517
 518  # same as above, but only wait for 40 seconds
 519  qm shutdown 300 && qm wait 300 -timeout 40
 520
 521
 522 =include pve_copyright