qm.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 Arbitrary arguments passed to kvm, for example:
  12 +
  13 args: -no-reboot -no-hpet
  14 +
  15 NOTE: this option is for experts only.
  16
  17 `autostart`: `boolean` (default=`0`)::
  18
  19 Automatic restart after crash (currently ignored).
  20
  21 `balloon`: `integer (0 - N)` ::
  22
  23 Amount of target RAM for the VM in MB. Using zero disables the ballon 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`: `[cputype=]<cputype> [,hidden=<1|0>]` ::
  46
  47 Emulated CPU type.
  48
  49 `cputype`=`<cputype>` (default=`kvm64`);;
  50
  51 Emulated CPU type.
  52
  53 `hidden`=`boolean` (default=`0`);;
  54
  55 Do not identify as a KVM virtual machine.
  56
  57 `cpulimit`: `number (0 - 128)` (default=`0`)::
  58
  59 Limit of CPU usage.
  60 +
  61 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
  62
  63 `cpuunits`: `integer (0 - 500000)` (default=`1000`)::
  64
  65 CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.
  66 +
  67 NOTE: You can disable fair-scheduler configuration by setting this to 0.
  68
  69 `description`: `string` ::
  70
  71 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
  72
  73 `freeze`: `boolean` ::
  74
  75 Freeze CPU at startup (use 'c' monitor command to start execution).
  76
  77 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
  78
  79 Map host PCI devices into guest.
  80 +
  81 NOTE: This option allows direct access to host hardware. So it is no longer
  82 possible to migrate such machines - use with special care.
  83 +
  84 CAUTION: Experimental! User reported problems with this option.
  85
  86 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
  87
  88 Host PCI device pass through. The PCI ID of a host's PCI device or a list
  89 of PCI virtual functions of the host. HOSTPCIID syntax is:
  90 +
  91 'bus:dev.func' (hexadecimal numbers)
  92 +
  93 You can us the 'lspci' command to list existing PCI devices.
  94
  95 `pcie`=`boolean` (default=`0`);;
  96
  97 Choose the PCI-express bus (needs the 'q35' machine model).
  98
  99 `rombar`=`boolean` (default=`1`);;
 100
 101 Specify whether or not the device's ROM will be visible in the guest's memory map.
 102
 103 `x-vga`=`boolean` (default=`0`);;
 104
 105 Enable vfio-vga device support.
 106
 107 `hotplug`: `string` (default=`network,disk,usb`)::
 108
 109 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
 110
 111 `ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,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=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 112
 113 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 114
 115 `aio`=`(native | threads)` ;;
 116
 117 AIO type to use.
 118
 119 `backup`=`boolean` ;;
 120
 121 Whether the drive should be included when making backups.
 122
 123 `bps`=`<bps>` ;;
 124
 125 Maximum r/w speed speed in bytes per second.
 126
 127 `bps_rd`=`<bps>` ;;
 128
 129 Maximum read speed speed in bytes per second.
 130
 131 `bps_wr`=`<bps>` ;;
 132
 133 Maximum write speed speed in bytes per second.
 134
 135 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
 136
 137 The drive's cache mode
 138
 139 `cyls`=`integer` ;;
 140
 141 Force the drive's physical geometry to have a specific cylinder count.
 142
 143 `detect_zeroes`=`boolean` ;;
 144
 145 Controls whether to detect and try to optimize writes of zeroes.
 146
 147 `discard`=`(ignore | on)` ;;
 148
 149 Controls whether to pass discard/trim requests to the underlying storage.
 150
 151 `file`=`<volume>` ;;
 152
 153 The drive's backing volume.
 154
 155 `format`=`<image format>` ;;
 156
 157 The drive's backing file's data format.
 158
 159 `heads`=`integer` ;;
 160
 161 Force the drive's physical geometry to have a specific head count.
 162
 163 `iops`=`<iops>` ;;
 164
 165 Maximum r/w I/O speed in operations per second.
 166
 167 `iops_max`=`<iops>` ;;
 168
 169 Maximum unthrottled r/w I/O pool speed in operations per second.
 170
 171 `iops_rd`=`<iops>` ;;
 172
 173 Maximum read I/O speed in operations per second.
 174
 175 `iops_rd_max`=`<iops>` ;;
 176
 177 Maximum unthrottled read I/O pool speed in operations per second.
 178
 179 `iops_wr`=`<iops>` ;;
 180
 181 Maximum write I/O speed in operations per second.
 182
 183 `iops_wr_max`=`<iops>` ;;
 184
 185 Maximum unthrottled write I/O pool speed in operations per second.
 186
 187 `mbps`=`<mbps>` ;;
 188
 189 Maximum r/w speed speed in megabytes per second.
 190
 191 `mbps_max`=`<mbps>` ;;
 192
 193 Maximum unthrottled r/w pool speed in megabytes per second.
 194
 195 `mbps_rd`=`<mbps>` ;;
 196
 197 Maximum read speed speed in megabytes per second.
 198
 199 `mbps_rd_max`=`<mbps>` ;;
 200
 201 Maximum unthrottled read pool speed in megabytes per second.
 202
 203 `mbps_wr`=`<mbps>` ;;
 204
 205 Maximum write speed speed in megabytes per second.
 206
 207 `mbps_wr_max`=`<mbps>` ;;
 208
 209 Maximum unthrottled write pool speed in megabytes per second.
 210
 211 `media`=`(cdrom | disk)` (default=`disk`);;
 212
 213 The drive's media type.
 214
 215 `model`=`<model>` ;;
 216
 217 The drive's reported model name, url-encoded, up to 40 bytes long.
 218
 219 `rerror`=`(ignore | report | stop)` ;;
 220
 221 Read error action.
 222
 223 `secs`=`integer` ;;
 224
 225 Force the drive's physical geometry to have a specific sector count.
 226
 227 `serial`=`<serial>` ;;
 228
 229 The drive's reported serial number, url-encoded, up to 20 bytes long.
 230
 231 `size`=`<DiskSize>` ;;
 232
 233 Disk size. This is purely informational and has no effect.
 234
 235 `snapshot`=`boolean` ;;
 236
 237 Whether the drive should be included when making snapshots.
 238
 239 `trans`=`(auto | lba | none)` ;;
 240
 241 Force disk geometry bios translation mode.
 242
 243 `werror`=`(enospc | ignore | report | stop)` ;;
 244
 245 Write error action.
 246
 247 `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`)::
 248
 249 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
 250
 251 `kvm`: `boolean` (default=`1`)::
 252
 253 Enable/disable KVM hardware virtualization.
 254
 255 `localtime`: `boolean` ::
 256
 257 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
 258
 259 `lock`: `(backup | migrate | rollback | snapshot)` ::
 260
 261 Lock/unlock the VM.
 262
 263 `machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 264
 265 Specific the Qemu machine type.
 266
 267 `memory`: `integer (16 - N)` (default=`512`)::
 268
 269 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
 270
 271 `migrate_downtime`: `number (0 - N)` (default=`0.1`)::
 272
 273 Set maximum tolerated downtime (in seconds) for migrations.
 274
 275 `migrate_speed`: `integer (0 - N)` (default=`0`)::
 276
 277 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 278
 279 `name`: `string` ::
 280
 281 Set a name for the VM. Only used on the configuration web interface.
 282
 283 `net[n]`: `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
 284
 285 Specify network devices.
 286
 287 `bridge`=`<bridge>` ;;
 288
 289 Bridge to attach the network device to. The Proxmox VE standard bridge
 290 is called 'vmbr0'.
 291 +
 292 If you do not specify a bridge, we create a kvm user (NATed) network
 293 device, which provides DHCP and DNS services. The following addresses
 294 are used:
 295 +
 296  10.0.2.2   Gateway
 297  10.0.2.3   DNS Server
 298  10.0.2.4   SMB Server
 299 +
 300 The DHCP server assign addresses to the guest starting from 10.0.2.15.
 301
 302 `firewall`=`boolean` ;;
 303
 304 Whether this interface should be protected by the firewall.
 305
 306 `link_down`=`boolean` ;;
 307
 308 Whether this interface should be disconnected (like pulling the plug).
 309
 310 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
 311
 312 MAC address. That address must be unique withing your network. This is automatically generated if not specified.
 313
 314 `model`=`<model>` ;;
 315
 316 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'.
 317
 318 `queues`=`integer (0 - 16)` ;;
 319
 320 Number of packet queues to be used on the device.
 321
 322 `rate`=`number (0 - N)` ;;
 323
 324 Rate limit in mbps (megabytes per second) as floating point number.
 325
 326 `tag`=`integer (1 - 4094)` ;;
 327
 328 VLAN tag to apply to packets on this interface.
 329
 330 `trunks`=`<vlanid[;vlanid...]>` ;;
 331
 332 VLAN trunks to pass through this interface.
 333
 334 `numa`: `boolean` (default=`0`)::
 335
 336 Enable/disable NUMA.
 337
 338 `numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
 339
 340 NUMA topology.
 341
 342 `cpus`=`<id[-id];...>` ;;
 343
 344 CPUs accessing this NUMA node.
 345
 346 `hostnodes`=`<id[-id];...>` ;;
 347
 348 Host NUMA nodes to use.
 349
 350 `memory`=`number` ;;
 351
 352 Amount of memory this NUMA node provides.
 353
 354 `policy`=`(bind | interleave | preferred)` ;;
 355
 356 NUMA allocation policy.
 357
 358 `onboot`: `boolean` (default=`0`)::
 359
 360 Specifies whether a VM will be started during system bootup.
 361
 362 `ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
 363
 364 Specify guest operating system. This is used to enable special
 365 optimization/features for specific operating systems:
 366 +
 367 [horizontal]
 368 other;; unspecified OS
 369 wxp;; Microsoft Windows XP
 370 w2k;; Microsoft Windows 2000
 371 w2k3;; Microsoft Windows 2003
 372 w2k8;; Microsoft Windows 2008
 373 wvista;; Microsoft Windows Vista
 374 win7;; Microsoft Windows 7
 375 win8;; Microsoft Windows 8/2012
 376 l24;; Linux 2.4 Kernel
 377 l26;; Linux 2.6/3.X Kernel
 378 solaris;; Solaris/OpenSolaris/OpenIndiania kernel
 379
 380 `parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
 381
 382 Map host parallel devices (n is 0 to 2).
 383 +
 384 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
 385 +
 386 CAUTION: Experimental! User reported problems with this option.
 387
 388 `protection`: `boolean` (default=`0`)::
 389
 390 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
 391
 392 `reboot`: `boolean` (default=`1`)::
 393
 394 Allow reboot. If set to '0' the VM exit on reboot.
 395
 396 `sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,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=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 397
 398 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 399
 400 `aio`=`(native | threads)` ;;
 401
 402 AIO type to use.
 403
 404 `backup`=`boolean` ;;
 405
 406 Whether the drive should be included when making backups.
 407
 408 `bps`=`<bps>` ;;
 409
 410 Maximum r/w speed speed in bytes per second.
 411
 412 `bps_rd`=`<bps>` ;;
 413
 414 Maximum read speed speed in bytes per second.
 415
 416 `bps_wr`=`<bps>` ;;
 417
 418 Maximum write speed speed in bytes per second.
 419
 420 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
 421
 422 The drive's cache mode
 423
 424 `cyls`=`integer` ;;
 425
 426 Force the drive's physical geometry to have a specific cylinder count.
 427
 428 `detect_zeroes`=`boolean` ;;
 429
 430 Controls whether to detect and try to optimize writes of zeroes.
 431
 432 `discard`=`(ignore | on)` ;;
 433
 434 Controls whether to pass discard/trim requests to the underlying storage.
 435
 436 `file`=`<volume>` ;;
 437
 438 The drive's backing volume.
 439
 440 `format`=`<image format>` ;;
 441
 442 The drive's backing file's data format.
 443
 444 `heads`=`integer` ;;
 445
 446 Force the drive's physical geometry to have a specific head count.
 447
 448 `iops`=`<iops>` ;;
 449
 450 Maximum r/w I/O speed in operations per second.
 451
 452 `iops_max`=`<iops>` ;;
 453
 454 Maximum unthrottled r/w I/O pool speed in operations per second.
 455
 456 `iops_rd`=`<iops>` ;;
 457
 458 Maximum read I/O speed in operations per second.
 459
 460 `iops_rd_max`=`<iops>` ;;
 461
 462 Maximum unthrottled read I/O pool speed in operations per second.
 463
 464 `iops_wr`=`<iops>` ;;
 465
 466 Maximum write I/O speed in operations per second.
 467
 468 `iops_wr_max`=`<iops>` ;;
 469
 470 Maximum unthrottled write I/O pool speed in operations per second.
 471
 472 `mbps`=`<mbps>` ;;
 473
 474 Maximum r/w speed speed in megabytes per second.
 475
 476 `mbps_max`=`<mbps>` ;;
 477
 478 Maximum unthrottled r/w pool speed in megabytes per second.
 479
 480 `mbps_rd`=`<mbps>` ;;
 481
 482 Maximum read speed speed in megabytes per second.
 483
 484 `mbps_rd_max`=`<mbps>` ;;
 485
 486 Maximum unthrottled read pool speed in megabytes per second.
 487
 488 `mbps_wr`=`<mbps>` ;;
 489
 490 Maximum write speed speed in megabytes per second.
 491
 492 `mbps_wr_max`=`<mbps>` ;;
 493
 494 Maximum unthrottled write pool speed in megabytes per second.
 495
 496 `media`=`(cdrom | disk)` (default=`disk`);;
 497
 498 The drive's media type.
 499
 500 `rerror`=`(ignore | report | stop)` ;;
 501
 502 Read error action.
 503
 504 `secs`=`integer` ;;
 505
 506 Force the drive's physical geometry to have a specific sector count.
 507
 508 `serial`=`<serial>` ;;
 509
 510 The drive's reported serial number, url-encoded, up to 20 bytes long.
 511
 512 `size`=`<DiskSize>` ;;
 513
 514 Disk size. This is purely informational and has no effect.
 515
 516 `snapshot`=`boolean` ;;
 517
 518 Whether the drive should be included when making snapshots.
 519
 520 `trans`=`(auto | lba | none)` ;;
 521
 522 Force disk geometry bios translation mode.
 523
 524 `werror`=`(enospc | ignore | report | stop)` ;;
 525
 526 Write error action.
 527
 528 `scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 529
 530 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 531
 532 `aio`=`(native | threads)` ;;
 533
 534 AIO type to use.
 535
 536 `backup`=`boolean` ;;
 537
 538 Whether the drive should be included when making backups.
 539
 540 `bps`=`<bps>` ;;
 541
 542 Maximum r/w speed speed in bytes per second.
 543
 544 `bps_rd`=`<bps>` ;;
 545
 546 Maximum read speed speed in bytes per second.
 547
 548 `bps_wr`=`<bps>` ;;
 549
 550 Maximum write speed speed in bytes per second.
 551
 552 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
 553
 554 The drive's cache mode
 555
 556 `cyls`=`integer` ;;
 557
 558 Force the drive's physical geometry to have a specific cylinder count.
 559
 560 `detect_zeroes`=`boolean` ;;
 561
 562 Controls whether to detect and try to optimize writes of zeroes.
 563
 564 `discard`=`(ignore | on)` ;;
 565
 566 Controls whether to pass discard/trim requests to the underlying storage.
 567
 568 `file`=`<volume>` ;;
 569
 570 The drive's backing volume.
 571
 572 `format`=`<image format>` ;;
 573
 574 The drive's backing file's data format.
 575
 576 `heads`=`integer` ;;
 577
 578 Force the drive's physical geometry to have a specific head count.
 579
 580 `iops`=`<iops>` ;;
 581
 582 Maximum r/w I/O speed in operations per second.
 583
 584 `iops_max`=`<iops>` ;;
 585
 586 Maximum unthrottled r/w I/O pool speed in operations per second.
 587
 588 `iops_rd`=`<iops>` ;;
 589
 590 Maximum read I/O speed in operations per second.
 591
 592 `iops_rd_max`=`<iops>` ;;
 593
 594 Maximum unthrottled read I/O pool speed in operations per second.
 595
 596 `iops_wr`=`<iops>` ;;
 597
 598 Maximum write I/O speed in operations per second.
 599
 600 `iops_wr_max`=`<iops>` ;;
 601
 602 Maximum unthrottled write I/O pool speed in operations per second.
 603
 604 `iothread`=`boolean` ;;
 605
 606 Whether to use iothreads for this drive
 607
 608 `mbps`=`<mbps>` ;;
 609
 610 Maximum r/w speed speed in megabytes per second.
 611
 612 `mbps_max`=`<mbps>` ;;
 613
 614 Maximum unthrottled r/w pool speed in megabytes per second.
 615
 616 `mbps_rd`=`<mbps>` ;;
 617
 618 Maximum read speed speed in megabytes per second.
 619
 620 `mbps_rd_max`=`<mbps>` ;;
 621
 622 Maximum unthrottled read pool speed in megabytes per second.
 623
 624 `mbps_wr`=`<mbps>` ;;
 625
 626 Maximum write speed speed in megabytes per second.
 627
 628 `mbps_wr_max`=`<mbps>` ;;
 629
 630 Maximum unthrottled write pool speed in megabytes per second.
 631
 632 `media`=`(cdrom | disk)` (default=`disk`);;
 633
 634 The drive's media type.
 635
 636 `queues`=`integer (2 - N)` ;;
 637
 638 Number of queues.
 639
 640 `secs`=`integer` ;;
 641
 642 Force the drive's physical geometry to have a specific sector count.
 643
 644 `serial`=`<serial>` ;;
 645
 646 The drive's reported serial number, url-encoded, up to 20 bytes long.
 647
 648 `size`=`<DiskSize>` ;;
 649
 650 Disk size. This is purely informational and has no effect.
 651
 652 `snapshot`=`boolean` ;;
 653
 654 Whether the drive should be included when making snapshots.
 655
 656 `trans`=`(auto | lba | none)` ;;
 657
 658 Force disk geometry bios translation mode.
 659
 660 `werror`=`(enospc | ignore | report | stop)` ;;
 661
 662 Write error action.
 663
 664 `scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
 665
 666 SCSI controller model
 667
 668 `serial[n]`: `(/dev/.+|socket)` ::
 669
 670 Create a serial device inside the VM (n is 0 to 3), and pass through a
 671 host serial device (i.e. /dev/ttyS0), or create a unix socket on the
 672 host side (use 'qm terminal' to open a terminal connection).
 673 +
 674 NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
 675 +
 676 CAUTION: Experimental! User reported problems with this option.
 677
 678 `shares`: `integer (0 - 50000)` (default=`1000`)::
 679
 680 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
 681
 682 `smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
 683
 684 Specify SMBIOS type 1 fields.
 685
 686 `family`=`<string>` ;;
 687
 688 Set SMBIOS1 family string.
 689
 690 `manufacturer`=`<string>` ;;
 691
 692 Set SMBIOS1 manufacturer.
 693
 694 `product`=`<string>` ;;
 695
 696 Set SMBIOS1 product ID.
 697
 698 `serial`=`<string>` ;;
 699
 700 Set SMBIOS1 serial number.
 701
 702 `sku`=`<string>` ;;
 703
 704 Set SMBIOS1 SKU string.
 705
 706 `uuid`=`<UUID>` ;;
 707
 708 Set SMBIOS1 UUID.
 709
 710 `version`=`<string>` ;;
 711
 712 Set SMBIOS1 version.
 713
 714 `smp`: `integer (1 - N)` (default=`1`)::
 715
 716 The number of CPUs. Please use option -sockets instead.
 717
 718 `sockets`: `integer (1 - N)` (default=`1`)::
 719
 720 The number of CPU sockets.
 721
 722 `startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
 723
 724 Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
 725
 726 `startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 727
 728 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
 729
 730 `tablet`: `boolean` (default=`1`)::
 731
 732 Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl).
 733
 734 `tdf`: `boolean` (default=`0`)::
 735
 736 Enable/disable time drift fix.
 737
 738 `template`: `boolean` (default=`0`)::
 739
 740 Enable/disable Template.
 741
 742 `unused[n]`: `string` ::
 743
 744 Reference to unused volumes. This is used internally, and should not be modified manually.
 745
 746 `usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
 747
 748 Configure an USB device (n is 0 to 4).
 749
 750 `host`=`<HOSTUSBDEVICE|spice>` ;;
 751
 752 The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
 753 +
 754  'bus-port(.port)*' (decimal numbers) or
 755  'vendor_id:product_id' (hexadeciaml numbers) or
 756  'spice'
 757 +
 758 You can use the 'lsusb -t' command to list existing usb devices.
 759 +
 760 NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
 761 +
 762 The value 'spice' can be used to add a usb redirection devices for spice.
 763
 764 `usb3`=`boolean` (default=`0`);;
 765
 766 Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).
 767
 768 `vcpus`: `integer (1 - N)` (default=`0`)::
 769
 770 Number of hotplugged vcpus.
 771
 772 `vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
 773
 774 Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.
 775
 776 `virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,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=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 777
 778 Use volume as VIRTIO hard disk (n is 0 to 15).
 779
 780 `aio`=`(native | threads)` ;;
 781
 782 AIO type to use.
 783
 784 `backup`=`boolean` ;;
 785
 786 Whether the drive should be included when making backups.
 787
 788 `bps`=`<bps>` ;;
 789
 790 Maximum r/w speed speed in bytes per second.
 791
 792 `bps_rd`=`<bps>` ;;
 793
 794 Maximum read speed speed in bytes per second.
 795
 796 `bps_wr`=`<bps>` ;;
 797
 798 Maximum write speed speed in bytes per second.
 799
 800 `cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
 801
 802 The drive's cache mode
 803
 804 `cyls`=`integer` ;;
 805
 806 Force the drive's physical geometry to have a specific cylinder count.
 807
 808 `detect_zeroes`=`boolean` ;;
 809
 810 Controls whether to detect and try to optimize writes of zeroes.
 811
 812 `discard`=`(ignore | on)` ;;
 813
 814 Controls whether to pass discard/trim requests to the underlying storage.
 815
 816 `file`=`<volume>` ;;
 817
 818 The drive's backing volume.
 819
 820 `format`=`<image format>` ;;
 821
 822 The drive's backing file's data format.
 823
 824 `heads`=`integer` ;;
 825
 826 Force the drive's physical geometry to have a specific head count.
 827
 828 `iops`=`<iops>` ;;
 829
 830 Maximum r/w I/O speed in operations per second.
 831
 832 `iops_max`=`<iops>` ;;
 833
 834 Maximum unthrottled r/w I/O pool speed in operations per second.
 835
 836 `iops_rd`=`<iops>` ;;
 837
 838 Maximum read I/O speed in operations per second.
 839
 840 `iops_rd_max`=`<iops>` ;;
 841
 842 Maximum unthrottled read I/O pool speed in operations per second.
 843
 844 `iops_wr`=`<iops>` ;;
 845
 846 Maximum write I/O speed in operations per second.
 847
 848 `iops_wr_max`=`<iops>` ;;
 849
 850 Maximum unthrottled write I/O pool speed in operations per second.
 851
 852 `iothread`=`boolean` ;;
 853
 854 Whether to use iothreads for this drive
 855
 856 `mbps`=`<mbps>` ;;
 857
 858 Maximum r/w speed speed in megabytes per second.
 859
 860 `mbps_max`=`<mbps>` ;;
 861
 862 Maximum unthrottled r/w pool speed in megabytes per second.
 863
 864 `mbps_rd`=`<mbps>` ;;
 865
 866 Maximum read speed speed in megabytes per second.
 867
 868 `mbps_rd_max`=`<mbps>` ;;
 869
 870 Maximum unthrottled read pool speed in megabytes per second.
 871
 872 `mbps_wr`=`<mbps>` ;;
 873
 874 Maximum write speed speed in megabytes per second.
 875
 876 `mbps_wr_max`=`<mbps>` ;;
 877
 878 Maximum unthrottled write pool speed in megabytes per second.
 879
 880 `media`=`(cdrom | disk)` (default=`disk`);;
 881
 882 The drive's media type.
 883
 884 `rerror`=`(ignore | report | stop)` ;;
 885
 886 Read error action.
 887
 888 `secs`=`integer` ;;
 889
 890 Force the drive's physical geometry to have a specific sector count.
 891
 892 `serial`=`<serial>` ;;
 893
 894 The drive's reported serial number, url-encoded, up to 20 bytes long.
 895
 896 `size`=`<DiskSize>` ;;
 897
 898 Disk size. This is purely informational and has no effect.
 899
 900 `snapshot`=`boolean` ;;
 901
 902 Whether the drive should be included when making snapshots.
 903
 904 `trans`=`(auto | lba | none)` ;;
 905
 906 Force disk geometry bios translation mode.
 907
 908 `werror`=`(enospc | ignore | report | stop)` ;;
 909
 910 Write error action.
 911
 912 `watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
 913
 914 Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)
 915
 916 `action`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
 917
 918 The action to perform if after activation the guest fails to poll the watchdog in time.
 919
 920 `model`=`(i6300esb | ib700)` (default=`i6300esb`);;
 921
 922 Watchdog type to emulate.
 923