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