move include after document header
[pve-docs.git] / 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 See 'man vm.conf' for a complete list of options.
42
43 Configuration files are stored inside the Proxmox configuration file
44 system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.
45
46 The default for option `keyboard` is read from
47 '/etc/pve/datacenter.conf'.
48
49 Locks
50 -----
51
52 Online migration and backups ('vzdump') set a lock to prevent
53 unintentional action on such VMs. Sometimes you need remove such lock
54 manually (power failure).
55
56  qm unlock <vmid>
57
58 Examples
59 --------
60
61 Create a new VM with 4 GB IDE disk.
62
63  qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
64
65 Start the new VM
66
67  qm start 300
68
69 Send a shutdown request, then wait until the VM is stopped.
70
71  qm shutdown 300 && qm wait 300
72
73 Same as above, but only wait for 40 seconds.
74
75  qm shutdown 300 && qm wait 300 -timeout 40
76
77
78 ifdef::manvolnum[]
79 include::pve-copyright.adoc[]
80 endif::manvolnum[]