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