Reformat qm documentation to make it similar to pct
[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
dd042288
EK
27Managing Virtual Machines with 'qm'
28------------------------------------
f69cfd23 29
dd042288 30qm is the tool to manage Qemu/Kvm virtual machines on {pve}. You can
f69cfd23
DM
31create and destroy virtual machines, and control execution
32(start/stop/suspend/resume). Besides that, you can use qm to set
33parameters in the associated config file. It is also possible to
34create and delete virtual disks.
35
dd042288
EK
36CLI Usage Examples
37~~~~~~~~~~~~~~~~~~
38
39Create a new VM with 4 GB IDE disk.
40
41 qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
42
43Start the new VM
44
45 qm start 300
46
47Send a shutdown request, then wait until the VM is stopped.
48
49 qm shutdown 300 && qm wait 300
50
51Same as above, but only wait for 40 seconds.
52
53 qm shutdown 300 && qm wait 300 -timeout 40
54
f69cfd23
DM
55Configuration
56-------------
57
58All configuration files consists of lines in the form
59
60 PARAMETER: value
61
871e1fd6 62Configuration files are stored inside the Proxmox cluster file
f69cfd23
DM
63system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.
64
a7f36905
DM
65Options
66~~~~~~~
67
68include::qm.conf.5-opts.adoc[]
69
f69cfd23
DM
70
71Locks
72-----
73
871e1fd6
FG
74Online migrations and backups ('vzdump') set a lock to prevent incompatible
75concurrent actions on the affected VMs. Sometimes you need to remove such a
76lock manually (e.g., after a power failure).
f69cfd23
DM
77
78 qm unlock <vmid>
79
f69cfd23
DM
80
81ifdef::manvolnum[]
82include::pve-copyright.adoc[]
83endif::manvolnum[]