`balloon`: `integer (0 - N)` ::
-Amount of target RAM for the VM in MB. Using zero disables the ballon
-driver.
+Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
`bios`: `(ovmf | seabios)` (default=`seabios`)::
Emulated CPU type.
+`cputype`=`<cputype>` (default=`kvm64`);;
+
+Emulated CPU type.
+
+`hidden`=`boolean` (default=`0`);;
+
+Do not identify as a KVM virtual machine.
+
`cpulimit`: `number (0 - 128)` (default=`0`)::
Limit of CPU usage.
+
-NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
-indicates no CPU limit.
+NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.
`cpuunits`: `integer (0 - 500000)` (default=`1000`)::
-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.
+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.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.
`description`: `string` ::
-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
+Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`freeze`: `boolean` ::
`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
-Map host pci devices. HOSTPCIDEVICE syntax is:
+Map host PCI devices into guest.
+
+`host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
+
+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:
+
'bus:dev.func' (hexadecimal numbers)
+
-You can us the 'lspci' command to list existing pci devices.
-+
-The 'rombar' option determines whether or not the device's ROM will be
-visible in the guest's memory map (default is 'on').
+You can us the 'lspci' command to list existing PCI devices.
+
-NOTE: This option allows direct access to host hardware. So it is no longer
+NOTE: This option allows direct access to host hardware. So it is no longer
possible to migrate such machines - use with special care.
+
-Experimental: user reported problems with this option.
+CAUTION: Experimental! User reported problems with this option.
+
+`pcie`=`boolean` (default=`0`);;
+
+Choose the PCI-express bus (needs the 'q35' machine model).
+
+`rombar`=`boolean` (default=`1`);;
+
+Specify whether or not the device's ROM will be visible in the guest's memory map.
+
+`x-vga`=`boolean` (default=`0`);;
+
+Enable vfio-vga device support.
`hotplug`: `string` (default=`network,disk,usb`)::
-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'.
+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'.
`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>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
+`aio`=`(native | threads)` ;;
+
+AIO type to use.
+
+`backup`=`boolean` ;;
+
+Whether the drive should be included when making backups.
+
+`bps`=`<bps>` ;;
+
+Maximum r/w speed speed in bytes per second.
+
+`bps_rd`=`<bps>` ;;
+
+Maximum read speed speed in bytes per second.
+
+`bps_wr`=`<bps>` ;;
+
+Maximum write speed speed in bytes per second.
+
+`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
+
+The drive's cache mode
+
+`cyls`=`integer` ;;
+
+Force the drive's physical geometry to have a specific cylinder count.
+
+`detect_zeroes`=`boolean` ;;
+
+Controls whether to detect and try to optimize writes of zeroes.
+
+`discard`=`(ignore | on)` ;;
+
+Controls whether to pass discard/trim requests to the underlying storage.
+
+`file`=`<volume>` ;;
+
+The drive's backing volume.
+
+`format`=`<image format>` ;;
+
+The drive's backing file's data format.
+
+`heads`=`integer` ;;
+
+Force the drive's physical geometry to have a specific head count.
+
+`iops`=`<iops>` ;;
+
+Maximum r/w I/O speed in operations per second.
+
+`iops_max`=`<iops>` ;;
+
+Maximum unthrottled r/w I/O pool speed in operations per second.
+
+`iops_rd`=`<iops>` ;;
+
+Maximum read I/O speed in operations per second.
+
+`iops_rd_max`=`<iops>` ;;
+
+Maximum unthrottled read I/O pool speed in operations per second.
+
+`iops_wr`=`<iops>` ;;
+
+Maximum write I/O speed in operations per second.
+
+`iops_wr_max`=`<iops>` ;;
+
+Maximum unthrottled write I/O pool speed in operations per second.
+
+`mbps`=`<mbps>` ;;
+
+Maximum r/w speed speed in megabytes per second.
+
+`mbps_max`=`<mbps>` ;;
+
+Maximum unthrottled r/w pool speed in megabytes per second.
+
+`mbps_rd`=`<mbps>` ;;
+
+Maximum read speed speed in megabytes per second.
+
+`mbps_rd_max`=`<mbps>` ;;
+
+Maximum unthrottled read pool speed in megabytes per second.
+
+`mbps_wr`=`<mbps>` ;;
+
+Maximum write speed speed in megabytes per second.
+
+`mbps_wr_max`=`<mbps>` ;;
+
+Maximum unthrottled write pool speed in megabytes per second.
+
+`media`=`(cdrom | disk)` (default=`disk`);;
+
+The drive's media type.
+
+`model`=`<model>` ;;
+
+The drive's reported model name, url-encoded, up to 40 bytes long.
+
+`rerror`=`(ignore | report | stop)` ;;
+
+Read error action.
+
+`secs`=`integer` ;;
+
+Force the drive's physical geometry to have a specific sector count.
+
+`serial`=`<serial>` ;;
+
+The drive's reported serial number, url-encoded, up to 20 bytes long.
+
+`size`=`<DiskSize>` ;;
+
+Disk size. This is purely informational and has no effect.
+
+`snapshot`=`boolean` ;;
+
+Whether the drive should be included when making snapshots.
+
+`trans`=`(auto | lba | none)` ;;
+
+Force disk geometry bios translation mode.
+
+`werror`=`(enospc | ignore | report | stop)` ;;
+
+Write error action.
+
`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`)::
-Keybord layout for vnc server. Default is read from the datacenter
-configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
`kvm`: `boolean` (default=`1`)::
`localtime`: `boolean` ::
-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
+Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
`lock`: `(backup | migrate | rollback | snapshot)` ::
`memory`: `integer (16 - N)` (default=`512`)::
-Amount of RAM for the VM in MB. This is the maximum available memory when
-you use the balloon device.
+Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
`migrate_downtime`: `number (0 - N)` (default=`0.1`)::
`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>]` ::
Specify network devices.
+
+`bridge`=`<bridge>` ;;
+
+Bridge to attach the network device to. The Proxmox VE standard bridge
+is called 'vmbr0'.
+
-MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
-i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
-+
-XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
-automatically generated if not specified.
-+
-The bridge parameter can be used to automatically add the interface to a
-bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
-+
-Option 'rate' is used to limit traffic bandwidth from and to this
-interface. It is specified as floating point number, unit is 'Megabytes per
-second'.
-+
-If you specify no bridge, we create a kvm 'user' (NATed) network device,
-which provides DHCP and DNS services. The following addresses are used:
+If you do not specify a bridge, we create a kvm user (NATed) network
+device, which provides DHCP and DNS services. The following addresses
+are used:
+
-10.0.2.2 Gateway
-10.0.2.3 DNS Server
-10.0.2.4 SMB Server
+ 10.0.2.2 Gateway
+ 10.0.2.3 DNS Server
+ 10.0.2.4 SMB Server
+
The DHCP server assign addresses to the guest starting from 10.0.2.15.
+`firewall`=`boolean` ;;
+
+Whether this interface should be protected by the firewall.
+
+`link_down`=`boolean` ;;
+
+Whether this interface should be disconnected (like pulling the plug).
+
+`macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
+
+MAC address. That address must be unique withing your network. This is automatically generated if not specified.
+
+`model`=`<model>` ;;
+
+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'.
+
+`queues`=`integer (0 - 16)` ;;
+
+Number of packet queues to be used on the device.
+
+`rate`=`number (0 - N)` ;;
+
+Rate limit in mbps (megabytes per second) as floating point number.
+
+`tag`=`integer (1 - 4094)` ;;
+
+VLAN tag to apply to packets on this interface.
+
+`trunks`=`<vlanid[;vlanid...]>` ;;
+
+VLAN trunks to pass through this interface.
+
`numa`: `boolean` (default=`0`)::
Enable/disable NUMA.
`numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
-numa topology
+NUMA topology.
+
+`cpus`=`<id[-id];...>` ;;
+
+CPUs accessing this NUMA node.
+
+`hostnodes`=`<id[-id];...>` ;;
+
+Host NUMA nodes to use.
+
+`memory`=`number` ;;
+
+Amount of memory this NUMA node provides.
+
+`policy`=`(bind | interleave | preferred)` ;;
+
+NUMA allocation policy.
`onboot`: `boolean` (default=`0`)::
`ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
-Used to enable special optimization/features for specific
-operating systems:
-+
-other => unspecified OS
-wxp => Microsoft Windows XP
-w2k => Microsoft Windows 2000
-w2k3 => Microsoft Windows 2003
-w2k8 => Microsoft Windows 2008
-wvista => Microsoft Windows Vista
-win7 => Microsoft Windows 7
-win8 => Microsoft Windows 8/2012
-l24 => Linux 2.4 Kernel
-l26 => Linux 2.6/3.X Kernel
-solaris => solaris/opensolaris/openindiania kernel
+Specify guest operating system. This is used to enable special
+optimization/features for specific operating systems:
+
-other|l24|l26|solaris ... no special behaviour
-wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch
+[horizontal]
+other;; unspecified OS
+wxp;; Microsoft Windows XP
+w2k;; Microsoft Windows 2000
+w2k3;; Microsoft Windows 2003
+w2k8;; Microsoft Windows 2008
+wvista;; Microsoft Windows Vista
+win7;; Microsoft Windows 7
+win8;; Microsoft Windows 8/2012
+l24;; Linux 2.4 Kernel
+l26;; Linux 2.6/3.X Kernel
+solaris;; Solaris/OpenSolaris/OpenIndiania kernel
`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
Map host parallel devices (n is 0 to 2).
+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
+NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
+
-Experimental: user reported problems with this option.
+CAUTION: Experimental! User reported problems with this option.
`protection`: `boolean` (default=`0`)::
-Sets the protection flag of the VM. This will prevent the remove operation.
+Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
`reboot`: `boolean` (default=`1`)::
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
+`aio`=`(native | threads)` ;;
+
+AIO type to use.
+
+`backup`=`boolean` ;;
+
+Whether the drive should be included when making backups.
+
+`bps`=`<bps>` ;;
+
+Maximum r/w speed speed in bytes per second.
+
+`bps_rd`=`<bps>` ;;
+
+Maximum read speed speed in bytes per second.
+
+`bps_wr`=`<bps>` ;;
+
+Maximum write speed speed in bytes per second.
+
+`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
+
+The drive's cache mode
+
+`cyls`=`integer` ;;
+
+Force the drive's physical geometry to have a specific cylinder count.
+
+`detect_zeroes`=`boolean` ;;
+
+Controls whether to detect and try to optimize writes of zeroes.
+
+`discard`=`(ignore | on)` ;;
+
+Controls whether to pass discard/trim requests to the underlying storage.
+
+`file`=`<volume>` ;;
+
+The drive's backing volume.
+
+`format`=`<image format>` ;;
+
+The drive's backing file's data format.
+
+`heads`=`integer` ;;
+
+Force the drive's physical geometry to have a specific head count.
+
+`iops`=`<iops>` ;;
+
+Maximum r/w I/O speed in operations per second.
+
+`iops_max`=`<iops>` ;;
+
+Maximum unthrottled r/w I/O pool speed in operations per second.
+
+`iops_rd`=`<iops>` ;;
+
+Maximum read I/O speed in operations per second.
+
+`iops_rd_max`=`<iops>` ;;
+
+Maximum unthrottled read I/O pool speed in operations per second.
+
+`iops_wr`=`<iops>` ;;
+
+Maximum write I/O speed in operations per second.
+
+`iops_wr_max`=`<iops>` ;;
+
+Maximum unthrottled write I/O pool speed in operations per second.
+
+`mbps`=`<mbps>` ;;
+
+Maximum r/w speed speed in megabytes per second.
+
+`mbps_max`=`<mbps>` ;;
+
+Maximum unthrottled r/w pool speed in megabytes per second.
+
+`mbps_rd`=`<mbps>` ;;
+
+Maximum read speed speed in megabytes per second.
+
+`mbps_rd_max`=`<mbps>` ;;
+
+Maximum unthrottled read pool speed in megabytes per second.
+
+`mbps_wr`=`<mbps>` ;;
+
+Maximum write speed speed in megabytes per second.
+
+`mbps_wr_max`=`<mbps>` ;;
+
+Maximum unthrottled write pool speed in megabytes per second.
+
+`media`=`(cdrom | disk)` (default=`disk`);;
+
+The drive's media type.
+
+`rerror`=`(ignore | report | stop)` ;;
+
+Read error action.
+
+`secs`=`integer` ;;
+
+Force the drive's physical geometry to have a specific sector count.
+
+`serial`=`<serial>` ;;
+
+The drive's reported serial number, url-encoded, up to 20 bytes long.
+
+`size`=`<DiskSize>` ;;
+
+Disk size. This is purely informational and has no effect.
+
+`snapshot`=`boolean` ;;
+
+Whether the drive should be included when making snapshots.
+
+`trans`=`(auto | lba | none)` ;;
+
+Force disk geometry bios translation mode.
+
+`werror`=`(enospc | ignore | report | stop)` ;;
+
+Write error action.
+
`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>]` ::
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
+`aio`=`(native | threads)` ;;
+
+AIO type to use.
+
+`backup`=`boolean` ;;
+
+Whether the drive should be included when making backups.
+
+`bps`=`<bps>` ;;
+
+Maximum r/w speed speed in bytes per second.
+
+`bps_rd`=`<bps>` ;;
+
+Maximum read speed speed in bytes per second.
+
+`bps_wr`=`<bps>` ;;
+
+Maximum write speed speed in bytes per second.
+
+`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
+
+The drive's cache mode
+
+`cyls`=`integer` ;;
+
+Force the drive's physical geometry to have a specific cylinder count.
+
+`detect_zeroes`=`boolean` ;;
+
+Controls whether to detect and try to optimize writes of zeroes.
+
+`discard`=`(ignore | on)` ;;
+
+Controls whether to pass discard/trim requests to the underlying storage.
+
+`file`=`<volume>` ;;
+
+The drive's backing volume.
+
+`format`=`<image format>` ;;
+
+The drive's backing file's data format.
+
+`heads`=`integer` ;;
+
+Force the drive's physical geometry to have a specific head count.
+
+`iops`=`<iops>` ;;
+
+Maximum r/w I/O speed in operations per second.
+
+`iops_max`=`<iops>` ;;
+
+Maximum unthrottled r/w I/O pool speed in operations per second.
+
+`iops_rd`=`<iops>` ;;
+
+Maximum read I/O speed in operations per second.
+
+`iops_rd_max`=`<iops>` ;;
+
+Maximum unthrottled read I/O pool speed in operations per second.
+
+`iops_wr`=`<iops>` ;;
+
+Maximum write I/O speed in operations per second.
+
+`iops_wr_max`=`<iops>` ;;
+
+Maximum unthrottled write I/O pool speed in operations per second.
+
+`iothread`=`boolean` ;;
+
+Whether to use iothreads for this drive
+
+`mbps`=`<mbps>` ;;
+
+Maximum r/w speed speed in megabytes per second.
+
+`mbps_max`=`<mbps>` ;;
+
+Maximum unthrottled r/w pool speed in megabytes per second.
+
+`mbps_rd`=`<mbps>` ;;
+
+Maximum read speed speed in megabytes per second.
+
+`mbps_rd_max`=`<mbps>` ;;
+
+Maximum unthrottled read pool speed in megabytes per second.
+
+`mbps_wr`=`<mbps>` ;;
+
+Maximum write speed speed in megabytes per second.
+
+`mbps_wr_max`=`<mbps>` ;;
+
+Maximum unthrottled write pool speed in megabytes per second.
+
+`media`=`(cdrom | disk)` (default=`disk`);;
+
+The drive's media type.
+
+`queues`=`integer (2 - N)` ;;
+
+Number of queues.
+
+`secs`=`integer` ;;
+
+Force the drive's physical geometry to have a specific sector count.
+
+`serial`=`<serial>` ;;
+
+The drive's reported serial number, url-encoded, up to 20 bytes long.
+
+`size`=`<DiskSize>` ;;
+
+Disk size. This is purely informational and has no effect.
+
+`snapshot`=`boolean` ;;
+
+Whether the drive should be included when making snapshots.
+
+`trans`=`(auto | lba | none)` ;;
+
+Force disk geometry bios translation mode.
+
+`werror`=`(enospc | ignore | report | stop)` ;;
+
+Write error action.
+
`scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
-scsi controller model
+SCSI controller model
`serial[n]`: `(/dev/.+|socket)` ::
-Create a serial device inside the VM (n is 0 to 3), and pass through a host
-serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
-(use 'qm terminal' to open a terminal connection).
+
-NOTE: If you pass through a host serial device, it is no longer possible to
-migrate such machines - use with special care.
+Create a serial device inside the VM (n is 0 to 3), and pass through a
+host serial device (i.e. /dev/ttyS0), or create a unix socket on the
+host side (use 'qm terminal' to open a terminal connection).
++
+NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
+
-Experimental: user reported problems with this option.
+CAUTION: Experimental! User reported problems with this option.
`shares`: `integer (0 - 50000)` (default=`1000`)::
-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
+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
`smbios1`: `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
Specify SMBIOS type 1 fields.
+`family`=`<string>` ;;
+
+Set SMBIOS1 family string.
+
+`manufacturer`=`<string>` ;;
+
+Set SMBIOS1 manufacturer.
+
+`product`=`<string>` ;;
+
+Set SMBIOS1 product ID.
+
+`serial`=`<string>` ;;
+
+Set SMBIOS1 serial number.
+
+`sku`=`<string>` ;;
+
+Set SMBIOS1 SKU string.
+
+`uuid`=`<UUID>` ;;
+
+Set SMBIOS1 UUID.
+
+`version`=`<string>` ;;
+
+Set SMBIOS1 version.
+
`smp`: `integer (1 - N)` (default=`1`)::
The number of CPUs. Please use option -sockets instead.
`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
-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'.
+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'.
`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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.
`tablet`: `boolean` (default=`1`)::
-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).
+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).
`tdf`: `boolean` (default=`0`)::
`unused[n]`: `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
`usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
-Configure an USB device (n is 0 to 4). This can be used to
-pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
+Configure an USB device (n is 0 to 4).
+
+`host`=`<HOSTUSBDEVICE|spice>` ;;
+
+The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:
+
-'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers) or
-'spice'
+ 'bus-port(.port)*' (decimal numbers) or
+ 'vendor_id:product_id' (hexadeciaml numbers) or
+ 'spice'
+
You can use the 'lsusb -t' command to list existing usb devices.
+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
+NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
+
The value 'spice' can be used to add a usb redirection devices for spice.
-+
-The 'usb3' option determines whether the device is a USB3 device or not
-(this does currently not work reliably with spice redirection and is then
-ignored).
+
+`usb3`=`boolean` (default=`0`);;
+
+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).
`vcpus`: `integer (1 - N)` (default=`0`)::
`vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-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.
+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.
`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>]` ::
Use volume as VIRTIO hard disk (n is 0 to 15).
+`aio`=`(native | threads)` ;;
+
+AIO type to use.
+
+`backup`=`boolean` ;;
+
+Whether the drive should be included when making backups.
+
+`bps`=`<bps>` ;;
+
+Maximum r/w speed speed in bytes per second.
+
+`bps_rd`=`<bps>` ;;
+
+Maximum read speed speed in bytes per second.
+
+`bps_wr`=`<bps>` ;;
+
+Maximum write speed speed in bytes per second.
+
+`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
+
+The drive's cache mode
+
+`cyls`=`integer` ;;
+
+Force the drive's physical geometry to have a specific cylinder count.
+
+`detect_zeroes`=`boolean` ;;
+
+Controls whether to detect and try to optimize writes of zeroes.
+
+`discard`=`(ignore | on)` ;;
+
+Controls whether to pass discard/trim requests to the underlying storage.
+
+`file`=`<volume>` ;;
+
+The drive's backing volume.
+
+`format`=`<image format>` ;;
+
+The drive's backing file's data format.
+
+`heads`=`integer` ;;
+
+Force the drive's physical geometry to have a specific head count.
+
+`iops`=`<iops>` ;;
+
+Maximum r/w I/O speed in operations per second.
+
+`iops_max`=`<iops>` ;;
+
+Maximum unthrottled r/w I/O pool speed in operations per second.
+
+`iops_rd`=`<iops>` ;;
+
+Maximum read I/O speed in operations per second.
+
+`iops_rd_max`=`<iops>` ;;
+
+Maximum unthrottled read I/O pool speed in operations per second.
+
+`iops_wr`=`<iops>` ;;
+
+Maximum write I/O speed in operations per second.
+
+`iops_wr_max`=`<iops>` ;;
+
+Maximum unthrottled write I/O pool speed in operations per second.
+
+`iothread`=`boolean` ;;
+
+Whether to use iothreads for this drive
+
+`mbps`=`<mbps>` ;;
+
+Maximum r/w speed speed in megabytes per second.
+
+`mbps_max`=`<mbps>` ;;
+
+Maximum unthrottled r/w pool speed in megabytes per second.
+
+`mbps_rd`=`<mbps>` ;;
+
+Maximum read speed speed in megabytes per second.
+
+`mbps_rd_max`=`<mbps>` ;;
+
+Maximum unthrottled read pool speed in megabytes per second.
+
+`mbps_wr`=`<mbps>` ;;
+
+Maximum write speed speed in megabytes per second.
+
+`mbps_wr_max`=`<mbps>` ;;
+
+Maximum unthrottled write pool speed in megabytes per second.
+
+`media`=`(cdrom | disk)` (default=`disk`);;
+
+The drive's media type.
+
+`rerror`=`(ignore | report | stop)` ;;
+
+Read error action.
+
+`secs`=`integer` ;;
+
+Force the drive's physical geometry to have a specific sector count.
+
+`serial`=`<serial>` ;;
+
+The drive's reported serial number, url-encoded, up to 20 bytes long.
+
+`size`=`<DiskSize>` ;;
+
+Disk size. This is purely informational and has no effect.
+
+`snapshot`=`boolean` ;;
+
+Whether the drive should be included when making snapshots.
+
+`trans`=`(auto | lba | none)` ;;
+
+Force disk geometry bios translation mode.
+
+`werror`=`(enospc | ignore | report | stop)` ;;
+
+Write error action.
+
`watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
-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)
+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)
+
+`action`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
+
+The action to perform if after activation the guest fails to poll the watchdog in time.
+
+`model`=`(i6300esb | ib700)` (default=`i6300esb`);;
+
+Watchdog type to emulate.
projects / pve-docs.git / blobdiff