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 | ||
10 | qm - Qemu/KVM Virtual Machine Manager | |
11 | ||
12 | ||
49a5e11c | 13 | SYNOPSIS |
f69cfd23 DM |
14 | -------- |
15 | ||
16 | include::qm.1-synopsis.adoc[] | |
17 | ||
18 | DESCRIPTION | |
19 | ----------- | |
20 | endif::manvolnum[] | |
f69cfd23 DM |
21 | ifndef::manvolnum[] |
22 | Qemu/KVM Virtual Machines | |
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 | ||
5eba0743 | 32 | Qemu (short form for Quick Emulator) is an open source hypervisor that emulates a |
c4cba5d7 EK |
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 | |
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 | |
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 | |
189d3661 | 41 | will see a real CDROM inserted in a CD drive. |
c4cba5d7 | 42 | |
189d3661 | 43 | Qemu can emulates 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 | |
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). | |
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 use interchangeably as Qemu in {pve} will always try to load the kvm | |
54 | module. | |
55 | ||
c4cba5d7 EK |
56 | Qemu inside {pve} runs as a root process, since this is required to access block |
57 | and PCI devices. | |
58 | ||
5eba0743 | 59 | |
c4cba5d7 EK |
60 | Emulated devices and paravirtualized devices |
61 | -------------------------------------------- | |
62 | ||
189d3661 DC |
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 | |
c4cba5d7 EK |
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 presente | |
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 | ||
189d3661 DC |
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 | |
c4cba5d7 | 86 | up to three times the throughput of an emulated Intel E1000 network card, as |
189d3661 | 87 | measured with `iperf(1)`. footnote:[See this benchmark on the KVM wiki |
c4cba5d7 EK |
88 | http://www.linux-kvm.org/page/Using_VirtIO_NIC] |
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 | |
b16d767f DM |
104 | [thumbnail="qm-general-settings.png"] |
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 | |
200114a7 DM |
118 | [thumbnail="qm-os-settings.png"] |
119 | ||
c4cba5d7 EK |
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 | ||
5eba0743 | 125 | |
80c0adcb | 126 | [[qm_hard_disk]] |
c4cba5d7 EK |
127 | Hard Disk |
128 | ~~~~~~~~~ | |
80c0adcb | 129 | |
2ec49380 | 130 | Qemu can emulate a number of storage controllers: |
c4cba5d7 EK |
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 more more designs, | |
134 | each and every OS you can think 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 | ||
b0b6802b EK |
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 | |
f4bfd701 DM |
144 | LSI 53C895A controller. |
145 | + | |
b0b6802b EK |
146 | A SCSI controller of type _Virtio_ 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 | |
c4cba5d7 | 149 | FreeBSD since 2014. For Windows OSes, you need to provide an extra iso |
b0b6802b EK |
150 | containing the drivers during the installation. |
151 | // https://pve.proxmox.com/wiki/Paravirtualized_Block_Drivers_for_Windows#During_windows_installation. | |
152 | ||
153 | * The *Virtio* controller, also called virtio-blk to distinguish from | |
154 | the Virtio SCSI controller, is an older type of paravirtualized controller | |
155 | which has been superseded in features by the Virtio SCSI Controller. | |
c4cba5d7 | 156 | |
fad1e51a | 157 | [thumbnail="qm-hard-disk.png"] |
c4cba5d7 EK |
158 | On each controller you attach a number of emulated hard disks, which are backed |
159 | by a file or a block device residing in the configured storage. The choice of | |
160 | a storage type will determine the format of the hard disk image. Storages which | |
161 | present block devices (LVM, ZFS, Ceph) will require the *raw disk image format*, | |
162 | whereas files based storages (Ext4, NFS, GlusterFS) will let you to choose | |
163 | either the *raw disk image format* or the *QEMU image format*. | |
164 | ||
165 | * the *QEMU image format* is a copy on write format which allows snapshots, and | |
166 | thin provisioning of the disk image. | |
189d3661 DC |
167 | * the *raw disk image* is a bit-to-bit image of a hard disk, similar to what |
168 | you would get when executing the `dd` command on a block device in Linux. This | |
169 | format do not support thin provisioning or snapshotting by itself, requiring | |
170 | cooperation from the storage layer for these tasks. It is however 10% faster | |
171 | than the *QEMU image format*. footnote:[See this benchmark for details | |
c4cba5d7 | 172 | http://events.linuxfoundation.org/sites/events/files/slides/CloudOpen2013_Khoa_Huynh_v3.pdf] |
189d3661 | 173 | * the *VMware image format* only makes sense if you intend to import/export the |
c4cba5d7 EK |
174 | disk image to other hypervisors. |
175 | ||
176 | Setting the *Cache* mode of the hard drive will impact how the host system will | |
177 | notify the guest systems of block write completions. The *No cache* default | |
178 | means that the guest system will be notified that a write is complete when each | |
179 | block reaches the physical storage write queue, ignoring the host page cache. | |
180 | This provides a good balance between safety and speed. | |
181 | ||
182 | If you want the {pve} backup manager to skip a disk when doing a backup of a VM, | |
183 | you can set the *No backup* option on that disk. | |
184 | ||
185 | If your storage supports _thin provisioning_ (see the storage chapter in the | |
186 | {pve} guide), and your VM has a *SCSI* controller you can activate the *Discard* | |
187 | option on the hard disks connected to that controller. With *Discard* enabled, | |
188 | when the filesystem of a VM marks blocks as unused after removing files, the | |
189 | emulated SCSI controller will relay this information to the storage, which will | |
190 | then shrink the disk image accordingly. | |
191 | ||
af9c6de1 | 192 | .IO Thread |
2b6e4b66 EK |
193 | The option *IO Thread* can only be enabled when using a disk with the *VirtIO* controller, |
194 | or with the *SCSI* controller, when the emulated controller type is *VirtIO SCSI*. | |
c564fc52 DC |
195 | With this enabled, Qemu uses one thread per disk, instead of one thread for all, |
196 | so it should increase performance when using multiple disks. | |
197 | Note that backups do not currently work with *IO Thread* enabled. | |
198 | ||
80c0adcb DM |
199 | |
200 | [[qm_cpu]] | |
34e541c5 EK |
201 | CPU |
202 | ~~~ | |
80c0adcb | 203 | |
34e541c5 EK |
204 | A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU. |
205 | This CPU can then contain one or many *cores*, which are independent | |
206 | processing units. Whether you have a single CPU socket with 4 cores, or two CPU | |
207 | sockets with two cores is mostly irrelevant from a performance point of view. | |
208 | However some software is licensed depending on the number of sockets you have in | |
209 | your machine, in that case it makes sense to set the number of of sockets to | |
f4bfd701 DM |
210 | what the license allows you, and increase the number of cores. |
211 | ||
34e541c5 EK |
212 | Increasing the number of virtual cpus (cores and sockets) will usually provide a |
213 | performance improvement though that is heavily dependent on the use of the VM. | |
214 | Multithreaded applications will of course benefit from a large number of | |
215 | virtual cpus, as for each virtual cpu you add, Qemu will create a new thread of | |
216 | execution on the host system. If you're not sure about the workload of your VM, | |
217 | it is usually a safe bet to set the number of *Total cores* to 2. | |
218 | ||
219 | NOTE: It is perfectly safe to set the _overall_ number of total cores in all | |
220 | your VMs to be greater than the number of of cores you have on your server (ie. | |
221 | 4 VMs with each 4 Total cores running in a 8 core machine is OK) In that case | |
222 | the host system will balance the Qemu execution threads between your server | |
223 | cores just like if you were running a standard multithreaded application. | |
224 | However {pve} will prevent you to allocate on a _single_ machine more vcpus than | |
225 | physically available, as this will only bring the performance down due to the | |
226 | cost of context switches. | |
227 | ||
228 | Qemu can emulate a number different of *CPU types* from 486 to the latest Xeon | |
229 | processors. Each new processor generation adds new features, like hardware | |
230 | assisted 3d rendering, random number generation, memory protection, etc ... | |
231 | Usually you should select for your VM a processor type which closely matches the | |
232 | CPU of the host system, as it means that the host CPU features (also called _CPU | |
233 | flags_ ) will be available in your VMs. If you want an exact match, you can set | |
234 | the CPU type to *host* in which case the VM will have exactly the same CPU flags | |
f4bfd701 DM |
235 | as your host system. |
236 | ||
34e541c5 EK |
237 | This has a downside though. If you want to do a live migration of VMs between |
238 | different hosts, your VM might end up on a new system with a different CPU type. | |
239 | If the CPU flags passed to the guest are missing, the qemu process will stop. To | |
240 | remedy this Qemu has also its own CPU type *kvm64*, that {pve} uses by defaults. | |
241 | kvm64 is a Pentium 4 look a like CPU type, which has a reduced CPU flags set, | |
f4bfd701 DM |
242 | but is guaranteed to work everywhere. |
243 | ||
244 | In short, if you care about live migration and moving VMs between nodes, leave | |
34e541c5 EK |
245 | the kvm64 default. If you don’t care about live migration, set the CPU type to |
246 | host, as in theory this will give your guests maximum performance. | |
247 | ||
248 | You can also optionally emulate a *NUMA* architecture in your VMs. The basics of | |
249 | the NUMA architecture mean that instead of having a global memory pool available | |
250 | to all your cores, the memory is spread into local banks close to each socket. | |
251 | This can bring speed improvements as the memory bus is not a bottleneck | |
252 | anymore. If your system has a NUMA architecture footnote:[if the command | |
253 | `numactl --hardware | grep available` returns more than one node, then your host | |
254 | system has a NUMA architecture] we recommend to activate the option, as this | |
255 | will allow proper distribution of the VM resources on the host system. This | |
256 | option is also required in {pve} to allow hotplugging of cores and RAM to a VM. | |
257 | ||
258 | If the NUMA option is used, it is recommended to set the number of sockets to | |
259 | the number of sockets of the host system. | |
260 | ||
80c0adcb DM |
261 | |
262 | [[qm_memory]] | |
34e541c5 EK |
263 | Memory |
264 | ~~~~~~ | |
80c0adcb | 265 | |
34e541c5 EK |
266 | For each VM you have the option to set a fixed size memory or asking |
267 | {pve} to dynamically allocate memory based on the current RAM usage of the | |
268 | host. | |
269 | ||
270 | When choosing a *fixed size memory* {pve} will simply allocate what you | |
271 | specify to your VM. | |
272 | ||
273 | // see autoballoon() in pvestatd.pm | |
274 | When choosing to *automatically allocate memory*, {pve} will make sure that the | |
275 | minimum amount you specified is always available to the VM, and if RAM usage on | |
276 | the host is below 80%, will dynamically add memory to the guest up to the | |
f4bfd701 DM |
277 | maximum memory specified. |
278 | ||
34e541c5 EK |
279 | When the host is becoming short on RAM, the VM will then release some memory |
280 | back to the host, swapping running processes if needed and starting the oom | |
281 | killer in last resort. The passing around of memory between host and guest is | |
282 | done via a special `balloon` kernel driver running inside the guest, which will | |
283 | grab or release memory pages from the host. | |
284 | 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/] | |
285 | ||
c9f6e1a4 EK |
286 | When multiple VMs use the autoallocate facility, it is possible to set a |
287 | *Shares* coefficient which indicates the relative amount of the free host memory | |
288 | that each VM shoud take. Suppose for instance you have four VMs, three of them | |
289 | running a HTTP server and the last one is a database server. To cache more | |
290 | database blocks in the database server RAM, you would like to prioritize the | |
291 | database VM when spare RAM is available. For this you assign a Shares property | |
292 | of 3000 to the database VM, leaving the other VMs to the Shares default setting | |
293 | of 1000. The host server has 32GB of RAM, and is curring using 16GB, leaving 32 | |
294 | * 80/100 - 16 = 9GB RAM to be allocated to the VMs. The database VM will get 9 * | |
295 | 3000 / (3000 + 1000 + 1000 + 1000) = 4.5 GB extra RAM and each HTTP server will | |
296 | get 1/5 GB. | |
297 | ||
34e541c5 EK |
298 | All Linux distributions released after 2010 have the balloon kernel driver |
299 | included. For Windows OSes, the balloon driver needs to be added manually and can | |
300 | incur a slowdown of the guest, so we don't recommend using it on critical | |
301 | systems. | |
302 | // see https://forum.proxmox.com/threads/solved-hyper-threading-vs-no-hyper-threading-fixed-vs-variable-memory.20265/ | |
303 | ||
304 | When allocating RAMs to your VMs, a good rule of thumb is always to leave 1GB | |
305 | of RAM available to the host. | |
306 | ||
80c0adcb DM |
307 | |
308 | [[qm_network_device]] | |
1ff7835b EK |
309 | Network Device |
310 | ~~~~~~~~~~~~~~ | |
80c0adcb | 311 | |
1ff7835b EK |
312 | Each VM can have many _Network interface controllers_ (NIC), of four different |
313 | types: | |
314 | ||
315 | * *Intel E1000* is the default, and emulates an Intel Gigabit network card. | |
316 | * the *VirtIO* paravirtualized NIC should be used if you aim for maximum | |
317 | performance. Like all VirtIO devices, the guest OS should have the proper driver | |
318 | installed. | |
319 | * the *Realtek 8139* emulates an older 100 MB/s network card, and should | |
320 | only be used when emulating older operating systems ( released before 2002 ) | |
321 | * the *vmxnet3* is another paravirtualized device, which should only be used | |
322 | when importing a VM from another hypervisor. | |
323 | ||
324 | {pve} will generate for each NIC a random *MAC address*, so that your VM is | |
325 | addressable on Ethernet networks. | |
326 | ||
af9c6de1 EK |
327 | The NIC you added to the VM can follow one of two differents models: |
328 | ||
329 | * in the default *Bridged mode* each virtual NIC is backed on the host by a | |
330 | _tap device_, ( a software loopback device simulating an Ethernet NIC ). This | |
331 | tap device is added to a bridge, by default vmbr0 in {pve}. In this mode, VMs | |
332 | have direct access to the Ethernet LAN on which the host is located. | |
333 | * in the alternative *NAT mode*, each virtual NIC will only communicate with | |
334 | the Qemu user networking stack, where a builting router and DHCP server can | |
335 | provide network access. This built-in DHCP will serve adresses in the private | |
336 | 10.0.2.0/24 range. The NAT mode is much slower than the bridged mode, and | |
337 | should only be used for testing. | |
338 | ||
339 | You can also skip adding a network device when creating a VM by selecting *No | |
340 | network device*. | |
341 | ||
342 | .Multiqueue | |
1ff7835b | 343 | If you are using the VirtIO driver, you can optionally activate the |
af9c6de1 | 344 | *Multiqueue* option. This option allows the guest OS to process networking |
1ff7835b EK |
345 | packets using multiple virtual CPUs, providing an increase in the total number |
346 | of packets transfered. | |
347 | ||
348 | //http://blog.vmsplice.net/2011/09/qemu-internals-vhost-architecture.html | |
349 | When using the VirtIO driver with {pve}, each NIC network queue is passed to the | |
350 | host kernel, where the queue will be processed by a kernel thread spawn by the | |
351 | vhost driver. With this option activated, it is possible to pass _multiple_ | |
352 | network queues to the host kernel for each NIC. | |
353 | ||
354 | //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 | 355 | When using Multiqueue, it is recommended to set it to a value equal |
1ff7835b EK |
356 | to the number of Total Cores of your guest. You also need to set in |
357 | the VM the number of multi-purpose channels on each VirtIO NIC with the ethtool | |
358 | command: | |
359 | ||
360 | `ethtool -L eth0 combined X` | |
361 | ||
362 | where X is the number of the number of vcpus of the VM. | |
363 | ||
af9c6de1 | 364 | You should note that setting the Multiqueue parameter to a value greater |
1ff7835b EK |
365 | than one will increase the CPU load on the host and guest systems as the |
366 | traffic increases. We recommend to set this option only when the VM has to | |
367 | process a great number of incoming connections, such as when the VM is running | |
368 | as a router, reverse proxy or a busy HTTP server doing long polling. | |
369 | ||
80c0adcb | 370 | |
685cc8e0 DC |
371 | USB Passthrough |
372 | ~~~~~~~~~~~~~~~ | |
80c0adcb | 373 | |
685cc8e0 DC |
374 | There are two different types of USB passthrough devices: |
375 | ||
376 | * Host USB passtrough | |
377 | * SPICE USB passthrough | |
378 | ||
379 | Host USB passthrough works by giving a VM a USB device of the host. | |
380 | This can either be done via the vendor- and product-id, or | |
381 | via the host bus and port. | |
382 | ||
383 | The vendor/product-id looks like this: *0123:abcd*, | |
384 | where *0123* is the id of the vendor, and *abcd* is the id | |
385 | of the product, meaning two pieces of the same usb device | |
386 | have the same id. | |
387 | ||
388 | The bus/port looks like this: *1-2.3.4*, where *1* is the bus | |
389 | and *2.3.4* is the port path. This represents the physical | |
390 | ports of your host (depending of the internal order of the | |
391 | usb controllers). | |
392 | ||
393 | If a device is present in a VM configuration when the VM starts up, | |
394 | but the device is not present in the host, the VM can boot without problems. | |
395 | As soon as the device/port ist available in the host, it gets passed through. | |
396 | ||
397 | WARNING: Using this kind of USB passthrough, means that you cannot move | |
398 | a VM online to another host, since the hardware is only available | |
399 | on the host the VM is currently residing. | |
400 | ||
401 | The second type of passthrough is SPICE USB passthrough. This is useful | |
402 | if you use a SPICE client which supports it. If you add a SPICE USB port | |
403 | to your VM, you can passthrough a USB device from where your SPICE client is, | |
404 | directly to the VM (for example an input device or hardware dongle). | |
405 | ||
80c0adcb DM |
406 | |
407 | [[qm_bios_and_uefi]] | |
076d60ae DC |
408 | BIOS and UEFI |
409 | ~~~~~~~~~~~~~ | |
410 | ||
411 | In order to properly emulate a computer, QEMU needs to use a firmware. | |
412 | By default QEMU uses *SeaBIOS* for this, which is an open-source, x86 BIOS | |
413 | implementation. SeaBIOS is a good choice for most standard setups. | |
414 | ||
415 | There are, however, some scenarios in which a BIOS is not a good firmware | |
416 | to boot from, e.g. if you want to do VGA passthrough. footnote:[Alex Williamson has a very good blog entry about this. | |
417 | http://vfio.blogspot.co.at/2014/08/primary-graphics-assignment-without-vga.html] | |
418 | In such cases, you should rather use *OVMF*, which is an open-source UEFI implemenation. footnote:[See the OVMF Project http://www.tianocore.org/ovmf/] | |
419 | ||
420 | If you want to use OVMF, there are several things to consider: | |
421 | ||
422 | In order to save things like the *boot order*, there needs to be an EFI Disk. | |
423 | This disk will be included in backups and snapshots, and there can only be one. | |
424 | ||
425 | You can create such a disk with the following command: | |
426 | ||
427 | qm set <vmid> -efidisk0 <storage>:1,format=<format> | |
428 | ||
429 | Where *<storage>* is the storage where you want to have the disk, and | |
430 | *<format>* is a format which the storage supports. Alternatively, you can | |
431 | create such a disk through the web interface with 'Add' -> 'EFI Disk' in the | |
432 | hardware section of a VM. | |
433 | ||
434 | When using OVMF with a virtual display (without VGA passthrough), | |
435 | you need to set the client resolution in the OVMF menu(which you can reach | |
436 | with a press of the ESC button during boot), or you have to choose | |
437 | SPICE as the display type. | |
438 | ||
288e3f46 EK |
439 | [[qm_startup_and_shutdown]] |
440 | Automatic Start and Shutdown of Virtual Machines | |
441 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
442 | ||
443 | After creating your VMs, you probably want them to start automatically | |
444 | when the host system boots. For this you need to select the option 'Start at | |
445 | boot' from the 'Options' Tab of your VM in the web interface, or set it with | |
446 | the following command: | |
447 | ||
448 | qm set <vmid> -onboot 1 | |
449 | ||
450 | In some case you want to be able to fine tune the boot order of your VMs, for | |
451 | instance if one of your VM is providing firewalling or DHCP to other guest | |
452 | systems. | |
453 | For this you can use the following parameters: | |
454 | ||
455 | * *Start/Shutdown order*: Defines the start order priority. E.g. set it to 1 if | |
456 | you want the VM to be the first to be started. (We use the reverse startup | |
457 | order for shutdown, so a machine with a start order of 1 would be the last to | |
458 | be shut down) | |
459 | * *Startup delay*: Defines the interval between this VM start and subsequent | |
460 | VMs starts . E.g. set it to 240 if you want to wait 240 seconds before starting | |
461 | other VMs. | |
462 | * *Shutdown timeout*: Defines the duration in seconds {pve} should wait | |
463 | for the VM to be offline after issuing a shutdown command. | |
464 | By default this value is set to 60, which means that {pve} will issue a | |
465 | shutdown request, wait 60s for the machine to be offline, and if after 60s | |
466 | the machine is still online will notify that the shutdown action failed. | |
467 | ||
468 | Please note that machines without a Start/Shutdown order parameter will always | |
469 | start after those where the parameter is set, and this parameter only | |
470 | makes sense between the machines running locally on a host, and not | |
471 | cluster-wide. | |
076d60ae | 472 | |
8c1189b6 | 473 | Managing Virtual Machines with `qm` |
dd042288 | 474 | ------------------------------------ |
f69cfd23 | 475 | |
dd042288 | 476 | qm is the tool to manage Qemu/Kvm virtual machines on {pve}. You can |
f69cfd23 DM |
477 | create and destroy virtual machines, and control execution |
478 | (start/stop/suspend/resume). Besides that, you can use qm to set | |
479 | parameters in the associated config file. It is also possible to | |
480 | create and delete virtual disks. | |
481 | ||
dd042288 EK |
482 | CLI Usage Examples |
483 | ~~~~~~~~~~~~~~~~~~ | |
484 | ||
485 | Create a new VM with 4 GB IDE disk. | |
486 | ||
487 | qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso | |
488 | ||
489 | Start the new VM | |
490 | ||
491 | qm start 300 | |
492 | ||
493 | Send a shutdown request, then wait until the VM is stopped. | |
494 | ||
495 | qm shutdown 300 && qm wait 300 | |
496 | ||
497 | Same as above, but only wait for 40 seconds. | |
498 | ||
499 | qm shutdown 300 && qm wait 300 -timeout 40 | |
500 | ||
f0a8ab95 DM |
501 | |
502 | [[qm_configuration]] | |
f69cfd23 DM |
503 | Configuration |
504 | ------------- | |
505 | ||
f0a8ab95 DM |
506 | VM configuration files are stored inside the Proxmox cluster file |
507 | system, and can be accessed at `/etc/pve/qemu-server/<VMID>.conf`. | |
508 | Like other files stored inside `/etc/pve/`, they get automatically | |
509 | replicated to all other cluster nodes. | |
f69cfd23 | 510 | |
f0a8ab95 DM |
511 | NOTE: VMIDs < 100 are reserved for internal purposes, and VMIDs need to be |
512 | unique cluster wide. | |
513 | ||
514 | .Example VM Configuration | |
515 | ---- | |
516 | cores: 1 | |
517 | sockets: 1 | |
518 | memory: 512 | |
519 | name: webmail | |
520 | ostype: l26 | |
521 | bootdisk: virtio0 | |
522 | net0: e1000=EE:D2:28:5F:B6:3E,bridge=vmbr0 | |
523 | virtio0: local:vm-100-disk-1,size=32G | |
524 | ---- | |
525 | ||
526 | Those configuration files are simple text files, and you can edit them | |
527 | using a normal text editor (`vi`, `nano`, ...). This is sometimes | |
528 | useful to do small corrections, but keep in mind that you need to | |
529 | restart the VM to apply such changes. | |
530 | ||
531 | For that reason, it is usually better to use the `qm` command to | |
532 | generate and modify those files, or do the whole thing using the GUI. | |
533 | Our toolkit is smart enough to instantaneously apply most changes to | |
534 | running VM. This feature is called "hot plug", and there is no | |
535 | need to restart the VM in that case. | |
536 | ||
537 | ||
538 | File Format | |
539 | ~~~~~~~~~~~ | |
540 | ||
541 | VM configuration files use a simple colon separated key/value | |
542 | format. Each line has the following format: | |
543 | ||
544 | ----- | |
545 | # this is a comment | |
546 | OPTION: value | |
547 | ----- | |
548 | ||
549 | Blank lines in those files are ignored, and lines starting with a `#` | |
550 | character are treated as comments and are also ignored. | |
551 | ||
552 | ||
553 | [[qm_snapshots]] | |
554 | Snapshots | |
555 | ~~~~~~~~~ | |
556 | ||
557 | When you create a snapshot, `qm` stores the configuration at snapshot | |
558 | time into a separate snapshot section within the same configuration | |
559 | file. For example, after creating a snapshot called ``testsnapshot'', | |
560 | your configuration file will look like this: | |
561 | ||
562 | .VM configuration with snapshot | |
563 | ---- | |
564 | memory: 512 | |
565 | swap: 512 | |
566 | parent: testsnaphot | |
567 | ... | |
568 | ||
569 | [testsnaphot] | |
570 | memory: 512 | |
571 | swap: 512 | |
572 | snaptime: 1457170803 | |
573 | ... | |
574 | ---- | |
575 | ||
576 | There are a few snapshot related properties like `parent` and | |
577 | `snaptime`. The `parent` property is used to store the parent/child | |
578 | relationship between snapshots. `snaptime` is the snapshot creation | |
579 | time stamp (Unix epoch). | |
f69cfd23 | 580 | |
f69cfd23 | 581 | |
80c0adcb | 582 | [[qm_options]] |
a7f36905 DM |
583 | Options |
584 | ~~~~~~~ | |
585 | ||
586 | include::qm.conf.5-opts.adoc[] | |
587 | ||
f69cfd23 DM |
588 | |
589 | Locks | |
590 | ----- | |
591 | ||
0bcc62dd DM |
592 | Online migrations, snapshots and backups (`vzdump`) set a lock to |
593 | prevent incompatible concurrent actions on the affected VMs. Sometimes | |
594 | you need to remove such a lock manually (e.g., after a power failure). | |
f69cfd23 DM |
595 | |
596 | qm unlock <vmid> | |
597 | ||
0bcc62dd DM |
598 | CAUTION: Only do that if you are sure the action which set the lock is |
599 | no longer running. | |
600 | ||
f69cfd23 DM |
601 | |
602 | ifdef::manvolnum[] | |
704f19fb DM |
603 | |
604 | Files | |
605 | ------ | |
606 | ||
607 | `/etc/pve/qemu-server/<VMID>.conf`:: | |
608 | ||
609 | Configuration file for the VM '<VMID>'. | |
610 | ||
611 | ||
f69cfd23 DM |
612 | include::pve-copyright.adoc[] |
613 | endif::manvolnum[] |