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