]>
Commit | Line | Data |
---|---|---|
1f554f76 DM |
1 | *qm* `<COMMAND> [ARGS] [OPTIONS]` |
2 | ||
3 | *qm clone* `<vmid> <newid>` `[OPTIONS]` | |
4 | ||
5 | Create a copy of virtual machine/template. | |
6 | ||
7 | `<vmid>` `integer (1 - N)` :: | |
8 | ||
9 | The (unique) ID of the VM. | |
10 | ||
11 | `<newid>` `integer (1 - N)` :: | |
12 | ||
13 | VMID for the clone. | |
14 | ||
15 | `-description` `string` :: | |
16 | ||
17 | Description for the new VM. | |
18 | ||
19 | `-format` `(qcow2 | raw | vmdk)` :: | |
20 | ||
21 | Target format for file storage. | |
22 | + | |
23 | NOTE: Requires option(s): `full` | |
24 | ||
25 | `-full` `boolean` (default=`0`):: | |
26 | ||
27 | Create a full copy of all disk. This is always done when you clone a normal | |
28 | VM. For VM templates, we try to create a linked clone by default. | |
29 | ||
30 | `-name` `string` :: | |
31 | ||
32 | Set a name for the new VM. | |
33 | ||
34 | `-pool` `string` :: | |
35 | ||
36 | Add the new VM to the specified pool. | |
37 | ||
38 | `-snapname` `string` :: | |
39 | ||
40 | The name of the snapshot. | |
41 | ||
42 | `-storage` `string` :: | |
43 | ||
44 | Target storage for full clone. | |
45 | + | |
46 | NOTE: Requires option(s): `full` | |
47 | ||
48 | `-target` `string` :: | |
49 | ||
50 | Target node. Only allowed if the original VM is on shared storage. | |
51 | ||
52 | ||
53 | ||
54 | *qm config* `<vmid>` `[OPTIONS]` | |
55 | ||
56 | Get current virtual machine configuration. This does not include pending | |
57 | configuration changes (see 'pending' API). | |
58 | ||
59 | `<vmid>` `integer (1 - N)` :: | |
60 | ||
61 | The (unique) ID of the VM. | |
62 | ||
63 | `-current` `boolean` (default=`0`):: | |
64 | ||
65 | Get current values (instead of pending values). | |
66 | ||
67 | ||
68 | ||
69 | *qm create* `<vmid>` `[OPTIONS]` | |
70 | ||
71 | Create or restore a virtual machine. | |
72 | ||
73 | `<vmid>` `integer (1 - N)` :: | |
74 | ||
75 | The (unique) ID of the VM. | |
76 | ||
77 | `-acpi` `boolean` (default=`1`):: | |
78 | ||
79 | Enable/disable ACPI. | |
80 | ||
81 | `-agent` `boolean` (default=`0`):: | |
82 | ||
83 | Enable/disable Qemu GuestAgent. | |
84 | ||
85 | `-archive` `string` :: | |
86 | ||
87 | The backup file. | |
88 | ||
89 | `-args` `string` :: | |
90 | ||
9b3e4991 | 91 | NOTE: this option is for experts only. It allows you to pass arbitrary |
1f554f76 | 92 | arguments to kvm, for example: |
9b3e4991 | 93 | + |
1f554f76 DM |
94 | args: -no-reboot -no-hpet |
95 | ||
96 | `-autostart` `boolean` (default=`0`):: | |
97 | ||
98 | Automatic restart after crash (currently ignored). | |
99 | ||
100 | `-balloon` `integer (0 - N)` :: | |
101 | ||
102 | Amount of target RAM for the VM in MB. Using zero disables the ballon | |
103 | driver. | |
104 | ||
105 | `-bios` `(ovmf | seabios)` (default=`seabios`):: | |
106 | ||
107 | Select BIOS implementation. | |
108 | ||
109 | `-boot` `[acdn]{1,4}` (default=`cdn`):: | |
110 | ||
111 | Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). | |
112 | ||
113 | `-bootdisk` `(ide|sata|scsi|virtio)\d+` :: | |
114 | ||
115 | Enable booting from specified disk. | |
116 | ||
117 | `-cdrom` `volume` :: | |
118 | ||
119 | This is an alias for option -ide2 | |
120 | ||
121 | `-cores` `integer (1 - N)` (default=`1`):: | |
122 | ||
123 | The number of cores per socket. | |
124 | ||
9b3e4991 | 125 | `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` :: |
1f554f76 DM |
126 | |
127 | Emulated CPU type. | |
128 | ||
129 | `-cpulimit` `number (0 - 128)` (default=`0`):: | |
130 | ||
9b3e4991 DM |
131 | Limit of CPU usage. |
132 | + | |
133 | NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' | |
134 | indicates no CPU limit. | |
1f554f76 DM |
135 | |
136 | `-cpuunits` `integer (0 - 500000)` (default=`1000`):: | |
137 | ||
138 | CPU weight for a VM. Argument is used in the kernel fair scheduler. The | |
139 | larger the number is, the more CPU time this VM gets. Number is relative to | |
140 | weights of all the other running VMs. | |
9b3e4991 | 141 | + |
1f554f76 DM |
142 | NOTE: You can disable fair-scheduler configuration by setting this to 0. |
143 | ||
144 | `-description` `string` :: | |
145 | ||
146 | Description for the VM. Only used on the configuration web interface. This | |
147 | is saved as comment inside the configuration file. | |
148 | ||
149 | `-force` `boolean` :: | |
150 | ||
151 | Allow to overwrite existing VM. | |
152 | + | |
153 | NOTE: Requires option(s): `archive` | |
154 | ||
155 | `-freeze` `boolean` :: | |
156 | ||
157 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
158 | ||
9b3e4991 | 159 | `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: |
1f554f76 DM |
160 | |
161 | Map host pci devices. HOSTPCIDEVICE syntax is: | |
9b3e4991 | 162 | + |
1f554f76 | 163 | 'bus:dev.func' (hexadecimal numbers) |
9b3e4991 | 164 | + |
1f554f76 | 165 | You can us the 'lspci' command to list existing pci devices. |
9b3e4991 | 166 | + |
1f554f76 DM |
167 | The 'rombar' option determines whether or not the device's ROM will be |
168 | visible in the guest's memory map (default is 'on'). | |
9b3e4991 DM |
169 | + |
170 | NOTE: This option allows direct access to host hardware. So it is no longer | |
1f554f76 | 171 | possible to migrate such machines - use with special care. |
9b3e4991 | 172 | + |
1f554f76 DM |
173 | Experimental: user reported problems with this option. |
174 | ||
175 | `-hotplug` `string` (default=`network,disk,usb`):: | |
176 | ||
177 | Selectively enable hotplug features. This is a comma separated list of | |
178 | hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to | |
179 | disable hotplug completely. Value '1' is an alias for the default | |
180 | 'network,disk,usb'. | |
181 | ||
9b3e4991 | 182 | `-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>]` :: |
1f554f76 DM |
183 | |
184 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). | |
185 | ||
186 | `-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`):: | |
187 | ||
188 | Keybord layout for vnc server. Default is read from the datacenter | |
189 | configuration file. | |
190 | ||
191 | `-kvm` `boolean` (default=`1`):: | |
192 | ||
193 | Enable/disable KVM hardware virtualization. | |
194 | ||
195 | `-localtime` `boolean` :: | |
196 | ||
197 | Set the real time clock to local time. This is enabled by default if ostype | |
198 | indicates a Microsoft OS. | |
199 | ||
200 | `-lock` `(backup | migrate | rollback | snapshot)` :: | |
201 | ||
202 | Lock/unlock the VM. | |
203 | ||
204 | `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: | |
205 | ||
206 | Specific the Qemu machine type. | |
207 | ||
208 | `-memory` `integer (16 - N)` (default=`512`):: | |
209 | ||
210 | Amount of RAM for the VM in MB. This is the maximum available memory when | |
211 | you use the balloon device. | |
212 | ||
213 | `-migrate_downtime` `number (0 - N)` (default=`0.1`):: | |
214 | ||
215 | Set maximum tolerated downtime (in seconds) for migrations. | |
216 | ||
217 | `-migrate_speed` `integer (0 - N)` (default=`0`):: | |
218 | ||
219 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
220 | ||
221 | `-name` `string` :: | |
222 | ||
223 | Set a name for the VM. Only used on the configuration web interface. | |
224 | ||
9b3e4991 | 225 | `-net[n]` `string` :: |
1f554f76 DM |
226 | |
227 | Specify network devices. | |
9b3e4991 | 228 | + |
1f554f76 DM |
229 | MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 |
230 | i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 | |
9b3e4991 | 231 | + |
1f554f76 DM |
232 | XX:XX:XX:XX:XX:XX should be an unique MAC address. This is |
233 | automatically generated if not specified. | |
9b3e4991 | 234 | + |
1f554f76 DM |
235 | The bridge parameter can be used to automatically add the interface to a |
236 | bridge device. The Proxmox VE standard bridge is called 'vmbr0'. | |
9b3e4991 | 237 | + |
1f554f76 DM |
238 | Option 'rate' is used to limit traffic bandwidth from and to this |
239 | interface. It is specified as floating point number, unit is 'Megabytes per | |
240 | second'. | |
9b3e4991 | 241 | + |
1f554f76 DM |
242 | If you specify no bridge, we create a kvm 'user' (NATed) network device, |
243 | which provides DHCP and DNS services. The following addresses are used: | |
9b3e4991 | 244 | + |
1f554f76 DM |
245 | 10.0.2.2 Gateway |
246 | 10.0.2.3 DNS Server | |
247 | 10.0.2.4 SMB Server | |
9b3e4991 | 248 | + |
1f554f76 DM |
249 | The DHCP server assign addresses to the guest starting from 10.0.2.15. |
250 | ||
1f554f76 DM |
251 | `-numa` `boolean` (default=`0`):: |
252 | ||
9b3e4991 | 253 | Enable/disable NUMA. |
1f554f76 | 254 | |
9b3e4991 | 255 | `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` :: |
1f554f76 DM |
256 | |
257 | numa topology | |
258 | ||
259 | `-onboot` `boolean` (default=`0`):: | |
260 | ||
261 | Specifies whether a VM will be started during system bootup. | |
262 | ||
263 | `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: | |
264 | ||
265 | Used to enable special optimization/features for specific | |
266 | operating systems: | |
9b3e4991 | 267 | + |
1f554f76 DM |
268 | other => unspecified OS |
269 | wxp => Microsoft Windows XP | |
270 | w2k => Microsoft Windows 2000 | |
271 | w2k3 => Microsoft Windows 2003 | |
272 | w2k8 => Microsoft Windows 2008 | |
273 | wvista => Microsoft Windows Vista | |
274 | win7 => Microsoft Windows 7 | |
275 | win8 => Microsoft Windows 8/2012 | |
276 | l24 => Linux 2.4 Kernel | |
277 | l26 => Linux 2.6/3.X Kernel | |
278 | solaris => solaris/opensolaris/openindiania kernel | |
9b3e4991 | 279 | + |
1f554f76 DM |
280 | other|l24|l26|solaris ... no special behaviour |
281 | wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch | |
282 | ||
283 | `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: | |
284 | ||
285 | Map host parallel devices (n is 0 to 2). | |
9b3e4991 DM |
286 | + |
287 | NOTE: This option allows direct access to host hardware. So it is no longer | |
1f554f76 | 288 | possible to migrate such machines - use with special care. |
9b3e4991 | 289 | + |
1f554f76 DM |
290 | Experimental: user reported problems with this option. |
291 | ||
292 | `-pool` `string` :: | |
293 | ||
294 | Add the VM to the specified pool. | |
295 | ||
296 | `-protection` `boolean` (default=`0`):: | |
297 | ||
298 | Sets the protection flag of the VM. This will prevent the remove operation. | |
299 | ||
300 | `-reboot` `boolean` (default=`1`):: | |
301 | ||
302 | Allow reboot. If set to '0' the VM exit on reboot. | |
303 | ||
9b3e4991 | 304 | `-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>]` :: |
1f554f76 DM |
305 | |
306 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). | |
307 | ||
9b3e4991 | 308 | `-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>]` :: |
1f554f76 DM |
309 | |
310 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). | |
311 | ||
312 | `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: | |
313 | ||
314 | scsi controller model | |
315 | ||
316 | `-serial[n]` `(/dev/.+|socket)` :: | |
317 | ||
318 | Create a serial device inside the VM (n is 0 to 3), and pass through a host | |
319 | serial device (i.e. /dev/ttyS0), or create a unix socket on the host side | |
320 | (use 'qm terminal' to open a terminal connection). | |
9b3e4991 DM |
321 | + |
322 | NOTE: If you pass through a host serial device, it is no longer possible to | |
1f554f76 | 323 | migrate such machines - use with special care. |
9b3e4991 | 324 | + |
1f554f76 DM |
325 | Experimental: user reported problems with this option. |
326 | ||
327 | `-shares` `integer (0 - 50000)` (default=`1000`):: | |
328 | ||
329 | Amount of memory shares for auto-ballooning. The larger the number is, the | |
330 | more memory this VM gets. Number is relative to weights of all other | |
331 | running VMs. Using zero disables auto-ballooning | |
332 | ||
9b3e4991 | 333 | `-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` :: |
1f554f76 DM |
334 | |
335 | Specify SMBIOS type 1 fields. | |
336 | ||
337 | `-smp` `integer (1 - N)` (default=`1`):: | |
338 | ||
339 | The number of CPUs. Please use option -sockets instead. | |
340 | ||
341 | `-sockets` `integer (1 - N)` (default=`1`):: | |
342 | ||
343 | The number of CPU sockets. | |
344 | ||
345 | `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: | |
346 | ||
347 | Set the initial date of the real time clock. Valid format for date are: | |
348 | 'now' or '2006-06-17T16:01:21' or '2006-06-17'. | |
349 | ||
350 | `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
351 | ||
352 | Startup and shutdown behavior. Order is a non-negative number defining the | |
353 | general startup order. Shutdown in done with reverse ordering. Additionally | |
354 | you can set the 'up' or 'down' delay in seconds, which specifies a delay to | |
355 | wait before the next VM is started or stopped. | |
356 | ||
357 | `-storage` `string` :: | |
358 | ||
359 | Default storage. | |
360 | ||
361 | `-tablet` `boolean` (default=`1`):: | |
362 | ||
9b3e4991 | 363 | Enable/disable the USB tablet device. This device is usually needed to |
1f554f76 DM |
364 | allow absolute mouse positioning with VNC. Else the mouse runs out of sync |
365 | with normal VNC clients. If you're running lots of console-only guests on | |
366 | one host, you may consider disabling this to save some context switches. | |
9b3e4991 | 367 | This is turned off by default if you use spice (-vga=qxl). |
1f554f76 DM |
368 | |
369 | `-tdf` `boolean` (default=`0`):: | |
370 | ||
371 | Enable/disable time drift fix. | |
372 | ||
373 | `-template` `boolean` (default=`0`):: | |
374 | ||
375 | Enable/disable Template. | |
376 | ||
377 | `-unique` `boolean` :: | |
378 | ||
379 | Assign a unique random ethernet address. | |
380 | + | |
381 | NOTE: Requires option(s): `archive` | |
382 | ||
383 | `-unused[n]` `string` :: | |
384 | ||
385 | Reference to unused volumes. | |
386 | ||
9b3e4991 | 387 | `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` :: |
1f554f76 DM |
388 | |
389 | Configure an USB device (n is 0 to 4). This can be used to | |
390 | pass-through usb devices to the guest. HOSTUSBDEVICE syntax is: | |
9b3e4991 | 391 | + |
1f554f76 | 392 | 'bus-port(.port)*' (decimal numbers) or |
9b3e4991 DM |
393 | 'vendor_id:product_id' (hexadeciaml numbers) or |
394 | 'spice' | |
395 | + | |
1f554f76 | 396 | You can use the 'lsusb -t' command to list existing usb devices. |
9b3e4991 DM |
397 | + |
398 | NOTE: This option allows direct access to host hardware. So it is no longer | |
1f554f76 | 399 | possible to migrate such machines - use with special care. |
9b3e4991 | 400 | + |
1f554f76 | 401 | The value 'spice' can be used to add a usb redirection devices for spice. |
9b3e4991 DM |
402 | + |
403 | The 'usb3' option determines whether the device is a USB3 device or not | |
404 | (this does currently not work reliably with spice redirection and is then | |
405 | ignored). | |
1f554f76 DM |
406 | |
407 | `-vcpus` `integer (1 - N)` (default=`0`):: | |
408 | ||
409 | Number of hotplugged vcpus. | |
410 | ||
411 | `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: | |
412 | ||
9b3e4991 DM |
413 | Select the VGA type. If you want to use high resolution modes (>= |
414 | 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is | |
415 | 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option | |
416 | enables the SPICE display sever. For win* OS you can select how many | |
417 | independent displays you want, Linux guests can add displays them self. You | |
418 | can also run without any graphic card, using a serial device as terminal. | |
1f554f76 | 419 | |
9b3e4991 | 420 | `-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>]` :: |
1f554f76 DM |
421 | |
422 | Use volume as VIRTIO hard disk (n is 0 to 15). | |
423 | ||
9b3e4991 | 424 | `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` :: |
1f554f76 | 425 | |
9b3e4991 | 426 | Create a virtual hardware watchdog device. Once enabled (by a guest |
1f554f76 | 427 | action), the watchdog must be periodically polled by an agent inside the |
9b3e4991 DM |
428 | guest or else the watchdog will reset the guest (or execute the respective |
429 | action specified) | |
1f554f76 DM |
430 | |
431 | ||
432 | ||
433 | *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]` | |
434 | ||
435 | Delete a VM snapshot. | |
436 | ||
437 | `<vmid>` `integer (1 - N)` :: | |
438 | ||
439 | The (unique) ID of the VM. | |
440 | ||
441 | `<snapname>` `string` :: | |
442 | ||
443 | The name of the snapshot. | |
444 | ||
445 | `-force` `boolean` :: | |
446 | ||
447 | For removal from config file, even if removing disk snapshots fails. | |
448 | ||
449 | ||
450 | ||
451 | *qm destroy* `<vmid>` `[OPTIONS]` | |
452 | ||
453 | Destroy the vm (also delete all used/owned volumes). | |
454 | ||
455 | `<vmid>` `integer (1 - N)` :: | |
456 | ||
457 | The (unique) ID of the VM. | |
458 | ||
459 | `-skiplock` `boolean` :: | |
460 | ||
461 | Ignore locks - only root is allowed to use this option. | |
462 | ||
463 | ||
464 | ||
465 | ||
466 | *qm help* `[<cmd>]` `[OPTIONS]` | |
467 | ||
468 | Get help about specified command. | |
469 | ||
470 | `<cmd>` `string` :: | |
471 | ||
472 | Command name | |
473 | ||
474 | `-verbose` `boolean` :: | |
475 | ||
476 | Verbose output format. | |
477 | ||
478 | ||
479 | ||
480 | ||
9b3e4991 | 481 | *qm list* `[OPTIONS]` |
1f554f76 DM |
482 | |
483 | Virtual machine index (per node). | |
484 | ||
9b3e4991 DM |
485 | `-full` `boolean` :: |
486 | ||
487 | Determine the full status of active VMs. | |
488 | ||
1f554f76 DM |
489 | |
490 | ||
491 | *qm migrate* `<vmid> <target>` `[OPTIONS]` | |
492 | ||
493 | Migrate virtual machine. Creates a new migration task. | |
494 | ||
495 | `<vmid>` `integer (1 - N)` :: | |
496 | ||
497 | The (unique) ID of the VM. | |
498 | ||
499 | `<target>` `string` :: | |
500 | ||
501 | Target node. | |
502 | ||
503 | `-force` `boolean` :: | |
504 | ||
505 | Allow to migrate VMs which use local devices. Only root may use this | |
506 | option. | |
507 | ||
508 | `-online` `boolean` :: | |
509 | ||
510 | Use online/live migration. | |
511 | ||
512 | ||
513 | ||
514 | ||
515 | *qm monitor* `<vmid>` | |
516 | ||
517 | Enter Qemu Monitor interface. | |
518 | ||
519 | `<vmid>` `integer (1 - N)` :: | |
520 | ||
521 | The (unique) ID of the VM. | |
522 | ||
523 | ||
524 | ||
525 | ||
526 | *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]` | |
527 | ||
528 | Move volume to different storage. | |
529 | ||
530 | `<vmid>` `integer (1 - N)` :: | |
531 | ||
532 | The (unique) ID of the VM. | |
533 | ||
534 | `<disk>` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: | |
535 | ||
536 | The disk you want to move. | |
537 | ||
538 | `<storage>` `string` :: | |
539 | ||
540 | Target storage. | |
541 | ||
542 | `-delete` `boolean` (default=`0`):: | |
543 | ||
544 | Delete the original disk after successful copy. By default the original | |
545 | disk is kept as unused disk. | |
546 | ||
547 | `-digest` `string` :: | |
548 | ||
549 | Prevent changes if current configuration file has different SHA1 digest. | |
550 | This can be used to prevent concurrent modifications. | |
551 | ||
552 | `-format` `(qcow2 | raw | vmdk)` :: | |
553 | ||
554 | Target Format. | |
555 | ||
556 | ||
557 | ||
558 | ||
559 | *qm mtunnel* | |
560 | ||
561 | Used by qmigrate - do not use manually. | |
562 | ||
563 | ||
564 | ||
565 | ||
566 | *qm pending* `<vmid>` | |
567 | ||
568 | Get virtual machine configuration, including pending changes. | |
569 | ||
570 | `<vmid>` `integer (1 - N)` :: | |
571 | ||
572 | The (unique) ID of the VM. | |
573 | ||
574 | ||
575 | ||
576 | ||
577 | *qm rescan* `[OPTIONS]` | |
578 | ||
579 | Rescan all storages and update disk sizes and unused disk images. | |
580 | ||
581 | `-vmid` `integer (1 - N)` :: | |
582 | ||
583 | The (unique) ID of the VM. | |
584 | ||
585 | ||
586 | ||
587 | ||
588 | *qm reset* `<vmid>` `[OPTIONS]` | |
589 | ||
590 | Reset virtual machine. | |
591 | ||
592 | `<vmid>` `integer (1 - N)` :: | |
593 | ||
594 | The (unique) ID of the VM. | |
595 | ||
596 | `-skiplock` `boolean` :: | |
597 | ||
598 | Ignore locks - only root is allowed to use this option. | |
599 | ||
600 | ||
601 | ||
602 | *qm resize* `<vmid> <disk> <size>` `[OPTIONS]` | |
603 | ||
604 | Extend volume size. | |
605 | ||
606 | `<vmid>` `integer (1 - N)` :: | |
607 | ||
608 | The (unique) ID of the VM. | |
609 | ||
610 | `<disk>` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: | |
611 | ||
612 | The disk you want to resize. | |
613 | ||
614 | `<size>` `\+?\d+(\.\d+)?[KMGT]?` :: | |
615 | ||
616 | The new size. With the '+' sign the value is added to the actual size of | |
617 | the volume and without it, the value is taken as an absolute one. Shrinking | |
618 | disk size is not supported. | |
619 | ||
620 | `-digest` `string` :: | |
621 | ||
622 | Prevent changes if current configuration file has different SHA1 digest. | |
623 | This can be used to prevent concurrent modifications. | |
624 | ||
625 | `-skiplock` `boolean` :: | |
626 | ||
627 | Ignore locks - only root is allowed to use this option. | |
628 | ||
629 | ||
630 | ||
631 | *qm resume* `<vmid>` `[OPTIONS]` | |
632 | ||
633 | Resume virtual machine. | |
634 | ||
635 | `<vmid>` `integer (1 - N)` :: | |
636 | ||
637 | The (unique) ID of the VM. | |
638 | ||
639 | `-nocheck` `boolean` :: | |
640 | ||
641 | no description available | |
642 | ||
643 | `-skiplock` `boolean` :: | |
644 | ||
645 | Ignore locks - only root is allowed to use this option. | |
646 | ||
647 | ||
648 | ||
649 | *qm rollback* `<vmid> <snapname>` | |
650 | ||
651 | Rollback VM state to specified snapshot. | |
652 | ||
653 | `<vmid>` `integer (1 - N)` :: | |
654 | ||
655 | The (unique) ID of the VM. | |
656 | ||
657 | `<snapname>` `string` :: | |
658 | ||
659 | The name of the snapshot. | |
660 | ||
661 | ||
662 | ||
663 | *qm sendkey* `<vmid> <key>` `[OPTIONS]` | |
664 | ||
665 | Send key event to virtual machine. | |
666 | ||
667 | `<vmid>` `integer (1 - N)` :: | |
668 | ||
669 | The (unique) ID of the VM. | |
670 | ||
671 | `<key>` `string` :: | |
672 | ||
673 | The key (qemu monitor encoding). | |
674 | ||
675 | `-skiplock` `boolean` :: | |
676 | ||
677 | Ignore locks - only root is allowed to use this option. | |
678 | ||
679 | ||
680 | ||
681 | *qm set* `<vmid>` `[OPTIONS]` | |
682 | ||
683 | Set virtual machine options (synchrounous API) - You should consider using | |
684 | the POST method instead for any actions involving hotplug or storage | |
685 | allocation. | |
686 | ||
687 | `<vmid>` `integer (1 - N)` :: | |
688 | ||
689 | The (unique) ID of the VM. | |
690 | ||
691 | `-acpi` `boolean` (default=`1`):: | |
692 | ||
693 | Enable/disable ACPI. | |
694 | ||
695 | `-agent` `boolean` (default=`0`):: | |
696 | ||
697 | Enable/disable Qemu GuestAgent. | |
698 | ||
699 | `-args` `string` :: | |
700 | ||
9b3e4991 | 701 | NOTE: this option is for experts only. It allows you to pass arbitrary |
1f554f76 | 702 | arguments to kvm, for example: |
9b3e4991 | 703 | + |
1f554f76 DM |
704 | args: -no-reboot -no-hpet |
705 | ||
706 | `-autostart` `boolean` (default=`0`):: | |
707 | ||
708 | Automatic restart after crash (currently ignored). | |
709 | ||
710 | `-balloon` `integer (0 - N)` :: | |
711 | ||
712 | Amount of target RAM for the VM in MB. Using zero disables the ballon | |
713 | driver. | |
714 | ||
715 | `-bios` `(ovmf | seabios)` (default=`seabios`):: | |
716 | ||
717 | Select BIOS implementation. | |
718 | ||
719 | `-boot` `[acdn]{1,4}` (default=`cdn`):: | |
720 | ||
721 | Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). | |
722 | ||
723 | `-bootdisk` `(ide|sata|scsi|virtio)\d+` :: | |
724 | ||
725 | Enable booting from specified disk. | |
726 | ||
727 | `-cdrom` `volume` :: | |
728 | ||
729 | This is an alias for option -ide2 | |
730 | ||
731 | `-cores` `integer (1 - N)` (default=`1`):: | |
732 | ||
733 | The number of cores per socket. | |
734 | ||
9b3e4991 | 735 | `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` :: |
1f554f76 DM |
736 | |
737 | Emulated CPU type. | |
738 | ||
739 | `-cpulimit` `number (0 - 128)` (default=`0`):: | |
740 | ||
9b3e4991 DM |
741 | Limit of CPU usage. |
742 | + | |
743 | NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' | |
744 | indicates no CPU limit. | |
1f554f76 DM |
745 | |
746 | `-cpuunits` `integer (0 - 500000)` (default=`1000`):: | |
747 | ||
748 | CPU weight for a VM. Argument is used in the kernel fair scheduler. The | |
749 | larger the number is, the more CPU time this VM gets. Number is relative to | |
750 | weights of all the other running VMs. | |
9b3e4991 | 751 | + |
1f554f76 DM |
752 | NOTE: You can disable fair-scheduler configuration by setting this to 0. |
753 | ||
754 | `-delete` `string` :: | |
755 | ||
756 | A list of settings you want to delete. | |
757 | ||
758 | `-description` `string` :: | |
759 | ||
760 | Description for the VM. Only used on the configuration web interface. This | |
761 | is saved as comment inside the configuration file. | |
762 | ||
763 | `-digest` `string` :: | |
764 | ||
765 | Prevent changes if current configuration file has different SHA1 digest. | |
766 | This can be used to prevent concurrent modifications. | |
767 | ||
768 | `-force` `boolean` :: | |
769 | ||
770 | Force physical removal. Without this, we simple remove the disk from the | |
771 | config file and create an additional configuration entry called | |
772 | 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause | |
773 | physical removal. | |
774 | + | |
775 | NOTE: Requires option(s): `delete` | |
776 | ||
777 | `-freeze` `boolean` :: | |
778 | ||
779 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
780 | ||
9b3e4991 | 781 | `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: |
1f554f76 DM |
782 | |
783 | Map host pci devices. HOSTPCIDEVICE syntax is: | |
9b3e4991 | 784 | + |
1f554f76 | 785 | 'bus:dev.func' (hexadecimal numbers) |
9b3e4991 | 786 | + |
1f554f76 | 787 | You can us the 'lspci' command to list existing pci devices. |
9b3e4991 | 788 | + |
1f554f76 DM |
789 | The 'rombar' option determines whether or not the device's ROM will be |
790 | visible in the guest's memory map (default is 'on'). | |
9b3e4991 DM |
791 | + |
792 | NOTE: This option allows direct access to host hardware. So it is no longer | |
1f554f76 | 793 | possible to migrate such machines - use with special care. |
9b3e4991 | 794 | + |
1f554f76 DM |
795 | Experimental: user reported problems with this option. |
796 | ||
797 | `-hotplug` `string` (default=`network,disk,usb`):: | |
798 | ||
799 | Selectively enable hotplug features. This is a comma separated list of | |
800 | hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to | |
801 | disable hotplug completely. Value '1' is an alias for the default | |
802 | 'network,disk,usb'. | |
803 | ||
9b3e4991 | 804 | `-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>]` :: |
1f554f76 DM |
805 | |
806 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). | |
807 | ||
808 | `-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`):: | |
809 | ||
810 | Keybord layout for vnc server. Default is read from the datacenter | |
811 | configuration file. | |
812 | ||
813 | `-kvm` `boolean` (default=`1`):: | |
814 | ||
815 | Enable/disable KVM hardware virtualization. | |
816 | ||
817 | `-localtime` `boolean` :: | |
818 | ||
819 | Set the real time clock to local time. This is enabled by default if ostype | |
820 | indicates a Microsoft OS. | |
821 | ||
822 | `-lock` `(backup | migrate | rollback | snapshot)` :: | |
823 | ||
824 | Lock/unlock the VM. | |
825 | ||
826 | `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: | |
827 | ||
828 | Specific the Qemu machine type. | |
829 | ||
830 | `-memory` `integer (16 - N)` (default=`512`):: | |
831 | ||
832 | Amount of RAM for the VM in MB. This is the maximum available memory when | |
833 | you use the balloon device. | |
834 | ||
835 | `-migrate_downtime` `number (0 - N)` (default=`0.1`):: | |
836 | ||
837 | Set maximum tolerated downtime (in seconds) for migrations. | |
838 | ||
839 | `-migrate_speed` `integer (0 - N)` (default=`0`):: | |
840 | ||
841 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
842 | ||
843 | `-name` `string` :: | |
844 | ||
845 | Set a name for the VM. Only used on the configuration web interface. | |
846 | ||
9b3e4991 | 847 | `-net[n]` `string` :: |
1f554f76 DM |
848 | |
849 | Specify network devices. | |
9b3e4991 | 850 | + |
1f554f76 DM |
851 | MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 |
852 | i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 | |
9b3e4991 | 853 | + |
1f554f76 DM |
854 | XX:XX:XX:XX:XX:XX should be an unique MAC address. This is |
855 | automatically generated if not specified. | |
9b3e4991 | 856 | + |
1f554f76 DM |
857 | The bridge parameter can be used to automatically add the interface to a |
858 | bridge device. The Proxmox VE standard bridge is called 'vmbr0'. | |
9b3e4991 | 859 | + |
1f554f76 DM |
860 | Option 'rate' is used to limit traffic bandwidth from and to this |
861 | interface. It is specified as floating point number, unit is 'Megabytes per | |
862 | second'. | |
9b3e4991 | 863 | + |
1f554f76 DM |
864 | If you specify no bridge, we create a kvm 'user' (NATed) network device, |
865 | which provides DHCP and DNS services. The following addresses are used: | |
9b3e4991 | 866 | + |
1f554f76 DM |
867 | 10.0.2.2 Gateway |
868 | 10.0.2.3 DNS Server | |
869 | 10.0.2.4 SMB Server | |
9b3e4991 | 870 | + |
1f554f76 DM |
871 | The DHCP server assign addresses to the guest starting from 10.0.2.15. |
872 | ||
1f554f76 DM |
873 | `-numa` `boolean` (default=`0`):: |
874 | ||
9b3e4991 | 875 | Enable/disable NUMA. |
1f554f76 | 876 | |
9b3e4991 | 877 | `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` :: |
1f554f76 DM |
878 | |
879 | numa topology | |
880 | ||
881 | `-onboot` `boolean` (default=`0`):: | |
882 | ||
883 | Specifies whether a VM will be started during system bootup. | |
884 | ||
885 | `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: | |
886 | ||
887 | Used to enable special optimization/features for specific | |
888 | operating systems: | |
9b3e4991 | 889 | + |
1f554f76 DM |
890 | other => unspecified OS |
891 | wxp => Microsoft Windows XP | |
892 | w2k => Microsoft Windows 2000 | |
893 | w2k3 => Microsoft Windows 2003 | |
894 | w2k8 => Microsoft Windows 2008 | |
895 | wvista => Microsoft Windows Vista | |
896 | win7 => Microsoft Windows 7 | |
897 | win8 => Microsoft Windows 8/2012 | |
898 | l24 => Linux 2.4 Kernel | |
899 | l26 => Linux 2.6/3.X Kernel | |
900 | solaris => solaris/opensolaris/openindiania kernel | |
9b3e4991 | 901 | + |
1f554f76 DM |
902 | other|l24|l26|solaris ... no special behaviour |
903 | wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch | |
904 | ||
905 | `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: | |
906 | ||
907 | Map host parallel devices (n is 0 to 2). | |
9b3e4991 DM |
908 | + |
909 | NOTE: This option allows direct access to host hardware. So it is no longer | |
1f554f76 | 910 | possible to migrate such machines - use with special care. |
9b3e4991 | 911 | + |
1f554f76 DM |
912 | Experimental: user reported problems with this option. |
913 | ||
914 | `-protection` `boolean` (default=`0`):: | |
915 | ||
916 | Sets the protection flag of the VM. This will prevent the remove operation. | |
917 | ||
918 | `-reboot` `boolean` (default=`1`):: | |
919 | ||
920 | Allow reboot. If set to '0' the VM exit on reboot. | |
921 | ||
922 | `-revert` `string` :: | |
923 | ||
924 | Revert a pending change. | |
925 | ||
9b3e4991 | 926 | `-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>]` :: |
1f554f76 DM |
927 | |
928 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). | |
929 | ||
9b3e4991 | 930 | `-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>]` :: |
1f554f76 DM |
931 | |
932 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). | |
933 | ||
934 | `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: | |
935 | ||
936 | scsi controller model | |
937 | ||
938 | `-serial[n]` `(/dev/.+|socket)` :: | |
939 | ||
940 | Create a serial device inside the VM (n is 0 to 3), and pass through a host | |
941 | serial device (i.e. /dev/ttyS0), or create a unix socket on the host side | |
942 | (use 'qm terminal' to open a terminal connection). | |
9b3e4991 DM |
943 | + |
944 | NOTE: If you pass through a host serial device, it is no longer possible to | |
1f554f76 | 945 | migrate such machines - use with special care. |
9b3e4991 | 946 | + |
1f554f76 DM |
947 | Experimental: user reported problems with this option. |
948 | ||
949 | `-shares` `integer (0 - 50000)` (default=`1000`):: | |
950 | ||
951 | Amount of memory shares for auto-ballooning. The larger the number is, the | |
952 | more memory this VM gets. Number is relative to weights of all other | |
953 | running VMs. Using zero disables auto-ballooning | |
954 | ||
955 | `-skiplock` `boolean` :: | |
956 | ||
957 | Ignore locks - only root is allowed to use this option. | |
958 | ||
9b3e4991 | 959 | `-smbios[n]` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` :: |
1f554f76 DM |
960 | |
961 | Specify SMBIOS type 1 fields. | |
962 | ||
963 | `-smp` `integer (1 - N)` (default=`1`):: | |
964 | ||
965 | The number of CPUs. Please use option -sockets instead. | |
966 | ||
967 | `-sockets` `integer (1 - N)` (default=`1`):: | |
968 | ||
969 | The number of CPU sockets. | |
970 | ||
971 | `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: | |
972 | ||
973 | Set the initial date of the real time clock. Valid format for date are: | |
974 | 'now' or '2006-06-17T16:01:21' or '2006-06-17'. | |
975 | ||
976 | `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
977 | ||
978 | Startup and shutdown behavior. Order is a non-negative number defining the | |
979 | general startup order. Shutdown in done with reverse ordering. Additionally | |
980 | you can set the 'up' or 'down' delay in seconds, which specifies a delay to | |
981 | wait before the next VM is started or stopped. | |
982 | ||
983 | `-tablet` `boolean` (default=`1`):: | |
984 | ||
9b3e4991 | 985 | Enable/disable the USB tablet device. This device is usually needed to |
1f554f76 DM |
986 | allow absolute mouse positioning with VNC. Else the mouse runs out of sync |
987 | with normal VNC clients. If you're running lots of console-only guests on | |
988 | one host, you may consider disabling this to save some context switches. | |
9b3e4991 | 989 | This is turned off by default if you use spice (-vga=qxl). |
1f554f76 DM |
990 | |
991 | `-tdf` `boolean` (default=`0`):: | |
992 | ||
993 | Enable/disable time drift fix. | |
994 | ||
995 | `-template` `boolean` (default=`0`):: | |
996 | ||
997 | Enable/disable Template. | |
998 | ||
999 | `-unused[n]` `string` :: | |
1000 | ||
1001 | Reference to unused volumes. | |
1002 | ||
9b3e4991 | 1003 | `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` :: |
1f554f76 DM |
1004 | |
1005 | Configure an USB device (n is 0 to 4). This can be used to | |
1006 | pass-through usb devices to the guest. HOSTUSBDEVICE syntax is: | |
9b3e4991 | 1007 | + |
1f554f76 | 1008 | 'bus-port(.port)*' (decimal numbers) or |
9b3e4991 DM |
1009 | 'vendor_id:product_id' (hexadeciaml numbers) or |
1010 | 'spice' | |
1011 | + | |
1f554f76 | 1012 | You can use the 'lsusb -t' command to list existing usb devices. |
9b3e4991 DM |
1013 | + |
1014 | NOTE: This option allows direct access to host hardware. So it is no longer | |
1f554f76 | 1015 | possible to migrate such machines - use with special care. |
9b3e4991 | 1016 | + |
1f554f76 | 1017 | The value 'spice' can be used to add a usb redirection devices for spice. |
9b3e4991 DM |
1018 | + |
1019 | The 'usb3' option determines whether the device is a USB3 device or not | |
1020 | (this does currently not work reliably with spice redirection and is then | |
1021 | ignored). | |
1f554f76 DM |
1022 | |
1023 | `-vcpus` `integer (1 - N)` (default=`0`):: | |
1024 | ||
1025 | Number of hotplugged vcpus. | |
1026 | ||
1027 | `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: | |
1028 | ||
9b3e4991 DM |
1029 | Select the VGA type. If you want to use high resolution modes (>= |
1030 | 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is | |
1031 | 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option | |
1032 | enables the SPICE display sever. For win* OS you can select how many | |
1033 | independent displays you want, Linux guests can add displays them self. You | |
1034 | can also run without any graphic card, using a serial device as terminal. | |
1f554f76 | 1035 | |
9b3e4991 | 1036 | `-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>]` :: |
1f554f76 DM |
1037 | |
1038 | Use volume as VIRTIO hard disk (n is 0 to 15). | |
1039 | ||
9b3e4991 | 1040 | `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` :: |
1f554f76 | 1041 | |
9b3e4991 | 1042 | Create a virtual hardware watchdog device. Once enabled (by a guest |
1f554f76 | 1043 | action), the watchdog must be periodically polled by an agent inside the |
9b3e4991 DM |
1044 | guest or else the watchdog will reset the guest (or execute the respective |
1045 | action specified) | |
1f554f76 DM |
1046 | |
1047 | ||
1048 | ||
1049 | ||
1050 | *qm showcmd* `<vmid>` | |
1051 | ||
1052 | Show command line which is used to start the VM (debug info). | |
1053 | ||
1054 | `<vmid>` `integer (1 - N)` :: | |
1055 | ||
1056 | The (unique) ID of the VM. | |
1057 | ||
1058 | ||
1059 | ||
1060 | ||
1061 | *qm shutdown* `<vmid>` `[OPTIONS]` | |
1062 | ||
9b3e4991 DM |
1063 | Shutdown virtual machine. This is similar to pressing the power button on a |
1064 | physical machine.This will send an ACPI event for the guest OS, which | |
1065 | should then proceed to a clean shutdown. | |
1f554f76 DM |
1066 | |
1067 | `<vmid>` `integer (1 - N)` :: | |
1068 | ||
1069 | The (unique) ID of the VM. | |
1070 | ||
1071 | `-forceStop` `boolean` (default=`0`):: | |
1072 | ||
1073 | Make sure the VM stops. | |
1074 | ||
1075 | `-keepActive` `boolean` (default=`0`):: | |
1076 | ||
1077 | Do not decativate storage volumes. | |
1078 | ||
1079 | `-skiplock` `boolean` :: | |
1080 | ||
1081 | Ignore locks - only root is allowed to use this option. | |
1082 | ||
1083 | `-timeout` `integer (0 - N)` :: | |
1084 | ||
1085 | Wait maximal timeout seconds. | |
1086 | ||
1087 | ||
1088 | ||
1089 | *qm snapshot* `<vmid> <snapname>` `[OPTIONS]` | |
1090 | ||
1091 | Snapshot a VM. | |
1092 | ||
1093 | `<vmid>` `integer (1 - N)` :: | |
1094 | ||
1095 | The (unique) ID of the VM. | |
1096 | ||
1097 | `<snapname>` `string` :: | |
1098 | ||
1099 | The name of the snapshot. | |
1100 | ||
1101 | `-description` `string` :: | |
1102 | ||
1103 | A textual description or comment. | |
1104 | ||
1105 | `-vmstate` `boolean` :: | |
1106 | ||
1107 | Save the vmstate | |
1108 | ||
1109 | ||
1110 | ||
1111 | *qm start* `<vmid>` `[OPTIONS]` | |
1112 | ||
1113 | Start virtual machine. | |
1114 | ||
1115 | `<vmid>` `integer (1 - N)` :: | |
1116 | ||
1117 | The (unique) ID of the VM. | |
1118 | ||
1119 | `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: | |
1120 | ||
1121 | Specific the Qemu machine type. | |
1122 | ||
1123 | `-migratedfrom` `string` :: | |
1124 | ||
1125 | The cluster node name. | |
1126 | ||
1127 | `-skiplock` `boolean` :: | |
1128 | ||
1129 | Ignore locks - only root is allowed to use this option. | |
1130 | ||
1131 | `-stateuri` `string` :: | |
1132 | ||
1133 | Some command save/restore state from this location. | |
1134 | ||
1135 | ||
1136 | ||
1137 | ||
1138 | *qm status* `<vmid>` `[OPTIONS]` | |
1139 | ||
1140 | Show VM status. | |
1141 | ||
1142 | `<vmid>` `integer (1 - N)` :: | |
1143 | ||
1144 | The (unique) ID of the VM. | |
1145 | ||
1146 | `-verbose` `boolean` :: | |
1147 | ||
1148 | Verbose output format | |
1149 | ||
1150 | ||
1151 | ||
1152 | ||
1153 | *qm stop* `<vmid>` `[OPTIONS]` | |
1154 | ||
9b3e4991 DM |
1155 | Stop virtual machine. The qemu process will exit immediately. Thisis akin |
1156 | to pulling the power plug of a running computer and may damage the VM data | |
1f554f76 DM |
1157 | |
1158 | `<vmid>` `integer (1 - N)` :: | |
1159 | ||
1160 | The (unique) ID of the VM. | |
1161 | ||
1162 | `-keepActive` `boolean` (default=`0`):: | |
1163 | ||
1164 | Do not decativate storage volumes. | |
1165 | ||
1166 | `-migratedfrom` `string` :: | |
1167 | ||
1168 | The cluster node name. | |
1169 | ||
1170 | `-skiplock` `boolean` :: | |
1171 | ||
1172 | Ignore locks - only root is allowed to use this option. | |
1173 | ||
1174 | `-timeout` `integer (0 - N)` :: | |
1175 | ||
1176 | Wait maximal timeout seconds. | |
1177 | ||
1178 | ||
1179 | ||
1180 | *qm suspend* `<vmid>` `[OPTIONS]` | |
1181 | ||
1182 | Suspend virtual machine. | |
1183 | ||
1184 | `<vmid>` `integer (1 - N)` :: | |
1185 | ||
1186 | The (unique) ID of the VM. | |
1187 | ||
1188 | `-skiplock` `boolean` :: | |
1189 | ||
1190 | Ignore locks - only root is allowed to use this option. | |
1191 | ||
1192 | ||
1193 | ||
1194 | *qm template* `<vmid>` `[OPTIONS]` | |
1195 | ||
1196 | Create a Template. | |
1197 | ||
1198 | `<vmid>` `integer (1 - N)` :: | |
1199 | ||
1200 | The (unique) ID of the VM. | |
1201 | ||
1202 | `-disk` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: | |
1203 | ||
1204 | If you want to convert only 1 disk to base image. | |
1205 | ||
1206 | ||
1207 | ||
1208 | ||
1209 | *qm terminal* `<vmid>` `[OPTIONS]` | |
1210 | ||
1211 | Open a terminal using a serial device (The VM need to have a serial device | |
1212 | configured, for example 'serial0: socket') | |
1213 | ||
1214 | `<vmid>` `integer (1 - N)` :: | |
1215 | ||
1216 | The (unique) ID of the VM. | |
1217 | ||
1218 | `-iface` `(serial0 | serial1 | serial2 | serial3)` :: | |
1219 | ||
1220 | Select the serial device. By default we simply use the first suitable | |
1221 | device. | |
1222 | ||
1223 | ||
1224 | ||
1225 | ||
1226 | *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]` | |
1227 | ||
1228 | Unlink/delete disk images. | |
1229 | ||
1230 | `<vmid>` `integer (1 - N)` :: | |
1231 | ||
1232 | The (unique) ID of the VM. | |
1233 | ||
1234 | `-force` `boolean` :: | |
1235 | ||
1236 | Force physical removal. Without this, we simple remove the disk from the | |
1237 | config file and create an additional configuration entry called | |
1238 | 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause | |
1239 | physical removal. | |
1240 | ||
1241 | `-idlist` `string` :: | |
1242 | ||
1243 | A list of disk IDs you want to delete. | |
1244 | ||
1245 | ||
1246 | ||
1247 | ||
1248 | *qm unlock* `<vmid>` | |
1249 | ||
1250 | Unlock the VM. | |
1251 | ||
1252 | `<vmid>` `integer (1 - N)` :: | |
1253 | ||
1254 | The (unique) ID of the VM. | |
1255 | ||
1256 | ||
1257 | ||
1258 | *qm vncproxy* `<vmid>` | |
1259 | ||
1260 | Proxy VM VNC traffic to stdin/stdout | |
1261 | ||
1262 | `<vmid>` `integer (1 - N)` :: | |
1263 | ||
1264 | The (unique) ID of the VM. | |
1265 | ||
1266 | ||
1267 | ||
1268 | *qm wait* `<vmid>` `[OPTIONS]` | |
1269 | ||
1270 | Wait until the VM is stopped. | |
1271 | ||
1272 | `<vmid>` `integer (1 - N)` :: | |
1273 | ||
1274 | The (unique) ID of the VM. | |
1275 | ||
1276 | `-timeout` `integer (1 - N)` :: | |
1277 | ||
1278 | Timeout in seconds. Default is to wait forever. | |
1279 | ||
1280 | ||
1281 | ||
1282 |