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