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