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