]> git.proxmox.com Git - pve-docs.git/blame - qm.adoc
pve-gui.adoc: more verbose description
[pve-docs.git] / qm.adoc
CommitLineData
80c0adcb 1[[chapter_virtual_machines]]
f69cfd23 2ifdef::manvolnum[]
b2f242ab
DM
3qm(1)
4=====
5f09af76
DM
5:pve-toplevel:
6
f69cfd23
DM
7NAME
8----
9
10qm - Qemu/KVM Virtual Machine Manager
11
12
49a5e11c 13SYNOPSIS
f69cfd23
DM
14--------
15
16include::qm.1-synopsis.adoc[]
17
18DESCRIPTION
19-----------
20endif::manvolnum[]
f69cfd23
DM
21ifndef::manvolnum[]
22Qemu/KVM Virtual Machines
23=========================
5f09af76 24:pve-toplevel:
194d2f29 25endif::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 32Qemu (short form for Quick Emulator) is an open source hypervisor that emulates a
c4cba5d7
EK
33physical computer. From the perspective of the host system where Qemu is
34running, Qemu is a user program which has access to a number of local resources
35like partitions, files, network cards which are then passed to an
189d3661 36emulated computer which sees them as if they were real devices.
c4cba5d7
EK
37
38A guest operating system running in the emulated computer accesses these
39devices, and runs as it were running on real hardware. For instance you can pass
40an iso image as a parameter to Qemu, and the OS running in the emulated computer
189d3661 41will see a real CDROM inserted in a CD drive.
c4cba5d7 42
189d3661 43Qemu can emulates a great variety of hardware from ARM to Sparc, but {pve} is
c4cba5d7
EK
44only concerned with 32 and 64 bits PC clone emulation, since it represents the
45overwhelming majority of server hardware. The emulation of PC clones is also one
46of the fastest due to the availability of processor extensions which greatly
47speed up Qemu when the emulated architecture is the same as the host
9c63b5d9
EK
48architecture.
49
50NOTE: You may sometimes encounter the term _KVM_ (Kernel-based Virtual Machine).
51It means that Qemu is running with the support of the virtualization processor
52extensions, 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
54module.
55
c4cba5d7
EK
56Qemu inside {pve} runs as a root process, since this is required to access block
57and PCI devices.
58
5eba0743 59
c4cba5d7
EK
60Emulated devices and paravirtualized devices
61--------------------------------------------
62
189d3661
DC
63The PC hardware emulated by Qemu includes a mainboard, network controllers,
64scsi, ide and sata controllers, serial ports (the complete list can be seen in
65the `kvm(1)` man page) all of them emulated in software. All these devices
66are the exact software equivalent of existing hardware devices, and if the OS
67running in the guest has the proper drivers it will use the devices as if it
c4cba5d7
EK
68were running on real hardware. This allows Qemu to runs _unmodified_ operating
69systems.
70
71This however has a performance cost, as running in software what was meant to
72run in hardware involves a lot of extra work for the host CPU. To mitigate this,
73Qemu can present to the guest operating system _paravirtualized devices_, where
74the guest OS recognizes it is running inside Qemu and cooperates with the
75hypervisor.
76
77Qemu relies on the virtio virtualization standard, and is thus able to presente
189d3661
DC
78paravirtualized virtio devices, which includes a paravirtualized generic disk
79controller, a paravirtualized network card, a paravirtualized serial port,
c4cba5d7
EK
80a paravirtualized SCSI controller, etc ...
81
189d3661
DC
82It is highly recommended to use the virtio devices whenever you can, as they
83provide a big performance improvement. Using the virtio generic disk controller
84versus an emulated IDE controller will double the sequential write throughput,
85as measured with `bonnie++(8)`. Using the virtio network interface can deliver
c4cba5d7 86up to three times the throughput of an emulated Intel E1000 network card, as
189d3661 87measured with `iperf(1)`. footnote:[See this benchmark on the KVM wiki
c4cba5d7
EK
88http://www.linux-kvm.org/page/Using_VirtIO_NIC]
89
5eba0743 90
80c0adcb 91[[qm_virtual_machines_settings]]
5274ad28 92Virtual Machines Settings
c4cba5d7 93-------------------------
80c0adcb 94
c4cba5d7
EK
95Generally 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
97could incur a performance slowdown, or putting your data at risk.
98
5eba0743 99
80c0adcb 100[[qm_general_settings]]
c4cba5d7
EK
101General Settings
102~~~~~~~~~~~~~~~~
80c0adcb 103
b473f999 104[thumbnail="gui-create-vm-general.png"]
b16d767f 105
c4cba5d7
EK
106General 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
115OS Settings
116~~~~~~~~~~~
80c0adcb 117
b473f999 118[thumbnail="gui-create-vm-os.png"]
200114a7 119
c4cba5d7
EK
120When creating a VM, setting the proper Operating System(OS) allows {pve} to
121optimize some low level parameters. For instance Windows OS expect the BIOS
122clock to use the local time, while Unix based OS expect the BIOS clock to have
123the UTC time.
124
5eba0743 125
80c0adcb 126[[qm_hard_disk]]
c4cba5d7
EK
127Hard Disk
128~~~~~~~~~
80c0adcb 129
2ec49380 130Qemu 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
133controller. Even if this controller has been superseded by more more designs,
134each and every OS you can think has support for it, making it a great choice
135if you want to run an OS released before 2003. You can connect up to 4 devices
136on this controller.
137
138* the *SATA* (Serial ATA) controller, dating from 2003, has a more modern
139design, allowing higher throughput and a greater number of devices to be
140connected. 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
143hardware, and can connect up to 14 storage devices. {pve} emulates by default a
f4bfd701
DM
144LSI 53C895A controller.
145+
b0b6802b
EK
146A SCSI controller of type _Virtio_ is the recommended setting if you aim for
147performance 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 149FreeBSD since 2014. For Windows OSes, you need to provide an extra iso
b0b6802b
EK
150containing 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
154the Virtio SCSI controller, is an older type of paravirtualized controller
155which has been superseded in features by the Virtio SCSI Controller.
c4cba5d7 156
b473f999 157[thumbnail="gui-create-vm-hard-disk.png"]
c4cba5d7
EK
158On each controller you attach a number of emulated hard disks, which are backed
159by a file or a block device residing in the configured storage. The choice of
160a storage type will determine the format of the hard disk image. Storages which
161present block devices (LVM, ZFS, Ceph) will require the *raw disk image format*,
162whereas files based storages (Ext4, NFS, GlusterFS) will let you to choose
163either 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
176Setting the *Cache* mode of the hard drive will impact how the host system will
177notify the guest systems of block write completions. The *No cache* default
178means that the guest system will be notified that a write is complete when each
179block reaches the physical storage write queue, ignoring the host page cache.
180This provides a good balance between safety and speed.
181
182If you want the {pve} backup manager to skip a disk when doing a backup of a VM,
183you can set the *No backup* option on that disk.
184
185If 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*
187option on the hard disks connected to that controller. With *Discard* enabled,
188when the filesystem of a VM marks blocks as unused after removing files, the
189emulated SCSI controller will relay this information to the storage, which will
190then shrink the disk image accordingly.
191
af9c6de1 192.IO Thread
2b6e4b66
EK
193The option *IO Thread* can only be enabled when using a disk with the *VirtIO* controller,
194or with the *SCSI* controller, when the emulated controller type is *VirtIO SCSI*.
c564fc52
DC
195With this enabled, Qemu uses one thread per disk, instead of one thread for all,
196so it should increase performance when using multiple disks.
197Note that backups do not currently work with *IO Thread* enabled.
198
80c0adcb
DM
199
200[[qm_cpu]]
34e541c5
EK
201CPU
202~~~
80c0adcb 203
b473f999 204[thumbnail="gui-create-vm-cpu.png"]
397c74c3 205
34e541c5
EK
206A *CPU socket* is a physical slot on a PC motherboard where you can plug a CPU.
207This CPU can then contain one or many *cores*, which are independent
208processing units. Whether you have a single CPU socket with 4 cores, or two CPU
209sockets with two cores is mostly irrelevant from a performance point of view.
210However some software is licensed depending on the number of sockets you have in
211your machine, in that case it makes sense to set the number of of sockets to
f4bfd701
DM
212what the license allows you, and increase the number of cores.
213
34e541c5
EK
214Increasing the number of virtual cpus (cores and sockets) will usually provide a
215performance improvement though that is heavily dependent on the use of the VM.
216Multithreaded applications will of course benefit from a large number of
217virtual cpus, as for each virtual cpu you add, Qemu will create a new thread of
218execution on the host system. If you're not sure about the workload of your VM,
219it is usually a safe bet to set the number of *Total cores* to 2.
220
221NOTE: It is perfectly safe to set the _overall_ number of total cores in all
222your VMs to be greater than the number of of cores you have on your server (ie.
2234 VMs with each 4 Total cores running in a 8 core machine is OK) In that case
224the host system will balance the Qemu execution threads between your server
225cores just like if you were running a standard multithreaded application.
226However {pve} will prevent you to allocate on a _single_ machine more vcpus than
227physically available, as this will only bring the performance down due to the
228cost of context switches.
229
230Qemu can emulate a number different of *CPU types* from 486 to the latest Xeon
231processors. Each new processor generation adds new features, like hardware
232assisted 3d rendering, random number generation, memory protection, etc ...
233Usually you should select for your VM a processor type which closely matches the
234CPU of the host system, as it means that the host CPU features (also called _CPU
235flags_ ) will be available in your VMs. If you want an exact match, you can set
236the CPU type to *host* in which case the VM will have exactly the same CPU flags
f4bfd701
DM
237as your host system.
238
34e541c5
EK
239This has a downside though. If you want to do a live migration of VMs between
240different hosts, your VM might end up on a new system with a different CPU type.
241If the CPU flags passed to the guest are missing, the qemu process will stop. To
242remedy this Qemu has also its own CPU type *kvm64*, that {pve} uses by defaults.
243kvm64 is a Pentium 4 look a like CPU type, which has a reduced CPU flags set,
f4bfd701
DM
244but is guaranteed to work everywhere.
245
246In short, if you care about live migration and moving VMs between nodes, leave
34e541c5
EK
247the kvm64 default. If you don’t care about live migration, set the CPU type to
248host, as in theory this will give your guests maximum performance.
249
250You can also optionally emulate a *NUMA* architecture in your VMs. The basics of
251the NUMA architecture mean that instead of having a global memory pool available
252to all your cores, the memory is spread into local banks close to each socket.
253This can bring speed improvements as the memory bus is not a bottleneck
254anymore. If your system has a NUMA architecture footnote:[if the command
255`numactl --hardware | grep available` returns more than one node, then your host
256system has a NUMA architecture] we recommend to activate the option, as this
257will allow proper distribution of the VM resources on the host system. This
258option is also required in {pve} to allow hotplugging of cores and RAM to a VM.
259
260If the NUMA option is used, it is recommended to set the number of sockets to
261the number of sockets of the host system.
262
80c0adcb
DM
263
264[[qm_memory]]
34e541c5
EK
265Memory
266~~~~~~
80c0adcb 267
34e541c5
EK
268For each VM you have the option to set a fixed size memory or asking
269{pve} to dynamically allocate memory based on the current RAM usage of the
270host.
271
96124d0f 272.Fixed Memory Allocation
b473f999 273[thumbnail="gui-create-vm-memory-fixed.png"]
96124d0f 274
34e541c5
EK
275When choosing a *fixed size memory* {pve} will simply allocate what you
276specify to your VM.
277
96124d0f 278.Automatic Memory Allocation
b473f999 279[thumbnail="gui-create-vm-memory-dynamic.png", float="left"]
96124d0f 280
34e541c5
EK
281// see autoballoon() in pvestatd.pm
282When choosing to *automatically allocate memory*, {pve} will make sure that the
283minimum amount you specified is always available to the VM, and if RAM usage on
284the host is below 80%, will dynamically add memory to the guest up to the
f4bfd701
DM
285maximum memory specified.
286
34e541c5
EK
287When the host is becoming short on RAM, the VM will then release some memory
288back to the host, swapping running processes if needed and starting the oom
289killer in last resort. The passing around of memory between host and guest is
290done via a special `balloon` kernel driver running inside the guest, which will
291grab or release memory pages from the host.
292footnote:[A good explanation of the inner workings of the balloon driver can be found here https://rwmj.wordpress.com/2010/07/17/virtio-balloon/]
293
c9f6e1a4
EK
294When multiple VMs use the autoallocate facility, it is possible to set a
295*Shares* coefficient which indicates the relative amount of the free host memory
296that each VM shoud take. Suppose for instance you have four VMs, three of them
297running a HTTP server and the last one is a database server. To cache more
298database blocks in the database server RAM, you would like to prioritize the
299database VM when spare RAM is available. For this you assign a Shares property
300of 3000 to the database VM, leaving the other VMs to the Shares default setting
301of 1000. The host server has 32GB of RAM, and is curring using 16GB, leaving 32
302* 80/100 - 16 = 9GB RAM to be allocated to the VMs. The database VM will get 9 *
3033000 / (3000 + 1000 + 1000 + 1000) = 4.5 GB extra RAM and each HTTP server will
304get 1/5 GB.
305
34e541c5
EK
306All Linux distributions released after 2010 have the balloon kernel driver
307included. For Windows OSes, the balloon driver needs to be added manually and can
308incur a slowdown of the guest, so we don't recommend using it on critical
309systems.
310// see https://forum.proxmox.com/threads/solved-hyper-threading-vs-no-hyper-threading-fixed-vs-variable-memory.20265/
311
312When allocating RAMs to your VMs, a good rule of thumb is always to leave 1GB
313of RAM available to the host.
314
80c0adcb
DM
315
316[[qm_network_device]]
1ff7835b
EK
317Network Device
318~~~~~~~~~~~~~~
80c0adcb 319
b473f999 320[thumbnail="gui-create-vm-network.png"]
c24ddb0a 321
1ff7835b
EK
322Each VM can have many _Network interface controllers_ (NIC), of four different
323types:
324
325 * *Intel E1000* is the default, and emulates an Intel Gigabit network card.
326 * the *VirtIO* paravirtualized NIC should be used if you aim for maximum
327performance. Like all VirtIO devices, the guest OS should have the proper driver
328installed.
329 * the *Realtek 8139* emulates an older 100 MB/s network card, and should
330only be used when emulating older operating systems ( released before 2002 )
331 * the *vmxnet3* is another paravirtualized device, which should only be used
332when importing a VM from another hypervisor.
333
334{pve} will generate for each NIC a random *MAC address*, so that your VM is
335addressable on Ethernet networks.
336
af9c6de1
EK
337The NIC you added to the VM can follow one of two differents models:
338
339 * in the default *Bridged mode* each virtual NIC is backed on the host by a
340_tap device_, ( a software loopback device simulating an Ethernet NIC ). This
341tap device is added to a bridge, by default vmbr0 in {pve}. In this mode, VMs
342have direct access to the Ethernet LAN on which the host is located.
343 * in the alternative *NAT mode*, each virtual NIC will only communicate with
344the Qemu user networking stack, where a builting router and DHCP server can
345provide network access. This built-in DHCP will serve adresses in the private
34610.0.2.0/24 range. The NAT mode is much slower than the bridged mode, and
347should only be used for testing.
348
349You can also skip adding a network device when creating a VM by selecting *No
350network device*.
351
352.Multiqueue
1ff7835b 353If you are using the VirtIO driver, you can optionally activate the
af9c6de1 354*Multiqueue* option. This option allows the guest OS to process networking
1ff7835b
EK
355packets using multiple virtual CPUs, providing an increase in the total number
356of packets transfered.
357
358//http://blog.vmsplice.net/2011/09/qemu-internals-vhost-architecture.html
359When using the VirtIO driver with {pve}, each NIC network queue is passed to the
360host kernel, where the queue will be processed by a kernel thread spawn by the
361vhost driver. With this option activated, it is possible to pass _multiple_
362network queues to the host kernel for each NIC.
363
364//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 365When using Multiqueue, it is recommended to set it to a value equal
1ff7835b
EK
366to the number of Total Cores of your guest. You also need to set in
367the VM the number of multi-purpose channels on each VirtIO NIC with the ethtool
368command:
369
370`ethtool -L eth0 combined X`
371
372where X is the number of the number of vcpus of the VM.
373
af9c6de1 374You should note that setting the Multiqueue parameter to a value greater
1ff7835b
EK
375than one will increase the CPU load on the host and guest systems as the
376traffic increases. We recommend to set this option only when the VM has to
377process a great number of incoming connections, such as when the VM is running
378as a router, reverse proxy or a busy HTTP server doing long polling.
379
80c0adcb 380
685cc8e0
DC
381USB Passthrough
382~~~~~~~~~~~~~~~
80c0adcb 383
685cc8e0
DC
384There are two different types of USB passthrough devices:
385
386* Host USB passtrough
387* SPICE USB passthrough
388
389Host USB passthrough works by giving a VM a USB device of the host.
390This can either be done via the vendor- and product-id, or
391via the host bus and port.
392
393The vendor/product-id looks like this: *0123:abcd*,
394where *0123* is the id of the vendor, and *abcd* is the id
395of the product, meaning two pieces of the same usb device
396have the same id.
397
398The bus/port looks like this: *1-2.3.4*, where *1* is the bus
399and *2.3.4* is the port path. This represents the physical
400ports of your host (depending of the internal order of the
401usb controllers).
402
403If a device is present in a VM configuration when the VM starts up,
404but the device is not present in the host, the VM can boot without problems.
405As soon as the device/port ist available in the host, it gets passed through.
406
407WARNING: Using this kind of USB passthrough, means that you cannot move
408a VM online to another host, since the hardware is only available
409on the host the VM is currently residing.
410
411The second type of passthrough is SPICE USB passthrough. This is useful
412if you use a SPICE client which supports it. If you add a SPICE USB port
413to your VM, you can passthrough a USB device from where your SPICE client is,
414directly to the VM (for example an input device or hardware dongle).
415
80c0adcb
DM
416
417[[qm_bios_and_uefi]]
076d60ae
DC
418BIOS and UEFI
419~~~~~~~~~~~~~
420
421In order to properly emulate a computer, QEMU needs to use a firmware.
422By default QEMU uses *SeaBIOS* for this, which is an open-source, x86 BIOS
423implementation. SeaBIOS is a good choice for most standard setups.
424
425There are, however, some scenarios in which a BIOS is not a good firmware
426to boot from, e.g. if you want to do VGA passthrough. footnote:[Alex Williamson has a very good blog entry about this.
427http://vfio.blogspot.co.at/2014/08/primary-graphics-assignment-without-vga.html]
428In such cases, you should rather use *OVMF*, which is an open-source UEFI implemenation. footnote:[See the OVMF Project http://www.tianocore.org/ovmf/]
429
430If you want to use OVMF, there are several things to consider:
431
432In order to save things like the *boot order*, there needs to be an EFI Disk.
433This disk will be included in backups and snapshots, and there can only be one.
434
435You can create such a disk with the following command:
436
437 qm set <vmid> -efidisk0 <storage>:1,format=<format>
438
439Where *<storage>* is the storage where you want to have the disk, and
440*<format>* is a format which the storage supports. Alternatively, you can
441create such a disk through the web interface with 'Add' -> 'EFI Disk' in the
442hardware section of a VM.
443
444When using OVMF with a virtual display (without VGA passthrough),
445you need to set the client resolution in the OVMF menu(which you can reach
446with a press of the ESC button during boot), or you have to choose
447SPICE as the display type.
448
288e3f46
EK
449[[qm_startup_and_shutdown]]
450Automatic Start and Shutdown of Virtual Machines
451~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
452
453After creating your VMs, you probably want them to start automatically
454when the host system boots. For this you need to select the option 'Start at
455boot' from the 'Options' Tab of your VM in the web interface, or set it with
456the following command:
457
458 qm set <vmid> -onboot 1
459
4dbeb548
DM
460.Start and Shutdown Order
461
462[thumbnail="gui-qemu-edit-start-order.png"]
463
464In some case you want to be able to fine tune the boot order of your
465VMs, for instance if one of your VM is providing firewalling or DHCP
466to other guest systems. For this you can use the following
467parameters:
288e3f46
EK
468
469* *Start/Shutdown order*: Defines the start order priority. E.g. set it to 1 if
470you want the VM to be the first to be started. (We use the reverse startup
471order for shutdown, so a machine with a start order of 1 would be the last to
472be shut down)
473* *Startup delay*: Defines the interval between this VM start and subsequent
474VMs starts . E.g. set it to 240 if you want to wait 240 seconds before starting
475other VMs.
476* *Shutdown timeout*: Defines the duration in seconds {pve} should wait
477for the VM to be offline after issuing a shutdown command.
478By default this value is set to 60, which means that {pve} will issue a
479shutdown request, wait 60s for the machine to be offline, and if after 60s
480the machine is still online will notify that the shutdown action failed.
481
482Please note that machines without a Start/Shutdown order parameter will always
483start after those where the parameter is set, and this parameter only
484makes sense between the machines running locally on a host, and not
485cluster-wide.
076d60ae 486
c73c190f
DM
487
488[[qm_migration]]
489Migration
490---------
491
e4bcef0a
DM
492[thumbnail="gui-qemu-migrate.png"]
493
c73c190f
DM
494If you have a cluster, you can migrate your VM to another host with
495
496 qm migrate <vmid> <target>
497
498When your VM is running and it has no local resources defined (such as disks
499on local storage, passed through devices, etc.) you can initiate a live
500migration with the -online flag.
501
502If you have local resources, you can still offline migrate your VMs,
503as long as all disk are on storages, which are defined on both hosts.
504Then the migration will copy the disk over the network to the target host.
505
eeb87f95
DM
506[[qm_copy_and_clone]]
507Copies and Clones
508-----------------
9e55c76d
DM
509
510[thumbnail="gui-qemu-full-clone.png"]
511
512VM installation is usually done using an installation media (CD-ROM)
513from the operation system vendor. Depending on the OS, this can be a
514time consuming task one might want to avoid.
515
516An easy way to deploy many VMs of the same type is to copy an existing
517VM. We use the term 'clone' for such copies, and distinguish between
518'linked' and 'full' clones.
519
520Full Clone::
521
522The result of such copy is an independent VM. The
523new VM does not share any storage resources with the original.
524+
707e37a2 525
9e55c76d
DM
526It is possible to select a *Target Storage*, so one can use this to
527migrate a VM to a totally different storage. You can also change the
528disk image *Format* if the storage driver supports several formats.
529+
707e37a2 530
9e55c76d
DM
531NOTE: A full clone need to read and copy all VM image data. This is
532usually much slower than creating a linked clone.
707e37a2
DM
533+
534
535Some storage types allows to copy a specific *Snapshot*, which
536defaults to the 'current' VM data. This also means that the final copy
537never includes any additional snapshots from the original VM.
538
9e55c76d
DM
539
540Linked Clone::
541
542Modern storage drivers supports a way to generate fast linked
543clones. Such a clone is a writable copy whose initial contents are the
544same as the original data. Creating a linked clone is nearly
545instantaneous, and initially consumes no additional space.
546+
707e37a2 547
9e55c76d
DM
548They are called 'linked' because the new image still refers to the
549original. Unmodified data blocks are read from the original image, but
550modification are written (and afterwards read) from a new
551location. This technique is called 'Copy-on-write'.
552+
707e37a2
DM
553
554This requires that the original volume is read-only. With {pve} one
555can convert any VM into a read-only <<qm_templates, Template>>). Such
556templates can later be used to create linked clones efficiently.
557+
558
559NOTE: You cannot delete the original template while linked clones
560exists.
9e55c76d 561+
707e37a2
DM
562
563It is not possible to change the *Target storage* for linked clones,
564because this is a storage internal feature.
9e55c76d
DM
565
566
567The *Target node* option allows you to create the new VM on a
568different node. The only restriction is that the VM is on shared
569storage, and that storage is also available on the target node.
570
9e55c76d
DM
571To avoid resource conflicts, all network interface MAC addresses gets
572randomized, and we generate a new 'UUID' for the VM BIOS (smbios1)
573setting.
574
575
707e37a2
DM
576[[qm_templates]]
577Virtual Machine Templates
578-------------------------
579
580One can convert a VM into a Template. Such templates are read-only,
581and you can use them to create linked clones.
582
583NOTE: It is not possible to start templates, because this would modify
584the disk images. If you want to change the template, create a linked
585clone and modify that.
586
587
8c1189b6 588Managing Virtual Machines with `qm`
dd042288 589------------------------------------
f69cfd23 590
dd042288 591qm is the tool to manage Qemu/Kvm virtual machines on {pve}. You can
f69cfd23
DM
592create and destroy virtual machines, and control execution
593(start/stop/suspend/resume). Besides that, you can use qm to set
594parameters in the associated config file. It is also possible to
595create and delete virtual disks.
596
dd042288
EK
597CLI Usage Examples
598~~~~~~~~~~~~~~~~~~
599
600Create a new VM with 4 GB IDE disk.
601
602 qm create 300 -ide0 4 -net0 e1000 -cdrom proxmox-mailgateway_2.1.iso
603
604Start the new VM
605
606 qm start 300
607
608Send a shutdown request, then wait until the VM is stopped.
609
610 qm shutdown 300 && qm wait 300
611
612Same as above, but only wait for 40 seconds.
613
614 qm shutdown 300 && qm wait 300 -timeout 40
615
f0a8ab95
DM
616
617[[qm_configuration]]
f69cfd23
DM
618Configuration
619-------------
620
f0a8ab95
DM
621VM configuration files are stored inside the Proxmox cluster file
622system, and can be accessed at `/etc/pve/qemu-server/<VMID>.conf`.
623Like other files stored inside `/etc/pve/`, they get automatically
624replicated to all other cluster nodes.
f69cfd23 625
f0a8ab95
DM
626NOTE: VMIDs < 100 are reserved for internal purposes, and VMIDs need to be
627unique cluster wide.
628
629.Example VM Configuration
630----
631cores: 1
632sockets: 1
633memory: 512
634name: webmail
635ostype: l26
636bootdisk: virtio0
637net0: e1000=EE:D2:28:5F:B6:3E,bridge=vmbr0
638virtio0: local:vm-100-disk-1,size=32G
639----
640
641Those configuration files are simple text files, and you can edit them
642using a normal text editor (`vi`, `nano`, ...). This is sometimes
643useful to do small corrections, but keep in mind that you need to
644restart the VM to apply such changes.
645
646For that reason, it is usually better to use the `qm` command to
647generate and modify those files, or do the whole thing using the GUI.
648Our toolkit is smart enough to instantaneously apply most changes to
649running VM. This feature is called "hot plug", and there is no
650need to restart the VM in that case.
651
652
653File Format
654~~~~~~~~~~~
655
656VM configuration files use a simple colon separated key/value
657format. Each line has the following format:
658
659-----
660# this is a comment
661OPTION: value
662-----
663
664Blank lines in those files are ignored, and lines starting with a `#`
665character are treated as comments and are also ignored.
666
667
668[[qm_snapshots]]
669Snapshots
670~~~~~~~~~
671
672When you create a snapshot, `qm` stores the configuration at snapshot
673time into a separate snapshot section within the same configuration
674file. For example, after creating a snapshot called ``testsnapshot'',
675your configuration file will look like this:
676
677.VM configuration with snapshot
678----
679memory: 512
680swap: 512
681parent: testsnaphot
682...
683
684[testsnaphot]
685memory: 512
686swap: 512
687snaptime: 1457170803
688...
689----
690
691There are a few snapshot related properties like `parent` and
692`snaptime`. The `parent` property is used to store the parent/child
693relationship between snapshots. `snaptime` is the snapshot creation
694time stamp (Unix epoch).
f69cfd23 695
f69cfd23 696
80c0adcb 697[[qm_options]]
a7f36905
DM
698Options
699~~~~~~~
700
701include::qm.conf.5-opts.adoc[]
702
f69cfd23
DM
703
704Locks
705-----
706
0bcc62dd
DM
707Online migrations, snapshots and backups (`vzdump`) set a lock to
708prevent incompatible concurrent actions on the affected VMs. Sometimes
709you need to remove such a lock manually (e.g., after a power failure).
f69cfd23
DM
710
711 qm unlock <vmid>
712
0bcc62dd
DM
713CAUTION: Only do that if you are sure the action which set the lock is
714no longer running.
715
f69cfd23
DM
716
717ifdef::manvolnum[]
704f19fb
DM
718
719Files
720------
721
722`/etc/pve/qemu-server/<VMID>.conf`::
723
724Configuration file for the VM '<VMID>'.
725
726
f69cfd23
DM
727include::pve-copyright.adoc[]
728endif::manvolnum[]