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