update 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
871e1fd6 41Configuration files are stored inside the Proxmox cluster file
f69cfd23
DM
42system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.
43
a7f36905
DM
44Options
45~~~~~~~
46
47include::qm.conf.5-opts.adoc[]
48
f69cfd23
DM
49
50Locks
51-----
52
871e1fd6
FG
53Online migrations and backups ('vzdump') set a lock to prevent incompatible
54concurrent actions on the affected VMs. Sometimes you need to remove such a
55lock manually (e.g., after a power failure).
f69cfd23
DM
56
57 qm unlock <vmid>
58
59Examples
60--------
61
62Create a new VM with 4 GB IDE disk.
63
64 qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
65
66Start the new VM
67
68 qm start 300
69
70Send a shutdown request, then wait until the VM is stopped.
71
72 qm shutdown 300 && qm wait 300
73
74Same as above, but only wait for 40 seconds.
75
76 qm shutdown 300 && qm wait 300 -timeout 40
77
78
79ifdef::manvolnum[]
80include::pve-copyright.adoc[]
81endif::manvolnum[]