]>
Commit | Line | Data |
---|---|---|
80c0adcb | 1 | [[chapter_virtual_machines]] |
f69cfd23 | 2 | ifdef::manvolnum[] |
b2f242ab DM |
3 | qm(1) |
4 | ===== | |
5f09af76 DM |
5 | :pve-toplevel: |
6 | ||
f69cfd23 DM |
7 | NAME |
8 | ---- | |
9 | ||
c730e973 | 10 | qm - QEMU/KVM Virtual Machine Manager |
f69cfd23 DM |
11 | |
12 | ||
49a5e11c | 13 | SYNOPSIS |
f69cfd23 DM |
14 | -------- |
15 | ||
16 | include::qm.1-synopsis.adoc[] | |
17 | ||
18 | DESCRIPTION | |
19 | ----------- | |
20 | endif::manvolnum[] | |
f69cfd23 | 21 | ifndef::manvolnum[] |
c730e973 | 22 | QEMU/KVM Virtual Machines |
f69cfd23 | 23 | ========================= |
5f09af76 | 24 | :pve-toplevel: |
194d2f29 | 25 | endif::manvolnum[] |
5f09af76 | 26 | |
c4cba5d7 EK |
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 | ||
c730e973 FE |
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 | |
c4cba5d7 | 35 | like partitions, files, network cards which are then passed to an |
189d3661 | 36 | emulated computer which sees them as if they were real devices. |
c4cba5d7 EK |
37 | |
38 | A guest operating system running in the emulated computer accesses these | |
3a433e9b | 39 | devices, and runs as if it were running on real hardware. For instance, you can pass |
c730e973 | 40 | an ISO image as a parameter to QEMU, and the OS running in the emulated computer |
3a433e9b | 41 | will see a real CD-ROM inserted into a CD drive. |
c4cba5d7 | 42 | |
c730e973 | 43 | QEMU can emulate a great variety of hardware from ARM to Sparc, but {pve} is |
c4cba5d7 EK |
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 | |
c730e973 | 47 | speed up QEMU when the emulated architecture is the same as the host |
9c63b5d9 EK |
48 | architecture. |
49 | ||
50 | NOTE: You may sometimes encounter the term _KVM_ (Kernel-based Virtual Machine). | |
c730e973 FE |
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 | |
9c63b5d9 EK |
54 | module. |
55 | ||
c730e973 | 56 | QEMU inside {pve} runs as a root process, since this is required to access block |
c4cba5d7 EK |
57 | and PCI devices. |
58 | ||
5eba0743 | 59 | |
c4cba5d7 EK |
60 | Emulated devices and paravirtualized devices |
61 | -------------------------------------------- | |
62 | ||
c730e973 | 63 | The PC hardware emulated by QEMU includes a mainboard, network controllers, |
3a433e9b | 64 | SCSI, IDE and SATA controllers, serial ports (the complete list can be seen in |
189d3661 DC |
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 | |
c730e973 | 68 | were running on real hardware. This allows QEMU to runs _unmodified_ operating |
c4cba5d7 EK |
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, | |
c730e973 FE |
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 | |
c4cba5d7 EK |
75 | hypervisor. |
76 | ||
c730e973 | 77 | QEMU relies on the virtio virtualization standard, and is thus able to present |
189d3661 DC |
78 | paravirtualized virtio devices, which includes a paravirtualized generic disk |
79 | controller, a paravirtualized network card, a paravirtualized serial port, | |
c4cba5d7 EK |
80 | a paravirtualized SCSI controller, etc ... |
81 | ||
e3d91783 FE |
82 | TIP: It is *highly recommended* to use the virtio devices whenever you can, as |
83 | they provide a big performance improvement and are generally better maintained. | |
84 | Using the virtio generic disk controller versus an emulated IDE controller will | |
85 | double the sequential write throughput, as measured with `bonnie++(8)`. Using | |
86 | the virtio network interface can deliver up to three times the throughput of an | |
0677f4cc FE |
87 | emulated Intel E1000 network card, as measured with `iperf(1)`. footnote:[See |
88 | this benchmark on the KVM wiki https://www.linux-kvm.org/page/Using_VirtIO_NIC] | |
c4cba5d7 | 89 | |
5eba0743 | 90 | |
80c0adcb | 91 | [[qm_virtual_machines_settings]] |
5274ad28 | 92 | Virtual Machines Settings |
c4cba5d7 | 93 | ------------------------- |
80c0adcb | 94 | |
c4cba5d7 EK |
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 | ||
5eba0743 | 99 | |
80c0adcb | 100 | [[qm_general_settings]] |
c4cba5d7 EK |
101 | General Settings |
102 | ~~~~~~~~~~~~~~~~ | |
80c0adcb | 103 | |
1ff5e4e8 | 104 | [thumbnail="screenshot/gui-create-vm-general.png"] |
b16d767f | 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 | |
1ff5e4e8 | 118 | [thumbnail="screenshot/gui-create-vm-os.png"] |
200114a7 | 119 | |
d3c00374 TL |
120 | When creating a virtual machine (VM), setting the proper Operating System(OS) |
121 | allows {pve} to optimize some low level parameters. For instance Windows OS | |
122 | expect the BIOS clock to use the local time, while Unix based OS expect the | |
123 | BIOS clock to have the UTC time. | |
124 | ||
125 | [[qm_system_settings]] | |
126 | System Settings | |
127 | ~~~~~~~~~~~~~~~ | |
128 | ||
ade78a55 TL |
129 | On VM creation you can change some basic system components of the new VM. You |
130 | can specify which xref:qm_display[display type] you want to use. | |
d3c00374 TL |
131 | [thumbnail="screenshot/gui-create-vm-system.png"] |
132 | Additionally, the xref:qm_hard_disk[SCSI controller] can be changed. | |
133 | If you plan to install the QEMU Guest Agent, or if your selected ISO image | |
c730e973 | 134 | already ships and installs it automatically, you may want to tick the 'QEMU |
d3c00374 TL |
135 | Agent' box, which lets {pve} know that it can use its features to show some |
136 | more information, and complete some actions (for example, shutdown or | |
137 | snapshots) more intelligently. | |
138 | ||
139 | {pve} allows to boot VMs with different firmware and machine types, namely | |
140 | xref:qm_bios_and_uefi[SeaBIOS and OVMF]. In most cases you want to switch from | |
3a433e9b | 141 | the default SeaBIOS to OVMF only if you plan to use |
d3c00374 TL |
142 | xref:qm_pci_passthrough[PCIe pass through]. A VMs 'Machine Type' defines the |
143 | hardware layout of the VM's virtual motherboard. You can choose between the | |
144 | default https://en.wikipedia.org/wiki/Intel_440FX[Intel 440FX] or the | |
145 | https://ark.intel.com/content/www/us/en/ark/products/31918/intel-82q35-graphics-and-memory-controller.html[Q35] | |
146 | chipset, which also provides a virtual PCIe bus, and thus may be desired if | |
5f318cc0 | 147 | one wants to pass through PCIe hardware. |
5eba0743 | 148 | |
80c0adcb | 149 | [[qm_hard_disk]] |
c4cba5d7 EK |
150 | Hard Disk |
151 | ~~~~~~~~~ | |
80c0adcb | 152 | |
3dbe1daa TL |
153 | [[qm_hard_disk_bus]] |
154 | Bus/Controller | |
155 | ^^^^^^^^^^^^^^ | |
c730e973 | 156 | QEMU can emulate a number of storage controllers: |
c4cba5d7 | 157 | |
741fa478 FE |
158 | TIP: It is highly recommended to use the *VirtIO SCSI* or *VirtIO Block* |
159 | controller for performance reasons and because they are better maintained. | |
160 | ||
c4cba5d7 | 161 | * the *IDE* controller, has a design which goes back to the 1984 PC/AT disk |
44f38275 | 162 | controller. Even if this controller has been superseded by recent designs, |
6fb50457 | 163 | each and every OS you can think of has support for it, making it a great choice |
c4cba5d7 EK |
164 | if you want to run an OS released before 2003. You can connect up to 4 devices |
165 | on this controller. | |
166 | ||
167 | * the *SATA* (Serial ATA) controller, dating from 2003, has a more modern | |
168 | design, allowing higher throughput and a greater number of devices to be | |
169 | connected. You can connect up to 6 devices on this controller. | |
170 | ||
b0b6802b EK |
171 | * the *SCSI* controller, designed in 1985, is commonly found on server grade |
172 | hardware, and can connect up to 14 storage devices. {pve} emulates by default a | |
f4bfd701 DM |
173 | LSI 53C895A controller. |
174 | + | |
a89ded0b FE |
175 | A SCSI controller of type _VirtIO SCSI single_ and enabling the |
176 | xref:qm_hard_disk_iothread[IO Thread] setting for the attached disks is | |
177 | recommended if you aim for performance. This is the default for newly created | |
178 | Linux VMs since {pve} 7.3. Each disk will have its own _VirtIO SCSI_ controller, | |
179 | and QEMU will handle the disks IO in a dedicated thread. Linux distributions | |
180 | have support for this controller since 2012, and FreeBSD since 2014. For Windows | |
181 | OSes, you need to provide an extra ISO containing the drivers during the | |
182 | installation. | |
b0b6802b EK |
183 | // https://pve.proxmox.com/wiki/Paravirtualized_Block_Drivers_for_Windows#During_windows_installation. |
184 | ||
30e6fe00 TL |
185 | * The *VirtIO Block* controller, often just called VirtIO or virtio-blk, |
186 | is an older type of paravirtualized controller. It has been superseded by the | |
187 | VirtIO SCSI Controller, in terms of features. | |
c4cba5d7 | 188 | |
1ff5e4e8 | 189 | [thumbnail="screenshot/gui-create-vm-hard-disk.png"] |
3dbe1daa TL |
190 | |
191 | [[qm_hard_disk_formats]] | |
192 | Image Format | |
193 | ^^^^^^^^^^^^ | |
c4cba5d7 EK |
194 | On each controller you attach a number of emulated hard disks, which are backed |
195 | by a file or a block device residing in the configured storage. The choice of | |
196 | a storage type will determine the format of the hard disk image. Storages which | |
197 | present block devices (LVM, ZFS, Ceph) will require the *raw disk image format*, | |
de14ebff | 198 | whereas files based storages (Ext4, NFS, CIFS, GlusterFS) will let you to choose |
c4cba5d7 EK |
199 | either the *raw disk image format* or the *QEMU image format*. |
200 | ||
201 | * the *QEMU image format* is a copy on write format which allows snapshots, and | |
202 | thin provisioning of the disk image. | |
189d3661 DC |
203 | * the *raw disk image* is a bit-to-bit image of a hard disk, similar to what |
204 | you would get when executing the `dd` command on a block device in Linux. This | |
4371b2fe | 205 | format does not support thin provisioning or snapshots by itself, requiring |
30e6fe00 TL |
206 | cooperation from the storage layer for these tasks. It may, however, be up to |
207 | 10% faster than the *QEMU image format*. footnote:[See this benchmark for details | |
43530f6f | 208 | https://events.static.linuxfound.org/sites/events/files/slides/CloudOpen2013_Khoa_Huynh_v3.pdf] |
189d3661 | 209 | * the *VMware image format* only makes sense if you intend to import/export the |
c4cba5d7 EK |
210 | disk image to other hypervisors. |
211 | ||
3dbe1daa TL |
212 | [[qm_hard_disk_cache]] |
213 | Cache Mode | |
214 | ^^^^^^^^^^ | |
c4cba5d7 EK |
215 | Setting the *Cache* mode of the hard drive will impact how the host system will |
216 | notify the guest systems of block write completions. The *No cache* default | |
217 | means that the guest system will be notified that a write is complete when each | |
218 | block reaches the physical storage write queue, ignoring the host page cache. | |
219 | This provides a good balance between safety and speed. | |
220 | ||
221 | If you want the {pve} backup manager to skip a disk when doing a backup of a VM, | |
222 | you can set the *No backup* option on that disk. | |
223 | ||
3205ac49 EK |
224 | If you want the {pve} storage replication mechanism to skip a disk when starting |
225 | a replication job, you can set the *Skip replication* option on that disk. | |
6fb50457 | 226 | As of {pve} 5.0, replication requires the disk images to be on a storage of type |
3205ac49 | 227 | `zfspool`, so adding a disk image to other storages when the VM has replication |
6fb50457 | 228 | configured requires to skip replication for this disk image. |
3205ac49 | 229 | |
3dbe1daa TL |
230 | [[qm_hard_disk_discard]] |
231 | Trim/Discard | |
232 | ^^^^^^^^^^^^ | |
c4cba5d7 | 233 | If your storage supports _thin provisioning_ (see the storage chapter in the |
53cbac40 NC |
234 | {pve} guide), you can activate the *Discard* option on a drive. With *Discard* |
235 | set and a _TRIM_-enabled guest OS footnote:[TRIM, UNMAP, and discard | |
236 | https://en.wikipedia.org/wiki/Trim_%28computing%29], when the VM's filesystem | |
237 | marks blocks as unused after deleting files, the controller will relay this | |
238 | information to the storage, which will then shrink the disk image accordingly. | |
43975153 SR |
239 | For the guest to be able to issue _TRIM_ commands, you must enable the *Discard* |
240 | option on the drive. Some guest operating systems may also require the | |
241 | *SSD Emulation* flag to be set. Note that *Discard* on *VirtIO Block* drives is | |
242 | only supported on guests using Linux Kernel 5.0 or higher. | |
c4cba5d7 | 243 | |
25203dc1 NC |
244 | If you would like a drive to be presented to the guest as a solid-state drive |
245 | rather than a rotational hard disk, you can set the *SSD emulation* option on | |
246 | that drive. There is no requirement that the underlying storage actually be | |
247 | backed by SSDs; this feature can be used with physical media of any type. | |
53cbac40 | 248 | Note that *SSD emulation* is not supported on *VirtIO Block* drives. |
25203dc1 | 249 | |
3dbe1daa TL |
250 | |
251 | [[qm_hard_disk_iothread]] | |
252 | IO Thread | |
253 | ^^^^^^^^^ | |
4c7a47cf FE |
254 | The option *IO Thread* can only be used when using a disk with the *VirtIO* |
255 | controller, or with the *SCSI* controller, when the emulated controller type is | |
256 | *VirtIO SCSI single*. With *IO Thread* enabled, QEMU creates one I/O thread per | |
58e695ca | 257 | storage controller rather than handling all I/O in the main event loop or vCPU |
afb90565 TL |
258 | threads. One benefit is better work distribution and utilization of the |
259 | underlying storage. Another benefit is reduced latency (hangs) in the guest for | |
260 | very I/O-intensive host workloads, since neither the main thread nor a vCPU | |
261 | thread can be blocked by disk I/O. | |
80c0adcb DM |
262 | |
263 | [[qm_cpu]] | |
34e541c5 EK |
264 | CPU |
265 | ~~~ | |
80c0adcb | 266 | |
1ff5e4e8 | 267 | [thumbnail="screenshot/gui-create-vm-cpu.png"] |
397c74c3 | 268 | |
34e541c5 EK |
269 | A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU. |
270 | This CPU can then contain one or many *cores*, which are independent | |
271 | processing units. Whether you have a single CPU socket with 4 cores, or two CPU | |
272 | sockets with two cores is mostly irrelevant from a performance point of view. | |
44f38275 TL |
273 | However some software licenses depend on the number of sockets a machine has, |
274 | in that case it makes sense to set the number of sockets to what the license | |
275 | allows you. | |
f4bfd701 | 276 | |
3a433e9b | 277 | Increasing the number of virtual CPUs (cores and sockets) will usually provide a |
34e541c5 | 278 | performance improvement though that is heavily dependent on the use of the VM. |
3a433e9b | 279 | Multi-threaded applications will of course benefit from a large number of |
c730e973 | 280 | virtual CPUs, as for each virtual cpu you add, QEMU will create a new thread of |
34e541c5 EK |
281 | execution on the host system. If you're not sure about the workload of your VM, |
282 | it is usually a safe bet to set the number of *Total cores* to 2. | |
283 | ||
fb29acdd | 284 | NOTE: It is perfectly safe if the _overall_ number of cores of all your VMs |
d6466262 TL |
285 | is greater than the number of cores on the server (for example, 4 VMs each with |
286 | 4 cores (= total 16) on a machine with only 8 cores). In that case the host | |
287 | system will balance the QEMU execution threads between your server cores, just | |
288 | like if you were running a standard multi-threaded application. However, {pve} | |
289 | will prevent you from starting VMs with more virtual CPU cores than physically | |
290 | available, as this will only bring the performance down due to the cost of | |
291 | context switches. | |
34e541c5 | 292 | |
af54f54d TL |
293 | [[qm_cpu_resource_limits]] |
294 | Resource Limits | |
295 | ^^^^^^^^^^^^^^^ | |
296 | ||
4371b2fe | 297 | In addition to the number of virtual cores, you can configure how much resources |
af54f54d TL |
298 | a VM can get in relation to the host CPU time and also in relation to other |
299 | VMs. | |
046643ec FG |
300 | With the *cpulimit* (``Host CPU Time'') option you can limit how much CPU time |
301 | the whole VM can use on the host. It is a floating point value representing CPU | |
af54f54d | 302 | time in percent, so `1.0` is equal to `100%`, `2.5` to `250%` and so on. If a |
4371b2fe | 303 | single process would fully use one single core it would have `100%` CPU Time |
af54f54d | 304 | usage. If a VM with four cores utilizes all its cores fully it would |
c730e973 | 305 | theoretically use `400%`. In reality the usage may be even a bit higher as QEMU |
af54f54d TL |
306 | can have additional threads for VM peripherals besides the vCPU core ones. |
307 | This setting can be useful if a VM should have multiple vCPUs, as it runs a few | |
308 | processes in parallel, but the VM as a whole should not be able to run all | |
309 | vCPUs at 100% at the same time. Using a specific example: lets say we have a VM | |
310 | which would profit from having 8 vCPUs, but at no time all of those 8 cores | |
311 | should run at full load - as this would make the server so overloaded that | |
312 | other VMs and CTs would get to less CPU. So, we set the *cpulimit* limit to | |
313 | `4.0` (=400%). If all cores do the same heavy work they would all get 50% of a | |
314 | real host cores CPU time. But, if only 4 would do work they could still get | |
315 | almost 100% of a real core each. | |
316 | ||
d6466262 TL |
317 | NOTE: VMs can, depending on their configuration, use additional threads, such |
318 | as for networking or IO operations but also live migration. Thus a VM can show | |
319 | up to use more CPU time than just its virtual CPUs could use. To ensure that a | |
320 | VM never uses more CPU time than virtual CPUs assigned set the *cpulimit* | |
321 | setting to the same value as the total core count. | |
af54f54d TL |
322 | |
323 | The second CPU resource limiting setting, *cpuunits* (nowadays often called CPU | |
48219c58 FE |
324 | shares or CPU weight), controls how much CPU time a VM gets compared to other |
325 | running VMs. It is a relative weight which defaults to `100` (or `1024` if the | |
326 | host uses legacy cgroup v1). If you increase this for a VM it will be | |
d6466262 TL |
327 | prioritized by the scheduler in comparison to other VMs with lower weight. For |
328 | example, if VM 100 has set the default `100` and VM 200 was changed to `200`, | |
329 | the latter VM 200 would receive twice the CPU bandwidth than the first VM 100. | |
af54f54d TL |
330 | |
331 | For more information see `man systemd.resource-control`, here `CPUQuota` | |
b90b797f | 332 | corresponds to `cpulimit` and `CPUWeight` corresponds to our `cpuunits` |
af54f54d TL |
333 | setting, visit its Notes section for references and implementation details. |
334 | ||
1e6b30b5 DB |
335 | The third CPU resource limiting setting, *affinity*, controls what host cores |
336 | the virtual machine will be permitted to execute on. E.g., if an affinity value | |
337 | of `0-3,8-11` is provided, the virtual machine will be restricted to using the | |
338 | host cores `0,1,2,3,8,9,10,` and `11`. Valid *affinity* values are written in | |
339 | cpuset `List Format`. List Format is a comma-separated list of CPU numbers and | |
340 | ranges of numbers, in ASCII decimal. | |
341 | ||
342 | NOTE: CPU *affinity* uses the `taskset` command to restrict virtual machines to | |
343 | a given set of cores. This restriction will not take effect for some types of | |
344 | processes that may be created for IO. *CPU affinity is not a security feature.* | |
345 | ||
346 | For more information regarding *affinity* see `man cpuset`. Here the | |
347 | `List Format` corresponds to valid *affinity* values. Visit its `Formats` | |
348 | section for more examples. | |
349 | ||
af54f54d TL |
350 | CPU Type |
351 | ^^^^^^^^ | |
352 | ||
c730e973 | 353 | QEMU can emulate a number different of *CPU types* from 486 to the latest Xeon |
34e541c5 EK |
354 | processors. Each new processor generation adds new features, like hardware |
355 | assisted 3d rendering, random number generation, memory protection, etc ... | |
356 | Usually you should select for your VM a processor type which closely matches the | |
357 | CPU of the host system, as it means that the host CPU features (also called _CPU | |
358 | flags_ ) will be available in your VMs. If you want an exact match, you can set | |
359 | the CPU type to *host* in which case the VM will have exactly the same CPU flags | |
f4bfd701 DM |
360 | as your host system. |
361 | ||
34e541c5 EK |
362 | This has a downside though. If you want to do a live migration of VMs between |
363 | different hosts, your VM might end up on a new system with a different CPU type. | |
364 | If the CPU flags passed to the guest are missing, the qemu process will stop. To | |
c730e973 | 365 | remedy this QEMU has also its own CPU type *kvm64*, that {pve} uses by defaults. |
34e541c5 | 366 | kvm64 is a Pentium 4 look a like CPU type, which has a reduced CPU flags set, |
f4bfd701 DM |
367 | but is guaranteed to work everywhere. |
368 | ||
369 | In short, if you care about live migration and moving VMs between nodes, leave | |
af54f54d TL |
370 | the kvm64 default. If you don’t care about live migration or have a homogeneous |
371 | cluster where all nodes have the same CPU, set the CPU type to host, as in | |
372 | theory this will give your guests maximum performance. | |
373 | ||
9e797d8c SR |
374 | Custom CPU Types |
375 | ^^^^^^^^^^^^^^^^ | |
376 | ||
377 | You can specify custom CPU types with a configurable set of features. These are | |
378 | maintained in the configuration file `/etc/pve/virtual-guest/cpu-models.conf` by | |
379 | an administrator. See `man cpu-models.conf` for format details. | |
380 | ||
381 | Specified custom types can be selected by any user with the `Sys.Audit` | |
382 | privilege on `/nodes`. When configuring a custom CPU type for a VM via the CLI | |
383 | or API, the name needs to be prefixed with 'custom-'. | |
384 | ||
72ae8aa2 FG |
385 | Meltdown / Spectre related CPU flags |
386 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
387 | ||
2975cb7a | 388 | There are several CPU flags related to the Meltdown and Spectre vulnerabilities |
72ae8aa2 FG |
389 | footnote:[Meltdown Attack https://meltdownattack.com/] which need to be set |
390 | manually unless the selected CPU type of your VM already enables them by default. | |
391 | ||
2975cb7a | 392 | There are two requirements that need to be fulfilled in order to use these |
72ae8aa2 | 393 | CPU flags: |
5dba2677 | 394 | |
72ae8aa2 FG |
395 | * The host CPU(s) must support the feature and propagate it to the guest's virtual CPU(s) |
396 | * The guest operating system must be updated to a version which mitigates the | |
397 | attacks and is able to utilize the CPU feature | |
398 | ||
2975cb7a AD |
399 | Otherwise you need to set the desired CPU flag of the virtual CPU, either by |
400 | editing the CPU options in the WebUI, or by setting the 'flags' property of the | |
401 | 'cpu' option in the VM configuration file. | |
402 | ||
403 | For Spectre v1,v2,v4 fixes, your CPU or system vendor also needs to provide a | |
72ae8aa2 FG |
404 | so-called ``microcode update'' footnote:[You can use `intel-microcode' / |
405 | `amd-microcode' from Debian non-free if your vendor does not provide such an | |
406 | update. Note that not all affected CPUs can be updated to support spec-ctrl.] | |
407 | for your CPU. | |
5dba2677 | 408 | |
2975cb7a AD |
409 | |
410 | To check if the {pve} host is vulnerable, execute the following command as root: | |
5dba2677 TL |
411 | |
412 | ---- | |
2975cb7a | 413 | for f in /sys/devices/system/cpu/vulnerabilities/*; do echo "${f##*/} -" $(cat "$f"); done |
5dba2677 TL |
414 | ---- |
415 | ||
144d5ede | 416 | A community script is also available to detect is the host is still vulnerable. |
2975cb7a | 417 | footnote:[spectre-meltdown-checker https://meltdown.ovh/] |
72ae8aa2 | 418 | |
2975cb7a AD |
419 | Intel processors |
420 | ^^^^^^^^^^^^^^^^ | |
72ae8aa2 | 421 | |
2975cb7a AD |
422 | * 'pcid' |
423 | + | |
144d5ede | 424 | This reduces the performance impact of the Meltdown (CVE-2017-5754) mitigation |
2975cb7a AD |
425 | called 'Kernel Page-Table Isolation (KPTI)', which effectively hides |
426 | the Kernel memory from the user space. Without PCID, KPTI is quite an expensive | |
427 | mechanism footnote:[PCID is now a critical performance/security feature on x86 | |
428 | https://groups.google.com/forum/m/#!topic/mechanical-sympathy/L9mHTbeQLNU]. | |
429 | + | |
430 | To check if the {pve} host supports PCID, execute the following command as root: | |
431 | + | |
72ae8aa2 | 432 | ---- |
2975cb7a | 433 | # grep ' pcid ' /proc/cpuinfo |
72ae8aa2 | 434 | ---- |
2975cb7a AD |
435 | + |
436 | If this does not return empty your host's CPU has support for 'pcid'. | |
72ae8aa2 | 437 | |
2975cb7a AD |
438 | * 'spec-ctrl' |
439 | + | |
144d5ede WB |
440 | Required to enable the Spectre v1 (CVE-2017-5753) and Spectre v2 (CVE-2017-5715) fix, |
441 | in cases where retpolines are not sufficient. | |
442 | Included by default in Intel CPU models with -IBRS suffix. | |
443 | Must be explicitly turned on for Intel CPU models without -IBRS suffix. | |
444 | Requires an updated host CPU microcode (intel-microcode >= 20180425). | |
2975cb7a AD |
445 | + |
446 | * 'ssbd' | |
447 | + | |
144d5ede WB |
448 | Required to enable the Spectre V4 (CVE-2018-3639) fix. Not included by default in any Intel CPU model. |
449 | Must be explicitly turned on for all Intel CPU models. | |
450 | Requires an updated host CPU microcode(intel-microcode >= 20180703). | |
72ae8aa2 | 451 | |
72ae8aa2 | 452 | |
2975cb7a AD |
453 | AMD processors |
454 | ^^^^^^^^^^^^^^ | |
455 | ||
456 | * 'ibpb' | |
457 | + | |
144d5ede WB |
458 | Required to enable the Spectre v1 (CVE-2017-5753) and Spectre v2 (CVE-2017-5715) fix, |
459 | in cases where retpolines are not sufficient. | |
460 | Included by default in AMD CPU models with -IBPB suffix. | |
461 | Must be explicitly turned on for AMD CPU models without -IBPB suffix. | |
2975cb7a AD |
462 | Requires the host CPU microcode to support this feature before it can be used for guest CPUs. |
463 | ||
464 | ||
465 | ||
466 | * 'virt-ssbd' | |
467 | + | |
468 | Required to enable the Spectre v4 (CVE-2018-3639) fix. | |
144d5ede WB |
469 | Not included by default in any AMD CPU model. |
470 | Must be explicitly turned on for all AMD CPU models. | |
471 | This should be provided to guests, even if amd-ssbd is also provided, for maximum guest compatibility. | |
472 | Note that this must be explicitly enabled when when using the "host" cpu model, | |
473 | because this is a virtual feature which does not exist in the physical CPUs. | |
2975cb7a AD |
474 | |
475 | ||
476 | * 'amd-ssbd' | |
477 | + | |
144d5ede WB |
478 | Required to enable the Spectre v4 (CVE-2018-3639) fix. |
479 | Not included by default in any AMD CPU model. Must be explicitly turned on for all AMD CPU models. | |
480 | This provides higher performance than virt-ssbd, therefore a host supporting this should always expose this to guests if possible. | |
2975cb7a AD |
481 | virt-ssbd should none the less also be exposed for maximum guest compatibility as some kernels only know about virt-ssbd. |
482 | ||
483 | ||
484 | * 'amd-no-ssb' | |
485 | + | |
486 | Recommended to indicate the host is not vulnerable to Spectre V4 (CVE-2018-3639). | |
144d5ede WB |
487 | Not included by default in any AMD CPU model. |
488 | Future hardware generations of CPU will not be vulnerable to CVE-2018-3639, | |
489 | and thus the guest should be told not to enable its mitigations, by exposing amd-no-ssb. | |
2975cb7a AD |
490 | This is mutually exclusive with virt-ssbd and amd-ssbd. |
491 | ||
5dba2677 | 492 | |
af54f54d TL |
493 | NUMA |
494 | ^^^^ | |
495 | You can also optionally emulate a *NUMA* | |
496 | footnote:[https://en.wikipedia.org/wiki/Non-uniform_memory_access] architecture | |
497 | in your VMs. The basics of the NUMA architecture mean that instead of having a | |
498 | global memory pool available to all your cores, the memory is spread into local | |
499 | banks close to each socket. | |
34e541c5 EK |
500 | This can bring speed improvements as the memory bus is not a bottleneck |
501 | anymore. If your system has a NUMA architecture footnote:[if the command | |
502 | `numactl --hardware | grep available` returns more than one node, then your host | |
503 | system has a NUMA architecture] we recommend to activate the option, as this | |
af54f54d TL |
504 | will allow proper distribution of the VM resources on the host system. |
505 | This option is also required to hot-plug cores or RAM in a VM. | |
34e541c5 EK |
506 | |
507 | If the NUMA option is used, it is recommended to set the number of sockets to | |
4ccb911c | 508 | the number of nodes of the host system. |
34e541c5 | 509 | |
af54f54d TL |
510 | vCPU hot-plug |
511 | ^^^^^^^^^^^^^ | |
512 | ||
513 | Modern operating systems introduced the capability to hot-plug and, to a | |
3a433e9b | 514 | certain extent, hot-unplug CPUs in a running system. Virtualization allows us |
4371b2fe FG |
515 | to avoid a lot of the (physical) problems real hardware can cause in such |
516 | scenarios. | |
517 | Still, this is a rather new and complicated feature, so its use should be | |
518 | restricted to cases where its absolutely needed. Most of the functionality can | |
519 | be replicated with other, well tested and less complicated, features, see | |
af54f54d TL |
520 | xref:qm_cpu_resource_limits[Resource Limits]. |
521 | ||
522 | In {pve} the maximal number of plugged CPUs is always `cores * sockets`. | |
523 | To start a VM with less than this total core count of CPUs you may use the | |
4371b2fe | 524 | *vpus* setting, it denotes how many vCPUs should be plugged in at VM start. |
af54f54d | 525 | |
4371b2fe | 526 | Currently only this feature is only supported on Linux, a kernel newer than 3.10 |
af54f54d TL |
527 | is needed, a kernel newer than 4.7 is recommended. |
528 | ||
529 | You can use a udev rule as follow to automatically set new CPUs as online in | |
530 | the guest: | |
531 | ||
532 | ---- | |
533 | SUBSYSTEM=="cpu", ACTION=="add", TEST=="online", ATTR{online}=="0", ATTR{online}="1" | |
534 | ---- | |
535 | ||
536 | Save this under /etc/udev/rules.d/ as a file ending in `.rules`. | |
537 | ||
d6466262 TL |
538 | Note: CPU hot-remove is machine dependent and requires guest cooperation. The |
539 | deletion command does not guarantee CPU removal to actually happen, typically | |
540 | it's a request forwarded to guest OS using target dependent mechanism, such as | |
541 | ACPI on x86/amd64. | |
af54f54d | 542 | |
80c0adcb DM |
543 | |
544 | [[qm_memory]] | |
34e541c5 EK |
545 | Memory |
546 | ~~~~~~ | |
80c0adcb | 547 | |
34e541c5 EK |
548 | For each VM you have the option to set a fixed size memory or asking |
549 | {pve} to dynamically allocate memory based on the current RAM usage of the | |
59552707 | 550 | host. |
34e541c5 | 551 | |
96124d0f | 552 | .Fixed Memory Allocation |
1ff5e4e8 | 553 | [thumbnail="screenshot/gui-create-vm-memory.png"] |
96124d0f | 554 | |
9ea21953 | 555 | When setting memory and minimum memory to the same amount |
9fb002e6 | 556 | {pve} will simply allocate what you specify to your VM. |
34e541c5 | 557 | |
9abfec65 DC |
558 | Even when using a fixed memory size, the ballooning device gets added to the |
559 | VM, because it delivers useful information such as how much memory the guest | |
560 | really uses. | |
561 | In general, you should leave *ballooning* enabled, but if you want to disable | |
d6466262 | 562 | it (like for debugging purposes), simply uncheck *Ballooning Device* or set |
9abfec65 DC |
563 | |
564 | balloon: 0 | |
565 | ||
566 | in the configuration. | |
567 | ||
96124d0f | 568 | .Automatic Memory Allocation |
96124d0f | 569 | |
34e541c5 | 570 | // see autoballoon() in pvestatd.pm |
58e04593 | 571 | When setting the minimum memory lower than memory, {pve} will make sure that the |
34e541c5 EK |
572 | minimum amount you specified is always available to the VM, and if RAM usage on |
573 | the host is below 80%, will dynamically add memory to the guest up to the | |
f4bfd701 DM |
574 | maximum memory specified. |
575 | ||
a35aad4a | 576 | When the host is running low on RAM, the VM will then release some memory |
34e541c5 EK |
577 | back to the host, swapping running processes if needed and starting the oom |
578 | killer in last resort. The passing around of memory between host and guest is | |
579 | done via a special `balloon` kernel driver running inside the guest, which will | |
580 | grab or release memory pages from the host. | |
581 | 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/] | |
582 | ||
c9f6e1a4 EK |
583 | When multiple VMs use the autoallocate facility, it is possible to set a |
584 | *Shares* coefficient which indicates the relative amount of the free host memory | |
470d4313 | 585 | that each VM should take. Suppose for instance you have four VMs, three of them |
a35aad4a | 586 | running an HTTP server and the last one is a database server. To cache more |
c9f6e1a4 EK |
587 | database blocks in the database server RAM, you would like to prioritize the |
588 | database VM when spare RAM is available. For this you assign a Shares property | |
589 | of 3000 to the database VM, leaving the other VMs to the Shares default setting | |
470d4313 | 590 | of 1000. The host server has 32GB of RAM, and is currently using 16GB, leaving 32 |
c9f6e1a4 EK |
591 | * 80/100 - 16 = 9GB RAM to be allocated to the VMs. The database VM will get 9 * |
592 | 3000 / (3000 + 1000 + 1000 + 1000) = 4.5 GB extra RAM and each HTTP server will | |
a35aad4a | 593 | get 1.5 GB. |
c9f6e1a4 | 594 | |
34e541c5 EK |
595 | All Linux distributions released after 2010 have the balloon kernel driver |
596 | included. For Windows OSes, the balloon driver needs to be added manually and can | |
597 | incur a slowdown of the guest, so we don't recommend using it on critical | |
59552707 | 598 | systems. |
34e541c5 EK |
599 | // see https://forum.proxmox.com/threads/solved-hyper-threading-vs-no-hyper-threading-fixed-vs-variable-memory.20265/ |
600 | ||
470d4313 | 601 | When allocating RAM to your VMs, a good rule of thumb is always to leave 1GB |
34e541c5 EK |
602 | of RAM available to the host. |
603 | ||
80c0adcb DM |
604 | |
605 | [[qm_network_device]] | |
1ff7835b EK |
606 | Network Device |
607 | ~~~~~~~~~~~~~~ | |
80c0adcb | 608 | |
1ff5e4e8 | 609 | [thumbnail="screenshot/gui-create-vm-network.png"] |
c24ddb0a | 610 | |
1ff7835b EK |
611 | Each VM can have many _Network interface controllers_ (NIC), of four different |
612 | types: | |
613 | ||
614 | * *Intel E1000* is the default, and emulates an Intel Gigabit network card. | |
615 | * the *VirtIO* paravirtualized NIC should be used if you aim for maximum | |
616 | performance. Like all VirtIO devices, the guest OS should have the proper driver | |
617 | installed. | |
618 | * the *Realtek 8139* emulates an older 100 MB/s network card, and should | |
59552707 | 619 | only be used when emulating older operating systems ( released before 2002 ) |
1ff7835b EK |
620 | * the *vmxnet3* is another paravirtualized device, which should only be used |
621 | when importing a VM from another hypervisor. | |
622 | ||
623 | {pve} will generate for each NIC a random *MAC address*, so that your VM is | |
624 | addressable on Ethernet networks. | |
625 | ||
470d4313 | 626 | The NIC you added to the VM can follow one of two different models: |
af9c6de1 EK |
627 | |
628 | * in the default *Bridged mode* each virtual NIC is backed on the host by a | |
629 | _tap device_, ( a software loopback device simulating an Ethernet NIC ). This | |
630 | tap device is added to a bridge, by default vmbr0 in {pve}. In this mode, VMs | |
631 | have direct access to the Ethernet LAN on which the host is located. | |
632 | * in the alternative *NAT mode*, each virtual NIC will only communicate with | |
c730e973 | 633 | the QEMU user networking stack, where a built-in router and DHCP server can |
470d4313 | 634 | provide network access. This built-in DHCP will serve addresses in the private |
af9c6de1 | 635 | 10.0.2.0/24 range. The NAT mode is much slower than the bridged mode, and |
f5041150 DC |
636 | should only be used for testing. This mode is only available via CLI or the API, |
637 | but not via the WebUI. | |
af9c6de1 EK |
638 | |
639 | You can also skip adding a network device when creating a VM by selecting *No | |
640 | network device*. | |
641 | ||
750d4f04 | 642 | You can overwrite the *MTU* setting for each VM network device. The option |
00dc358b | 643 | `mtu=1` represents a special case, in which the MTU value will be inherited |
750d4f04 DT |
644 | from the underlying bridge. |
645 | This option is only available for *VirtIO* network devices. | |
646 | ||
af9c6de1 | 647 | .Multiqueue |
1ff7835b | 648 | If you are using the VirtIO driver, you can optionally activate the |
af9c6de1 | 649 | *Multiqueue* option. This option allows the guest OS to process networking |
1ff7835b | 650 | packets using multiple virtual CPUs, providing an increase in the total number |
470d4313 | 651 | of packets transferred. |
1ff7835b EK |
652 | |
653 | //http://blog.vmsplice.net/2011/09/qemu-internals-vhost-architecture.html | |
654 | When using the VirtIO driver with {pve}, each NIC network queue is passed to the | |
a35aad4a | 655 | host kernel, where the queue will be processed by a kernel thread spawned by the |
1ff7835b EK |
656 | vhost driver. With this option activated, it is possible to pass _multiple_ |
657 | network queues to the host kernel for each NIC. | |
658 | ||
659 | //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 | 660 | When using Multiqueue, it is recommended to set it to a value equal |
1ff7835b EK |
661 | to the number of Total Cores of your guest. You also need to set in |
662 | the VM the number of multi-purpose channels on each VirtIO NIC with the ethtool | |
59552707 | 663 | command: |
1ff7835b | 664 | |
7a0d4784 | 665 | `ethtool -L ens1 combined X` |
1ff7835b EK |
666 | |
667 | where X is the number of the number of vcpus of the VM. | |
668 | ||
af9c6de1 | 669 | You should note that setting the Multiqueue parameter to a value greater |
1ff7835b EK |
670 | than one will increase the CPU load on the host and guest systems as the |
671 | traffic increases. We recommend to set this option only when the VM has to | |
672 | process a great number of incoming connections, such as when the VM is running | |
673 | as a router, reverse proxy or a busy HTTP server doing long polling. | |
674 | ||
6cb67d7f DC |
675 | [[qm_display]] |
676 | Display | |
677 | ~~~~~~~ | |
678 | ||
679 | QEMU can virtualize a few types of VGA hardware. Some examples are: | |
680 | ||
681 | * *std*, the default, emulates a card with Bochs VBE extensions. | |
1368dc02 TL |
682 | * *cirrus*, this was once the default, it emulates a very old hardware module |
683 | with all its problems. This display type should only be used if really | |
684 | necessary footnote:[https://www.kraxel.org/blog/2014/10/qemu-using-cirrus-considered-harmful/ | |
d6466262 TL |
685 | qemu: using cirrus considered harmful], for example, if using Windows XP or |
686 | earlier | |
6cb67d7f DC |
687 | * *vmware*, is a VMWare SVGA-II compatible adapter. |
688 | * *qxl*, is the QXL paravirtualized graphics card. Selecting this also | |
37422176 AL |
689 | enables https://www.spice-space.org/[SPICE] (a remote viewer protocol) for the |
690 | VM. | |
e039fe3c TL |
691 | * *virtio-gl*, often named VirGL is a virtual 3D GPU for use inside VMs that |
692 | can offload workloads to the host GPU without requiring special (expensive) | |
693 | models and drivers and neither binding the host GPU completely, allowing | |
694 | reuse between multiple guests and or the host. | |
695 | + | |
696 | NOTE: VirGL support needs some extra libraries that aren't installed by | |
697 | default due to being relatively big and also not available as open source for | |
698 | all GPU models/vendors. For most setups you'll just need to do: | |
699 | `apt install libgl1 libegl1` | |
6cb67d7f DC |
700 | |
701 | You can edit the amount of memory given to the virtual GPU, by setting | |
1368dc02 | 702 | the 'memory' option. This can enable higher resolutions inside the VM, |
6cb67d7f DC |
703 | especially with SPICE/QXL. |
704 | ||
1368dc02 | 705 | As the memory is reserved by display device, selecting Multi-Monitor mode |
d6466262 | 706 | for SPICE (such as `qxl2` for dual monitors) has some implications: |
6cb67d7f | 707 | |
1368dc02 TL |
708 | * Windows needs a device for each monitor, so if your 'ostype' is some |
709 | version of Windows, {pve} gives the VM an extra device per monitor. | |
6cb67d7f | 710 | Each device gets the specified amount of memory. |
1368dc02 | 711 | |
6cb67d7f DC |
712 | * Linux VMs, can always enable more virtual monitors, but selecting |
713 | a Multi-Monitor mode multiplies the memory given to the device with | |
714 | the number of monitors. | |
715 | ||
1368dc02 TL |
716 | Selecting `serialX` as display 'type' disables the VGA output, and redirects |
717 | the Web Console to the selected serial port. A configured display 'memory' | |
718 | setting will be ignored in that case. | |
80c0adcb | 719 | |
dbb44ef0 | 720 | [[qm_usb_passthrough]] |
685cc8e0 DC |
721 | USB Passthrough |
722 | ~~~~~~~~~~~~~~~ | |
80c0adcb | 723 | |
685cc8e0 DC |
724 | There are two different types of USB passthrough devices: |
725 | ||
470d4313 | 726 | * Host USB passthrough |
685cc8e0 DC |
727 | * SPICE USB passthrough |
728 | ||
729 | Host USB passthrough works by giving a VM a USB device of the host. | |
730 | This can either be done via the vendor- and product-id, or | |
731 | via the host bus and port. | |
732 | ||
733 | The vendor/product-id looks like this: *0123:abcd*, | |
734 | where *0123* is the id of the vendor, and *abcd* is the id | |
735 | of the product, meaning two pieces of the same usb device | |
736 | have the same id. | |
737 | ||
738 | The bus/port looks like this: *1-2.3.4*, where *1* is the bus | |
739 | and *2.3.4* is the port path. This represents the physical | |
740 | ports of your host (depending of the internal order of the | |
741 | usb controllers). | |
742 | ||
743 | If a device is present in a VM configuration when the VM starts up, | |
744 | but the device is not present in the host, the VM can boot without problems. | |
470d4313 | 745 | As soon as the device/port is available in the host, it gets passed through. |
685cc8e0 | 746 | |
e60ce90c | 747 | WARNING: Using this kind of USB passthrough means that you cannot move |
685cc8e0 DC |
748 | a VM online to another host, since the hardware is only available |
749 | on the host the VM is currently residing. | |
750 | ||
751 | The second type of passthrough is SPICE USB passthrough. This is useful | |
752 | if you use a SPICE client which supports it. If you add a SPICE USB port | |
753 | to your VM, you can passthrough a USB device from where your SPICE client is, | |
754 | directly to the VM (for example an input device or hardware dongle). | |
755 | ||
80c0adcb DM |
756 | |
757 | [[qm_bios_and_uefi]] | |
076d60ae DC |
758 | BIOS and UEFI |
759 | ~~~~~~~~~~~~~ | |
760 | ||
761 | In order to properly emulate a computer, QEMU needs to use a firmware. | |
55ce3375 TL |
762 | Which, on common PCs often known as BIOS or (U)EFI, is executed as one of the |
763 | first steps when booting a VM. It is responsible for doing basic hardware | |
764 | initialization and for providing an interface to the firmware and hardware for | |
765 | the operating system. By default QEMU uses *SeaBIOS* for this, which is an | |
766 | open-source, x86 BIOS implementation. SeaBIOS is a good choice for most | |
767 | standard setups. | |
076d60ae | 768 | |
8e5720fd | 769 | Some operating systems (such as Windows 11) may require use of an UEFI |
58e695ca | 770 | compatible implementation. In such cases, you must use *OVMF* instead, |
8e5720fd SR |
771 | which is an open-source UEFI implementation. footnote:[See the OVMF Project https://github.com/tianocore/tianocore.github.io/wiki/OVMF] |
772 | ||
d6466262 TL |
773 | There are other scenarios in which the SeaBIOS may not be the ideal firmware to |
774 | boot from, for example if you want to do VGA passthrough. footnote:[Alex | |
775 | Williamson has a good blog entry about this | |
776 | https://vfio.blogspot.co.at/2014/08/primary-graphics-assignment-without-vga.html] | |
076d60ae DC |
777 | |
778 | If you want to use OVMF, there are several things to consider: | |
779 | ||
780 | In order to save things like the *boot order*, there needs to be an EFI Disk. | |
781 | This disk will be included in backups and snapshots, and there can only be one. | |
782 | ||
783 | You can create such a disk with the following command: | |
784 | ||
32e8b5b2 AL |
785 | ---- |
786 | # qm set <vmid> -efidisk0 <storage>:1,format=<format>,efitype=4m,pre-enrolled-keys=1 | |
787 | ---- | |
076d60ae DC |
788 | |
789 | Where *<storage>* is the storage where you want to have the disk, and | |
790 | *<format>* is a format which the storage supports. Alternatively, you can | |
791 | create such a disk through the web interface with 'Add' -> 'EFI Disk' in the | |
792 | hardware section of a VM. | |
793 | ||
8e5720fd SR |
794 | The *efitype* option specifies which version of the OVMF firmware should be |
795 | used. For new VMs, this should always be '4m', as it supports Secure Boot and | |
796 | has more space allocated to support future development (this is the default in | |
797 | the GUI). | |
798 | ||
799 | *pre-enroll-keys* specifies if the efidisk should come pre-loaded with | |
800 | distribution-specific and Microsoft Standard Secure Boot keys. It also enables | |
801 | Secure Boot by default (though it can still be disabled in the OVMF menu within | |
802 | the VM). | |
803 | ||
804 | NOTE: If you want to start using Secure Boot in an existing VM (that still uses | |
805 | a '2m' efidisk), you need to recreate the efidisk. To do so, delete the old one | |
806 | (`qm set <vmid> -delete efidisk0`) and add a new one as described above. This | |
807 | will reset any custom configurations you have made in the OVMF menu! | |
808 | ||
076d60ae | 809 | When using OVMF with a virtual display (without VGA passthrough), |
8e5720fd | 810 | you need to set the client resolution in the OVMF menu (which you can reach |
076d60ae DC |
811 | with a press of the ESC button during boot), or you have to choose |
812 | SPICE as the display type. | |
813 | ||
95e8e1b7 SR |
814 | [[qm_tpm]] |
815 | Trusted Platform Module (TPM) | |
816 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
817 | ||
818 | A *Trusted Platform Module* is a device which stores secret data - such as | |
819 | encryption keys - securely and provides tamper-resistance functions for | |
820 | validating system boot. | |
821 | ||
d6466262 TL |
822 | Certain operating systems (such as Windows 11) require such a device to be |
823 | attached to a machine (be it physical or virtual). | |
95e8e1b7 SR |
824 | |
825 | A TPM is added by specifying a *tpmstate* volume. This works similar to an | |
826 | efidisk, in that it cannot be changed (only removed) once created. You can add | |
827 | one via the following command: | |
828 | ||
32e8b5b2 AL |
829 | ---- |
830 | # qm set <vmid> -tpmstate0 <storage>:1,version=<version> | |
831 | ---- | |
95e8e1b7 SR |
832 | |
833 | Where *<storage>* is the storage you want to put the state on, and *<version>* | |
834 | is either 'v1.2' or 'v2.0'. You can also add one via the web interface, by | |
835 | choosing 'Add' -> 'TPM State' in the hardware section of a VM. | |
836 | ||
837 | The 'v2.0' TPM spec is newer and better supported, so unless you have a specific | |
838 | implementation that requires a 'v1.2' TPM, it should be preferred. | |
839 | ||
840 | NOTE: Compared to a physical TPM, an emulated one does *not* provide any real | |
841 | security benefits. The point of a TPM is that the data on it cannot be modified | |
842 | easily, except via commands specified as part of the TPM spec. Since with an | |
843 | emulated device the data storage happens on a regular volume, it can potentially | |
844 | be edited by anyone with access to it. | |
845 | ||
0ad30983 DC |
846 | [[qm_ivshmem]] |
847 | Inter-VM shared memory | |
848 | ~~~~~~~~~~~~~~~~~~~~~~ | |
849 | ||
8861c7ad TL |
850 | You can add an Inter-VM shared memory device (`ivshmem`), which allows one to |
851 | share memory between the host and a guest, or also between multiple guests. | |
0ad30983 DC |
852 | |
853 | To add such a device, you can use `qm`: | |
854 | ||
32e8b5b2 AL |
855 | ---- |
856 | # qm set <vmid> -ivshmem size=32,name=foo | |
857 | ---- | |
0ad30983 DC |
858 | |
859 | Where the size is in MiB. The file will be located under | |
860 | `/dev/shm/pve-shm-$name` (the default name is the vmid). | |
861 | ||
4d1a19eb TL |
862 | NOTE: Currently the device will get deleted as soon as any VM using it got |
863 | shutdown or stopped. Open connections will still persist, but new connections | |
864 | to the exact same device cannot be made anymore. | |
865 | ||
8861c7ad | 866 | A use case for such a device is the Looking Glass |
451bb75f SR |
867 | footnote:[Looking Glass: https://looking-glass.io/] project, which enables high |
868 | performance, low-latency display mirroring between host and guest. | |
0ad30983 | 869 | |
ca8c3009 AL |
870 | [[qm_audio_device]] |
871 | Audio Device | |
872 | ~~~~~~~~~~~~ | |
873 | ||
874 | To add an audio device run the following command: | |
875 | ||
876 | ---- | |
877 | qm set <vmid> -audio0 device=<device> | |
878 | ---- | |
879 | ||
880 | Supported audio devices are: | |
881 | ||
882 | * `ich9-intel-hda`: Intel HD Audio Controller, emulates ICH9 | |
883 | * `intel-hda`: Intel HD Audio Controller, emulates ICH6 | |
884 | * `AC97`: Audio Codec '97, useful for older operating systems like Windows XP | |
885 | ||
cf41761d AL |
886 | There are two backends available: |
887 | ||
888 | * 'spice' | |
889 | * 'none' | |
890 | ||
891 | The 'spice' backend can be used in combination with xref:qm_display[SPICE] while | |
892 | the 'none' backend can be useful if an audio device is needed in the VM for some | |
893 | software to work. To use the physical audio device of the host use device | |
894 | passthrough (see xref:qm_pci_passthrough[PCI Passthrough] and | |
895 | xref:qm_usb_passthrough[USB Passthrough]). Remote protocols like Microsoft’s RDP | |
896 | have options to play sound. | |
897 | ||
ca8c3009 | 898 | |
adb2c91d SR |
899 | [[qm_virtio_rng]] |
900 | VirtIO RNG | |
901 | ~~~~~~~~~~ | |
902 | ||
903 | A RNG (Random Number Generator) is a device providing entropy ('randomness') to | |
904 | a system. A virtual hardware-RNG can be used to provide such entropy from the | |
905 | host system to a guest VM. This helps to avoid entropy starvation problems in | |
906 | the guest (a situation where not enough entropy is available and the system may | |
907 | slow down or run into problems), especially during the guests boot process. | |
908 | ||
909 | To add a VirtIO-based emulated RNG, run the following command: | |
910 | ||
911 | ---- | |
912 | qm set <vmid> -rng0 source=<source>[,max_bytes=X,period=Y] | |
913 | ---- | |
914 | ||
915 | `source` specifies where entropy is read from on the host and has to be one of | |
916 | the following: | |
917 | ||
918 | * `/dev/urandom`: Non-blocking kernel entropy pool (preferred) | |
919 | * `/dev/random`: Blocking kernel pool (not recommended, can lead to entropy | |
920 | starvation on the host system) | |
921 | * `/dev/hwrng`: To pass through a hardware RNG attached to the host (if multiple | |
922 | are available, the one selected in | |
923 | `/sys/devices/virtual/misc/hw_random/rng_current` will be used) | |
924 | ||
925 | A limit can be specified via the `max_bytes` and `period` parameters, they are | |
926 | read as `max_bytes` per `period` in milliseconds. However, it does not represent | |
927 | a linear relationship: 1024B/1000ms would mean that up to 1 KiB of data becomes | |
928 | available on a 1 second timer, not that 1 KiB is streamed to the guest over the | |
929 | course of one second. Reducing the `period` can thus be used to inject entropy | |
930 | into the guest at a faster rate. | |
931 | ||
932 | By default, the limit is set to 1024 bytes per 1000 ms (1 KiB/s). It is | |
933 | recommended to always use a limiter to avoid guests using too many host | |
934 | resources. If desired, a value of '0' for `max_bytes` can be used to disable | |
935 | all limits. | |
936 | ||
777cf894 | 937 | [[qm_bootorder]] |
8cd6f474 TL |
938 | Device Boot Order |
939 | ~~~~~~~~~~~~~~~~~ | |
777cf894 SR |
940 | |
941 | QEMU can tell the guest which devices it should boot from, and in which order. | |
d6466262 | 942 | This can be specified in the config via the `boot` property, for example: |
777cf894 SR |
943 | |
944 | ---- | |
945 | boot: order=scsi0;net0;hostpci0 | |
946 | ---- | |
947 | ||
948 | [thumbnail="screenshot/gui-qemu-edit-bootorder.png"] | |
949 | ||
950 | This way, the guest would first attempt to boot from the disk `scsi0`, if that | |
951 | fails, it would go on to attempt network boot from `net0`, and in case that | |
952 | fails too, finally attempt to boot from a passed through PCIe device (seen as | |
953 | disk in case of NVMe, otherwise tries to launch into an option ROM). | |
954 | ||
955 | On the GUI you can use a drag-and-drop editor to specify the boot order, and use | |
956 | the checkbox to enable or disable certain devices for booting altogether. | |
957 | ||
958 | NOTE: If your guest uses multiple disks to boot the OS or load the bootloader, | |
959 | all of them must be marked as 'bootable' (that is, they must have the checkbox | |
960 | enabled or appear in the list in the config) for the guest to be able to boot. | |
961 | This is because recent SeaBIOS and OVMF versions only initialize disks if they | |
962 | are marked 'bootable'. | |
963 | ||
964 | In any case, even devices not appearing in the list or having the checkmark | |
965 | disabled will still be available to the guest, once it's operating system has | |
966 | booted and initialized them. The 'bootable' flag only affects the guest BIOS and | |
967 | bootloader. | |
968 | ||
969 | ||
288e3f46 EK |
970 | [[qm_startup_and_shutdown]] |
971 | Automatic Start and Shutdown of Virtual Machines | |
972 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
973 | ||
974 | After creating your VMs, you probably want them to start automatically | |
975 | when the host system boots. For this you need to select the option 'Start at | |
976 | boot' from the 'Options' Tab of your VM in the web interface, or set it with | |
977 | the following command: | |
978 | ||
32e8b5b2 AL |
979 | ---- |
980 | # qm set <vmid> -onboot 1 | |
981 | ---- | |
288e3f46 | 982 | |
4dbeb548 DM |
983 | .Start and Shutdown Order |
984 | ||
1ff5e4e8 | 985 | [thumbnail="screenshot/gui-qemu-edit-start-order.png"] |
4dbeb548 DM |
986 | |
987 | In some case you want to be able to fine tune the boot order of your | |
988 | VMs, for instance if one of your VM is providing firewalling or DHCP | |
989 | to other guest systems. For this you can use the following | |
990 | parameters: | |
288e3f46 | 991 | |
d6466262 TL |
992 | * *Start/Shutdown order*: Defines the start order priority. For example, set it |
993 | * to 1 if | |
288e3f46 EK |
994 | you want the VM to be the first to be started. (We use the reverse startup |
995 | order for shutdown, so a machine with a start order of 1 would be the last to | |
7eed72d8 | 996 | be shut down). If multiple VMs have the same order defined on a host, they will |
d750c851 | 997 | additionally be ordered by 'VMID' in ascending order. |
288e3f46 | 998 | * *Startup delay*: Defines the interval between this VM start and subsequent |
d6466262 TL |
999 | VMs starts. For example, set it to 240 if you want to wait 240 seconds before |
1000 | starting other VMs. | |
288e3f46 | 1001 | * *Shutdown timeout*: Defines the duration in seconds {pve} should wait |
d6466262 TL |
1002 | for the VM to be offline after issuing a shutdown command. By default this |
1003 | value is set to 180, which means that {pve} will issue a shutdown request and | |
1004 | wait 180 seconds for the machine to be offline. If the machine is still online | |
1005 | after the timeout it will be stopped forcefully. | |
288e3f46 | 1006 | |
2b2c6286 TL |
1007 | NOTE: VMs managed by the HA stack do not follow the 'start on boot' and |
1008 | 'boot order' options currently. Those VMs will be skipped by the startup and | |
1009 | shutdown algorithm as the HA manager itself ensures that VMs get started and | |
1010 | stopped. | |
1011 | ||
288e3f46 | 1012 | Please note that machines without a Start/Shutdown order parameter will always |
7eed72d8 | 1013 | start after those where the parameter is set. Further, this parameter can only |
d750c851 | 1014 | be enforced between virtual machines running on the same host, not |
288e3f46 | 1015 | cluster-wide. |
076d60ae | 1016 | |
0f7778ac DW |
1017 | If you require a delay between the host boot and the booting of the first VM, |
1018 | see the section on xref:first_guest_boot_delay[Proxmox VE Node Management]. | |
1019 | ||
c0f039aa AL |
1020 | |
1021 | [[qm_qemu_agent]] | |
c730e973 | 1022 | QEMU Guest Agent |
c0f039aa AL |
1023 | ~~~~~~~~~~~~~~~~ |
1024 | ||
c730e973 | 1025 | The QEMU Guest Agent is a service which runs inside the VM, providing a |
c0f039aa AL |
1026 | communication channel between the host and the guest. It is used to exchange |
1027 | information and allows the host to issue commands to the guest. | |
1028 | ||
1029 | For example, the IP addresses in the VM summary panel are fetched via the guest | |
1030 | agent. | |
1031 | ||
1032 | Or when starting a backup, the guest is told via the guest agent to sync | |
1033 | outstanding writes via the 'fs-freeze' and 'fs-thaw' commands. | |
1034 | ||
1035 | For the guest agent to work properly the following steps must be taken: | |
1036 | ||
1037 | * install the agent in the guest and make sure it is running | |
1038 | * enable the communication via the agent in {pve} | |
1039 | ||
1040 | Install Guest Agent | |
1041 | ^^^^^^^^^^^^^^^^^^^ | |
1042 | ||
1043 | For most Linux distributions, the guest agent is available. The package is | |
1044 | usually named `qemu-guest-agent`. | |
1045 | ||
1046 | For Windows, it can be installed from the | |
1047 | https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso[Fedora | |
1048 | VirtIO driver ISO]. | |
1049 | ||
1050 | Enable Guest Agent Communication | |
1051 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1052 | ||
1053 | Communication from {pve} with the guest agent can be enabled in the VM's | |
1054 | *Options* panel. A fresh start of the VM is necessary for the changes to take | |
1055 | effect. | |
1056 | ||
1057 | It is possible to enable the 'Run guest-trim' option. With this enabled, | |
1058 | {pve} will issue a trim command to the guest after the following | |
1059 | operations that have the potential to write out zeros to the storage: | |
1060 | ||
1061 | * moving a disk to another storage | |
1062 | * live migrating a VM to another node with local storage | |
1063 | ||
1064 | On a thin provisioned storage, this can help to free up unused space. | |
1065 | ||
95117b6c FE |
1066 | NOTE: There is a caveat with ext4 on Linux, because it uses an in-memory |
1067 | optimization to avoid issuing duplicate TRIM requests. Since the guest doesn't | |
1068 | know about the change in the underlying storage, only the first guest-trim will | |
1069 | run as expected. Subsequent ones, until the next reboot, will only consider | |
1070 | parts of the filesystem that changed since then. | |
1071 | ||
c0f039aa AL |
1072 | Troubleshooting |
1073 | ^^^^^^^^^^^^^^^ | |
1074 | ||
1075 | .VM does not shut down | |
1076 | ||
1077 | Make sure the guest agent is installed and running. | |
1078 | ||
1079 | Once the guest agent is enabled, {pve} will send power commands like | |
1080 | 'shutdown' via the guest agent. If the guest agent is not running, commands | |
1081 | cannot get executed properly and the shutdown command will run into a timeout. | |
1082 | ||
22a0091c AL |
1083 | [[qm_spice_enhancements]] |
1084 | SPICE Enhancements | |
1085 | ~~~~~~~~~~~~~~~~~~ | |
1086 | ||
1087 | SPICE Enhancements are optional features that can improve the remote viewer | |
1088 | experience. | |
1089 | ||
1090 | To enable them via the GUI go to the *Options* panel of the virtual machine. Run | |
1091 | the following command to enable them via the CLI: | |
1092 | ||
1093 | ---- | |
1094 | qm set <vmid> -spice_enhancements foldersharing=1,videostreaming=all | |
1095 | ---- | |
1096 | ||
1097 | NOTE: To use these features the <<qm_display,*Display*>> of the virtual machine | |
1098 | must be set to SPICE (qxl). | |
1099 | ||
1100 | Folder Sharing | |
1101 | ^^^^^^^^^^^^^^ | |
1102 | ||
1103 | Share a local folder with the guest. The `spice-webdavd` daemon needs to be | |
1104 | installed in the guest. It makes the shared folder available through a local | |
1105 | WebDAV server located at http://localhost:9843. | |
1106 | ||
1107 | For Windows guests the installer for the 'Spice WebDAV daemon' can be downloaded | |
1108 | from the | |
1109 | https://www.spice-space.org/download.html#windows-binaries[official SPICE website]. | |
1110 | ||
1111 | Most Linux distributions have a package called `spice-webdavd` that can be | |
1112 | installed. | |
1113 | ||
1114 | To share a folder in Virt-Viewer (Remote Viewer) go to 'File -> Preferences'. | |
1115 | Select the folder to share and then enable the checkbox. | |
1116 | ||
1117 | NOTE: Folder sharing currently only works in the Linux version of Virt-Viewer. | |
1118 | ||
0dcd22f5 AL |
1119 | CAUTION: Experimental! Currently this feature does not work reliably. |
1120 | ||
22a0091c AL |
1121 | Video Streaming |
1122 | ^^^^^^^^^^^^^^^ | |
1123 | ||
1124 | Fast refreshing areas are encoded into a video stream. Two options exist: | |
1125 | ||
1126 | * *all*: Any fast refreshing area will be encoded into a video stream. | |
1127 | * *filter*: Additional filters are used to decide if video streaming should be | |
1128 | used (currently only small window surfaces are skipped). | |
1129 | ||
1130 | A general recommendation if video streaming should be enabled and which option | |
1131 | to choose from cannot be given. Your mileage may vary depending on the specific | |
1132 | circumstances. | |
1133 | ||
1134 | Troubleshooting | |
1135 | ^^^^^^^^^^^^^^^ | |
1136 | ||
19a58e02 | 1137 | .Shared folder does not show up |
22a0091c AL |
1138 | |
1139 | Make sure the WebDAV service is enabled and running in the guest. On Windows it | |
1140 | is called 'Spice webdav proxy'. In Linux the name is 'spice-webdavd' but can be | |
1141 | different depending on the distribution. | |
1142 | ||
1143 | If the service is running, check the WebDAV server by opening | |
1144 | http://localhost:9843 in a browser in the guest. | |
1145 | ||
1146 | It can help to restart the SPICE session. | |
c73c190f DM |
1147 | |
1148 | [[qm_migration]] | |
1149 | Migration | |
1150 | --------- | |
1151 | ||
1ff5e4e8 | 1152 | [thumbnail="screenshot/gui-qemu-migrate.png"] |
e4bcef0a | 1153 | |
c73c190f DM |
1154 | If you have a cluster, you can migrate your VM to another host with |
1155 | ||
32e8b5b2 AL |
1156 | ---- |
1157 | # qm migrate <vmid> <target> | |
1158 | ---- | |
c73c190f | 1159 | |
8df8cfb7 DC |
1160 | There are generally two mechanisms for this |
1161 | ||
1162 | * Online Migration (aka Live Migration) | |
1163 | * Offline Migration | |
1164 | ||
1165 | Online Migration | |
1166 | ~~~~~~~~~~~~~~~~ | |
1167 | ||
27780834 TL |
1168 | If your VM is running and no locally bound resources are configured (such as |
1169 | passed-through devices), you can initiate a live migration with the `--online` | |
1170 | flag in the `qm migration` command evocation. The web-interface defaults to | |
1171 | live migration when the VM is running. | |
c73c190f | 1172 | |
8df8cfb7 DC |
1173 | How it works |
1174 | ^^^^^^^^^^^^ | |
1175 | ||
27780834 TL |
1176 | Online migration first starts a new QEMU process on the target host with the |
1177 | 'incoming' flag, which performs only basic initialization with the guest vCPUs | |
1178 | still paused and then waits for the guest memory and device state data streams | |
1179 | of the source Virtual Machine. | |
1180 | All other resources, such as disks, are either shared or got already sent | |
1181 | before runtime state migration of the VMs begins; so only the memory content | |
1182 | and device state remain to be transferred. | |
1183 | ||
1184 | Once this connection is established, the source begins asynchronously sending | |
1185 | the memory content to the target. If the guest memory on the source changes, | |
1186 | those sections are marked dirty and another pass is made to send the guest | |
1187 | memory data. | |
1188 | This loop is repeated until the data difference between running source VM | |
1189 | and incoming target VM is small enough to be sent in a few milliseconds, | |
1190 | because then the source VM can be paused completely, without a user or program | |
1191 | noticing the pause, so that the remaining data can be sent to the target, and | |
1192 | then unpause the targets VM's CPU to make it the new running VM in well under a | |
1193 | second. | |
8df8cfb7 DC |
1194 | |
1195 | Requirements | |
1196 | ^^^^^^^^^^^^ | |
1197 | ||
1198 | For Live Migration to work, there are some things required: | |
1199 | ||
27780834 TL |
1200 | * The VM has no local resources that cannot be migrated. For example, |
1201 | PCI or USB devices that are passed through currently block live-migration. | |
1202 | Local Disks, on the other hand, can be migrated by sending them to the target | |
1203 | just fine. | |
1204 | * The hosts are located in the same {pve} cluster. | |
1205 | * The hosts have a working (and reliable) network connection between them. | |
1206 | * The target host must have the same, or higher versions of the | |
1207 | {pve} packages. Although it can sometimes work the other way around, this | |
1208 | cannot be guaranteed. | |
1209 | * The hosts have CPUs from the same vendor with similar capabilities. Different | |
1210 | vendor *might* work depending on the actual models and VMs CPU type | |
1211 | configured, but it cannot be guaranteed - so please test before deploying | |
1212 | such a setup in production. | |
8df8cfb7 DC |
1213 | |
1214 | Offline Migration | |
1215 | ~~~~~~~~~~~~~~~~~ | |
1216 | ||
27780834 TL |
1217 | If you have local resources, you can still migrate your VMs offline as long as |
1218 | all disk are on storage defined on both hosts. | |
1219 | Migration then copies the disks to the target host over the network, as with | |
1220 | online migration. Note that any hardware pass-through configuration may need to | |
1221 | be adapted to the device location on the target host. | |
1222 | ||
1223 | // TODO: mention hardware map IDs as better way to solve that, once available | |
c73c190f | 1224 | |
eeb87f95 DM |
1225 | [[qm_copy_and_clone]] |
1226 | Copies and Clones | |
1227 | ----------------- | |
9e55c76d | 1228 | |
1ff5e4e8 | 1229 | [thumbnail="screenshot/gui-qemu-full-clone.png"] |
9e55c76d DM |
1230 | |
1231 | VM installation is usually done using an installation media (CD-ROM) | |
61018238 | 1232 | from the operating system vendor. Depending on the OS, this can be a |
9e55c76d DM |
1233 | time consuming task one might want to avoid. |
1234 | ||
1235 | An easy way to deploy many VMs of the same type is to copy an existing | |
1236 | VM. We use the term 'clone' for such copies, and distinguish between | |
1237 | 'linked' and 'full' clones. | |
1238 | ||
1239 | Full Clone:: | |
1240 | ||
1241 | The result of such copy is an independent VM. The | |
1242 | new VM does not share any storage resources with the original. | |
1243 | + | |
707e37a2 | 1244 | |
9e55c76d DM |
1245 | It is possible to select a *Target Storage*, so one can use this to |
1246 | migrate a VM to a totally different storage. You can also change the | |
1247 | disk image *Format* if the storage driver supports several formats. | |
1248 | + | |
707e37a2 | 1249 | |
730fbca4 | 1250 | NOTE: A full clone needs to read and copy all VM image data. This is |
9e55c76d | 1251 | usually much slower than creating a linked clone. |
707e37a2 DM |
1252 | + |
1253 | ||
1254 | Some storage types allows to copy a specific *Snapshot*, which | |
1255 | defaults to the 'current' VM data. This also means that the final copy | |
1256 | never includes any additional snapshots from the original VM. | |
1257 | ||
9e55c76d DM |
1258 | |
1259 | Linked Clone:: | |
1260 | ||
730fbca4 | 1261 | Modern storage drivers support a way to generate fast linked |
9e55c76d DM |
1262 | clones. Such a clone is a writable copy whose initial contents are the |
1263 | same as the original data. Creating a linked clone is nearly | |
1264 | instantaneous, and initially consumes no additional space. | |
1265 | + | |
707e37a2 | 1266 | |
9e55c76d DM |
1267 | They are called 'linked' because the new image still refers to the |
1268 | original. Unmodified data blocks are read from the original image, but | |
1269 | modification are written (and afterwards read) from a new | |
1270 | location. This technique is called 'Copy-on-write'. | |
1271 | + | |
707e37a2 DM |
1272 | |
1273 | This requires that the original volume is read-only. With {pve} one | |
1274 | can convert any VM into a read-only <<qm_templates, Template>>). Such | |
1275 | templates can later be used to create linked clones efficiently. | |
1276 | + | |
1277 | ||
730fbca4 OB |
1278 | NOTE: You cannot delete an original template while linked clones |
1279 | exist. | |
9e55c76d | 1280 | + |
707e37a2 DM |
1281 | |
1282 | It is not possible to change the *Target storage* for linked clones, | |
1283 | because this is a storage internal feature. | |
9e55c76d DM |
1284 | |
1285 | ||
1286 | The *Target node* option allows you to create the new VM on a | |
1287 | different node. The only restriction is that the VM is on shared | |
1288 | storage, and that storage is also available on the target node. | |
1289 | ||
730fbca4 | 1290 | To avoid resource conflicts, all network interface MAC addresses get |
9e55c76d DM |
1291 | randomized, and we generate a new 'UUID' for the VM BIOS (smbios1) |
1292 | setting. | |
1293 | ||
1294 | ||
707e37a2 DM |
1295 | [[qm_templates]] |
1296 | Virtual Machine Templates | |
1297 | ------------------------- | |
1298 | ||
1299 | One can convert a VM into a Template. Such templates are read-only, | |
1300 | and you can use them to create linked clones. | |
1301 | ||
1302 | NOTE: It is not possible to start templates, because this would modify | |
1303 | the disk images. If you want to change the template, create a linked | |
1304 | clone and modify that. | |
1305 | ||
319d5325 DC |
1306 | VM Generation ID |
1307 | ---------------- | |
1308 | ||
941ff8d3 | 1309 | {pve} supports Virtual Machine Generation ID ('vmgenid') footnote:[Official |
effa4818 TL |
1310 | 'vmgenid' Specification |
1311 | https://docs.microsoft.com/en-us/windows/desktop/hyperv_v2/virtual-machine-generation-identifier] | |
1312 | for virtual machines. | |
1313 | This can be used by the guest operating system to detect any event resulting | |
1314 | in a time shift event, for example, restoring a backup or a snapshot rollback. | |
319d5325 | 1315 | |
effa4818 TL |
1316 | When creating new VMs, a 'vmgenid' will be automatically generated and saved |
1317 | in its configuration file. | |
319d5325 | 1318 | |
effa4818 TL |
1319 | To create and add a 'vmgenid' to an already existing VM one can pass the |
1320 | special value `1' to let {pve} autogenerate one or manually set the 'UUID' | |
d6466262 TL |
1321 | footnote:[Online GUID generator http://guid.one/] by using it as value, for |
1322 | example: | |
319d5325 | 1323 | |
effa4818 | 1324 | ---- |
32e8b5b2 AL |
1325 | # qm set VMID -vmgenid 1 |
1326 | # qm set VMID -vmgenid 00000000-0000-0000-0000-000000000000 | |
effa4818 | 1327 | ---- |
319d5325 | 1328 | |
cfd48f55 TL |
1329 | NOTE: The initial addition of a 'vmgenid' device to an existing VM, may result |
1330 | in the same effects as a change on snapshot rollback, backup restore, etc., has | |
1331 | as the VM can interpret this as generation change. | |
1332 | ||
effa4818 TL |
1333 | In the rare case the 'vmgenid' mechanism is not wanted one can pass `0' for |
1334 | its value on VM creation, or retroactively delete the property in the | |
1335 | configuration with: | |
319d5325 | 1336 | |
effa4818 | 1337 | ---- |
32e8b5b2 | 1338 | # qm set VMID -delete vmgenid |
effa4818 | 1339 | ---- |
319d5325 | 1340 | |
effa4818 TL |
1341 | The most prominent use case for 'vmgenid' are newer Microsoft Windows |
1342 | operating systems, which use it to avoid problems in time sensitive or | |
d6466262 | 1343 | replicate services (such as databases or domain controller |
cfd48f55 TL |
1344 | footnote:[https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/get-started/virtual-dc/virtualized-domain-controller-architecture]) |
1345 | on snapshot rollback, backup restore or a whole VM clone operation. | |
319d5325 | 1346 | |
c069256d EK |
1347 | Importing Virtual Machines and disk images |
1348 | ------------------------------------------ | |
56368da8 EK |
1349 | |
1350 | A VM export from a foreign hypervisor takes usually the form of one or more disk | |
59552707 | 1351 | images, with a configuration file describing the settings of the VM (RAM, |
56368da8 EK |
1352 | number of cores). + |
1353 | The disk images can be in the vmdk format, if the disks come from | |
59552707 DM |
1354 | VMware or VirtualBox, or qcow2 if the disks come from a KVM hypervisor. |
1355 | The most popular configuration format for VM exports is the OVF standard, but in | |
1356 | practice interoperation is limited because many settings are not implemented in | |
1357 | the standard itself, and hypervisors export the supplementary information | |
56368da8 EK |
1358 | in non-standard extensions. |
1359 | ||
1360 | Besides the problem of format, importing disk images from other hypervisors | |
1361 | may fail if the emulated hardware changes too much from one hypervisor to | |
1362 | another. Windows VMs are particularly concerned by this, as the OS is very | |
1363 | picky about any changes of hardware. This problem may be solved by | |
1364 | installing the MergeIDE.zip utility available from the Internet before exporting | |
1365 | and choosing a hard disk type of *IDE* before booting the imported Windows VM. | |
1366 | ||
59552707 | 1367 | Finally there is the question of paravirtualized drivers, which improve the |
56368da8 EK |
1368 | speed of the emulated system and are specific to the hypervisor. |
1369 | GNU/Linux and other free Unix OSes have all the necessary drivers installed by | |
1370 | default and you can switch to the paravirtualized drivers right after importing | |
59552707 | 1371 | the VM. For Windows VMs, you need to install the Windows paravirtualized |
56368da8 EK |
1372 | drivers by yourself. |
1373 | ||
1374 | GNU/Linux and other free Unix can usually be imported without hassle. Note | |
eb01c5cf | 1375 | that we cannot guarantee a successful import/export of Windows VMs in all |
56368da8 EK |
1376 | cases due to the problems above. |
1377 | ||
c069256d EK |
1378 | Step-by-step example of a Windows OVF import |
1379 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
56368da8 | 1380 | |
59552707 | 1381 | Microsoft provides |
c069256d | 1382 | https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/[Virtual Machines downloads] |
144d5ede | 1383 | to get started with Windows development.We are going to use one of these |
c069256d | 1384 | to demonstrate the OVF import feature. |
56368da8 | 1385 | |
c069256d EK |
1386 | Download the Virtual Machine zip |
1387 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
56368da8 | 1388 | |
144d5ede | 1389 | After getting informed about the user agreement, choose the _Windows 10 |
c069256d | 1390 | Enterprise (Evaluation - Build)_ for the VMware platform, and download the zip. |
56368da8 EK |
1391 | |
1392 | Extract the disk image from the zip | |
1393 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1394 | ||
c069256d EK |
1395 | Using the `unzip` utility or any archiver of your choice, unpack the zip, |
1396 | and copy via ssh/scp the ovf and vmdk files to your {pve} host. | |
56368da8 | 1397 | |
c069256d EK |
1398 | Import the Virtual Machine |
1399 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
56368da8 | 1400 | |
c069256d EK |
1401 | This will create a new virtual machine, using cores, memory and |
1402 | VM name as read from the OVF manifest, and import the disks to the +local-lvm+ | |
1403 | storage. You have to configure the network manually. | |
56368da8 | 1404 | |
32e8b5b2 AL |
1405 | ---- |
1406 | # qm importovf 999 WinDev1709Eval.ovf local-lvm | |
1407 | ---- | |
56368da8 | 1408 | |
c069256d | 1409 | The VM is ready to be started. |
56368da8 | 1410 | |
c069256d EK |
1411 | Adding an external disk image to a Virtual Machine |
1412 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
56368da8 | 1413 | |
144d5ede | 1414 | You can also add an existing disk image to a VM, either coming from a |
c069256d EK |
1415 | foreign hypervisor, or one that you created yourself. |
1416 | ||
1417 | Suppose you created a Debian/Ubuntu disk image with the 'vmdebootstrap' tool: | |
1418 | ||
1419 | vmdebootstrap --verbose \ | |
67d59a35 | 1420 | --size 10GiB --serial-console \ |
c069256d EK |
1421 | --grub --no-extlinux \ |
1422 | --package openssh-server \ | |
1423 | --package avahi-daemon \ | |
1424 | --package qemu-guest-agent \ | |
1425 | --hostname vm600 --enable-dhcp \ | |
1426 | --customize=./copy_pub_ssh.sh \ | |
1427 | --sparse --image vm600.raw | |
1428 | ||
10a2a4aa FE |
1429 | You can now create a new target VM, importing the image to the storage `pvedir` |
1430 | and attaching it to the VM's SCSI controller: | |
c069256d | 1431 | |
32e8b5b2 AL |
1432 | ---- |
1433 | # qm create 600 --net0 virtio,bridge=vmbr0 --name vm600 --serial0 socket \ | |
10a2a4aa FE |
1434 | --boot order=scsi0 --scsihw virtio-scsi-pci --ostype l26 \ |
1435 | --scsi0 pvedir:0,import-from=/path/to/dir/vm600.raw | |
32e8b5b2 | 1436 | ---- |
c069256d EK |
1437 | |
1438 | The VM is ready to be started. | |
707e37a2 | 1439 | |
7eb69fd2 | 1440 | |
16b4185a | 1441 | ifndef::wiki[] |
7eb69fd2 | 1442 | include::qm-cloud-init.adoc[] |
16b4185a DM |
1443 | endif::wiki[] |
1444 | ||
6e4c46c4 DC |
1445 | ifndef::wiki[] |
1446 | include::qm-pci-passthrough.adoc[] | |
1447 | endif::wiki[] | |
16b4185a | 1448 | |
c2c8eb89 | 1449 | Hookscripts |
91f416b7 | 1450 | ----------- |
c2c8eb89 DC |
1451 | |
1452 | You can add a hook script to VMs with the config property `hookscript`. | |
1453 | ||
32e8b5b2 AL |
1454 | ---- |
1455 | # qm set 100 --hookscript local:snippets/hookscript.pl | |
1456 | ---- | |
c2c8eb89 DC |
1457 | |
1458 | It will be called during various phases of the guests lifetime. | |
1459 | For an example and documentation see the example script under | |
1460 | `/usr/share/pve-docs/examples/guest-example-hookscript.pl`. | |
7eb69fd2 | 1461 | |
88a31964 DC |
1462 | [[qm_hibernate]] |
1463 | Hibernation | |
1464 | ----------- | |
1465 | ||
1466 | You can suspend a VM to disk with the GUI option `Hibernate` or with | |
1467 | ||
32e8b5b2 AL |
1468 | ---- |
1469 | # qm suspend ID --todisk | |
1470 | ---- | |
88a31964 DC |
1471 | |
1472 | That means that the current content of the memory will be saved onto disk | |
1473 | and the VM gets stopped. On the next start, the memory content will be | |
1474 | loaded and the VM can continue where it was left off. | |
1475 | ||
1476 | [[qm_vmstatestorage]] | |
1477 | .State storage selection | |
1478 | If no target storage for the memory is given, it will be automatically | |
1479 | chosen, the first of: | |
1480 | ||
1481 | 1. The storage `vmstatestorage` from the VM config. | |
1482 | 2. The first shared storage from any VM disk. | |
1483 | 3. The first non-shared storage from any VM disk. | |
1484 | 4. The storage `local` as a fallback. | |
1485 | ||
8c1189b6 | 1486 | Managing Virtual Machines with `qm` |
dd042288 | 1487 | ------------------------------------ |
f69cfd23 | 1488 | |
c730e973 | 1489 | qm is the tool to manage QEMU/KVM virtual machines on {pve}. You can |
f69cfd23 DM |
1490 | create and destroy virtual machines, and control execution |
1491 | (start/stop/suspend/resume). Besides that, you can use qm to set | |
1492 | parameters in the associated config file. It is also possible to | |
1493 | create and delete virtual disks. | |
1494 | ||
dd042288 EK |
1495 | CLI Usage Examples |
1496 | ~~~~~~~~~~~~~~~~~~ | |
1497 | ||
b01b1f2c EK |
1498 | Using an iso file uploaded on the 'local' storage, create a VM |
1499 | with a 4 GB IDE disk on the 'local-lvm' storage | |
dd042288 | 1500 | |
32e8b5b2 AL |
1501 | ---- |
1502 | # qm create 300 -ide0 local-lvm:4 -net0 e1000 -cdrom local:iso/proxmox-mailgateway_2.1.iso | |
1503 | ---- | |
dd042288 EK |
1504 | |
1505 | Start the new VM | |
1506 | ||
32e8b5b2 AL |
1507 | ---- |
1508 | # qm start 300 | |
1509 | ---- | |
dd042288 EK |
1510 | |
1511 | Send a shutdown request, then wait until the VM is stopped. | |
1512 | ||
32e8b5b2 AL |
1513 | ---- |
1514 | # qm shutdown 300 && qm wait 300 | |
1515 | ---- | |
dd042288 EK |
1516 | |
1517 | Same as above, but only wait for 40 seconds. | |
1518 | ||
32e8b5b2 AL |
1519 | ---- |
1520 | # qm shutdown 300 && qm wait 300 -timeout 40 | |
1521 | ---- | |
dd042288 | 1522 | |
87927c65 DJ |
1523 | Destroying a VM always removes it from Access Control Lists and it always |
1524 | removes the firewall configuration of the VM. You have to activate | |
1525 | '--purge', if you want to additionally remove the VM from replication jobs, | |
1526 | backup jobs and HA resource configurations. | |
1527 | ||
32e8b5b2 AL |
1528 | ---- |
1529 | # qm destroy 300 --purge | |
1530 | ---- | |
87927c65 | 1531 | |
66aecccb AL |
1532 | Move a disk image to a different storage. |
1533 | ||
32e8b5b2 AL |
1534 | ---- |
1535 | # qm move-disk 300 scsi0 other-storage | |
1536 | ---- | |
66aecccb AL |
1537 | |
1538 | Reassign a disk image to a different VM. This will remove the disk `scsi1` from | |
1539 | the source VM and attaches it as `scsi3` to the target VM. In the background | |
1540 | the disk image is being renamed so that the name matches the new owner. | |
1541 | ||
32e8b5b2 AL |
1542 | ---- |
1543 | # qm move-disk 300 scsi1 --target-vmid 400 --target-disk scsi3 | |
1544 | ---- | |
87927c65 | 1545 | |
f0a8ab95 DM |
1546 | |
1547 | [[qm_configuration]] | |
f69cfd23 DM |
1548 | Configuration |
1549 | ------------- | |
1550 | ||
f0a8ab95 DM |
1551 | VM configuration files are stored inside the Proxmox cluster file |
1552 | system, and can be accessed at `/etc/pve/qemu-server/<VMID>.conf`. | |
1553 | Like other files stored inside `/etc/pve/`, they get automatically | |
1554 | replicated to all other cluster nodes. | |
f69cfd23 | 1555 | |
f0a8ab95 DM |
1556 | NOTE: VMIDs < 100 are reserved for internal purposes, and VMIDs need to be |
1557 | unique cluster wide. | |
1558 | ||
1559 | .Example VM Configuration | |
1560 | ---- | |
777cf894 | 1561 | boot: order=virtio0;net0 |
f0a8ab95 DM |
1562 | cores: 1 |
1563 | sockets: 1 | |
1564 | memory: 512 | |
1565 | name: webmail | |
1566 | ostype: l26 | |
f0a8ab95 DM |
1567 | net0: e1000=EE:D2:28:5F:B6:3E,bridge=vmbr0 |
1568 | virtio0: local:vm-100-disk-1,size=32G | |
1569 | ---- | |
1570 | ||
1571 | Those configuration files are simple text files, and you can edit them | |
1572 | using a normal text editor (`vi`, `nano`, ...). This is sometimes | |
1573 | useful to do small corrections, but keep in mind that you need to | |
1574 | restart the VM to apply such changes. | |
1575 | ||
1576 | For that reason, it is usually better to use the `qm` command to | |
1577 | generate and modify those files, or do the whole thing using the GUI. | |
1578 | Our toolkit is smart enough to instantaneously apply most changes to | |
1579 | running VM. This feature is called "hot plug", and there is no | |
1580 | need to restart the VM in that case. | |
1581 | ||
1582 | ||
1583 | File Format | |
1584 | ~~~~~~~~~~~ | |
1585 | ||
1586 | VM configuration files use a simple colon separated key/value | |
1587 | format. Each line has the following format: | |
1588 | ||
1589 | ----- | |
1590 | # this is a comment | |
1591 | OPTION: value | |
1592 | ----- | |
1593 | ||
1594 | Blank lines in those files are ignored, and lines starting with a `#` | |
1595 | character are treated as comments and are also ignored. | |
1596 | ||
1597 | ||
1598 | [[qm_snapshots]] | |
1599 | Snapshots | |
1600 | ~~~~~~~~~ | |
1601 | ||
1602 | When you create a snapshot, `qm` stores the configuration at snapshot | |
1603 | time into a separate snapshot section within the same configuration | |
1604 | file. For example, after creating a snapshot called ``testsnapshot'', | |
1605 | your configuration file will look like this: | |
1606 | ||
1607 | .VM configuration with snapshot | |
1608 | ---- | |
1609 | memory: 512 | |
1610 | swap: 512 | |
1611 | parent: testsnaphot | |
1612 | ... | |
1613 | ||
1614 | [testsnaphot] | |
1615 | memory: 512 | |
1616 | swap: 512 | |
1617 | snaptime: 1457170803 | |
1618 | ... | |
1619 | ---- | |
1620 | ||
1621 | There are a few snapshot related properties like `parent` and | |
1622 | `snaptime`. The `parent` property is used to store the parent/child | |
1623 | relationship between snapshots. `snaptime` is the snapshot creation | |
1624 | time stamp (Unix epoch). | |
f69cfd23 | 1625 | |
88a31964 DC |
1626 | You can optionally save the memory of a running VM with the option `vmstate`. |
1627 | For details about how the target storage gets chosen for the VM state, see | |
1628 | xref:qm_vmstatestorage[State storage selection] in the chapter | |
1629 | xref:qm_hibernate[Hibernation]. | |
f69cfd23 | 1630 | |
80c0adcb | 1631 | [[qm_options]] |
a7f36905 DM |
1632 | Options |
1633 | ~~~~~~~ | |
1634 | ||
1635 | include::qm.conf.5-opts.adoc[] | |
1636 | ||
f69cfd23 DM |
1637 | |
1638 | Locks | |
1639 | ----- | |
1640 | ||
d6466262 TL |
1641 | Online migrations, snapshots and backups (`vzdump`) set a lock to prevent |
1642 | incompatible concurrent actions on the affected VMs. Sometimes you need to | |
1643 | remove such a lock manually (for example after a power failure). | |
f69cfd23 | 1644 | |
32e8b5b2 AL |
1645 | ---- |
1646 | # qm unlock <vmid> | |
1647 | ---- | |
f69cfd23 | 1648 | |
0bcc62dd DM |
1649 | CAUTION: Only do that if you are sure the action which set the lock is |
1650 | no longer running. | |
1651 | ||
f69cfd23 | 1652 | |
16b4185a DM |
1653 | ifdef::wiki[] |
1654 | ||
1655 | See Also | |
1656 | ~~~~~~~~ | |
1657 | ||
1658 | * link:/wiki/Cloud-Init_Support[Cloud-Init Support] | |
1659 | ||
1660 | endif::wiki[] | |
1661 | ||
1662 | ||
f69cfd23 | 1663 | ifdef::manvolnum[] |
704f19fb DM |
1664 | |
1665 | Files | |
1666 | ------ | |
1667 | ||
1668 | `/etc/pve/qemu-server/<VMID>.conf`:: | |
1669 | ||
1670 | Configuration file for the VM '<VMID>'. | |
1671 | ||
1672 | ||
f69cfd23 DM |
1673 | include::pve-copyright.adoc[] |
1674 | endif::manvolnum[] |