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