Update index.adoc
[pve-docs.git] / qm.adoc
CommitLineData
f69cfd23
DM
1include::attributes.txt[]
2ifdef::manvolnum[]
3PVE({manvolnum})
4================
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=========================
24endif::manvolnum[]
25
26
27qm is a script to manage virtual machines with Qemu/Kvm. You can
28create and destroy virtual machines, and control execution
29(start/stop/suspend/resume). Besides that, you can use qm to set
30parameters in the associated config file. It is also possible to
31create and delete virtual disks.
32
33Configuration
34-------------
35
36All configuration files consists of lines in the form
37
38 PARAMETER: value
39
40See 'man vm.conf' for a complete list of options.
41
42Configuration files are stored inside the Proxmox configuration file
43system, and can be access at '/etc/pve/qemu-server/<VMID>.conf'.
44
45The default for option `keyboard` is read from
46'/etc/pve/datacenter.conf'.
47
48Locks
49-----
50
51Online migration and backups ('vzdump') set a lock to prevent
52unintentional action on such VMs. Sometimes you need remove such lock
53manually (power failure).
54
55 qm unlock <vmid>
56
57Examples
58--------
59
60Create a new VM with 4 GB IDE disk.
61
62 qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
63
64Start the new VM
65
66 qm start 300
67
68Send a shutdown request, then wait until the VM is stopped.
69
70 qm shutdown 300 && qm wait 300
71
72Same as above, but only wait for 40 seconds.
73
74 qm shutdown 300 && qm wait 300 -timeout 40
75
76
77ifdef::manvolnum[]
78include::pve-copyright.adoc[]
79endif::manvolnum[]