qm: vmgenid: fix spacing and reword,
[pve-docs.git] / qm.adoc
1 [[chapter_virtual_machines]]
2 ifdef::manvolnum[]
3 qm(1)
4 =====
5 :pve-toplevel:
6
7 NAME
8 ----
9
10 qm - Qemu/KVM Virtual Machine Manager
11
12
13 SYNOPSIS
14 --------
15
16 include::qm.1-synopsis.adoc[]
17
18 DESCRIPTION
19 -----------
20 endif::manvolnum[]
21 ifndef::manvolnum[]
22 Qemu/KVM Virtual Machines
23 =========================
24 :pve-toplevel:
25 endif::manvolnum[]
26
27 // deprecates
28 // http://pve.proxmox.com/wiki/Container_and_Full_Virtualization
29 // http://pve.proxmox.com/wiki/KVM
30 // http://pve.proxmox.com/wiki/Qemu_Server
31
32 Qemu (short form for Quick Emulator) is an open source hypervisor that emulates a
33 physical computer. From the perspective of the host system where Qemu is
34 running, Qemu is a user program which has access to a number of local resources
35 like partitions, files, network cards which are then passed to an
36 emulated computer which sees them as if they were real devices.
37
38 A guest operating system running in the emulated computer accesses these
39 devices, and runs as it were running on real hardware. For instance you can pass
40 an iso image as a parameter to Qemu, and the OS running in the emulated computer
41 will see a real CDROM inserted in a CD drive.
42
43 Qemu can emulate a great variety of hardware from ARM to Sparc, but {pve} is
44 only concerned with 32 and 64 bits PC clone emulation, since it represents the
45 overwhelming majority of server hardware. The emulation of PC clones is also one
46 of the fastest due to the availability of processor extensions which greatly
47 speed up Qemu when the emulated architecture is the same as the host
48 architecture.
49
50 NOTE: You may sometimes encounter the term _KVM_ (Kernel-based Virtual Machine).
51 It means that Qemu is running with the support of the virtualization processor
52 extensions, via the Linux kvm module. In the context of {pve} _Qemu_ and
53 _KVM_ can be used interchangeably as Qemu in {pve} will always try to load the kvm
54 module.
55
56 Qemu inside {pve} runs as a root process, since this is required to access block
57 and PCI devices.
58
59
60 Emulated devices and paravirtualized devices
61 --------------------------------------------
62
63 The PC hardware emulated by Qemu includes a mainboard, network controllers,
64 scsi, ide and sata controllers, serial ports (the complete list can be seen in
65 the `kvm(1)` man page) all of them emulated in software. All these devices
66 are the exact software equivalent of existing hardware devices, and if the OS
67 running in the guest has the proper drivers it will use the devices as if it
68 were running on real hardware. This allows Qemu to runs _unmodified_ operating
69 systems.
70
71 This however has a performance cost, as running in software what was meant to
72 run in hardware involves a lot of extra work for the host CPU. To mitigate this,
73 Qemu can present to the guest operating system _paravirtualized devices_, where
74 the guest OS recognizes it is running inside Qemu and cooperates with the
75 hypervisor.
76
77 Qemu relies on the virtio virtualization standard, and is thus able to present
78 paravirtualized virtio devices, which includes a paravirtualized generic disk
79 controller, a paravirtualized network card, a paravirtualized serial port,
80 a paravirtualized SCSI controller, etc ...
81
82 It is highly recommended to use the virtio devices whenever you can, as they
83 provide a big performance improvement. Using  the virtio generic disk controller
84 versus an emulated IDE controller will double the sequential write throughput,
85 as measured with `bonnie++(8)`. Using the virtio network interface can deliver
86 up to three times the throughput of an emulated Intel E1000 network card, as
87 measured with `iperf(1)`. footnote:[See this benchmark on the KVM wiki
88 http://www.linux-kvm.org/page/Using_VirtIO_NIC]
89
90
91 [[qm_virtual_machines_settings]]
92 Virtual Machines Settings
93 -------------------------
94
95 Generally speaking {pve} tries to choose sane defaults for virtual machines
96 (VM). Make sure you understand the meaning of the settings you change, as it
97 could incur a performance slowdown, or putting your data at risk.
98
99
100 [[qm_general_settings]]
101 General Settings
102 ~~~~~~~~~~~~~~~~
103
104 [thumbnail="screenshot/gui-create-vm-general.png"]
105
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
113
114 [[qm_os_settings]]
115 OS Settings
116 ~~~~~~~~~~~
117
118 [thumbnail="screenshot/gui-create-vm-os.png"]
119
120 When creating a VM, setting the proper Operating System(OS) allows {pve} to
121 optimize some low level parameters. For instance Windows OS expect the BIOS
122 clock to use the local time, while Unix based OS expect the BIOS clock to have
123 the UTC time.
124
125
126 [[qm_hard_disk]]
127 Hard Disk
128 ~~~~~~~~~
129
130 Qemu can emulate a number of storage controllers:
131
132 * the *IDE* controller, has a design which goes back to the 1984 PC/AT disk
133 controller. Even if this controller has been superseded by recent designs,
134 each and every OS you can think of has support for it, making it a great choice
135 if you want to run an OS released before 2003. You can connect up to 4 devices
136 on this controller.
137
138 * the *SATA* (Serial ATA) controller, dating from 2003, has a more modern
139 design, allowing higher throughput and a greater number of devices to be
140 connected. You can connect up to 6 devices on this controller.
141
142 * the *SCSI* controller, designed in 1985, is commonly found on server grade
143 hardware, and can connect up to 14 storage devices. {pve} emulates by default a
144 LSI 53C895A controller.
145 +
146 A SCSI controller of type _VirtIO SCSI_ is the recommended setting if you aim for
147 performance and is automatically selected for newly created Linux VMs since
148 {pve} 4.3. Linux distributions have support for this controller since 2012, and
149 FreeBSD since 2014. For Windows OSes, you need to provide an extra iso
150 containing the drivers during the installation.
151 // https://pve.proxmox.com/wiki/Paravirtualized_Block_Drivers_for_Windows#During_windows_installation.
152 If you aim at maximum performance, you can select a SCSI controller of type
153 _VirtIO SCSI single_ which will allow you to select the *IO Thread* option.
154 When selecting _VirtIO SCSI single_ Qemu will create a new controller for
155 each disk, instead of adding all disks to the same controller.
156
157 * The *VirtIO Block* controller, often just called VirtIO or virtio-blk,
158 is an older type of paravirtualized controller. It has been superseded by the
159 VirtIO SCSI Controller, in terms of features.
160
161 [thumbnail="screenshot/gui-create-vm-hard-disk.png"]
162 On each controller you attach a number of emulated hard disks, which are backed
163 by a file or a block device residing in the configured storage. The choice of
164 a storage type will determine the format of the hard disk image. Storages which
165 present block devices (LVM, ZFS, Ceph) will require the *raw disk image format*,
166 whereas files based storages (Ext4, NFS, CIFS, GlusterFS) will let you to choose
167 either the *raw disk image format* or the *QEMU image format*.
168
169  * the *QEMU image format* is a copy on write format which allows snapshots, and
170   thin provisioning of the disk image.
171  * the *raw disk image* is a bit-to-bit image of a hard disk, similar to what
172  you would get when executing the `dd` command on a block device in Linux. This
173  format does not support thin provisioning or snapshots by itself, requiring
174  cooperation from the storage layer for these tasks. It may, however, be up to
175  10% faster than the *QEMU image format*. footnote:[See this benchmark for details
176  http://events.linuxfoundation.org/sites/events/files/slides/CloudOpen2013_Khoa_Huynh_v3.pdf]
177  * the *VMware image format* only makes sense if you intend to import/export the
178  disk image to other hypervisors.
179
180 Setting the *Cache* mode of the hard drive will impact how the host system will
181 notify the guest systems of block write completions. The *No cache* default
182 means that the guest system will be notified that a write is complete when each
183 block reaches the physical storage write queue, ignoring the host page cache.
184 This provides a good balance between safety and speed.
185
186 If you want the {pve} backup manager to skip a disk when doing a backup of a VM,
187 you can set the *No backup* option on that disk.
188
189 If you want the {pve} storage replication mechanism to skip a disk when starting
190  a replication job, you can set the *Skip replication* option on that disk.
191 As of {pve} 5.0, replication requires the disk images to be on a storage of type
192 `zfspool`, so adding a disk image to other storages when the VM has replication
193 configured requires to skip replication for this disk image.
194
195 If your storage supports _thin provisioning_ (see the storage chapter in the
196 {pve} guide), and your VM has a *SCSI* controller you can activate the *Discard*
197 option on the hard disks connected to that controller. With *Discard* enabled,
198 when the filesystem of a VM marks blocks as unused after removing files, the
199 emulated SCSI controller will relay this information to the storage, which will
200 then shrink the disk image accordingly.
201
202 .IO Thread
203 The option *IO Thread* can only be used when using a disk with the
204 *VirtIO* controller, or with the *SCSI* controller, when the emulated controller
205  type is  *VirtIO SCSI single*.
206 With this enabled, Qemu creates one I/O thread per storage controller,
207 instead of a single thread for all I/O, so it increases performance when
208 multiple disks are used and each disk has its own storage controller.
209 Note that backups do not currently work with *IO Thread* enabled.
210
211
212 [[qm_cpu]]
213 CPU
214 ~~~
215
216 [thumbnail="screenshot/gui-create-vm-cpu.png"]
217
218 A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU.
219 This CPU can then contain one or many *cores*, which are independent
220 processing units. Whether you have a single CPU socket with 4 cores, or two CPU
221 sockets with two cores is mostly irrelevant from a performance point of view.
222 However some software licenses depend on the number of sockets a machine has,
223 in that case it makes sense to set the number of sockets to what the license
224 allows you.
225
226 Increasing the number of virtual cpus (cores and sockets) will usually provide a
227 performance improvement though that is heavily dependent on the use of the VM.
228 Multithreaded applications will of course benefit from a large number of
229 virtual cpus, as for each virtual cpu you add, Qemu will create a new thread of
230 execution on the host system. If you're not sure about the workload of your VM,
231 it is usually a safe bet to set the number of *Total cores* to 2.
232
233 NOTE: It is perfectly safe if the _overall_ number of cores of all your VMs
234 is greater than the number of cores on the server (e.g., 4 VMs with each 4
235 cores on a machine with only 8 cores). In that case the host system will
236 balance the Qemu execution threads between your server cores, just like if you
237 were running a standard multithreaded application. However, {pve} will prevent
238 you from assigning more virtual CPU cores than physically available, as this will
239 only bring the performance down due to the cost of context switches.
240
241 [[qm_cpu_resource_limits]]
242 Resource Limits
243 ^^^^^^^^^^^^^^^
244
245 In addition to the number of virtual cores, you can configure how much resources
246 a VM can get in relation to the host CPU time and also in relation to other
247 VMs.
248 With the *cpulimit* (``Host CPU Time'') option you can limit how much CPU time
249 the whole VM can use on the host. It is a floating point value representing CPU
250 time in percent, so `1.0` is equal to `100%`, `2.5` to `250%` and so on. If a
251 single process would fully use one single core it would have `100%` CPU Time
252 usage. If a VM with four cores utilizes all its cores fully it would
253 theoretically use `400%`. In reality the usage may be even a bit higher as Qemu
254 can have additional threads for VM peripherals besides the vCPU core ones.
255 This setting can be useful if a VM should have multiple vCPUs, as it runs a few
256 processes in parallel, but the VM as a whole should not be able to run all
257 vCPUs at 100% at the same time. Using a specific example: lets say we have a VM
258 which would profit from having 8 vCPUs, but at no time all of those 8 cores
259 should run at full load - as this would make the server so overloaded that
260 other VMs and CTs would get to less CPU. So, we set the *cpulimit* limit to
261 `4.0` (=400%). If all cores do the same heavy work they would all get 50% of a
262 real host cores CPU time. But, if only 4 would do work they could still get
263 almost 100% of a real core each.
264
265 NOTE: VMs can, depending on their configuration, use additional threads e.g.,
266 for networking or IO operations but also live migration. Thus a VM can show up
267 to use more CPU time than just its virtual CPUs could use. To ensure that a VM
268 never uses more CPU time than virtual CPUs assigned set the *cpulimit* setting
269 to the same value as the total core count.
270
271 The second CPU resource limiting setting, *cpuunits* (nowadays often called CPU
272 shares or CPU weight), controls how much CPU time a VM gets in regards to other
273 VMs running.  It is a relative weight which defaults to `1024`, if you increase
274 this for a VM it will be prioritized by the scheduler in comparison to other
275 VMs with lower weight. E.g., if VM 100 has set the default 1024 and VM 200 was
276 changed to `2048`, the latter VM 200 would receive twice the CPU bandwidth than
277 the first VM 100.
278
279 For more information see `man systemd.resource-control`, here `CPUQuota`
280 corresponds to `cpulimit` and `CPUShares` corresponds to our `cpuunits`
281 setting, visit its Notes section for references and implementation details.
282
283 CPU Type
284 ^^^^^^^^
285
286 Qemu can emulate a number different of *CPU types* from 486 to the latest Xeon
287 processors. Each new processor generation adds new features, like hardware
288 assisted 3d rendering, random number generation, memory protection, etc ...
289 Usually you should select for your VM a processor type which closely matches the
290 CPU of the host system, as it means that the host CPU features (also called _CPU
291 flags_ ) will be available in your VMs. If you want an exact match, you can set
292 the CPU type to *host* in which case the VM will have exactly the same CPU flags
293 as your host system.
294
295 This has a downside though. If you want to do a live migration of VMs between
296 different hosts, your VM might end up on a new system with a different CPU type.
297 If the CPU flags passed to the guest are missing, the qemu process will stop. To
298 remedy this Qemu has also its own CPU type *kvm64*, that {pve} uses by defaults.
299 kvm64 is a Pentium 4 look a like CPU type, which has a reduced CPU flags set,
300 but is guaranteed to work everywhere.
301
302 In short, if you care about live migration and moving VMs between nodes, leave
303 the kvm64 default. If you don’t care about live migration or have a homogeneous
304 cluster where all nodes have the same CPU, set the CPU type to host, as in
305 theory this will give your guests maximum performance.
306
307 Meltdown / Spectre related CPU flags
308 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
309
310 There are two CPU flags related to the Meltdown and Spectre vulnerabilities
311 footnote:[Meltdown Attack https://meltdownattack.com/] which need to be set
312 manually unless the selected CPU type of your VM already enables them by default.
313
314 The first, called 'pcid', helps to reduce the performance impact of the Meltdown
315 mitigation called 'Kernel Page-Table Isolation (KPTI)', which effectively hides
316 the Kernel memory from the user space. Without PCID, KPTI is quite an expensive
317 mechanism footnote:[PCID is now a critical performance/security feature on x86
318 https://groups.google.com/forum/m/#!topic/mechanical-sympathy/L9mHTbeQLNU].
319
320 The second CPU flag is called 'spec-ctrl', which allows an operating system to
321 selectively disable or restrict speculative execution in order to limit the
322 ability of attackers to exploit the Spectre vulnerability.
323
324 There are two requirements that need to be fulfilled in order to use these two
325 CPU flags:
326
327 * The host CPU(s) must support the feature and propagate it to the guest's virtual CPU(s)
328 * The guest operating system must be updated to a version which mitigates the
329   attacks and is able to utilize the CPU feature
330
331 In order to use 'spec-ctrl', your CPU or system vendor also needs to provide a
332 so-called ``microcode update'' footnote:[You can use `intel-microcode' /
333 `amd-microcode' from Debian non-free if your vendor does not provide such an
334 update. Note that not all affected CPUs can be updated to support spec-ctrl.]
335 for your CPU.
336
337 To check if the {pve} host supports PCID, execute the following command as root:
338
339 ----
340 # grep ' pcid ' /proc/cpuinfo
341 ----
342
343 If this does not return empty your host's CPU has support for 'pcid'.
344
345 To check if the {pve} host supports spec-ctrl, execute the following command as root:
346
347 ----
348 # grep ' spec_ctrl ' /proc/cpuinfo
349 ----
350
351 If this does not return empty your host's CPU has support for 'spec-ctrl'.
352
353 If you use `host' or another CPU type which enables the desired flags by
354 default, and you updated your guest OS to make use of the associated CPU
355 features, you're already set.
356
357 Otherwise you need to set the desired CPU flag of the virtual CPU, either by
358 editing the CPU options in the WebUI, or by setting the 'flags' property of the
359 'cpu' option in the VM configuration file.
360
361 NUMA
362 ^^^^
363 You can also optionally emulate a *NUMA*
364 footnote:[https://en.wikipedia.org/wiki/Non-uniform_memory_access] architecture
365 in your VMs. The basics of the NUMA architecture mean that instead of having a
366 global memory pool available to all your cores, the memory is spread into local
367 banks close to each socket.
368 This can bring speed improvements as the memory bus is not a bottleneck
369 anymore. If your system has a NUMA architecture footnote:[if the command
370 `numactl --hardware | grep available` returns more than one node, then your host
371 system has a NUMA architecture] we recommend to activate the option, as this
372 will allow proper distribution of the VM resources on the host system.
373 This option is also required to hot-plug cores or RAM in a VM.
374
375 If the NUMA option is used, it is recommended to set the number of sockets to
376 the number of sockets of the host system.
377
378 vCPU hot-plug
379 ^^^^^^^^^^^^^
380
381 Modern operating systems introduced the capability to hot-plug and, to a
382 certain extent, hot-unplug CPUs in a running systems. Virtualisation allows us
383 to avoid a lot of the (physical) problems real hardware can cause in such
384 scenarios.
385 Still, this is a rather new and complicated feature, so its use should be
386 restricted to cases where its absolutely needed. Most of the functionality can
387 be replicated with other, well tested and less complicated, features, see
388 xref:qm_cpu_resource_limits[Resource Limits].
389
390 In {pve} the maximal number of plugged CPUs is always `cores * sockets`.
391 To start a VM with less than this total core count of CPUs you may use the
392 *vpus* setting, it denotes how many vCPUs should be plugged in at VM start.
393
394 Currently only this feature is only supported on Linux, a kernel newer than 3.10
395 is needed, a kernel newer than 4.7 is recommended.
396
397 You can use a udev rule as follow to automatically set new CPUs as online in
398 the guest:
399
400 ----
401 SUBSYSTEM=="cpu", ACTION=="add", TEST=="online", ATTR{online}=="0", ATTR{online}="1"
402 ----
403
404 Save this under /etc/udev/rules.d/ as a file ending in `.rules`.
405
406 Note: CPU hot-remove is machine dependent and requires guest cooperation.
407 The deletion command does not guarantee CPU removal to actually happen,
408 typically it's a request forwarded to guest using target dependent mechanism,
409 e.g., ACPI on x86/amd64.
410
411
412 [[qm_memory]]
413 Memory
414 ~~~~~~
415
416 For each VM you have the option to set a fixed size memory or asking
417 {pve} to dynamically allocate memory based on the current RAM usage of the
418 host.
419
420 .Fixed Memory Allocation
421 [thumbnail="screenshot/gui-create-vm-memory.png"]
422
423 When setting memory and minimum memory to the same amount
424 {pve} will simply allocate what you specify to your VM.
425
426 Even when using a fixed memory size, the ballooning device gets added to the
427 VM, because it delivers useful information such as how much memory the guest
428 really uses.
429 In general, you should leave *ballooning* enabled, but if you want to disable
430 it (e.g. for debugging purposes), simply uncheck
431 *Ballooning Device* or set
432
433  balloon: 0
434
435 in the configuration.
436
437 .Automatic Memory Allocation
438
439 // see autoballoon() in pvestatd.pm
440 When setting the minimum memory lower than memory, {pve} will make sure that the
441 minimum amount you specified is always available to the VM, and if RAM usage on
442 the host is below 80%, will dynamically add memory to the guest up to the
443 maximum memory specified.
444
445 When the host is running low on RAM, the VM will then release some memory
446 back to the host, swapping running processes if needed and starting the oom
447 killer in last resort. The passing around of memory between host and guest is
448 done via a special `balloon` kernel driver running inside the guest, which will
449 grab or release memory pages from the host.
450 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/]
451
452 When multiple VMs use the autoallocate facility, it is possible to set a
453 *Shares* coefficient which indicates the relative amount of the free host memory
454 that each VM should take. Suppose for instance you have four VMs, three of them
455 running an HTTP server and the last one is a database server. To cache more
456 database blocks in the database server RAM, you would like to prioritize the
457 database VM when spare RAM is available. For this you assign a Shares property
458 of 3000 to the database VM, leaving the other VMs to the Shares default setting
459 of 1000. The host server has 32GB of RAM, and is currently using 16GB, leaving 32
460 * 80/100 - 16 = 9GB RAM to be allocated to the VMs. The database VM will get 9 *
461 3000 / (3000 + 1000 + 1000 + 1000) = 4.5 GB extra RAM and each HTTP server will
462 get 1.5 GB.
463
464 All Linux distributions released after 2010 have the balloon kernel driver
465 included. For Windows OSes, the balloon driver needs to be added manually and can
466 incur a slowdown of the guest, so we don't recommend using it on critical
467 systems.
468 // see https://forum.proxmox.com/threads/solved-hyper-threading-vs-no-hyper-threading-fixed-vs-variable-memory.20265/
469
470 When allocating RAM to your VMs, a good rule of thumb is always to leave 1GB
471 of RAM available to the host.
472
473
474 [[qm_network_device]]
475 Network Device
476 ~~~~~~~~~~~~~~
477
478 [thumbnail="screenshot/gui-create-vm-network.png"]
479
480 Each VM can have many _Network interface controllers_ (NIC), of four different
481 types:
482
483  * *Intel E1000* is the default, and emulates an Intel Gigabit network card.
484  * the *VirtIO* paravirtualized NIC should be used if you aim for maximum
485 performance. Like all VirtIO devices, the guest OS should have the proper driver
486 installed.
487  * the *Realtek 8139* emulates an older 100 MB/s network card, and should
488 only be used when emulating older operating systems ( released before 2002 )
489  * the *vmxnet3* is another paravirtualized device, which should only be used
490 when importing a VM from another hypervisor.
491
492 {pve} will generate for each NIC a random *MAC address*, so that your VM is
493 addressable on Ethernet networks.
494
495 The NIC you added to the VM can follow one of two different models:
496
497  * in the default *Bridged mode* each virtual NIC is backed on the host by a
498 _tap device_, ( a software loopback device simulating an Ethernet NIC ). This
499 tap device is added to a bridge, by default vmbr0 in {pve}. In this mode, VMs
500 have direct access to the Ethernet LAN on which the host is located.
501  * in the alternative *NAT mode*, each virtual NIC will only communicate with
502 the Qemu user networking stack, where a built-in router and DHCP server can
503 provide network access. This built-in DHCP will serve addresses in the private
504 10.0.2.0/24 range. The NAT mode is much slower than the bridged mode, and
505 should only be used for testing. This mode is only available via CLI or the API,
506 but not via the WebUI.
507
508 You can also skip adding a network device when creating a VM by selecting *No
509 network device*.
510
511 .Multiqueue
512 If you are using the VirtIO driver, you can optionally activate the
513 *Multiqueue* option. This option allows the guest OS to process networking
514 packets using multiple virtual CPUs, providing an increase in the total number
515 of packets transferred.
516
517 //http://blog.vmsplice.net/2011/09/qemu-internals-vhost-architecture.html
518 When using the VirtIO driver with {pve}, each NIC network queue is passed to the
519 host kernel, where the queue will be processed by a kernel thread spawned by the
520 vhost driver. With this option activated, it is possible to pass _multiple_
521 network queues to the host kernel for each NIC.
522
523 //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
524 When using Multiqueue, it is recommended to set it to a value equal
525 to the number of Total Cores of your guest. You also need to set in
526 the VM the number of multi-purpose channels on each VirtIO NIC with the ethtool
527 command:
528
529 `ethtool -L ens1 combined X`
530
531 where X is the number of the number of vcpus of the VM.
532
533 You should note that setting the Multiqueue parameter to a value greater
534 than one will increase the CPU load on the host and guest systems as the
535 traffic increases. We recommend to set this option only when the VM has to
536 process a great number of incoming connections, such as when the VM is running
537 as a router, reverse proxy or a busy HTTP server doing long polling.
538
539
540 [[qm_usb_passthrough]]
541 USB Passthrough
542 ~~~~~~~~~~~~~~~
543
544 There are two different types of USB passthrough devices:
545
546 * Host USB passthrough
547 * SPICE USB passthrough
548
549 Host USB passthrough works by giving a VM a USB device of the host.
550 This can either be done via the vendor- and product-id, or
551 via the host bus and port.
552
553 The vendor/product-id looks like this: *0123:abcd*,
554 where *0123* is the id of the vendor, and *abcd* is the id
555 of the product, meaning two pieces of the same usb device
556 have the same id.
557
558 The bus/port looks like this: *1-2.3.4*, where *1* is the bus
559 and *2.3.4* is the port path. This represents the physical
560 ports of your host (depending of the internal order of the
561 usb controllers).
562
563 If a device is present in a VM configuration when the VM starts up,
564 but the device is not present in the host, the VM can boot without problems.
565 As soon as the device/port is available in the host, it gets passed through.
566
567 WARNING: Using this kind of USB passthrough means that you cannot move
568 a VM online to another host, since the hardware is only available
569 on the host the VM is currently residing.
570
571 The second type of passthrough is SPICE USB passthrough. This is useful
572 if you use a SPICE client which supports it. If you add a SPICE USB port
573 to your VM, you can passthrough a USB device from where your SPICE client is,
574 directly to the VM (for example an input device or hardware dongle).
575
576
577 [[qm_bios_and_uefi]]
578 BIOS and UEFI
579 ~~~~~~~~~~~~~
580
581 In order to properly emulate a computer, QEMU needs to use a firmware.
582 By default QEMU uses *SeaBIOS* for this, which is an open-source, x86 BIOS
583 implementation. SeaBIOS is a good choice for most standard setups.
584
585 There are, however, some scenarios in which a BIOS is not a good firmware
586 to boot from, e.g. if you want to do VGA passthrough. footnote:[Alex Williamson has a very good blog entry about this.
587 http://vfio.blogspot.co.at/2014/08/primary-graphics-assignment-without-vga.html]
588 In such cases, you should rather use *OVMF*, which is an open-source UEFI implementation. footnote:[See the OVMF Project http://www.tianocore.org/ovmf/]
589
590 If you want to use OVMF, there are several things to consider:
591
592 In order to save things like the *boot order*, there needs to be an EFI Disk.
593 This disk will be included in backups and snapshots, and there can only be one.
594
595 You can create such a disk with the following command:
596
597  qm set <vmid> -efidisk0 <storage>:1,format=<format>
598
599 Where *<storage>* is the storage where you want to have the disk, and
600 *<format>* is a format which the storage supports. Alternatively, you can
601 create such a disk through the web interface with 'Add' -> 'EFI Disk' in the
602 hardware section of a VM.
603
604 When using OVMF with a virtual display (without VGA passthrough),
605 you need to set the client resolution in the OVMF menu(which you can reach
606 with a press of the ESC button during boot), or you have to choose
607 SPICE as the display type.
608
609 [[qm_startup_and_shutdown]]
610 Automatic Start and Shutdown of Virtual Machines
611 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
612
613 After creating your VMs, you probably want them to start automatically
614 when the host system boots. For this you need to select the option 'Start at
615 boot' from the 'Options' Tab of your VM in the web interface, or set it with
616 the following command:
617
618  qm set <vmid> -onboot 1
619
620 .Start and Shutdown Order
621
622 [thumbnail="screenshot/gui-qemu-edit-start-order.png"]
623
624 In some case you want to be able to fine tune the boot order of your
625 VMs, for instance if one of your VM is providing firewalling or DHCP
626 to other guest systems.  For this you can use the following
627 parameters:
628
629 * *Start/Shutdown order*: Defines the start order priority. E.g. set it to 1 if
630 you want the VM to be the first to be started. (We use the reverse startup
631 order for shutdown, so a machine with a start order of 1 would be the last to
632 be shut down). If multiple VMs have the same order defined on a host, they will
633 additionally be ordered by 'VMID' in ascending order.
634 * *Startup delay*: Defines the interval between this VM start and subsequent
635 VMs starts . E.g. set it to 240 if you want to wait 240 seconds before starting
636 other VMs.
637 * *Shutdown timeout*: Defines the duration in seconds {pve} should wait
638 for the VM to be offline after issuing a shutdown command.
639 By default this value is set to 180, which means that {pve} will issue a
640 shutdown request and wait 180 seconds for the machine to be offline. If
641 the machine is still online after the timeout it will be stopped forcefully.
642
643 NOTE: VMs managed by the HA stack do not follow the 'start on boot' and
644 'boot order' options currently. Those VMs will be skipped by the startup and
645 shutdown algorithm as the HA manager itself ensures that VMs get started and
646 stopped.
647
648 Please note that machines without a Start/Shutdown order parameter will always
649 start after those where the parameter is set. Further, this parameter can only
650 be enforced between virtual machines running on the same host, not
651 cluster-wide.
652
653
654 [[qm_migration]]
655 Migration
656 ---------
657
658 [thumbnail="screenshot/gui-qemu-migrate.png"]
659
660 If you have a cluster, you can migrate your VM to another host with
661
662  qm migrate <vmid> <target>
663
664 There are generally two mechanisms for this
665
666 * Online Migration (aka Live Migration)
667 * Offline Migration
668
669 Online Migration
670 ~~~~~~~~~~~~~~~~
671
672 When your VM is running and it has no local resources defined (such as disks
673 on local storage, passed through devices, etc.) you can initiate a live
674 migration with the -online flag.
675
676 How it works
677 ^^^^^^^^^^^^
678
679 This starts a Qemu Process on the target host with the 'incoming' flag, which
680 means that the process starts and waits for the memory data and device states
681 from the source Virtual Machine (since all other resources, e.g. disks,
682 are shared, the memory content and device state are the only things left
683 to transmit).
684
685 Once this connection is established, the source begins to send the memory
686 content asynchronously to the target. If the memory on the source changes,
687 those sections are marked dirty and there will be another pass of sending data.
688 This happens until the amount of data to send is so small that it can
689 pause the VM on the source, send the remaining data to the target and start
690 the VM on the target in under a second.
691
692 Requirements
693 ^^^^^^^^^^^^
694
695 For Live Migration to work, there are some things required:
696
697 * The VM has no local resources (e.g. passed through devices, local disks, etc.)
698 * The hosts are in the same {pve} cluster.
699 * The hosts have a working (and reliable) network connection.
700 * The target host must have the same or higher versions of the
701   {pve} packages. (It *might* work the other way, but this is never guaranteed)
702
703 Offline Migration
704 ~~~~~~~~~~~~~~~~~
705
706 If you have local resources, you can still offline migrate your VMs,
707 as long as all disk are on storages, which are defined on both hosts.
708 Then the migration will copy the disk over the network to the target host.
709
710 [[qm_copy_and_clone]]
711 Copies and Clones
712 -----------------
713
714 [thumbnail="screenshot/gui-qemu-full-clone.png"]
715
716 VM installation is usually done using an installation media (CD-ROM)
717 from the operation system vendor. Depending on the OS, this can be a
718 time consuming task one might want to avoid.
719
720 An easy way to deploy many VMs of the same type is to copy an existing
721 VM. We use the term 'clone' for such copies, and distinguish between
722 'linked' and 'full' clones.
723
724 Full Clone::
725
726 The result of such copy is an independent VM. The
727 new VM does not share any storage resources with the original.
728 +
729
730 It is possible to select a *Target Storage*, so one can use this to
731 migrate a VM to a totally different storage. You can also change the
732 disk image *Format* if the storage driver supports several formats.
733 +
734
735 NOTE: A full clone need to read and copy all VM image data. This is
736 usually much slower than creating a linked clone.
737 +
738
739 Some storage types allows to copy a specific *Snapshot*, which
740 defaults to the 'current' VM data. This also means that the final copy
741 never includes any additional snapshots from the original VM.
742
743
744 Linked Clone::
745
746 Modern storage drivers supports a way to generate fast linked
747 clones. Such a clone is a writable copy whose initial contents are the
748 same as the original data. Creating a linked clone is nearly
749 instantaneous, and initially consumes no additional space.
750 +
751
752 They are called 'linked' because the new image still refers to the
753 original. Unmodified data blocks are read from the original image, but
754 modification are written (and afterwards read) from a new
755 location. This technique is called 'Copy-on-write'.
756 +
757
758 This requires that the original volume is read-only. With {pve} one
759 can convert any VM into a read-only <<qm_templates, Template>>). Such
760 templates can later be used to create linked clones efficiently.
761 +
762
763 NOTE: You cannot delete the original template while linked clones
764 exists.
765 +
766
767 It is not possible to change the *Target storage* for linked clones,
768 because this is a storage internal feature.
769
770
771 The *Target node* option allows you to create the new VM on a
772 different node. The only restriction is that the VM is on shared
773 storage, and that storage is also available on the target node.
774
775 To avoid resource conflicts, all network interface MAC addresses gets
776 randomized, and we generate a new 'UUID' for the VM BIOS (smbios1)
777 setting.
778
779
780 [[qm_templates]]
781 Virtual Machine Templates
782 -------------------------
783
784 One can convert a VM into a Template. Such templates are read-only,
785 and you can use them to create linked clones.
786
787 NOTE: It is not possible to start templates, because this would modify
788 the disk images. If you want to change the template, create a linked
789 clone and modify that.
790
791 VM Generation ID
792 ----------------
793
794 {pve} supports Virtual Machine Generation ID ('vmgedid') footnote:[Official
795 'vmgenid' Specification
796 https://docs.microsoft.com/en-us/windows/desktop/hyperv_v2/virtual-machine-generation-identifier]
797 for virtual machines.
798 This can be used by the guest operating system to detect any event resulting
799 in a time shift event, for example, restoring a backup or a snapshot rollback.
800
801 When creating new VMs, a 'vmgenid' will be automatically generated and saved
802 in its configuration file.
803
804 To create and add a 'vmgenid' to an already existing VM one can pass the
805 special value `1' to let {pve} autogenerate one or manually set the 'UUID'
806 footnote:[Online GUID generator http://guid.one/] by using it as value,
807 e.g.:
808
809 ----
810  qm set VMID -vmgenid 1
811  qm set VMID -vmgenid 00000000-0000-0000-0000-000000000000
812 ----
813
814 In the rare case the 'vmgenid' mechanism is not wanted one can pass `0' for
815 its value on VM creation, or retroactively delete the property in the
816 configuration with:
817
818 ----
819  qm set VMID -delete vmgenid
820 ----
821
822 The most prominent use case for 'vmgenid' are newer Microsoft Windows
823 operating systems, which use it to avoid problems in time sensitive or
824 replicate services (e.g., databases, domain controller) on snapshot
825 rollback, backup restore or a whole VM clone operation.
826
827 Importing Virtual Machines and disk images
828 ------------------------------------------
829
830 A VM export from a foreign hypervisor takes usually the form of one or more disk
831  images, with a configuration file describing the settings of the VM (RAM,
832  number of cores). +
833 The disk images can be in the vmdk format, if the disks come from
834 VMware or VirtualBox, or qcow2 if the disks come from a KVM hypervisor.
835 The most popular configuration format for VM exports is the OVF standard, but in
836 practice interoperation is limited because many settings are not implemented in
837 the standard itself, and hypervisors export the supplementary information
838 in non-standard extensions.
839
840 Besides the problem of format, importing disk images from other hypervisors
841 may fail if the emulated hardware changes too much from one hypervisor to
842 another. Windows VMs are particularly concerned by this, as the OS is very
843 picky about any changes of hardware. This problem may be solved by
844 installing the MergeIDE.zip utility available from the Internet before exporting
845 and choosing a hard disk type of *IDE* before booting the imported Windows VM.
846
847 Finally there is the question of paravirtualized drivers, which improve the
848 speed of the emulated system and are specific to the hypervisor.
849 GNU/Linux and other free Unix OSes have all the necessary drivers installed by
850 default and you can switch to the paravirtualized drivers right after importing
851 the VM. For Windows VMs, you need to install the Windows paravirtualized
852 drivers by yourself.
853
854 GNU/Linux and other free Unix can usually be imported without hassle. Note
855 that we cannot guarantee a successful import/export of Windows VMs in all
856 cases due to the problems above.
857
858 Step-by-step example of a Windows OVF import
859 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
860
861 Microsoft provides
862 https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/[Virtual Machines downloads]
863  to get started with Windows development.We are going to use one of these 
864 to demonstrate the OVF import feature.
865
866 Download the Virtual Machine zip
867 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
868
869 After getting informed about the user agreement, choose the _Windows 10 
870 Enterprise (Evaluation - Build)_ for the VMware platform, and download the zip.
871
872 Extract the disk image from the zip
873 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
874
875 Using the `unzip` utility or any archiver of your choice, unpack the zip,
876 and copy via ssh/scp the ovf and vmdk files to your {pve} host.
877
878 Import the Virtual Machine
879 ^^^^^^^^^^^^^^^^^^^^^^^^^^
880
881 This will create a new virtual machine, using cores, memory and
882 VM name as read from the OVF manifest, and import the disks to the +local-lvm+
883  storage. You have to configure the network manually.
884
885  qm importovf 999 WinDev1709Eval.ovf local-lvm
886
887 The VM is ready to be started.
888
889 Adding an external disk image to a Virtual Machine
890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
891
892 You can also add an existing disk image to a VM, either coming from a 
893 foreign hypervisor, or one that you created yourself.
894
895 Suppose you created a Debian/Ubuntu disk image with the 'vmdebootstrap' tool:
896
897  vmdebootstrap --verbose \
898   --size 10GiB --serial-console \
899   --grub --no-extlinux \
900   --package openssh-server \
901   --package avahi-daemon \
902   --package qemu-guest-agent \
903   --hostname vm600 --enable-dhcp \
904   --customize=./copy_pub_ssh.sh \
905   --sparse --image vm600.raw
906
907 You can now create a new target VM for this image.
908
909  qm create 600 --net0 virtio,bridge=vmbr0 --name vm600 --serial0 socket \
910    --bootdisk scsi0 --scsihw virtio-scsi-pci --ostype l26
911
912 Add the disk image as +unused0+ to the VM, using the storage +pvedir+:
913
914  qm importdisk 600 vm600.raw pvedir
915
916 Finally attach the unused disk to the SCSI controller of the VM:
917
918  qm set 600 --scsi0 pvedir:600/vm-600-disk-1.raw
919
920 The VM is ready to be started.
921
922
923 ifndef::wiki[]
924 include::qm-cloud-init.adoc[]
925 endif::wiki[]
926
927
928
929 Managing Virtual Machines with `qm`
930 ------------------------------------
931
932 qm is the tool to manage Qemu/Kvm virtual machines on {pve}. You can
933 create and destroy virtual machines, and control execution
934 (start/stop/suspend/resume). Besides that, you can use qm to set
935 parameters in the associated config file. It is also possible to
936 create and delete virtual disks.
937
938 CLI Usage Examples
939 ~~~~~~~~~~~~~~~~~~
940
941 Using an iso file uploaded on the 'local' storage, create a VM
942 with a 4 GB IDE disk on the 'local-lvm' storage
943
944  qm create 300 -ide0 local-lvm:4 -net0 e1000 -cdrom local:iso/proxmox-mailgateway_2.1.iso
945
946 Start the new VM
947
948  qm start 300
949
950 Send a shutdown request, then wait until the VM is stopped.
951
952  qm shutdown 300 && qm wait 300
953
954 Same as above, but only wait for 40 seconds.
955
956  qm shutdown 300 && qm wait 300 -timeout 40
957
958
959 [[qm_configuration]]
960 Configuration
961 -------------
962
963 VM configuration files are stored inside the Proxmox cluster file
964 system, and can be accessed at `/etc/pve/qemu-server/<VMID>.conf`.
965 Like other files stored inside `/etc/pve/`, they get automatically
966 replicated to all other cluster nodes.
967
968 NOTE: VMIDs < 100 are reserved for internal purposes, and VMIDs need to be
969 unique cluster wide.
970
971 .Example VM Configuration
972 ----
973 cores: 1
974 sockets: 1
975 memory: 512
976 name: webmail
977 ostype: l26
978 bootdisk: virtio0
979 net0: e1000=EE:D2:28:5F:B6:3E,bridge=vmbr0
980 virtio0: local:vm-100-disk-1,size=32G
981 ----
982
983 Those configuration files are simple text files, and you can edit them
984 using a normal text editor (`vi`, `nano`, ...). This is sometimes
985 useful to do small corrections, but keep in mind that you need to
986 restart the VM to apply such changes.
987
988 For that reason, it is usually better to use the `qm` command to
989 generate and modify those files, or do the whole thing using the GUI.
990 Our toolkit is smart enough to instantaneously apply most changes to
991 running VM. This feature is called "hot plug", and there is no
992 need to restart the VM in that case.
993
994
995 File Format
996 ~~~~~~~~~~~
997
998 VM configuration files use a simple colon separated key/value
999 format. Each line has the following format:
1000
1001 -----
1002 # this is a comment
1003 OPTION: value
1004 -----
1005
1006 Blank lines in those files are ignored, and lines starting with a `#`
1007 character are treated as comments and are also ignored.
1008
1009
1010 [[qm_snapshots]]
1011 Snapshots
1012 ~~~~~~~~~
1013
1014 When you create a snapshot, `qm` stores the configuration at snapshot
1015 time into a separate snapshot section within the same configuration
1016 file. For example, after creating a snapshot called ``testsnapshot'',
1017 your configuration file will look like this:
1018
1019 .VM configuration with snapshot
1020 ----
1021 memory: 512
1022 swap: 512
1023 parent: testsnaphot
1024 ...
1025
1026 [testsnaphot]
1027 memory: 512
1028 swap: 512
1029 snaptime: 1457170803
1030 ...
1031 ----
1032
1033 There are a few snapshot related properties like `parent` and
1034 `snaptime`. The `parent` property is used to store the parent/child
1035 relationship between snapshots. `snaptime` is the snapshot creation
1036 time stamp (Unix epoch).
1037
1038
1039 [[qm_options]]
1040 Options
1041 ~~~~~~~
1042
1043 include::qm.conf.5-opts.adoc[]
1044
1045
1046 Locks
1047 -----
1048
1049 Online migrations, snapshots and backups (`vzdump`) set a lock to
1050 prevent incompatible concurrent actions on the affected VMs. Sometimes
1051 you need to remove such a lock manually (e.g., after a power failure).
1052
1053  qm unlock <vmid>
1054
1055 CAUTION: Only do that if you are sure the action which set the lock is
1056 no longer running.
1057
1058
1059 ifdef::wiki[]
1060
1061 See Also
1062 ~~~~~~~~
1063
1064 * link:/wiki/Cloud-Init_Support[Cloud-Init Support]
1065
1066 endif::wiki[]
1067
1068
1069 ifdef::manvolnum[]
1070
1071 Files
1072 ------
1073
1074 `/etc/pve/qemu-server/<VMID>.conf`::
1075
1076 Configuration file for the VM '<VMID>'.
1077
1078
1079 include::pve-copyright.adoc[]
1080 endif::manvolnum[]