update generated docs
[pve-docs.git] / qm.1-synopsis.adoc
1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
2
3 *qm agent* `<vmid> <command>`
4
5 Execute Qemu Guest Agent commands.
6
7 `<vmid>`: `<integer> (1 - N)` ::
8
9 The (unique) ID of the VM.
10
11 `<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-memory-block-info | get-memory-blocks | get-time | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
12
13 The QGA command.
14
15
16
17 *qm clone* `<vmid> <newid>` `[OPTIONS]`
18
19 Create a copy of virtual machine/template.
20
21 `<vmid>`: `<integer> (1 - N)` ::
22
23 The (unique) ID of the VM.
24
25 `<newid>`: `<integer> (1 - N)` ::
26
27 VMID for the clone.
28
29 `-description` `<string>` ::
30
31 Description for the new VM.
32
33 `-format` `<qcow2 | raw | vmdk>` ::
34
35 Target format for file storage.
36 +
37 NOTE: Requires option(s): `full`
38
39 `-full` `<boolean>` ('default =' `0`)::
40
41 Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.
42
43 `-name` `<string>` ::
44
45 Set a name for the new VM.
46
47 `-pool` `<string>` ::
48
49 Add the new VM to the specified pool.
50
51 `-snapname` `<string>` ::
52
53 The name of the snapshot.
54
55 `-storage` `<string>` ::
56
57 Target storage for full clone.
58 +
59 NOTE: Requires option(s): `full`
60
61 `-target` `<string>` ::
62
63 Target node. Only allowed if the original VM is on shared storage.
64
65
66
67 *qm config* `<vmid>` `[OPTIONS]`
68
69 Get current virtual machine configuration. This does not include pending
70 configuration changes (see 'pending' API).
71
72 `<vmid>`: `<integer> (1 - N)` ::
73
74 The (unique) ID of the VM.
75
76 `-current` `<boolean>` ('default =' `0`)::
77
78 Get current values (instead of pending values).
79
80
81
82 *qm create* `<vmid>` `[OPTIONS]`
83
84 Create or restore a virtual machine.
85
86 `<vmid>`: `<integer> (1 - N)` ::
87
88 The (unique) ID of the VM.
89
90 `-acpi` `<boolean>` ('default =' `1`)::
91
92 Enable/disable ACPI.
93
94 `-agent` `<boolean>` ('default =' `0`)::
95
96 Enable/disable Qemu GuestAgent.
97
98 `-archive` `<string>` ::
99
100 The backup file.
101
102 `-args` `<string>` ::
103
104 Arbitrary arguments passed to kvm.
105
106 `-autostart` `<boolean>` ('default =' `0`)::
107
108 Automatic restart after crash (currently ignored).
109
110 `-balloon` `<integer> (0 - N)` ::
111
112 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
113
114 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
115
116 Select BIOS implementation.
117
118 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
119
120 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
121
122 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
123
124 Enable booting from specified disk.
125
126 `-cdrom` `<volume>` ::
127
128 This is an alias for option -ide2
129
130 `-cores` `<integer> (1 - N)` ('default =' `1`)::
131
132 The number of cores per socket.
133
134 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
135
136 Emulated CPU type.
137
138 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
139
140 Limit of CPU usage.
141
142 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
143
144 CPU weight for a VM.
145
146 `-description` `<string>` ::
147
148 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
149
150 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
151
152 Configure a Disk for storing EFI vars
153
154 `-force` `<boolean>` ::
155
156 Allow to overwrite existing VM.
157 +
158 NOTE: Requires option(s): `archive`
159
160 `-freeze` `<boolean>` ::
161
162 Freeze CPU at startup (use 'c' monitor command to start execution).
163
164 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
165
166 Map host PCI devices into guest.
167
168 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
169
170 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
171
172 `-hugepages` `<1024 | 2 | any>` ::
173
174 Enable/disable hugepages memory.
175
176 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
177
178 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
179
180 `-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`)::
181
182 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
183
184 `-kvm` `<boolean>` ('default =' `1`)::
185
186 Enable/disable KVM hardware virtualization.
187
188 `-localtime` `<boolean>` ::
189
190 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
191
192 `-lock` `<backup | migrate | rollback | snapshot>` ::
193
194 Lock/unlock the VM.
195
196 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
197
198 Specific the Qemu machine type.
199
200 `-memory` `<integer> (16 - N)` ('default =' `512`)::
201
202 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
203
204 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
205
206 Set maximum tolerated downtime (in seconds) for migrations.
207
208 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
209
210 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
211
212 `-name` `<string>` ::
213
214 Set a name for the VM. Only used on the configuration web interface.
215
216 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
217
218 Specify network devices.
219
220 `-numa` `<boolean>` ('default =' `0`)::
221
222 Enable/disable NUMA.
223
224 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
225
226 NUMA topology.
227
228 `-onboot` `<boolean>` ('default =' `0`)::
229
230 Specifies whether a VM will be started during system bootup.
231
232 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
233
234 Specify guest operating system.
235
236 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
237
238 Map host parallel devices (n is 0 to 2).
239
240 `-pool` `<string>` ::
241
242 Add the VM to the specified pool.
243
244 `-protection` `<boolean>` ('default =' `0`)::
245
246 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
247
248 `-reboot` `<boolean>` ('default =' `1`)::
249
250 Allow reboot. If set to '0' the VM exit on reboot.
251
252 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
253
254 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
255
256 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
257
258 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
259
260 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
261
262 SCSI controller model
263
264 `-serial[n]` `(/dev/.+|socket)` ::
265
266 Create a serial device inside the VM (n is 0 to 3)
267
268 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
269
270 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
271
272 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
273
274 Specify SMBIOS type 1 fields.
275
276 `-smp` `<integer> (1 - N)` ('default =' `1`)::
277
278 The number of CPUs. Please use option -sockets instead.
279
280 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
281
282 The number of CPU sockets.
283
284 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
285
286 Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
287
288 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
289
290 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
291
292 `-storage` `<string>` ::
293
294 Default storage.
295
296 `-tablet` `<boolean>` ('default =' `1`)::
297
298 Enable/disable the USB tablet device.
299
300 `-tdf` `<boolean>` ('default =' `0`)::
301
302 Enable/disable time drift fix.
303
304 `-template` `<boolean>` ('default =' `0`)::
305
306 Enable/disable Template.
307
308 `-unique` `<boolean>` ::
309
310 Assign a unique random ethernet address.
311 +
312 NOTE: Requires option(s): `archive`
313
314 `-unused[n]` `<string>` ::
315
316 Reference to unused volumes. This is used internally, and should not be modified manually.
317
318 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
319
320 Configure an USB device (n is 0 to 4).
321
322 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
323
324 Number of hotplugged vcpus.
325
326 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
327
328 Select the VGA type.
329
330 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
331
332 Use volume as VIRTIO hard disk (n is 0 to 15).
333
334 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
335
336 Create a virtual hardware watchdog device.
337
338
339
340 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
341
342 Delete a VM snapshot.
343
344 `<vmid>`: `<integer> (1 - N)` ::
345
346 The (unique) ID of the VM.
347
348 `<snapname>`: `<string>` ::
349
350 The name of the snapshot.
351
352 `-force` `<boolean>` ::
353
354 For removal from config file, even if removing disk snapshots fails.
355
356
357
358 *qm destroy* `<vmid>` `[OPTIONS]`
359
360 Destroy the vm (also delete all used/owned volumes).
361
362 `<vmid>`: `<integer> (1 - N)` ::
363
364 The (unique) ID of the VM.
365
366 `-skiplock` `<boolean>` ::
367
368 Ignore locks - only root is allowed to use this option.
369
370
371
372
373 *qm help* `[<cmd>]` `[OPTIONS]`
374
375 Get help about specified command.
376
377 `<cmd>`: `<string>` ::
378
379 Command name
380
381 `-verbose` `<boolean>` ::
382
383 Verbose output format.
384
385
386
387
388 *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
389
390 Import an external disk image as an unused disk in a VM. The
391  image format has to be supported by qemu-img(1).
392
393 `<vmid>`: `<integer> (1 - N)` ::
394
395 The (unique) ID of the VM.
396
397 `<source>`: `<string>` ::
398
399 Path to the disk image to import
400
401 `<storage>`: `<string>` ::
402
403 Target storage ID
404
405 `-format` `<qcow2 | raw | vmdk>` ::
406
407 Target format
408
409
410
411
412 *qm list* `[OPTIONS]`
413
414 Virtual machine index (per node).
415
416 `-full` `<boolean>` ::
417
418 Determine the full status of active VMs.
419
420
421
422 *qm listsnapshot* `<vmid>`
423
424 List all snapshots.
425
426 `<vmid>`: `<integer> (1 - N)` ::
427
428 The (unique) ID of the VM.
429
430
431
432 *qm migrate* `<vmid> <target>` `[OPTIONS]`
433
434 Migrate virtual machine. Creates a new migration task.
435
436 `<vmid>`: `<integer> (1 - N)` ::
437
438 The (unique) ID of the VM.
439
440 `<target>`: `<string>` ::
441
442 Target node.
443
444 `-force` `<boolean>` ::
445
446 Allow to migrate VMs which use local devices. Only root may use this option.
447
448 `-migration_network` `<string>` ::
449
450 CIDR of the (sub) network that is used for migration.
451
452 `-migration_type` `<insecure | secure>` ::
453
454 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
455
456 `-online` `<boolean>` ::
457
458 Use online/live migration.
459
460 `-targetstorage` `<string>` ::
461
462 Default target storage.
463
464 `-with-local-disks` `<boolean>` ::
465
466 Enable live storage migration for local disk
467
468
469
470
471 *qm monitor* `<vmid>`
472
473 Enter Qemu Monitor interface.
474
475 `<vmid>`: `<integer> (1 - N)` ::
476
477 The (unique) ID of the VM.
478
479
480
481
482 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
483
484 Move volume to different storage.
485
486 `<vmid>`: `<integer> (1 - N)` ::
487
488 The (unique) ID of the VM.
489
490 `<disk>`: `<efidisk0 | 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>` ::
491
492 The disk you want to move.
493
494 `<storage>`: `<string>` ::
495
496 Target storage.
497
498 `-delete` `<boolean>` ('default =' `0`)::
499
500 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
501
502 `-digest` `<string>` ::
503
504 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
505
506 `-format` `<qcow2 | raw | vmdk>` ::
507
508 Target Format.
509
510
511
512
513 *qm mtunnel*
514
515 Used by qmigrate - do not use manually.
516
517
518
519 *qm nbdstop* `<vmid>`
520
521 Stop embedded nbd server.
522
523 `<vmid>`: `<integer> (1 - N)` ::
524
525 The (unique) ID of the VM.
526
527
528
529
530 *qm pending* `<vmid>`
531
532 Get virtual machine configuration, including pending changes.
533
534 `<vmid>`: `<integer> (1 - N)` ::
535
536 The (unique) ID of the VM.
537
538
539
540
541 *qm rescan* `[OPTIONS]`
542
543 Rescan all storages and update disk sizes and unused disk images.
544
545 `-vmid` `<integer> (1 - N)` ::
546
547 The (unique) ID of the VM.
548
549
550
551
552 *qm reset* `<vmid>` `[OPTIONS]`
553
554 Reset virtual machine.
555
556 `<vmid>`: `<integer> (1 - N)` ::
557
558 The (unique) ID of the VM.
559
560 `-skiplock` `<boolean>` ::
561
562 Ignore locks - only root is allowed to use this option.
563
564
565
566 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
567
568 Extend volume size.
569
570 `<vmid>`: `<integer> (1 - N)` ::
571
572 The (unique) ID of the VM.
573
574 `<disk>`: `<efidisk0 | 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>` ::
575
576 The disk you want to resize.
577
578 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
579
580 The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.
581
582 `-digest` `<string>` ::
583
584 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
585
586 `-skiplock` `<boolean>` ::
587
588 Ignore locks - only root is allowed to use this option.
589
590
591
592 *qm resume* `<vmid>` `[OPTIONS]`
593
594 Resume virtual machine.
595
596 `<vmid>`: `<integer> (1 - N)` ::
597
598 The (unique) ID of the VM.
599
600 `-nocheck` `<boolean>` ::
601
602 no description available
603
604 `-skiplock` `<boolean>` ::
605
606 Ignore locks - only root is allowed to use this option.
607
608
609
610 *qm rollback* `<vmid> <snapname>`
611
612 Rollback VM state to specified snapshot.
613
614 `<vmid>`: `<integer> (1 - N)` ::
615
616 The (unique) ID of the VM.
617
618 `<snapname>`: `<string>` ::
619
620 The name of the snapshot.
621
622
623
624 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
625
626 Send key event to virtual machine.
627
628 `<vmid>`: `<integer> (1 - N)` ::
629
630 The (unique) ID of the VM.
631
632 `<key>`: `<string>` ::
633
634 The key (qemu monitor encoding).
635
636 `-skiplock` `<boolean>` ::
637
638 Ignore locks - only root is allowed to use this option.
639
640
641
642 *qm set* `<vmid>` `[OPTIONS]`
643
644 Set virtual machine options (synchrounous API) - You should consider using
645 the POST method instead for any actions involving hotplug or storage
646 allocation.
647
648 `<vmid>`: `<integer> (1 - N)` ::
649
650 The (unique) ID of the VM.
651
652 `-acpi` `<boolean>` ('default =' `1`)::
653
654 Enable/disable ACPI.
655
656 `-agent` `<boolean>` ('default =' `0`)::
657
658 Enable/disable Qemu GuestAgent.
659
660 `-args` `<string>` ::
661
662 Arbitrary arguments passed to kvm.
663
664 `-autostart` `<boolean>` ('default =' `0`)::
665
666 Automatic restart after crash (currently ignored).
667
668 `-balloon` `<integer> (0 - N)` ::
669
670 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
671
672 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
673
674 Select BIOS implementation.
675
676 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
677
678 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
679
680 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
681
682 Enable booting from specified disk.
683
684 `-cdrom` `<volume>` ::
685
686 This is an alias for option -ide2
687
688 `-cores` `<integer> (1 - N)` ('default =' `1`)::
689
690 The number of cores per socket.
691
692 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
693
694 Emulated CPU type.
695
696 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
697
698 Limit of CPU usage.
699
700 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
701
702 CPU weight for a VM.
703
704 `-delete` `<string>` ::
705
706 A list of settings you want to delete.
707
708 `-description` `<string>` ::
709
710 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
711
712 `-digest` `<string>` ::
713
714 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
715
716 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
717
718 Configure a Disk for storing EFI vars
719
720 `-force` `<boolean>` ::
721
722 Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.
723 +
724 NOTE: Requires option(s): `delete`
725
726 `-freeze` `<boolean>` ::
727
728 Freeze CPU at startup (use 'c' monitor command to start execution).
729
730 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
731
732 Map host PCI devices into guest.
733
734 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
735
736 Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'.
737
738 `-hugepages` `<1024 | 2 | any>` ::
739
740 Enable/disable hugepages memory.
741
742 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
743
744 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
745
746 `-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`)::
747
748 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
749
750 `-kvm` `<boolean>` ('default =' `1`)::
751
752 Enable/disable KVM hardware virtualization.
753
754 `-localtime` `<boolean>` ::
755
756 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
757
758 `-lock` `<backup | migrate | rollback | snapshot>` ::
759
760 Lock/unlock the VM.
761
762 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
763
764 Specific the Qemu machine type.
765
766 `-memory` `<integer> (16 - N)` ('default =' `512`)::
767
768 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
769
770 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
771
772 Set maximum tolerated downtime (in seconds) for migrations.
773
774 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
775
776 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
777
778 `-name` `<string>` ::
779
780 Set a name for the VM. Only used on the configuration web interface.
781
782 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
783
784 Specify network devices.
785
786 `-numa` `<boolean>` ('default =' `0`)::
787
788 Enable/disable NUMA.
789
790 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
791
792 NUMA topology.
793
794 `-onboot` `<boolean>` ('default =' `0`)::
795
796 Specifies whether a VM will be started during system bootup.
797
798 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
799
800 Specify guest operating system.
801
802 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
803
804 Map host parallel devices (n is 0 to 2).
805
806 `-protection` `<boolean>` ('default =' `0`)::
807
808 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
809
810 `-reboot` `<boolean>` ('default =' `1`)::
811
812 Allow reboot. If set to '0' the VM exit on reboot.
813
814 `-revert` `<string>` ::
815
816 Revert a pending change.
817
818 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
819
820 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
821
822 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
823
824 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
825
826 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
827
828 SCSI controller model
829
830 `-serial[n]` `(/dev/.+|socket)` ::
831
832 Create a serial device inside the VM (n is 0 to 3)
833
834 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
835
836 Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning
837
838 `-skiplock` `<boolean>` ::
839
840 Ignore locks - only root is allowed to use this option.
841
842 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
843
844 Specify SMBIOS type 1 fields.
845
846 `-smp` `<integer> (1 - N)` ('default =' `1`)::
847
848 The number of CPUs. Please use option -sockets instead.
849
850 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
851
852 The number of CPU sockets.
853
854 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
855
856 Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
857
858 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
859
860 Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
861
862 `-tablet` `<boolean>` ('default =' `1`)::
863
864 Enable/disable the USB tablet device.
865
866 `-tdf` `<boolean>` ('default =' `0`)::
867
868 Enable/disable time drift fix.
869
870 `-template` `<boolean>` ('default =' `0`)::
871
872 Enable/disable Template.
873
874 `-unused[n]` `<string>` ::
875
876 Reference to unused volumes. This is used internally, and should not be modified manually.
877
878 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
879
880 Configure an USB device (n is 0 to 4).
881
882 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
883
884 Number of hotplugged vcpus.
885
886 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
887
888 Select the VGA type.
889
890 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
891
892 Use volume as VIRTIO hard disk (n is 0 to 15).
893
894 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
895
896 Create a virtual hardware watchdog device.
897
898
899
900
901 *qm showcmd* `<vmid>`
902
903 Show command line which is used to start the VM (debug info).
904
905 `<vmid>`: `<integer> (1 - N)` ::
906
907 The (unique) ID of the VM.
908
909
910
911
912 *qm shutdown* `<vmid>` `[OPTIONS]`
913
914 Shutdown virtual machine. This is similar to pressing the power button on a
915 physical machine.This will send an ACPI event for the guest OS, which
916 should then proceed to a clean shutdown.
917
918 `<vmid>`: `<integer> (1 - N)` ::
919
920 The (unique) ID of the VM.
921
922 `-forceStop` `<boolean>` ('default =' `0`)::
923
924 Make sure the VM stops.
925
926 `-keepActive` `<boolean>` ('default =' `0`)::
927
928 Do not deactivate storage volumes.
929
930 `-skiplock` `<boolean>` ::
931
932 Ignore locks - only root is allowed to use this option.
933
934 `-timeout` `<integer> (0 - N)` ::
935
936 Wait maximal timeout seconds.
937
938
939
940 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
941
942 Snapshot a VM.
943
944 `<vmid>`: `<integer> (1 - N)` ::
945
946 The (unique) ID of the VM.
947
948 `<snapname>`: `<string>` ::
949
950 The name of the snapshot.
951
952 `-description` `<string>` ::
953
954 A textual description or comment.
955
956 `-vmstate` `<boolean>` ::
957
958 Save the vmstate
959
960
961
962 *qm start* `<vmid>` `[OPTIONS]`
963
964 Start virtual machine.
965
966 `<vmid>`: `<integer> (1 - N)` ::
967
968 The (unique) ID of the VM.
969
970 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
971
972 Specific the Qemu machine type.
973
974 `-migratedfrom` `<string>` ::
975
976 The cluster node name.
977
978 `-migration_network` `<string>` ::
979
980 CIDR of the (sub) network that is used for migration.
981
982 `-migration_type` `<insecure | secure>` ::
983
984 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
985
986 `-skiplock` `<boolean>` ::
987
988 Ignore locks - only root is allowed to use this option.
989
990 `-stateuri` `<string>` ::
991
992 Some command save/restore state from this location.
993
994 `-targetstorage` `<string>` ::
995
996 Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
997
998
999
1000
1001 *qm status* `<vmid>` `[OPTIONS]`
1002
1003 Show VM status.
1004
1005 `<vmid>`: `<integer> (1 - N)` ::
1006
1007 The (unique) ID of the VM.
1008
1009 `-verbose` `<boolean>` ::
1010
1011 Verbose output format
1012
1013
1014
1015
1016 *qm stop* `<vmid>` `[OPTIONS]`
1017
1018 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1019 to pulling the power plug of a running computer and may damage the VM data
1020
1021 `<vmid>`: `<integer> (1 - N)` ::
1022
1023 The (unique) ID of the VM.
1024
1025 `-keepActive` `<boolean>` ('default =' `0`)::
1026
1027 Do not deactivate storage volumes.
1028
1029 `-migratedfrom` `<string>` ::
1030
1031 The cluster node name.
1032
1033 `-skiplock` `<boolean>` ::
1034
1035 Ignore locks - only root is allowed to use this option.
1036
1037 `-timeout` `<integer> (0 - N)` ::
1038
1039 Wait maximal timeout seconds.
1040
1041
1042
1043 *qm suspend* `<vmid>` `[OPTIONS]`
1044
1045 Suspend virtual machine.
1046
1047 `<vmid>`: `<integer> (1 - N)` ::
1048
1049 The (unique) ID of the VM.
1050
1051 `-skiplock` `<boolean>` ::
1052
1053 Ignore locks - only root is allowed to use this option.
1054
1055
1056
1057 *qm template* `<vmid>` `[OPTIONS]`
1058
1059 Create a Template.
1060
1061 `<vmid>`: `<integer> (1 - N)` ::
1062
1063 The (unique) ID of the VM.
1064
1065 `-disk` `<efidisk0 | 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>` ::
1066
1067 If you want to convert only 1 disk to base image.
1068
1069
1070
1071
1072 *qm terminal* `<vmid>` `[OPTIONS]`
1073
1074 Open a terminal using a serial device (The VM need to have a serial device
1075 configured, for example 'serial0: socket')
1076
1077 `<vmid>`: `<integer> (1 - N)` ::
1078
1079 The (unique) ID of the VM.
1080
1081 `-iface` `<serial0 | serial1 | serial2 | serial3>` ::
1082
1083 Select the serial device. By default we simply use the first suitable device.
1084
1085
1086
1087
1088 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1089
1090 Unlink/delete disk images.
1091
1092 `<vmid>`: `<integer> (1 - N)` ::
1093
1094 The (unique) ID of the VM.
1095
1096 `-force` `<boolean>` ::
1097
1098 Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.
1099
1100 `-idlist` `<string>` ::
1101
1102 A list of disk IDs you want to delete.
1103
1104
1105
1106
1107 *qm unlock* `<vmid>`
1108
1109 Unlock the VM.
1110
1111 `<vmid>`: `<integer> (1 - N)` ::
1112
1113 The (unique) ID of the VM.
1114
1115
1116
1117 *qm vncproxy* `<vmid>`
1118
1119 Proxy VM VNC traffic to stdin/stdout
1120
1121 `<vmid>`: `<integer> (1 - N)` ::
1122
1123 The (unique) ID of the VM.
1124
1125
1126
1127 *qm wait* `<vmid>` `[OPTIONS]`
1128
1129 Wait until the VM is stopped.
1130
1131 `<vmid>`: `<integer> (1 - N)` ::
1132
1133 The (unique) ID of the VM.
1134
1135 `-timeout` `<integer> (1 - N)` ::
1136
1137 Timeout in seconds. Default is to wait forever.
1138
1139
1140
1141