qm.adoc

   1 ifdef::manvolnum[]
   2 PVE({manvolnum})
   3 ================
   4 include::attributes.txt[]
   5
   6 NAME
   7 ----
   8
   9 qm - Qemu/KVM Virtual Machine Manager
  10
  11
  12 SYNOPSYS
  13 --------
  14
  15 include::qm.1-synopsis.adoc[]
  16
  17 DESCRIPTION
  18 -----------
  19 endif::manvolnum[]
  20
  21 ifndef::manvolnum[]
  22 Qemu/KVM Virtual Machines
  23 =========================
  24 include::attributes.txt[]
  25 endif::manvolnum[]
  26
  27
  28 qm is a script to manage virtual machines with Qemu/Kvm. You can
  29 create and destroy virtual machines, and control execution
  30 (start/stop/suspend/resume). Besides that, you can use qm to set
  31 parameters in the associated config file. It is also possible to
  32 create and delete virtual disks.
  33
  34 Configuration
  35 -------------
  36
  37 All configuration files consists of lines in the form
  38
  39  PARAMETER: value
  40
  41 Configuration files are stored inside the Proxmox cluster file
  42 system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.
  43
  44 Options
  45 ~~~~~~~
  46
  47 include::qm.conf.5-opts.adoc[]
  48
  49
  50 Locks
  51 -----
  52
  53 Online migrations and backups ('vzdump') set a lock to prevent incompatible
  54 concurrent actions on the affected VMs. Sometimes you need to remove such a
  55 lock manually (e.g., after a power failure).
  56
  57  qm unlock <vmid>
  58
  59 Examples
  60 --------
  61
  62 Create a new VM with 4 GB IDE disk.
  63
  64  qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
  65
  66 Start the new VM
  67
  68  qm start 300
  69
  70 Send a shutdown request, then wait until the VM is stopped.
  71
  72  qm shutdown 300 && qm wait 300
  73
  74 Same as above, but only wait for 40 seconds.
  75
  76  qm shutdown 300 && qm wait 300 -timeout 40
  77
  78
  79 ifdef::manvolnum[]
  80 include::pve-copyright.adoc[]
  81 endif::manvolnum[]