]>
Commit | Line | Data |
---|---|---|
80c0adcb | 1 | [[chapter_virtual_machines]] |
f69cfd23 | 2 | ifdef::manvolnum[] |
b2f242ab DM |
3 | qm(1) |
4 | ===== | |
38fd0958 | 5 | include::attributes.txt[] |
5f09af76 DM |
6 | :pve-toplevel: |
7 | ||
f69cfd23 DM |
8 | NAME |
9 | ---- | |
10 | ||
11 | qm - Qemu/KVM Virtual Machine Manager | |
12 | ||
13 | ||
49a5e11c | 14 | SYNOPSIS |
f69cfd23 DM |
15 | -------- |
16 | ||
17 | include::qm.1-synopsis.adoc[] | |
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
f69cfd23 DM |
22 | ifndef::manvolnum[] |
23 | Qemu/KVM Virtual Machines | |
24 | ========================= | |
38fd0958 | 25 | include::attributes.txt[] |
5f09af76 | 26 | :pve-toplevel: |
194d2f29 | 27 | endif::manvolnum[] |
5f09af76 | 28 | |
c4cba5d7 EK |
29 | // deprecates |
30 | // http://pve.proxmox.com/wiki/Container_and_Full_Virtualization | |
31 | // http://pve.proxmox.com/wiki/KVM | |
32 | // http://pve.proxmox.com/wiki/Qemu_Server | |
33 | ||
5eba0743 | 34 | Qemu (short form for Quick Emulator) is an open source hypervisor that emulates a |
c4cba5d7 EK |
35 | physical computer. From the perspective of the host system where Qemu is |
36 | running, Qemu is a user program which has access to a number of local resources | |
37 | like partitions, files, network cards which are then passed to an | |
189d3661 | 38 | emulated computer which sees them as if they were real devices. |
c4cba5d7 EK |
39 | |
40 | A guest operating system running in the emulated computer accesses these | |
41 | devices, and runs as it were running on real hardware. For instance you can pass | |
42 | an iso image as a parameter to Qemu, and the OS running in the emulated computer | |
189d3661 | 43 | will see a real CDROM inserted in a CD drive. |
c4cba5d7 | 44 | |
189d3661 | 45 | Qemu can emulates a great variety of hardware from ARM to Sparc, but {pve} is |
c4cba5d7 EK |
46 | only concerned with 32 and 64 bits PC clone emulation, since it represents the |
47 | overwhelming majority of server hardware. The emulation of PC clones is also one | |
48 | of the fastest due to the availability of processor extensions which greatly | |
49 | speed up Qemu when the emulated architecture is the same as the host | |
9c63b5d9 EK |
50 | architecture. |
51 | ||
52 | NOTE: You may sometimes encounter the term _KVM_ (Kernel-based Virtual Machine). | |
53 | It means that Qemu is running with the support of the virtualization processor | |
54 | extensions, via the Linux kvm module. In the context of {pve} _Qemu_ and | |
55 | _KVM_ can be use interchangeably as Qemu in {pve} will always try to load the kvm | |
56 | module. | |
57 | ||
c4cba5d7 EK |
58 | Qemu inside {pve} runs as a root process, since this is required to access block |
59 | and PCI devices. | |
60 | ||
5eba0743 | 61 | |
c4cba5d7 EK |
62 | Emulated devices and paravirtualized devices |
63 | -------------------------------------------- | |
64 | ||
189d3661 DC |
65 | The PC hardware emulated by Qemu includes a mainboard, network controllers, |
66 | scsi, ide and sata controllers, serial ports (the complete list can be seen in | |
67 | the `kvm(1)` man page) all of them emulated in software. All these devices | |
68 | are the exact software equivalent of existing hardware devices, and if the OS | |
69 | running in the guest has the proper drivers it will use the devices as if it | |
c4cba5d7 EK |
70 | were running on real hardware. This allows Qemu to runs _unmodified_ operating |
71 | systems. | |
72 | ||
73 | This however has a performance cost, as running in software what was meant to | |
74 | run in hardware involves a lot of extra work for the host CPU. To mitigate this, | |
75 | Qemu can present to the guest operating system _paravirtualized devices_, where | |
76 | the guest OS recognizes it is running inside Qemu and cooperates with the | |
77 | hypervisor. | |
78 | ||
79 | Qemu relies on the virtio virtualization standard, and is thus able to presente | |
189d3661 DC |
80 | paravirtualized virtio devices, which includes a paravirtualized generic disk |
81 | controller, a paravirtualized network card, a paravirtualized serial port, | |
c4cba5d7 EK |
82 | a paravirtualized SCSI controller, etc ... |
83 | ||
189d3661 DC |
84 | It is highly recommended to use the virtio devices whenever you can, as they |
85 | provide a big performance improvement. Using the virtio generic disk controller | |
86 | versus an emulated IDE controller will double the sequential write throughput, | |
87 | as measured with `bonnie++(8)`. Using the virtio network interface can deliver | |
c4cba5d7 | 88 | up to three times the throughput of an emulated Intel E1000 network card, as |
189d3661 | 89 | measured with `iperf(1)`. footnote:[See this benchmark on the KVM wiki |
c4cba5d7 EK |
90 | http://www.linux-kvm.org/page/Using_VirtIO_NIC] |
91 | ||
5eba0743 | 92 | |
80c0adcb | 93 | [[qm_virtual_machines_settings]] |
c4cba5d7 EK |
94 | Virtual Machines settings |
95 | ------------------------- | |
80c0adcb | 96 | |
c4cba5d7 EK |
97 | Generally speaking {pve} tries to choose sane defaults for virtual machines |
98 | (VM). Make sure you understand the meaning of the settings you change, as it | |
99 | could incur a performance slowdown, or putting your data at risk. | |
100 | ||
5eba0743 | 101 | |
80c0adcb | 102 | [[qm_general_settings]] |
c4cba5d7 EK |
103 | General Settings |
104 | ~~~~~~~~~~~~~~~~ | |
80c0adcb | 105 | |
c4cba5d7 EK |
106 | General settings of a VM include |
107 | ||
108 | * the *Node* : the physical server on which the VM will run | |
109 | * the *VM ID*: a unique number in this {pve} installation used to identify your VM | |
110 | * *Name*: a free form text string you can use to describe the VM | |
111 | * *Resource Pool*: a logical group of VMs | |
112 | ||
5eba0743 | 113 | |
80c0adcb | 114 | [[qm_os_settings]] |
c4cba5d7 EK |
115 | OS Settings |
116 | ~~~~~~~~~~~ | |
80c0adcb | 117 | |
c4cba5d7 EK |
118 | When creating a VM, setting the proper Operating System(OS) allows {pve} to |
119 | optimize some low level parameters. For instance Windows OS expect the BIOS | |
120 | clock to use the local time, while Unix based OS expect the BIOS clock to have | |
121 | the UTC time. | |
122 | ||
5eba0743 | 123 | |
80c0adcb | 124 | [[qm_hard_disk]] |
c4cba5d7 EK |
125 | Hard Disk |
126 | ~~~~~~~~~ | |
80c0adcb | 127 | |
2ec49380 | 128 | Qemu can emulate a number of storage controllers: |
c4cba5d7 EK |
129 | |
130 | * the *IDE* controller, has a design which goes back to the 1984 PC/AT disk | |
131 | controller. Even if this controller has been superseded by more more designs, | |
132 | each and every OS you can think has support for it, making it a great choice | |
133 | if you want to run an OS released before 2003. You can connect up to 4 devices | |
134 | on this controller. | |
135 | ||
136 | * the *SATA* (Serial ATA) controller, dating from 2003, has a more modern | |
137 | design, allowing higher throughput and a greater number of devices to be | |
138 | connected. You can connect up to 6 devices on this controller. | |
139 | ||
b0b6802b EK |
140 | * the *SCSI* controller, designed in 1985, is commonly found on server grade |
141 | hardware, and can connect up to 14 storage devices. {pve} emulates by default a | |
142 | LSI 53C895A controller. + | |
143 | A SCSI controller of type _Virtio_ is the recommended setting if you aim for | |
144 | performance and is automatically selected for newly created Linux VMs since | |
145 | {pve} 4.3. Linux distributions have support for this controller since 2012, and | |
c4cba5d7 | 146 | FreeBSD since 2014. For Windows OSes, you need to provide an extra iso |
b0b6802b EK |
147 | containing the drivers during the installation. |
148 | // https://pve.proxmox.com/wiki/Paravirtualized_Block_Drivers_for_Windows#During_windows_installation. | |
149 | ||
150 | * The *Virtio* controller, also called virtio-blk to distinguish from | |
151 | the Virtio SCSI controller, is an older type of paravirtualized controller | |
152 | which has been superseded in features by the Virtio SCSI Controller. | |
c4cba5d7 EK |
153 | |
154 | On each controller you attach a number of emulated hard disks, which are backed | |
155 | by a file or a block device residing in the configured storage. The choice of | |
156 | a storage type will determine the format of the hard disk image. Storages which | |
157 | present block devices (LVM, ZFS, Ceph) will require the *raw disk image format*, | |
158 | whereas files based storages (Ext4, NFS, GlusterFS) will let you to choose | |
159 | either the *raw disk image format* or the *QEMU image format*. | |
160 | ||
161 | * the *QEMU image format* is a copy on write format which allows snapshots, and | |
162 | thin provisioning of the disk image. | |
189d3661 DC |
163 | * the *raw disk image* is a bit-to-bit image of a hard disk, similar to what |
164 | you would get when executing the `dd` command on a block device in Linux. This | |
165 | format do not support thin provisioning or snapshotting by itself, requiring | |
166 | cooperation from the storage layer for these tasks. It is however 10% faster | |
167 | than the *QEMU image format*. footnote:[See this benchmark for details | |
c4cba5d7 | 168 | http://events.linuxfoundation.org/sites/events/files/slides/CloudOpen2013_Khoa_Huynh_v3.pdf] |
189d3661 | 169 | * the *VMware image format* only makes sense if you intend to import/export the |
c4cba5d7 EK |
170 | disk image to other hypervisors. |
171 | ||
172 | Setting the *Cache* mode of the hard drive will impact how the host system will | |
173 | notify the guest systems of block write completions. The *No cache* default | |
174 | means that the guest system will be notified that a write is complete when each | |
175 | block reaches the physical storage write queue, ignoring the host page cache. | |
176 | This provides a good balance between safety and speed. | |
177 | ||
178 | If you want the {pve} backup manager to skip a disk when doing a backup of a VM, | |
179 | you can set the *No backup* option on that disk. | |
180 | ||
181 | If your storage supports _thin provisioning_ (see the storage chapter in the | |
182 | {pve} guide), and your VM has a *SCSI* controller you can activate the *Discard* | |
183 | option on the hard disks connected to that controller. With *Discard* enabled, | |
184 | when the filesystem of a VM marks blocks as unused after removing files, the | |
185 | emulated SCSI controller will relay this information to the storage, which will | |
186 | then shrink the disk image accordingly. | |
187 | ||
af9c6de1 | 188 | .IO Thread |
2b6e4b66 EK |
189 | The option *IO Thread* can only be enabled when using a disk with the *VirtIO* controller, |
190 | or with the *SCSI* controller, when the emulated controller type is *VirtIO SCSI*. | |
c564fc52 DC |
191 | With this enabled, Qemu uses one thread per disk, instead of one thread for all, |
192 | so it should increase performance when using multiple disks. | |
193 | Note that backups do not currently work with *IO Thread* enabled. | |
194 | ||
80c0adcb DM |
195 | |
196 | [[qm_cpu]] | |
34e541c5 EK |
197 | CPU |
198 | ~~~ | |
80c0adcb | 199 | |
34e541c5 EK |
200 | A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU. |
201 | This CPU can then contain one or many *cores*, which are independent | |
202 | processing units. Whether you have a single CPU socket with 4 cores, or two CPU | |
203 | sockets with two cores is mostly irrelevant from a performance point of view. | |
204 | However some software is licensed depending on the number of sockets you have in | |
205 | your machine, in that case it makes sense to set the number of of sockets to | |
206 | what the license allows you, and increase the number of cores. + | |
207 | Increasing the number of virtual cpus (cores and sockets) will usually provide a | |
208 | performance improvement though that is heavily dependent on the use of the VM. | |
209 | Multithreaded applications will of course benefit from a large number of | |
210 | virtual cpus, as for each virtual cpu you add, Qemu will create a new thread of | |
211 | execution on the host system. If you're not sure about the workload of your VM, | |
212 | it is usually a safe bet to set the number of *Total cores* to 2. | |
213 | ||
214 | NOTE: It is perfectly safe to set the _overall_ number of total cores in all | |
215 | your VMs to be greater than the number of of cores you have on your server (ie. | |
216 | 4 VMs with each 4 Total cores running in a 8 core machine is OK) In that case | |
217 | the host system will balance the Qemu execution threads between your server | |
218 | cores just like if you were running a standard multithreaded application. | |
219 | However {pve} will prevent you to allocate on a _single_ machine more vcpus than | |
220 | physically available, as this will only bring the performance down due to the | |
221 | cost of context switches. | |
222 | ||
223 | Qemu can emulate a number different of *CPU types* from 486 to the latest Xeon | |
224 | processors. Each new processor generation adds new features, like hardware | |
225 | assisted 3d rendering, random number generation, memory protection, etc ... | |
226 | Usually you should select for your VM a processor type which closely matches the | |
227 | CPU of the host system, as it means that the host CPU features (also called _CPU | |
228 | flags_ ) will be available in your VMs. If you want an exact match, you can set | |
229 | the CPU type to *host* in which case the VM will have exactly the same CPU flags | |
230 | as your host system. + | |
231 | This has a downside though. If you want to do a live migration of VMs between | |
232 | different hosts, your VM might end up on a new system with a different CPU type. | |
233 | If the CPU flags passed to the guest are missing, the qemu process will stop. To | |
234 | remedy this Qemu has also its own CPU type *kvm64*, that {pve} uses by defaults. | |
235 | kvm64 is a Pentium 4 look a like CPU type, which has a reduced CPU flags set, | |
236 | but is guaranteed to work everywhere. + | |
237 | In short, if you care about live migration and moving VMs between nodes, leave | |
238 | the kvm64 default. If you don’t care about live migration, set the CPU type to | |
239 | host, as in theory this will give your guests maximum performance. | |
240 | ||
241 | You can also optionally emulate a *NUMA* architecture in your VMs. The basics of | |
242 | the NUMA architecture mean that instead of having a global memory pool available | |
243 | to all your cores, the memory is spread into local banks close to each socket. | |
244 | This can bring speed improvements as the memory bus is not a bottleneck | |
245 | anymore. If your system has a NUMA architecture footnote:[if the command | |
246 | `numactl --hardware | grep available` returns more than one node, then your host | |
247 | system has a NUMA architecture] we recommend to activate the option, as this | |
248 | will allow proper distribution of the VM resources on the host system. This | |
249 | option is also required in {pve} to allow hotplugging of cores and RAM to a VM. | |
250 | ||
251 | If the NUMA option is used, it is recommended to set the number of sockets to | |
252 | the number of sockets of the host system. | |
253 | ||
80c0adcb DM |
254 | |
255 | [[qm_memory]] | |
34e541c5 EK |
256 | Memory |
257 | ~~~~~~ | |
80c0adcb | 258 | |
34e541c5 EK |
259 | For each VM you have the option to set a fixed size memory or asking |
260 | {pve} to dynamically allocate memory based on the current RAM usage of the | |
261 | host. | |
262 | ||
263 | When choosing a *fixed size memory* {pve} will simply allocate what you | |
264 | specify to your VM. | |
265 | ||
266 | // see autoballoon() in pvestatd.pm | |
267 | When choosing to *automatically allocate memory*, {pve} will make sure that the | |
268 | minimum amount you specified is always available to the VM, and if RAM usage on | |
269 | the host is below 80%, will dynamically add memory to the guest up to the | |
270 | maximum memory specified. + | |
271 | When the host is becoming short on RAM, the VM will then release some memory | |
272 | back to the host, swapping running processes if needed and starting the oom | |
273 | killer in last resort. The passing around of memory between host and guest is | |
274 | done via a special `balloon` kernel driver running inside the guest, which will | |
275 | grab or release memory pages from the host. | |
276 | footnote:[A good explanation of the inner workings of the balloon driver can be found here https://rwmj.wordpress.com/2010/07/17/virtio-balloon/] | |
277 | ||
c9f6e1a4 EK |
278 | When multiple VMs use the autoallocate facility, it is possible to set a |
279 | *Shares* coefficient which indicates the relative amount of the free host memory | |
280 | that each VM shoud take. Suppose for instance you have four VMs, three of them | |
281 | running a HTTP server and the last one is a database server. To cache more | |
282 | database blocks in the database server RAM, you would like to prioritize the | |
283 | database VM when spare RAM is available. For this you assign a Shares property | |
284 | of 3000 to the database VM, leaving the other VMs to the Shares default setting | |
285 | of 1000. The host server has 32GB of RAM, and is curring using 16GB, leaving 32 | |
286 | * 80/100 - 16 = 9GB RAM to be allocated to the VMs. The database VM will get 9 * | |
287 | 3000 / (3000 + 1000 + 1000 + 1000) = 4.5 GB extra RAM and each HTTP server will | |
288 | get 1/5 GB. | |
289 | ||
34e541c5 EK |
290 | All Linux distributions released after 2010 have the balloon kernel driver |
291 | included. For Windows OSes, the balloon driver needs to be added manually and can | |
292 | incur a slowdown of the guest, so we don't recommend using it on critical | |
293 | systems. | |
294 | // see https://forum.proxmox.com/threads/solved-hyper-threading-vs-no-hyper-threading-fixed-vs-variable-memory.20265/ | |
295 | ||
296 | When allocating RAMs to your VMs, a good rule of thumb is always to leave 1GB | |
297 | of RAM available to the host. | |
298 | ||
80c0adcb DM |
299 | |
300 | [[qm_network_device]] | |
1ff7835b EK |
301 | Network Device |
302 | ~~~~~~~~~~~~~~ | |
80c0adcb | 303 | |
1ff7835b EK |
304 | Each VM can have many _Network interface controllers_ (NIC), of four different |
305 | types: | |
306 | ||
307 | * *Intel E1000* is the default, and emulates an Intel Gigabit network card. | |
308 | * the *VirtIO* paravirtualized NIC should be used if you aim for maximum | |
309 | performance. Like all VirtIO devices, the guest OS should have the proper driver | |
310 | installed. | |
311 | * the *Realtek 8139* emulates an older 100 MB/s network card, and should | |
312 | only be used when emulating older operating systems ( released before 2002 ) | |
313 | * the *vmxnet3* is another paravirtualized device, which should only be used | |
314 | when importing a VM from another hypervisor. | |
315 | ||
316 | {pve} will generate for each NIC a random *MAC address*, so that your VM is | |
317 | addressable on Ethernet networks. | |
318 | ||
af9c6de1 EK |
319 | The NIC you added to the VM can follow one of two differents models: |
320 | ||
321 | * in the default *Bridged mode* each virtual NIC is backed on the host by a | |
322 | _tap device_, ( a software loopback device simulating an Ethernet NIC ). This | |
323 | tap device is added to a bridge, by default vmbr0 in {pve}. In this mode, VMs | |
324 | have direct access to the Ethernet LAN on which the host is located. | |
325 | * in the alternative *NAT mode*, each virtual NIC will only communicate with | |
326 | the Qemu user networking stack, where a builting router and DHCP server can | |
327 | provide network access. This built-in DHCP will serve adresses in the private | |
328 | 10.0.2.0/24 range. The NAT mode is much slower than the bridged mode, and | |
329 | should only be used for testing. | |
330 | ||
331 | You can also skip adding a network device when creating a VM by selecting *No | |
332 | network device*. | |
333 | ||
334 | .Multiqueue | |
1ff7835b | 335 | If you are using the VirtIO driver, you can optionally activate the |
af9c6de1 | 336 | *Multiqueue* option. This option allows the guest OS to process networking |
1ff7835b EK |
337 | packets using multiple virtual CPUs, providing an increase in the total number |
338 | of packets transfered. | |
339 | ||
340 | //http://blog.vmsplice.net/2011/09/qemu-internals-vhost-architecture.html | |
341 | When using the VirtIO driver with {pve}, each NIC network queue is passed to the | |
342 | host kernel, where the queue will be processed by a kernel thread spawn by the | |
343 | vhost driver. With this option activated, it is possible to pass _multiple_ | |
344 | network queues to the host kernel for each NIC. | |
345 | ||
346 | //https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Virtualization_Tuning_and_Optimization_Guide/sect-Virtualization_Tuning_Optimization_Guide-Networking-Techniques.html#sect-Virtualization_Tuning_Optimization_Guide-Networking-Multi-queue_virtio-net | |
af9c6de1 | 347 | When using Multiqueue, it is recommended to set it to a value equal |
1ff7835b EK |
348 | to the number of Total Cores of your guest. You also need to set in |
349 | the VM the number of multi-purpose channels on each VirtIO NIC with the ethtool | |
350 | command: | |
351 | ||
352 | `ethtool -L eth0 combined X` | |
353 | ||
354 | where X is the number of the number of vcpus of the VM. | |
355 | ||
af9c6de1 | 356 | You should note that setting the Multiqueue parameter to a value greater |
1ff7835b EK |
357 | than one will increase the CPU load on the host and guest systems as the |
358 | traffic increases. We recommend to set this option only when the VM has to | |
359 | process a great number of incoming connections, such as when the VM is running | |
360 | as a router, reverse proxy or a busy HTTP server doing long polling. | |
361 | ||
80c0adcb | 362 | |
685cc8e0 DC |
363 | USB Passthrough |
364 | ~~~~~~~~~~~~~~~ | |
80c0adcb | 365 | |
685cc8e0 DC |
366 | There are two different types of USB passthrough devices: |
367 | ||
368 | * Host USB passtrough | |
369 | * SPICE USB passthrough | |
370 | ||
371 | Host USB passthrough works by giving a VM a USB device of the host. | |
372 | This can either be done via the vendor- and product-id, or | |
373 | via the host bus and port. | |
374 | ||
375 | The vendor/product-id looks like this: *0123:abcd*, | |
376 | where *0123* is the id of the vendor, and *abcd* is the id | |
377 | of the product, meaning two pieces of the same usb device | |
378 | have the same id. | |
379 | ||
380 | The bus/port looks like this: *1-2.3.4*, where *1* is the bus | |
381 | and *2.3.4* is the port path. This represents the physical | |
382 | ports of your host (depending of the internal order of the | |
383 | usb controllers). | |
384 | ||
385 | If a device is present in a VM configuration when the VM starts up, | |
386 | but the device is not present in the host, the VM can boot without problems. | |
387 | As soon as the device/port ist available in the host, it gets passed through. | |
388 | ||
389 | WARNING: Using this kind of USB passthrough, means that you cannot move | |
390 | a VM online to another host, since the hardware is only available | |
391 | on the host the VM is currently residing. | |
392 | ||
393 | The second type of passthrough is SPICE USB passthrough. This is useful | |
394 | if you use a SPICE client which supports it. If you add a SPICE USB port | |
395 | to your VM, you can passthrough a USB device from where your SPICE client is, | |
396 | directly to the VM (for example an input device or hardware dongle). | |
397 | ||
80c0adcb DM |
398 | |
399 | [[qm_bios_and_uefi]] | |
076d60ae DC |
400 | BIOS and UEFI |
401 | ~~~~~~~~~~~~~ | |
402 | ||
403 | In order to properly emulate a computer, QEMU needs to use a firmware. | |
404 | By default QEMU uses *SeaBIOS* for this, which is an open-source, x86 BIOS | |
405 | implementation. SeaBIOS is a good choice for most standard setups. | |
406 | ||
407 | There are, however, some scenarios in which a BIOS is not a good firmware | |
408 | to boot from, e.g. if you want to do VGA passthrough. footnote:[Alex Williamson has a very good blog entry about this. | |
409 | http://vfio.blogspot.co.at/2014/08/primary-graphics-assignment-without-vga.html] | |
410 | In such cases, you should rather use *OVMF*, which is an open-source UEFI implemenation. footnote:[See the OVMF Project http://www.tianocore.org/ovmf/] | |
411 | ||
412 | If you want to use OVMF, there are several things to consider: | |
413 | ||
414 | In order to save things like the *boot order*, there needs to be an EFI Disk. | |
415 | This disk will be included in backups and snapshots, and there can only be one. | |
416 | ||
417 | You can create such a disk with the following command: | |
418 | ||
419 | qm set <vmid> -efidisk0 <storage>:1,format=<format> | |
420 | ||
421 | Where *<storage>* is the storage where you want to have the disk, and | |
422 | *<format>* is a format which the storage supports. Alternatively, you can | |
423 | create such a disk through the web interface with 'Add' -> 'EFI Disk' in the | |
424 | hardware section of a VM. | |
425 | ||
426 | When using OVMF with a virtual display (without VGA passthrough), | |
427 | you need to set the client resolution in the OVMF menu(which you can reach | |
428 | with a press of the ESC button during boot), or you have to choose | |
429 | SPICE as the display type. | |
430 | ||
431 | ||
8c1189b6 | 432 | Managing Virtual Machines with `qm` |
dd042288 | 433 | ------------------------------------ |
f69cfd23 | 434 | |
dd042288 | 435 | qm is the tool to manage Qemu/Kvm virtual machines on {pve}. You can |
f69cfd23 DM |
436 | create and destroy virtual machines, and control execution |
437 | (start/stop/suspend/resume). Besides that, you can use qm to set | |
438 | parameters in the associated config file. It is also possible to | |
439 | create and delete virtual disks. | |
440 | ||
dd042288 EK |
441 | CLI Usage Examples |
442 | ~~~~~~~~~~~~~~~~~~ | |
443 | ||
444 | Create a new VM with 4 GB IDE disk. | |
445 | ||
446 | qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso | |
447 | ||
448 | Start the new VM | |
449 | ||
450 | qm start 300 | |
451 | ||
452 | Send a shutdown request, then wait until the VM is stopped. | |
453 | ||
454 | qm shutdown 300 && qm wait 300 | |
455 | ||
456 | Same as above, but only wait for 40 seconds. | |
457 | ||
458 | qm shutdown 300 && qm wait 300 -timeout 40 | |
459 | ||
f69cfd23 DM |
460 | Configuration |
461 | ------------- | |
462 | ||
463 | All configuration files consists of lines in the form | |
464 | ||
465 | PARAMETER: value | |
466 | ||
871e1fd6 | 467 | Configuration files are stored inside the Proxmox cluster file |
8c1189b6 | 468 | system, and can be accessed at `/etc/pve/qemu-server/<VMID>.conf`. |
f69cfd23 | 469 | |
80c0adcb | 470 | [[qm_options]] |
a7f36905 DM |
471 | Options |
472 | ~~~~~~~ | |
473 | ||
474 | include::qm.conf.5-opts.adoc[] | |
475 | ||
f69cfd23 DM |
476 | |
477 | Locks | |
478 | ----- | |
479 | ||
8c1189b6 | 480 | Online migrations and backups (`vzdump`) set a lock to prevent incompatible |
871e1fd6 FG |
481 | concurrent actions on the affected VMs. Sometimes you need to remove such a |
482 | lock manually (e.g., after a power failure). | |
f69cfd23 DM |
483 | |
484 | qm unlock <vmid> | |
485 | ||
f69cfd23 DM |
486 | |
487 | ifdef::manvolnum[] | |
488 | include::pve-copyright.adoc[] | |
489 | endif::manvolnum[] |