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