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