qm.conf(5)

Enable/disable communication with a QEMU Guest Agent (QGA) running in the VM.

Freeze/thaw guest filesystems on backup for consistency.

Run fstrim after moving a disk or migrating the VM.

Select the agent type

Configure an audio device.

Driver backend for the audio device.

Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). Deprecated, use order= instead.

The guest will attempt to boot from devices in the order they appear here.

Specify a custom file containing all meta data passed to the VM via" ." cloud-init. This is provider specific meaning configdrive2 and nocloud differ.

To pass a custom file containing all network data to the VM via cloud-init.

To pass a custom file containing all user data to the VM via cloud-init.

To pass a custom file containing all vendor data to the VM via cloud-init.

Emulated CPU type. Can be default or custom name (custom model names must be prefixed with custom-).

List of additional CPU flags separated by ;. Use +FLAG to enable, -FLAG to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes

Do not identify as a KVM virtual machine.

The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.

The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host’s. Set to host to use value from host CPU, but note that doing so will break live migration to CPUs with other values.

CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS.

Size and type of the OVMF EFI vars. 4m is newer and recommended, and required for Secure Boot. For backwards compatibility, 2m is used if not otherwise specified. Ignored for VMs with arch=aarch64 (ARM).

The drive’s backing volume.

The drive’s backing file’s data format.

Use am EFI vars template with distribution-specific and Microsoft Standard keys enrolled, if used with efitype=4m. Note that this will enable Secure Boot by default, though it can still be turned off from within the VM.

Disk size. This is purely informational and has no effect.

Override PCI device ID visible to guest

Host PCI device pass through. The PCI ID of a host’s PCI device or a list of PCI virtual functions of the host. HOSTPCIID syntax is:

Pass this device in legacy IGD mode, making it the primary and exclusive graphics device in the VM. Requires pc-i440fx machine type and VGA set to none.

The ID of a cluster wide mapping. Either this or the default-key host must be set.

The type of mediated device to use. An instance of this type will be created on startup of the VM and will be cleaned up when the VM stops.

Choose the PCI-express bus (needs the q35 machine model).

Specify whether or not the device’s ROM will be visible in the guest’s memory map.

Custom pci device rom filename (must be located in /usr/share/kvm/).

Override PCI subsystem device ID visible to guest

Override PCI subsystem vendor ID visible to guest

Override PCI vendor ID visible to guest

Enable vfio-vga device support.

AIO type to use.

Whether the drive should be included when making backups.

Maximum r/w speed in bytes per second.

Maximum length of I/O bursts in seconds.

Maximum read speed in bytes per second.

Maximum length of read I/O bursts in seconds.

Maximum write speed in bytes per second.

Maximum length of write I/O bursts in seconds.

The drive’s cache mode

Force the drive’s physical geometry to have a specific cylinder count.

Controls whether to detect and try to optimize writes of zeroes.

Controls whether to pass discard/trim requests to the underlying storage.

The drive’s backing volume.

The drive’s backing file’s data format.

Force the drive’s physical geometry to have a specific head count.

Maximum r/w I/O in operations per second.

Maximum unthrottled r/w I/O pool in operations per second.

Maximum length of I/O bursts in seconds.

Maximum read I/O in operations per second.

Maximum unthrottled read I/O pool in operations per second.

Maximum length of read I/O bursts in seconds.

Maximum write I/O in operations per second.

Maximum unthrottled write I/O pool in operations per second.

Maximum length of write I/O bursts in seconds.

Maximum r/w speed in megabytes per second.

Maximum unthrottled r/w pool in megabytes per second.

Maximum read speed in megabytes per second.

Maximum unthrottled read pool in megabytes per second.

Maximum write speed in megabytes per second.

Maximum unthrottled write pool in megabytes per second.

The drive’s media type.

The drive’s reported model name, url-encoded, up to 40 bytes long.

Whether the drive should considered for replication jobs.

Read error action.

Force the drive’s physical geometry to have a specific sector count.

The drive’s reported serial number, url-encoded, up to 20 bytes long.

Mark this locally-managed volume as available on all nodes.

This option does not share the volume automatically, it assumes it is shared already!

Disk size. This is purely informational and has no effect.

Controls qemu’s snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.

Whether to expose this drive as an SSD, rather than a rotational hard disk.

Force disk geometry bios translation mode.

Write error action.

The drive’s worldwide name, encoded as 16 bytes hex string, prefixed by 0x.

Default gateway for IPv4 traffic.

Requires option(s): ip

Default gateway for IPv6 traffic.

Requires option(s): ip6

IPv4 address in CIDR format.

IPv6 address in CIDR format.

The name of the file. Will be prefixed with pve-shm-. Default is the VMID. Will be deleted when the VM is stopped.

The size of the file in MB.

Specifies the QEMU machine type.

Enable and set guest vIOMMU variant (Intel vIOMMU needs q35 to be set as machine type).

Current amount of online RAM for the VM in MiB. This is the maximum available memory when you use the balloon device.

Bridge to attach the network device to. The Proxmox VE standard bridge is called vmbr0.

10.0.2.2   Gateway
10.0.2.3   DNS Server
10.0.2.4   SMB Server

Whether this interface should be protected by the firewall.

Whether this interface should be disconnected (like pulling the plug).

A common MAC address with the I/G (Individual/Group) bit not set.

Network Card Model. The virtio model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use e1000.

Force MTU, for VirtIO only. Set to 1 to use the bridge MTU

Number of packet queues to be used on the device.

Rate limit in mbps (megabytes per second) as floating point number.

VLAN tag to apply to packets on this interface.

VLAN trunks to pass through this interface.

CPUs accessing this NUMA node.

Host NUMA nodes to use.

Amount of memory this NUMA node provides.

NUMA allocation policy.

Maximum bytes of entropy allowed to get injected into the guest every period milliseconds. Prefer a lower value when using /dev/random as source. Use 0 to disable limiting (potentially dangerous!).

Every period milliseconds the entropy-injection quota is reset, allowing the guest to retrieve another max_bytes of entropy.

The file on the host to gather entropy from. In most cases /dev/urandom should be preferred over /dev/random to avoid entropy-starvation issues on the host. Using urandom does not decrease security in any meaningful way, as it’s still seeded from real entropy, and the bytes provided will most likely be mixed with real entropy on the guest as well. /dev/hwrng can be used to pass through a hardware RNG from the host.

AIO type to use.

Whether the drive should be included when making backups.

Maximum r/w speed in bytes per second.

Maximum length of I/O bursts in seconds.

Maximum read speed in bytes per second.

Maximum length of read I/O bursts in seconds.

Maximum write speed in bytes per second.

Maximum length of write I/O bursts in seconds.

The drive’s cache mode

Force the drive’s physical geometry to have a specific cylinder count.

Controls whether to detect and try to optimize writes of zeroes.

Controls whether to pass discard/trim requests to the underlying storage.

The drive’s backing volume.

The drive’s backing file’s data format.

Force the drive’s physical geometry to have a specific head count.

Maximum r/w I/O in operations per second.

Maximum unthrottled r/w I/O pool in operations per second.

Maximum length of I/O bursts in seconds.

Maximum read I/O in operations per second.

Maximum unthrottled read I/O pool in operations per second.

Maximum length of read I/O bursts in seconds.

Maximum write I/O in operations per second.

Maximum unthrottled write I/O pool in operations per second.

Maximum length of write I/O bursts in seconds.

Maximum r/w speed in megabytes per second.

Maximum unthrottled r/w pool in megabytes per second.

Maximum read speed in megabytes per second.

Maximum unthrottled read pool in megabytes per second.

Maximum write speed in megabytes per second.

Maximum unthrottled write pool in megabytes per second.

The drive’s media type.

Whether the drive should considered for replication jobs.

Read error action.

Force the drive’s physical geometry to have a specific sector count.

The drive’s reported serial number, url-encoded, up to 20 bytes long.

Mark this locally-managed volume as available on all nodes.

This option does not share the volume automatically, it assumes it is shared already!

Disk size. This is purely informational and has no effect.

Controls qemu’s snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.

Whether to expose this drive as an SSD, rather than a rotational hard disk.

Force disk geometry bios translation mode.

Write error action.

The drive’s worldwide name, encoded as 16 bytes hex string, prefixed by 0x.

AIO type to use.

Whether the drive should be included when making backups.

Maximum r/w speed in bytes per second.

Maximum length of I/O bursts in seconds.

Maximum read speed in bytes per second.

Maximum length of read I/O bursts in seconds.

Maximum write speed in bytes per second.

Maximum length of write I/O bursts in seconds.

The drive’s cache mode

Force the drive’s physical geometry to have a specific cylinder count.

Controls whether to detect and try to optimize writes of zeroes.

Controls whether to pass discard/trim requests to the underlying storage.

The drive’s backing volume.

The drive’s backing file’s data format.

Force the drive’s physical geometry to have a specific head count.

Maximum r/w I/O in operations per second.

Maximum unthrottled r/w I/O pool in operations per second.

Maximum length of I/O bursts in seconds.

Maximum read I/O in operations per second.

Maximum unthrottled read I/O pool in operations per second.

Maximum length of read I/O bursts in seconds.

Maximum write I/O in operations per second.

Maximum unthrottled write I/O pool in operations per second.

Maximum length of write I/O bursts in seconds.

Whether to use iothreads for this drive

Maximum r/w speed in megabytes per second.

Maximum unthrottled r/w pool in megabytes per second.

Maximum read speed in megabytes per second.

Maximum unthrottled read pool in megabytes per second.

Maximum write speed in megabytes per second.

Maximum unthrottled write pool in megabytes per second.

The drive’s media type.

The drive’s product name, up to 16 bytes long.

Number of queues.

Whether the drive should considered for replication jobs.

Read error action.

Whether the drive is read-only.

whether to use scsi-block for full passthrough of host block device

can lead to I/O errors in combination with low memory or high memory fragmentation on host

Force the drive’s physical geometry to have a specific sector count.

The drive’s reported serial number, url-encoded, up to 20 bytes long.

Mark this locally-managed volume as available on all nodes.

This option does not share the volume automatically, it assumes it is shared already!

Disk size. This is purely informational and has no effect.

Controls qemu’s snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.

Whether to expose this drive as an SSD, rather than a rotational hard disk.

Force disk geometry bios translation mode.

The drive’s vendor name, up to 8 bytes long.

Write error action.

The drive’s worldwide name, encoded as 16 bytes hex string, prefixed by 0x.

Flag to indicate that the SMBIOS values are base64 encoded

Set SMBIOS1 family string.

Set SMBIOS1 manufacturer.

Set SMBIOS1 product ID.

Set SMBIOS1 serial number.

Set SMBIOS1 SKU string.

Set SMBIOS1 UUID.

Set SMBIOS1 version.

Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.

Enable video streaming. Uses compression for detected video streams.

The drive’s backing volume.

Disk size. This is purely informational and has no effect.

The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.

The drive’s backing volume.

The Host USB device or port or the value spice. HOSTUSBDEVICE syntax is:

'bus-port(.port)*' (decimal numbers) or
'vendor_id:product_id' (hexadecimal numbers) or
'spice'

This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.

The ID of a cluster wide mapping. Either this or the default-key host must be set.

Specifies whether if given host option is a USB3 device or port. For modern guests (machine version >= 7.1 and ostype l26 and windows > 7), this flag is irrelevant (all devices are plugged into a xhci controller).

Enable a specific clipboard. If not set, depending on the display type the SPICE one will be added. Migration with VNC clipboard is not yet supported!

Sets the VGA memory (in MiB). Has no effect with serial display.

Select the VGA type. Using type cirrus is not recommended.

AIO type to use.

Whether the drive should be included when making backups.

Maximum r/w speed in bytes per second.

Maximum length of I/O bursts in seconds.

Maximum read speed in bytes per second.

Maximum length of read I/O bursts in seconds.

Maximum write speed in bytes per second.

Maximum length of write I/O bursts in seconds.

The drive’s cache mode

Force the drive’s physical geometry to have a specific cylinder count.

Controls whether to detect and try to optimize writes of zeroes.

Controls whether to pass discard/trim requests to the underlying storage.

The drive’s backing volume.

The drive’s backing file’s data format.

Force the drive’s physical geometry to have a specific head count.

Maximum r/w I/O in operations per second.

Maximum unthrottled r/w I/O pool in operations per second.

Maximum length of I/O bursts in seconds.

Maximum read I/O in operations per second.

Maximum unthrottled read I/O pool in operations per second.

Maximum length of read I/O bursts in seconds.

Maximum write I/O in operations per second.

Maximum unthrottled write I/O pool in operations per second.

Maximum length of write I/O bursts in seconds.

Whether to use iothreads for this drive

Maximum r/w speed in megabytes per second.

Maximum unthrottled r/w pool in megabytes per second.

Maximum read speed in megabytes per second.

Maximum unthrottled read pool in megabytes per second.

Maximum write speed in megabytes per second.

Maximum unthrottled write pool in megabytes per second.

The drive’s media type.

Whether the drive should considered for replication jobs.

Read error action.

Whether the drive is read-only.

Force the drive’s physical geometry to have a specific sector count.

The drive’s reported serial number, url-encoded, up to 20 bytes long.

Mark this locally-managed volume as available on all nodes.

This option does not share the volume automatically, it assumes it is shared already!

Disk size. This is purely informational and has no effect.

Controls qemu’s snapshot mode feature. If activated, changes made to the disk are temporary and will be discarded when the VM is shutdown.

Force disk geometry bios translation mode.

Write error action.

The action to perform if after activation the guest fails to poll the watchdog in time.

Watchdog type to emulate.