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