vm.conf.5-opts.adoc

   1 `acpi`: `boolean` (default=`1`)::
   2
   3 Enable/disable ACPI.
   4
   5 `agent`: `boolean` (default=`0`)::
   6
   7 Enable/disable Qemu GuestAgent.
   8
   9 `args`: `string` ::
  10
  11 NOTE: this option is for experts only. It allows you to pass arbitrary
  12 arguments to kvm, for example:
  13 +
  14 args: -no-reboot -no-hpet
  15
  16 `autostart`: `boolean` (default=`0`)::
  17
  18 Automatic restart after crash (currently ignored).
  19
  20 `balloon`: `integer (0 - N)` ::
  21
  22 Amount of target RAM for the VM in MB. Using zero disables the ballon
  23 driver.
  24
  25 `bios`: `(ovmf | seabios)` (default=`seabios`)::
  26
  27 Select BIOS implementation.
  28
  29 `boot`: `[acdn]{1,4}` (default=`cdn`)::
  30
  31 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
  32
  33 `bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
  34
  35 Enable booting from specified disk.
  36
  37 `cdrom`: `volume` ::
  38
  39 This is an alias for option -ide2
  40
  41 `cores`: `integer (1 - N)` (default=`1`)::
  42
  43 The number of cores per socket.
  44
  45 `cpu`: ::
  46
  47 Emulated CPU type.
  48
  49 `cpulimit`: `number (0 - 128)` (default=`0`)::
  50
  51 Limit of CPU usage.
  52 +
  53 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
  54 indicates no CPU limit.
  55
  56 `cpuunits`: `integer (0 - 500000)` (default=`1000`)::
  57
  58 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
  59 larger the number is, the more CPU time this VM gets. Number is relative to
  60 weights of all the other running VMs.
  61 +
  62 NOTE: You can disable fair-scheduler configuration by setting this to 0.
  63
  64 `description`: `string` ::
  65
  66 Description for the VM. Only used on the configuration web interface. This
  67 is saved as comment inside the configuration file.
  68
  69 `freeze`: `boolean` ::
  70
  71 Freeze CPU at startup (use 'c' monitor command to start execution).
  72
  73 `hostpci[n]`: `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` ::
  74
  75 Map host pci devices. HOSTPCIDEVICE syntax is:
  76 +
  77 'bus:dev.func' (hexadecimal numbers)
  78 +
  79 You can us the 'lspci' command to list existing pci devices.
  80 +
  81 The 'rombar' option determines whether or not the device's ROM will be
  82 visible in the guest's memory map (default is 'on').
  83 +
  84 NOTE: This option allows direct access to host hardware. So it is no longer
  85 possible to migrate such machines - use with special care.
  86 +
  87 Experimental: user reported problems with this option.
  88
  89 `hotplug`: `string` (default=`network,disk,usb`)::
  90
  91 Selectively enable hotplug features. This is a comma separated list of
  92 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
  93 disable hotplug completely. Value '1' is an alias for the default
  94 'network,disk,usb'.
  95
  96 `ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
  97
  98 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
  99
 100 `keyboard`: `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`)::
 101
 102 Keybord layout for vnc server. Default is read from the datacenter
 103 configuration file.
 104
 105 `kvm`: `boolean` (default=`1`)::
 106
 107 Enable/disable KVM hardware virtualization.
 108
 109 `localtime`: `boolean` ::
 110
 111 Set the real time clock to local time. This is enabled by default if ostype
 112 indicates a Microsoft OS.
 113
 114 `lock`: `(backup | migrate | rollback | snapshot)` ::
 115
 116 Lock/unlock the VM.
 117
 118 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 119
 120 Specific the Qemu machine type.
 121
 122 `memory`: `integer (16 - N)` (default=`512`)::
 123
 124 Amount of RAM for the VM in MB. This is the maximum available memory when
 125 you use the balloon device.
 126
 127 `migrate_downtime`: `number (0 - N)` (default=`0.1`)::
 128
 129 Set maximum tolerated downtime (in seconds) for migrations.
 130
 131 `migrate_speed`: `integer (0 - N)` (default=`0`)::
 132
 133 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 134
 135 `name`: `string` ::
 136
 137 Set a name for the VM. Only used on the configuration web interface.
 138
 139 `net[n]`: `MODEL=XX:XX:XX:XX:XX:XX [,bridge=<dev>][,queues=<nbqueues>][,rate=<mbps>] [,tag=<vlanid>][,trunks=<vlanid[;vlanid]>][,firewall=0|1],link_down=0|1]` ::
 140
 141 Specify network devices.
 142 +
 143 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
 144 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
 145 +
 146 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
 147 automatically generated if not specified.
 148 +
 149 The bridge parameter can be used to automatically add the interface to a
 150 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
 151 +
 152 Option 'rate' is used to limit traffic bandwidth from and to this
 153 interface. It is specified as floating point number, unit is 'Megabytes per
 154 second'.
 155 +
 156 If you specify no bridge, we create a kvm 'user' (NATed) network device,
 157 which provides DHCP and DNS services. The following addresses are used:
 158 +
 159 10.0.2.2   Gateway
 160 10.0.2.3   DNS Server
 161 10.0.2.4   SMB Server
 162 +
 163 The DHCP server assign addresses to the guest starting from 10.0.2.15.
 164
 165 `numa`: `boolean` (default=`0`)::
 166
 167 Enable/disable NUMA.
 168
 169 `numa[n]`: `cpus=<id[-id],memory=<mb>[[,hostnodes=<id[-id]>] [,policy=<preferred|bind|interleave>]]` ::
 170
 171 numa topology
 172
 173 `onboot`: `boolean` (default=`0`)::
 174
 175 Specifies whether a VM will be started during system bootup.
 176
 177 `ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
 178
 179 Used to enable special optimization/features for specific
 180 operating systems:
 181 +
 182 other  => unspecified OS
 183 wxp    => Microsoft Windows XP
 184 w2k    => Microsoft Windows 2000
 185 w2k3   => Microsoft Windows 2003
 186 w2k8   => Microsoft Windows 2008
 187 wvista => Microsoft Windows Vista
 188 win7   => Microsoft Windows 7
 189 win8   => Microsoft Windows 8/2012
 190 l24    => Linux 2.4 Kernel
 191 l26    => Linux 2.6/3.X Kernel
 192 solaris => solaris/opensolaris/openindiania kernel
 193 +
 194 other|l24|l26|solaris                       ... no special behaviour
 195 wxp|w2k|w2k3|w2k8|wvista|win7|win8  ... use --localtime switch
 196
 197 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
 198
 199 Map host parallel devices (n is 0 to 2).
 200 +
 201 NOTE: This option allows direct access to host hardware. So it is no longer
 202 possible to migrate such machines - use with special care.
 203 +
 204 Experimental: user reported problems with this option.
 205
 206 `protection`: `boolean` (default=`0`)::
 207
 208 Sets the protection flag of the VM. This will prevent the remove operation.
 209
 210 `reboot`: `boolean` (default=`1`)::
 211
 212 Allow reboot. If set to '0' the VM exit on reboot.
 213
 214 `sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 215
 216 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 217
 218 `scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 219
 220 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 221
 222 `scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
 223
 224 scsi controller model
 225
 226 `serial[n]`: `(/dev/.+|socket)` ::
 227
 228 Create a serial device inside the VM (n is 0 to 3), and pass through a host
 229 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
 230 (use 'qm terminal' to open a terminal connection).
 231 +
 232 NOTE: If you pass through a host serial device, it is no longer possible to
 233 migrate such machines - use with special care.
 234 +
 235 Experimental: user reported problems with this option.
 236
 237 `shares`: `integer (0 - 50000)` (default=`1000`)::
 238
 239 Amount of memory shares for auto-ballooning. The larger the number is, the
 240 more memory this VM gets. Number is relative to weights of all other
 241 running VMs. Using zero disables auto-ballooning
 242
 243 `smbios[n]`: `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
 244
 245 Specify SMBIOS type 1 fields.
 246
 247 `smp`: `integer (1 - N)` (default=`1`)::
 248
 249 The number of CPUs. Please use option -sockets instead.
 250
 251 `sockets`: `integer (1 - N)` (default=`1`)::
 252
 253 The number of CPU sockets.
 254
 255 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
 256
 257 Set the initial date of the real time clock. Valid format for date are:
 258 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
 259
 260 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 261
 262 Startup and shutdown behavior. Order is a non-negative number defining the
 263 general startup order. Shutdown in done with reverse ordering. Additionally
 264 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
 265 wait before the next VM is started or stopped.
 266
 267 `tablet`: `boolean` (default=`1`)::
 268
 269 Enable/disable the USB tablet device. This device is usually needed to
 270 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
 271 with normal VNC clients. If you're running lots of console-only guests on
 272 one host, you may consider disabling this to save some context switches.
 273 This is turned off by default if you use spice (-vga=qxl).
 274
 275 `tdf`: `boolean` (default=`0`)::
 276
 277 Enable/disable time drift fix.
 278
 279 `template`: `boolean` (default=`0`)::
 280
 281 Enable/disable Template.
 282
 283 `unused[n]`: `string` ::
 284
 285 Reference to unused volumes.
 286
 287 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
 288
 289 Configure an USB device (n is 0 to 4). This can be used to
 290 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
 291 +
 292 'bus-port(.port)*' (decimal numbers) or
 293 'vendor_id:product_id' (hexadeciaml numbers) or
 294 'spice'
 295 +
 296 You can use the 'lsusb -t' command to list existing usb devices.
 297 +
 298 NOTE: This option allows direct access to host hardware. So it is no longer
 299 possible to migrate such machines - use with special care.
 300 +
 301 The value 'spice' can be used to add a usb redirection devices for spice.
 302 +
 303 The 'usb3' option determines whether the device is a USB3 device or not
 304 (this does currently not work reliably with spice redirection and is then
 305 ignored).
 306
 307 `vcpus`: `integer (1 - N)` (default=`0`)::
 308
 309 Number of hotplugged vcpus.
 310
 311 `vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
 312
 313 Select the VGA type. If you want to use high resolution modes (>=
 314 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
 315 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
 316 enables the SPICE display sever. For win* OS you can select how many
 317 independent displays you want, Linux guests can add displays them self. You
 318 can also run without any graphic card, using a serial device as terminal.
 319
 320 `virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 321
 322 Use volume as VIRTIO hard disk (n is 0 to 15).
 323
 324 `watchdog`: `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` ::
 325
 326 Create a virtual hardware watchdog device. Once enabled (by a guest
 327 action), the watchdog must be periodically polled by an agent inside the
 328 guest or else the watchdog will reset the guest (or execute the respective
 329 action specified)
 330