]>
Commit | Line | Data |
---|---|---|
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 cloudinit dump* `<vmid> <type>` | |
73 | ||
74 | Get automatically generated cloudinit config. | |
75 | ||
76 | `<vmid>`: `<integer> (1 - N)` :: | |
77 | ||
78 | The (unique) ID of the VM. | |
79 | ||
80 | `<type>`: `<meta | network | user>` :: | |
81 | ||
82 | Config type. | |
83 | ||
84 | *qm cloudinit pending* `<vmid>` | |
85 | ||
86 | Get the cloudinit configuration with both current and pending values. | |
87 | ||
88 | `<vmid>`: `<integer> (1 - N)` :: | |
89 | ||
90 | The (unique) ID of the VM. | |
91 | ||
92 | *qm cloudinit update* `<vmid>` | |
93 | ||
94 | Regenerate and change cloudinit config drive. | |
95 | ||
96 | `<vmid>`: `<integer> (1 - N)` :: | |
97 | ||
98 | The (unique) ID of the VM. | |
99 | ||
100 | *qm config* `<vmid>` `[OPTIONS]` | |
101 | ||
102 | Get the virtual machine configuration with pending configuration changes | |
103 | applied. Set the 'current' parameter to get the current configuration | |
104 | instead. | |
105 | ||
106 | `<vmid>`: `<integer> (1 - N)` :: | |
107 | ||
108 | The (unique) ID of the VM. | |
109 | ||
110 | `--current` `<boolean>` ('default =' `0`):: | |
111 | ||
112 | Get current values (instead of pending values). | |
113 | ||
114 | `--snapshot` `<string>` :: | |
115 | ||
116 | Fetch config values from given snapshot. | |
117 | ||
118 | *qm create* `<vmid>` `[OPTIONS]` | |
119 | ||
120 | Create or restore a virtual machine. | |
121 | ||
122 | `<vmid>`: `<integer> (1 - N)` :: | |
123 | ||
124 | The (unique) ID of the VM. | |
125 | ||
126 | `--acpi` `<boolean>` ('default =' `1`):: | |
127 | ||
128 | Enable/disable ACPI. | |
129 | ||
130 | `--affinity` `<string>` :: | |
131 | ||
132 | List of host cores used to execute guest processes, for example: 0,5,8-11 | |
133 | ||
134 | `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` :: | |
135 | ||
136 | Enable/disable communication with the QEMU Guest Agent and its properties. | |
137 | ||
138 | `--arch` `<aarch64 | x86_64>` :: | |
139 | ||
140 | Virtual processor architecture. Defaults to the host. | |
141 | ||
142 | `--archive` `<string>` :: | |
143 | ||
144 | The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. | |
145 | ||
146 | `--args` `<string>` :: | |
147 | ||
148 | Arbitrary arguments passed to kvm. | |
149 | ||
150 | `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` :: | |
151 | ||
152 | Configure a audio device, useful in combination with QXL/Spice. | |
153 | ||
154 | `--autostart` `<boolean>` ('default =' `0`):: | |
155 | ||
156 | Automatic restart after crash (currently ignored). | |
157 | ||
158 | `--balloon` `<integer> (0 - N)` :: | |
159 | ||
160 | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. | |
161 | ||
162 | `--bios` `<ovmf | seabios>` ('default =' `seabios`):: | |
163 | ||
164 | Select BIOS implementation. | |
165 | ||
166 | `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` :: | |
167 | ||
168 | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. | |
169 | ||
170 | `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: | |
171 | ||
172 | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. | |
173 | ||
174 | `--bwlimit` `<integer> (0 - N)` ('default =' `restore limit from datacenter or storage config`):: | |
175 | ||
176 | Override I/O bandwidth limit (in KiB/s). | |
177 | ||
178 | `--cdrom` `<volume>` :: | |
179 | ||
180 | This is an alias for option -ide2 | |
181 | ||
182 | `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` :: | |
183 | ||
184 | cloud-init: Specify custom files to replace the automatically generated ones at start. | |
185 | ||
186 | `--cipassword` `<password>` :: | |
187 | ||
188 | 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. | |
189 | ||
190 | `--citype` `<configdrive2 | nocloud | opennebula>` :: | |
191 | ||
192 | 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. | |
193 | ||
194 | `--ciupgrade` `<boolean>` :: | |
195 | ||
196 | cloud-init: do an automatic package upgrade after the first boot. | |
197 | ||
198 | `--ciuser` `<string>` :: | |
199 | ||
200 | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. | |
201 | ||
202 | `--cores` `<integer> (1 - N)` ('default =' `1`):: | |
203 | ||
204 | The number of cores per socket. | |
205 | ||
206 | `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` :: | |
207 | ||
208 | Emulated CPU type. | |
209 | ||
210 | `--cpulimit` `<number> (0 - 128)` ('default =' `0`):: | |
211 | ||
212 | Limit of CPU usage. | |
213 | ||
214 | `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: | |
215 | ||
216 | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. | |
217 | ||
218 | `--description` `<string>` :: | |
219 | ||
220 | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. | |
221 | ||
222 | `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` :: | |
223 | ||
224 | Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
225 | ||
226 | `--force` `<boolean>` :: | |
227 | ||
228 | Allow to overwrite existing VM. | |
229 | + | |
230 | NOTE: Requires option(s): `archive` | |
231 | ||
232 | `--freeze` `<boolean>` :: | |
233 | ||
234 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
235 | ||
236 | `--hookscript` `<string>` :: | |
237 | ||
238 | Script that will be executed during various steps in the vms lifetime. | |
239 | ||
240 | `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` :: | |
241 | ||
242 | Map host PCI devices into guest. | |
243 | ||
244 | `--hotplug` `<string>` ('default =' `network,disk,usb`):: | |
245 | ||
246 | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. | |
247 | ||
248 | `--hugepages` `<1024 | 2 | any>` :: | |
249 | ||
250 | Enable/disable hugepages memory. | |
251 | ||
252 | `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>]` :: | |
253 | ||
254 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
255 | ||
256 | `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` :: | |
257 | ||
258 | cloud-init: Specify IP addresses and gateways for the corresponding interface. | |
259 | + | |
260 | IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. | |
261 | + | |
262 | The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit | |
263 | gateway should be provided. | |
264 | For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires | |
265 | cloud-init 19.4 or newer. | |
266 | + | |
267 | If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using | |
268 | dhcp on IPv4. | |
269 | ||
270 | `--ivshmem` `size=<integer> [,name=<string>]` :: | |
271 | ||
272 | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | |
273 | ||
274 | `--keephugepages` `<boolean>` ('default =' `0`):: | |
275 | ||
276 | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | |
277 | ||
278 | `--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>` :: | |
279 | ||
280 | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. | |
281 | ||
282 | `--kvm` `<boolean>` ('default =' `1`):: | |
283 | ||
284 | Enable/disable KVM hardware virtualization. | |
285 | ||
286 | `--live-restore` `<boolean>` :: | |
287 | ||
288 | Start the VM immediately from the backup and restore in background. PBS only. | |
289 | + | |
290 | NOTE: Requires option(s): `archive` | |
291 | ||
292 | `--localtime` `<boolean>` :: | |
293 | ||
294 | Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. | |
295 | ||
296 | `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` :: | |
297 | ||
298 | Lock/unlock the VM. | |
299 | ||
300 | `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: | |
301 | ||
302 | Specifies the QEMU machine type. | |
303 | ||
304 | `--memory` `<integer> (16 - N)` ('default =' `512`):: | |
305 | ||
306 | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. | |
307 | ||
308 | `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`):: | |
309 | ||
310 | Set maximum tolerated downtime (in seconds) for migrations. | |
311 | ||
312 | `--migrate_speed` `<integer> (0 - N)` ('default =' `0`):: | |
313 | ||
314 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
315 | ||
316 | `--name` `<string>` :: | |
317 | ||
318 | Set a name for the VM. Only used on the configuration web interface. | |
319 | ||
320 | `--nameserver` `<string>` :: | |
321 | ||
322 | 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. | |
323 | ||
324 | `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: | |
325 | ||
326 | Specify network devices. | |
327 | ||
328 | `--numa` `<boolean>` ('default =' `0`):: | |
329 | ||
330 | Enable/disable NUMA. | |
331 | ||
332 | `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: | |
333 | ||
334 | NUMA topology. | |
335 | ||
336 | `--onboot` `<boolean>` ('default =' `0`):: | |
337 | ||
338 | Specifies whether a VM will be started during system bootup. | |
339 | ||
340 | `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` :: | |
341 | ||
342 | Specify guest operating system. | |
343 | ||
344 | `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: | |
345 | ||
346 | Map host parallel devices (n is 0 to 2). | |
347 | ||
348 | `--pool` `<string>` :: | |
349 | ||
350 | Add the VM to the specified pool. | |
351 | ||
352 | `--protection` `<boolean>` ('default =' `0`):: | |
353 | ||
354 | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | |
355 | ||
356 | `--reboot` `<boolean>` ('default =' `1`):: | |
357 | ||
358 | Allow reboot. If set to '0' the VM exit on reboot. | |
359 | ||
360 | `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` :: | |
361 | ||
362 | Configure a VirtIO-based Random Number Generator. | |
363 | ||
364 | `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>]` :: | |
365 | ||
366 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
367 | ||
368 | `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>] [,ro=<1|0>] [,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>]` :: | |
369 | ||
370 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
371 | ||
372 | `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`):: | |
373 | ||
374 | SCSI controller model | |
375 | ||
376 | `--searchdomain` `<string>` :: | |
377 | ||
378 | 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. | |
379 | ||
380 | `--serial[n]` `(/dev/.+|socket)` :: | |
381 | ||
382 | Create a serial device inside the VM (n is 0 to 3) | |
383 | ||
384 | `--shares` `<integer> (0 - 50000)` ('default =' `1000`):: | |
385 | ||
386 | 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. | |
387 | ||
388 | `--smbios1` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` :: | |
389 | ||
390 | Specify SMBIOS type 1 fields. | |
391 | ||
392 | `--smp` `<integer> (1 - N)` ('default =' `1`):: | |
393 | ||
394 | The number of CPUs. Please use option -sockets instead. | |
395 | ||
396 | `--sockets` `<integer> (1 - N)` ('default =' `1`):: | |
397 | ||
398 | The number of CPU sockets. | |
399 | ||
400 | `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` :: | |
401 | ||
402 | Configure additional enhancements for SPICE. | |
403 | ||
404 | `--sshkeys` `<filepath>` :: | |
405 | ||
406 | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). | |
407 | ||
408 | `--start` `<boolean>` ('default =' `0`):: | |
409 | ||
410 | Start VM after it was created successfully. | |
411 | ||
412 | `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: | |
413 | ||
414 | 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'. | |
415 | ||
416 | `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
417 | ||
418 | 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. | |
419 | ||
420 | `--storage` `<string>` :: | |
421 | ||
422 | Default storage. | |
423 | ||
424 | `--tablet` `<boolean>` ('default =' `1`):: | |
425 | ||
426 | Enable/disable the USB tablet device. | |
427 | ||
428 | `--tags` `<string>` :: | |
429 | ||
430 | Tags of the VM. This is only meta information. | |
431 | ||
432 | `--tdf` `<boolean>` ('default =' `0`):: | |
433 | ||
434 | Enable/disable time drift fix. | |
435 | ||
436 | `--template` `<boolean>` ('default =' `0`):: | |
437 | ||
438 | Enable/disable Template. | |
439 | ||
440 | `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` :: | |
441 | ||
442 | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
443 | ||
444 | `--unique` `<boolean>` :: | |
445 | ||
446 | Assign a unique random ethernet address. | |
447 | + | |
448 | NOTE: Requires option(s): `archive` | |
449 | ||
450 | `--unused[n]` `[file=]<volume>` :: | |
451 | ||
452 | Reference to unused volumes. This is used internally, and should not be modified manually. | |
453 | ||
454 | `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: | |
455 | ||
456 | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). | |
457 | ||
458 | `--vcpus` `<integer> (1 - N)` ('default =' `0`):: | |
459 | ||
460 | Number of hotplugged vcpus. | |
461 | ||
462 | `--vga` `[[type=]<enum>] [,memory=<integer>]` :: | |
463 | ||
464 | Configure the VGA hardware. | |
465 | ||
466 | `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
467 | ||
468 | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
469 | ||
470 | `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`):: | |
471 | ||
472 | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | |
473 | ||
474 | `--vmstatestorage` `<string>` :: | |
475 | ||
476 | Default storage for VM state volumes/files. | |
477 | ||
478 | `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` :: | |
479 | ||
480 | Create a virtual hardware watchdog device. | |
481 | ||
482 | *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]` | |
483 | ||
484 | Delete a VM snapshot. | |
485 | ||
486 | `<vmid>`: `<integer> (1 - N)` :: | |
487 | ||
488 | The (unique) ID of the VM. | |
489 | ||
490 | `<snapname>`: `<string>` :: | |
491 | ||
492 | The name of the snapshot. | |
493 | ||
494 | `--force` `<boolean>` :: | |
495 | ||
496 | For removal from config file, even if removing disk snapshots fails. | |
497 | ||
498 | *qm destroy* `<vmid>` `[OPTIONS]` | |
499 | ||
500 | Destroy the VM and all used/owned volumes. Removes any VM specific | |
501 | permissions and firewall rules | |
502 | ||
503 | `<vmid>`: `<integer> (1 - N)` :: | |
504 | ||
505 | The (unique) ID of the VM. | |
506 | ||
507 | `--destroy-unreferenced-disks` `<boolean>` ('default =' `0`):: | |
508 | ||
509 | If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. | |
510 | ||
511 | `--purge` `<boolean>` :: | |
512 | ||
513 | Remove VMID from configurations, like backup & replication jobs and HA. | |
514 | ||
515 | `--skiplock` `<boolean>` :: | |
516 | ||
517 | Ignore locks - only root is allowed to use this option. | |
518 | ||
519 | *qm disk import* `<vmid> <source> <storage>` `[OPTIONS]` | |
520 | ||
521 | Import an external disk image as an unused disk in a VM. The | |
522 | image format has to be supported by qemu-img(1). | |
523 | ||
524 | `<vmid>`: `<integer> (1 - N)` :: | |
525 | ||
526 | The (unique) ID of the VM. | |
527 | ||
528 | `<source>`: `<string>` :: | |
529 | ||
530 | Path to the disk image to import | |
531 | ||
532 | `<storage>`: `<string>` :: | |
533 | ||
534 | Target storage ID | |
535 | ||
536 | `--format` `<qcow2 | raw | vmdk>` :: | |
537 | ||
538 | Target format | |
539 | ||
540 | *qm disk move* `<vmid> <disk> [<storage>]` `[OPTIONS]` | |
541 | ||
542 | Move volume to different storage or to a different VM. | |
543 | ||
544 | `<vmid>`: `<integer> (1 - N)` :: | |
545 | ||
546 | The (unique) ID of the VM. | |
547 | ||
548 | `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
549 | ||
550 | The disk you want to move. | |
551 | ||
552 | `<storage>`: `<string>` :: | |
553 | ||
554 | Target storage. | |
555 | ||
556 | `--bwlimit` `<integer> (0 - N)` ('default =' `move limit from datacenter or storage config`):: | |
557 | ||
558 | Override I/O bandwidth limit (in KiB/s). | |
559 | ||
560 | `--delete` `<boolean>` ('default =' `0`):: | |
561 | ||
562 | Delete the original disk after successful copy. By default the original disk is kept as unused disk. | |
563 | ||
564 | `--digest` `<string>` :: | |
565 | ||
566 | Prevent changes if current configuration file has different SHA1" | |
567 | ." digest. This can be used to prevent concurrent modifications. | |
568 | ||
569 | `--format` `<qcow2 | raw | vmdk>` :: | |
570 | ||
571 | Target Format. | |
572 | ||
573 | `--target-digest` `<string>` :: | |
574 | ||
575 | Prevent changes if the current config file of the target VM has a" | |
576 | ." different SHA1 digest. This can be used to detect concurrent modifications. | |
577 | ||
578 | `--target-disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | unused0 | unused1 | unused10 | unused100 | unused101 | unused102 | unused103 | unused104 | unused105 | unused106 | unused107 | unused108 | unused109 | unused11 | unused110 | unused111 | unused112 | unused113 | unused114 | unused115 | unused116 | unused117 | unused118 | unused119 | unused12 | unused120 | unused121 | unused122 | unused123 | unused124 | unused125 | unused126 | unused127 | unused128 | unused129 | unused13 | unused130 | unused131 | unused132 | unused133 | unused134 | unused135 | unused136 | unused137 | unused138 | unused139 | unused14 | unused140 | unused141 | unused142 | unused143 | unused144 | unused145 | unused146 | unused147 | unused148 | unused149 | unused15 | unused150 | unused151 | unused152 | unused153 | unused154 | unused155 | unused156 | unused157 | unused158 | unused159 | unused16 | unused160 | unused161 | unused162 | unused163 | unused164 | unused165 | unused166 | unused167 | unused168 | unused169 | unused17 | unused170 | unused171 | unused172 | unused173 | unused174 | unused175 | unused176 | unused177 | unused178 | unused179 | unused18 | unused180 | unused181 | unused182 | unused183 | unused184 | unused185 | unused186 | unused187 | unused188 | unused189 | unused19 | unused190 | unused191 | unused192 | unused193 | unused194 | unused195 | unused196 | unused197 | unused198 | unused199 | unused2 | unused20 | unused200 | unused201 | unused202 | unused203 | unused204 | unused205 | unused206 | unused207 | unused208 | unused209 | unused21 | unused210 | unused211 | unused212 | unused213 | unused214 | unused215 | unused216 | unused217 | unused218 | unused219 | unused22 | unused220 | unused221 | unused222 | unused223 | unused224 | unused225 | unused226 | unused227 | unused228 | unused229 | unused23 | unused230 | unused231 | unused232 | unused233 | unused234 | unused235 | unused236 | unused237 | unused238 | unused239 | unused24 | unused240 | unused241 | unused242 | unused243 | unused244 | unused245 | unused246 | unused247 | unused248 | unused249 | unused25 | unused250 | unused251 | unused252 | unused253 | unused254 | unused255 | unused26 | unused27 | unused28 | unused29 | unused3 | unused30 | unused31 | unused32 | unused33 | unused34 | unused35 | unused36 | unused37 | unused38 | unused39 | unused4 | unused40 | unused41 | unused42 | unused43 | unused44 | unused45 | unused46 | unused47 | unused48 | unused49 | unused5 | unused50 | unused51 | unused52 | unused53 | unused54 | unused55 | unused56 | unused57 | unused58 | unused59 | unused6 | unused60 | unused61 | unused62 | unused63 | unused64 | unused65 | unused66 | unused67 | unused68 | unused69 | unused7 | unused70 | unused71 | unused72 | unused73 | unused74 | unused75 | unused76 | unused77 | unused78 | unused79 | unused8 | unused80 | unused81 | unused82 | unused83 | unused84 | unused85 | unused86 | unused87 | unused88 | unused89 | unused9 | unused90 | unused91 | unused92 | unused93 | unused94 | unused95 | unused96 | unused97 | unused98 | unused99 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
579 | ||
580 | The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. | |
581 | ||
582 | `--target-vmid` `<integer> (1 - N)` :: | |
583 | ||
584 | The (unique) ID of the VM. | |
585 | ||
586 | *qm disk rescan* `[OPTIONS]` | |
587 | ||
588 | Rescan all storages and update disk sizes and unused disk images. | |
589 | ||
590 | `--dryrun` `<boolean>` ('default =' `0`):: | |
591 | ||
592 | Do not actually write changes out to VM config(s). | |
593 | ||
594 | `--vmid` `<integer> (1 - N)` :: | |
595 | ||
596 | The (unique) ID of the VM. | |
597 | ||
598 | *qm disk resize* `<vmid> <disk> <size>` `[OPTIONS]` | |
599 | ||
600 | Extend volume size. | |
601 | ||
602 | `<vmid>`: `<integer> (1 - N)` :: | |
603 | ||
604 | The (unique) ID of the VM. | |
605 | ||
606 | `<disk>`: `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
607 | ||
608 | The disk you want to resize. | |
609 | ||
610 | `<size>`: `\+?\d+(\.\d+)?[KMGT]?` :: | |
611 | ||
612 | 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. | |
613 | ||
614 | `--digest` `<string>` :: | |
615 | ||
616 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
617 | ||
618 | `--skiplock` `<boolean>` :: | |
619 | ||
620 | Ignore locks - only root is allowed to use this option. | |
621 | ||
622 | *qm disk unlink* `<vmid> --idlist <string>` `[OPTIONS]` | |
623 | ||
624 | Unlink/delete disk images. | |
625 | ||
626 | `<vmid>`: `<integer> (1 - N)` :: | |
627 | ||
628 | The (unique) ID of the VM. | |
629 | ||
630 | `--force` `<boolean>` :: | |
631 | ||
632 | 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. | |
633 | ||
634 | `--idlist` `<string>` :: | |
635 | ||
636 | A list of disk IDs you want to delete. | |
637 | ||
638 | *qm guest cmd* `<vmid> <command>` | |
639 | ||
640 | Execute QEMU Guest Agent commands. | |
641 | ||
642 | `<vmid>`: `<integer> (1 - N)` :: | |
643 | ||
644 | The (unique) ID of the VM. | |
645 | ||
646 | `<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>` :: | |
647 | ||
648 | The QGA command. | |
649 | ||
650 | *qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]` | |
651 | ||
652 | Executes the given command via the guest agent | |
653 | ||
654 | `<vmid>`: `<integer> (1 - N)` :: | |
655 | ||
656 | The (unique) ID of the VM. | |
657 | ||
658 | `<extra-args>`: `<array>` :: | |
659 | ||
660 | Extra arguments as array | |
661 | ||
662 | `--pass-stdin` `<boolean>` ('default =' `0`):: | |
663 | ||
664 | When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB. | |
665 | ||
666 | `--synchronous` `<boolean>` ('default =' `1`):: | |
667 | ||
668 | If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout. | |
669 | ||
670 | `--timeout` `<integer> (0 - N)` ('default =' `30`):: | |
671 | ||
672 | The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate | |
673 | ||
674 | *qm guest exec-status* `<vmid> <pid>` | |
675 | ||
676 | Gets the status of the given pid started by the guest-agent | |
677 | ||
678 | `<vmid>`: `<integer> (1 - N)` :: | |
679 | ||
680 | The (unique) ID of the VM. | |
681 | ||
682 | `<pid>`: `<integer>` :: | |
683 | ||
684 | The PID to query | |
685 | ||
686 | *qm guest passwd* `<vmid> <username>` `[OPTIONS]` | |
687 | ||
688 | Sets the password for the given user to the given password | |
689 | ||
690 | `<vmid>`: `<integer> (1 - N)` :: | |
691 | ||
692 | The (unique) ID of the VM. | |
693 | ||
694 | `<username>`: `<string>` :: | |
695 | ||
696 | The user to set the password for. | |
697 | ||
698 | `--crypted` `<boolean>` ('default =' `0`):: | |
699 | ||
700 | set to 1 if the password has already been passed through crypt() | |
701 | ||
702 | *qm help* `[OPTIONS]` | |
703 | ||
704 | Get help about specified command. | |
705 | ||
706 | `--extra-args` `<array>` :: | |
707 | ||
708 | Shows help for a specific command | |
709 | ||
710 | `--verbose` `<boolean>` :: | |
711 | ||
712 | Verbose output format. | |
713 | ||
714 | *qm importdisk* | |
715 | ||
716 | An alias for 'qm disk import'. | |
717 | ||
718 | *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]` | |
719 | ||
720 | Create a new VM using parameters read from an OVF manifest | |
721 | ||
722 | `<vmid>`: `<integer> (1 - N)` :: | |
723 | ||
724 | The (unique) ID of the VM. | |
725 | ||
726 | `<manifest>`: `<string>` :: | |
727 | ||
728 | path to the ovf file | |
729 | ||
730 | `<storage>`: `<string>` :: | |
731 | ||
732 | Target storage ID | |
733 | ||
734 | `--dryrun` `<boolean>` :: | |
735 | ||
736 | Print a parsed representation of the extracted OVF parameters, but do not create a VM | |
737 | ||
738 | `--format` `<qcow2 | raw | vmdk>` :: | |
739 | ||
740 | Target format | |
741 | ||
742 | *qm list* `[OPTIONS]` | |
743 | ||
744 | Virtual machine index (per node). | |
745 | ||
746 | `--full` `<boolean>` :: | |
747 | ||
748 | Determine the full status of active VMs. | |
749 | ||
750 | *qm listsnapshot* `<vmid>` | |
751 | ||
752 | List all snapshots. | |
753 | ||
754 | `<vmid>`: `<integer> (1 - N)` :: | |
755 | ||
756 | The (unique) ID of the VM. | |
757 | ||
758 | *qm migrate* `<vmid> <target>` `[OPTIONS]` | |
759 | ||
760 | Migrate virtual machine. Creates a new migration task. | |
761 | ||
762 | `<vmid>`: `<integer> (1 - N)` :: | |
763 | ||
764 | The (unique) ID of the VM. | |
765 | ||
766 | `<target>`: `<string>` :: | |
767 | ||
768 | Target node. | |
769 | ||
770 | `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: | |
771 | ||
772 | Override I/O bandwidth limit (in KiB/s). | |
773 | ||
774 | `--force` `<boolean>` :: | |
775 | ||
776 | Allow to migrate VMs which use local devices. Only root may use this option. | |
777 | ||
778 | `--migration_network` `<string>` :: | |
779 | ||
780 | CIDR of the (sub) network that is used for migration. | |
781 | ||
782 | `--migration_type` `<insecure | secure>` :: | |
783 | ||
784 | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. | |
785 | ||
786 | `--online` `<boolean>` :: | |
787 | ||
788 | Use online/live migration if VM is running. Ignored if VM is stopped. | |
789 | ||
790 | `--targetstorage` `<string>` :: | |
791 | ||
792 | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | |
793 | ||
794 | `--with-local-disks` `<boolean>` :: | |
795 | ||
796 | Enable live storage migration for local disk | |
797 | ||
798 | *qm monitor* `<vmid>` | |
799 | ||
800 | Enter QEMU Monitor interface. | |
801 | ||
802 | `<vmid>`: `<integer> (1 - N)` :: | |
803 | ||
804 | The (unique) ID of the VM. | |
805 | ||
806 | *qm move-disk* | |
807 | ||
808 | An alias for 'qm disk move'. | |
809 | ||
810 | *qm move_disk* | |
811 | ||
812 | An alias for 'qm disk move'. | |
813 | ||
814 | *qm mtunnel* | |
815 | ||
816 | Used by qmigrate - do not use manually. | |
817 | ||
818 | *qm nbdstop* `<vmid>` | |
819 | ||
820 | Stop embedded nbd server. | |
821 | ||
822 | `<vmid>`: `<integer> (1 - N)` :: | |
823 | ||
824 | The (unique) ID of the VM. | |
825 | ||
826 | *qm pending* `<vmid>` | |
827 | ||
828 | Get the virtual machine configuration with both current and pending values. | |
829 | ||
830 | `<vmid>`: `<integer> (1 - N)` :: | |
831 | ||
832 | The (unique) ID of the VM. | |
833 | ||
834 | *qm reboot* `<vmid>` `[OPTIONS]` | |
835 | ||
836 | Reboot the VM by shutting it down, and starting it again. Applies pending | |
837 | changes. | |
838 | ||
839 | `<vmid>`: `<integer> (1 - N)` :: | |
840 | ||
841 | The (unique) ID of the VM. | |
842 | ||
843 | `--timeout` `<integer> (0 - N)` :: | |
844 | ||
845 | Wait maximal timeout seconds for the shutdown. | |
846 | ||
847 | *qm remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]` | |
848 | ||
849 | Migrate virtual machine to a remote cluster. Creates a new migration task. | |
850 | EXPERIMENTAL feature! | |
851 | ||
852 | `<vmid>`: `<integer> (1 - N)` :: | |
853 | ||
854 | The (unique) ID of the VM. | |
855 | ||
856 | `<target-vmid>`: `<integer> (1 - N)` :: | |
857 | ||
858 | The (unique) ID of the VM. | |
859 | ||
860 | `<target-endpoint>`: `apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]` :: | |
861 | ||
862 | Remote target endpoint | |
863 | ||
864 | `--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: | |
865 | ||
866 | Override I/O bandwidth limit (in KiB/s). | |
867 | ||
868 | `--delete` `<boolean>` ('default =' `0`):: | |
869 | ||
870 | Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. | |
871 | ||
872 | `--online` `<boolean>` :: | |
873 | ||
874 | Use online/live migration if VM is running. Ignored if VM is stopped. | |
875 | ||
876 | `--target-bridge` `<string>` :: | |
877 | ||
878 | Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. | |
879 | ||
880 | `--target-storage` `<string>` :: | |
881 | ||
882 | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | |
883 | ||
884 | *qm rescan* | |
885 | ||
886 | An alias for 'qm disk rescan'. | |
887 | ||
888 | *qm reset* `<vmid>` `[OPTIONS]` | |
889 | ||
890 | Reset virtual machine. | |
891 | ||
892 | `<vmid>`: `<integer> (1 - N)` :: | |
893 | ||
894 | The (unique) ID of the VM. | |
895 | ||
896 | `--skiplock` `<boolean>` :: | |
897 | ||
898 | Ignore locks - only root is allowed to use this option. | |
899 | ||
900 | *qm resize* | |
901 | ||
902 | An alias for 'qm disk resize'. | |
903 | ||
904 | *qm resume* `<vmid>` `[OPTIONS]` | |
905 | ||
906 | Resume virtual machine. | |
907 | ||
908 | `<vmid>`: `<integer> (1 - N)` :: | |
909 | ||
910 | The (unique) ID of the VM. | |
911 | ||
912 | `--nocheck` `<boolean>` :: | |
913 | ||
914 | no description available | |
915 | ||
916 | `--skiplock` `<boolean>` :: | |
917 | ||
918 | Ignore locks - only root is allowed to use this option. | |
919 | ||
920 | *qm rollback* `<vmid> <snapname>` `[OPTIONS]` | |
921 | ||
922 | Rollback VM state to specified snapshot. | |
923 | ||
924 | `<vmid>`: `<integer> (1 - N)` :: | |
925 | ||
926 | The (unique) ID of the VM. | |
927 | ||
928 | `<snapname>`: `<string>` :: | |
929 | ||
930 | The name of the snapshot. | |
931 | ||
932 | `--start` `<boolean>` ('default =' `0`):: | |
933 | ||
934 | Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.) | |
935 | ||
936 | *qm sendkey* `<vmid> <key>` `[OPTIONS]` | |
937 | ||
938 | Send key event to virtual machine. | |
939 | ||
940 | `<vmid>`: `<integer> (1 - N)` :: | |
941 | ||
942 | The (unique) ID of the VM. | |
943 | ||
944 | `<key>`: `<string>` :: | |
945 | ||
946 | The key (qemu monitor encoding). | |
947 | ||
948 | `--skiplock` `<boolean>` :: | |
949 | ||
950 | Ignore locks - only root is allowed to use this option. | |
951 | ||
952 | *qm set* `<vmid>` `[OPTIONS]` | |
953 | ||
954 | Set virtual machine options (synchrounous API) - You should consider using | |
955 | the POST method instead for any actions involving hotplug or storage | |
956 | allocation. | |
957 | ||
958 | `<vmid>`: `<integer> (1 - N)` :: | |
959 | ||
960 | The (unique) ID of the VM. | |
961 | ||
962 | `--acpi` `<boolean>` ('default =' `1`):: | |
963 | ||
964 | Enable/disable ACPI. | |
965 | ||
966 | `--affinity` `<string>` :: | |
967 | ||
968 | List of host cores used to execute guest processes, for example: 0,5,8-11 | |
969 | ||
970 | `--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]` :: | |
971 | ||
972 | Enable/disable communication with the QEMU Guest Agent and its properties. | |
973 | ||
974 | `--arch` `<aarch64 | x86_64>` :: | |
975 | ||
976 | Virtual processor architecture. Defaults to the host. | |
977 | ||
978 | `--args` `<string>` :: | |
979 | ||
980 | Arbitrary arguments passed to kvm. | |
981 | ||
982 | `--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice|none>]` :: | |
983 | ||
984 | Configure a audio device, useful in combination with QXL/Spice. | |
985 | ||
986 | `--autostart` `<boolean>` ('default =' `0`):: | |
987 | ||
988 | Automatic restart after crash (currently ignored). | |
989 | ||
990 | `--balloon` `<integer> (0 - N)` :: | |
991 | ||
992 | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. | |
993 | ||
994 | `--bios` `<ovmf | seabios>` ('default =' `seabios`):: | |
995 | ||
996 | Select BIOS implementation. | |
997 | ||
998 | `--boot` `[[legacy=]<[acdn]{1,4}>] [,order=<device[;device...]>]` :: | |
999 | ||
1000 | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. | |
1001 | ||
1002 | `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: | |
1003 | ||
1004 | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. | |
1005 | ||
1006 | `--cdrom` `<volume>` :: | |
1007 | ||
1008 | This is an alias for option -ide2 | |
1009 | ||
1010 | `--cicustom` `[meta=<volume>] [,network=<volume>] [,user=<volume>] [,vendor=<volume>]` :: | |
1011 | ||
1012 | cloud-init: Specify custom files to replace the automatically generated ones at start. | |
1013 | ||
1014 | `--cipassword` `<password>` :: | |
1015 | ||
1016 | 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. | |
1017 | ||
1018 | `--citype` `<configdrive2 | nocloud | opennebula>` :: | |
1019 | ||
1020 | 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. | |
1021 | ||
1022 | `--ciupgrade` `<boolean>` :: | |
1023 | ||
1024 | cloud-init: do an automatic package upgrade after the first boot. | |
1025 | ||
1026 | `--ciuser` `<string>` :: | |
1027 | ||
1028 | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. | |
1029 | ||
1030 | `--cores` `<integer> (1 - N)` ('default =' `1`):: | |
1031 | ||
1032 | The number of cores per socket. | |
1033 | ||
1034 | `--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` :: | |
1035 | ||
1036 | Emulated CPU type. | |
1037 | ||
1038 | `--cpulimit` `<number> (0 - 128)` ('default =' `0`):: | |
1039 | ||
1040 | Limit of CPU usage. | |
1041 | ||
1042 | `--cpuunits` `<integer> (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: | |
1043 | ||
1044 | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. | |
1045 | ||
1046 | `--delete` `<string>` :: | |
1047 | ||
1048 | A list of settings you want to delete. | |
1049 | ||
1050 | `--description` `<string>` :: | |
1051 | ||
1052 | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. | |
1053 | ||
1054 | `--digest` `<string>` :: | |
1055 | ||
1056 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
1057 | ||
1058 | `--efidisk0` `[file=]<volume> [,efitype=<2m|4m>] [,format=<enum>] [,import-from=<source volume>] [,pre-enrolled-keys=<1|0>] [,size=<DiskSize>]` :: | |
1059 | ||
1060 | Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
1061 | ||
1062 | `--force` `<boolean>` :: | |
1063 | ||
1064 | 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. | |
1065 | + | |
1066 | NOTE: Requires option(s): `delete` | |
1067 | ||
1068 | `--freeze` `<boolean>` :: | |
1069 | ||
1070 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
1071 | ||
1072 | `--hookscript` `<string>` :: | |
1073 | ||
1074 | Script that will be executed during various steps in the vms lifetime. | |
1075 | ||
1076 | `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,device-id=<hex id>] [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,sub-device-id=<hex id>] [,sub-vendor-id=<hex id>] [,vendor-id=<hex id>] [,x-vga=<1|0>]` :: | |
1077 | ||
1078 | Map host PCI devices into guest. | |
1079 | ||
1080 | `--hotplug` `<string>` ('default =' `network,disk,usb`):: | |
1081 | ||
1082 | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. | |
1083 | ||
1084 | `--hugepages` `<1024 | 2 | any>` :: | |
1085 | ||
1086 | Enable/disable hugepages memory. | |
1087 | ||
1088 | `--ide[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>]` :: | |
1089 | ||
1090 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
1091 | ||
1092 | `--ipconfig[n]` `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` :: | |
1093 | ||
1094 | cloud-init: Specify IP addresses and gateways for the corresponding interface. | |
1095 | + | |
1096 | IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. | |
1097 | + | |
1098 | The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit | |
1099 | gateway should be provided. | |
1100 | For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires | |
1101 | cloud-init 19.4 or newer. | |
1102 | + | |
1103 | If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using | |
1104 | dhcp on IPv4. | |
1105 | ||
1106 | `--ivshmem` `size=<integer> [,name=<string>]` :: | |
1107 | ||
1108 | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | |
1109 | ||
1110 | `--keephugepages` `<boolean>` ('default =' `0`):: | |
1111 | ||
1112 | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | |
1113 | ||
1114 | `--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>` :: | |
1115 | ||
1116 | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. | |
1117 | ||
1118 | `--kvm` `<boolean>` ('default =' `1`):: | |
1119 | ||
1120 | Enable/disable KVM hardware virtualization. | |
1121 | ||
1122 | `--localtime` `<boolean>` :: | |
1123 | ||
1124 | Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. | |
1125 | ||
1126 | `--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` :: | |
1127 | ||
1128 | Lock/unlock the VM. | |
1129 | ||
1130 | `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: | |
1131 | ||
1132 | Specifies the QEMU machine type. | |
1133 | ||
1134 | `--memory` `<integer> (16 - N)` ('default =' `512`):: | |
1135 | ||
1136 | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. | |
1137 | ||
1138 | `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`):: | |
1139 | ||
1140 | Set maximum tolerated downtime (in seconds) for migrations. | |
1141 | ||
1142 | `--migrate_speed` `<integer> (0 - N)` ('default =' `0`):: | |
1143 | ||
1144 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
1145 | ||
1146 | `--name` `<string>` :: | |
1147 | ||
1148 | Set a name for the VM. Only used on the configuration web interface. | |
1149 | ||
1150 | `--nameserver` `<string>` :: | |
1151 | ||
1152 | 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. | |
1153 | ||
1154 | `--net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` :: | |
1155 | ||
1156 | Specify network devices. | |
1157 | ||
1158 | `--numa` `<boolean>` ('default =' `0`):: | |
1159 | ||
1160 | Enable/disable NUMA. | |
1161 | ||
1162 | `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: | |
1163 | ||
1164 | NUMA topology. | |
1165 | ||
1166 | `--onboot` `<boolean>` ('default =' `0`):: | |
1167 | ||
1168 | Specifies whether a VM will be started during system bootup. | |
1169 | ||
1170 | `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win11 | win7 | win8 | wvista | wxp>` :: | |
1171 | ||
1172 | Specify guest operating system. | |
1173 | ||
1174 | `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: | |
1175 | ||
1176 | Map host parallel devices (n is 0 to 2). | |
1177 | ||
1178 | `--protection` `<boolean>` ('default =' `0`):: | |
1179 | ||
1180 | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | |
1181 | ||
1182 | `--reboot` `<boolean>` ('default =' `1`):: | |
1183 | ||
1184 | Allow reboot. If set to '0' the VM exit on reboot. | |
1185 | ||
1186 | `--revert` `<string>` :: | |
1187 | ||
1188 | Revert a pending change. | |
1189 | ||
1190 | `--rng0` `[source=]</dev/urandom|/dev/random|/dev/hwrng> [,max_bytes=<integer>] [,period=<integer>]` :: | |
1191 | ||
1192 | Configure a VirtIO-based Random Number Generator. | |
1193 | ||
1194 | `--sata[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>]` :: | |
1195 | ||
1196 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
1197 | ||
1198 | `--scsi[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>] [,ro=<1|0>] [,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>]` :: | |
1199 | ||
1200 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
1201 | ||
1202 | `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`):: | |
1203 | ||
1204 | SCSI controller model | |
1205 | ||
1206 | `--searchdomain` `<string>` :: | |
1207 | ||
1208 | 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. | |
1209 | ||
1210 | `--serial[n]` `(/dev/.+|socket)` :: | |
1211 | ||
1212 | Create a serial device inside the VM (n is 0 to 3) | |
1213 | ||
1214 | `--shares` `<integer> (0 - 50000)` ('default =' `1000`):: | |
1215 | ||
1216 | 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. | |
1217 | ||
1218 | `--skiplock` `<boolean>` :: | |
1219 | ||
1220 | Ignore locks - only root is allowed to use this option. | |
1221 | ||
1222 | `--smbios1` `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` :: | |
1223 | ||
1224 | Specify SMBIOS type 1 fields. | |
1225 | ||
1226 | `--smp` `<integer> (1 - N)` ('default =' `1`):: | |
1227 | ||
1228 | The number of CPUs. Please use option -sockets instead. | |
1229 | ||
1230 | `--sockets` `<integer> (1 - N)` ('default =' `1`):: | |
1231 | ||
1232 | The number of CPU sockets. | |
1233 | ||
1234 | `--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` :: | |
1235 | ||
1236 | Configure additional enhancements for SPICE. | |
1237 | ||
1238 | `--sshkeys` `<filepath>` :: | |
1239 | ||
1240 | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). | |
1241 | ||
1242 | `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: | |
1243 | ||
1244 | 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'. | |
1245 | ||
1246 | `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
1247 | ||
1248 | 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. | |
1249 | ||
1250 | `--tablet` `<boolean>` ('default =' `1`):: | |
1251 | ||
1252 | Enable/disable the USB tablet device. | |
1253 | ||
1254 | `--tags` `<string>` :: | |
1255 | ||
1256 | Tags of the VM. This is only meta information. | |
1257 | ||
1258 | `--tdf` `<boolean>` ('default =' `0`):: | |
1259 | ||
1260 | Enable/disable time drift fix. | |
1261 | ||
1262 | `--template` `<boolean>` ('default =' `0`):: | |
1263 | ||
1264 | Enable/disable Template. | |
1265 | ||
1266 | `--tpmstate0` `[file=]<volume> [,import-from=<source volume>] [,size=<DiskSize>] [,version=<v1.2|v2.0>]` :: | |
1267 | ||
1268 | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
1269 | ||
1270 | `--unused[n]` `[file=]<volume>` :: | |
1271 | ||
1272 | Reference to unused volumes. This is used internally, and should not be modified manually. | |
1273 | ||
1274 | `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: | |
1275 | ||
1276 | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). | |
1277 | ||
1278 | `--vcpus` `<integer> (1 - N)` ('default =' `0`):: | |
1279 | ||
1280 | Number of hotplugged vcpus. | |
1281 | ||
1282 | `--vga` `[[type=]<enum>] [,memory=<integer>]` :: | |
1283 | ||
1284 | Configure the VGA hardware. | |
1285 | ||
1286 | `--virtio[n]` `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,import-from=<source volume>] [,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>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
1287 | ||
1288 | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. | |
1289 | ||
1290 | `--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`):: | |
1291 | ||
1292 | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | |
1293 | ||
1294 | `--vmstatestorage` `<string>` :: | |
1295 | ||
1296 | Default storage for VM state volumes/files. | |
1297 | ||
1298 | `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` :: | |
1299 | ||
1300 | Create a virtual hardware watchdog device. | |
1301 | ||
1302 | *qm showcmd* `<vmid>` `[OPTIONS]` | |
1303 | ||
1304 | Show command line which is used to start the VM (debug info). | |
1305 | ||
1306 | `<vmid>`: `<integer> (1 - N)` :: | |
1307 | ||
1308 | The (unique) ID of the VM. | |
1309 | ||
1310 | `--pretty` `<boolean>` ('default =' `0`):: | |
1311 | ||
1312 | Puts each option on a new line to enhance human readability | |
1313 | ||
1314 | `--snapshot` `<string>` :: | |
1315 | ||
1316 | Fetch config values from given snapshot. | |
1317 | ||
1318 | *qm shutdown* `<vmid>` `[OPTIONS]` | |
1319 | ||
1320 | Shutdown virtual machine. This is similar to pressing the power button on a | |
1321 | physical machine.This will send an ACPI event for the guest OS, which | |
1322 | should then proceed to a clean shutdown. | |
1323 | ||
1324 | `<vmid>`: `<integer> (1 - N)` :: | |
1325 | ||
1326 | The (unique) ID of the VM. | |
1327 | ||
1328 | `--forceStop` `<boolean>` ('default =' `0`):: | |
1329 | ||
1330 | Make sure the VM stops. | |
1331 | ||
1332 | `--keepActive` `<boolean>` ('default =' `0`):: | |
1333 | ||
1334 | Do not deactivate storage volumes. | |
1335 | ||
1336 | `--skiplock` `<boolean>` :: | |
1337 | ||
1338 | Ignore locks - only root is allowed to use this option. | |
1339 | ||
1340 | `--timeout` `<integer> (0 - N)` :: | |
1341 | ||
1342 | Wait maximal timeout seconds. | |
1343 | ||
1344 | *qm snapshot* `<vmid> <snapname>` `[OPTIONS]` | |
1345 | ||
1346 | Snapshot a VM. | |
1347 | ||
1348 | `<vmid>`: `<integer> (1 - N)` :: | |
1349 | ||
1350 | The (unique) ID of the VM. | |
1351 | ||
1352 | `<snapname>`: `<string>` :: | |
1353 | ||
1354 | The name of the snapshot. | |
1355 | ||
1356 | `--description` `<string>` :: | |
1357 | ||
1358 | A textual description or comment. | |
1359 | ||
1360 | `--vmstate` `<boolean>` :: | |
1361 | ||
1362 | Save the vmstate | |
1363 | ||
1364 | *qm start* `<vmid>` `[OPTIONS]` | |
1365 | ||
1366 | Start virtual machine. | |
1367 | ||
1368 | `<vmid>`: `<integer> (1 - N)` :: | |
1369 | ||
1370 | The (unique) ID of the VM. | |
1371 | ||
1372 | `--force-cpu` `<string>` :: | |
1373 | ||
1374 | Override QEMU's -cpu argument with the given string. | |
1375 | ||
1376 | `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: | |
1377 | ||
1378 | Specifies the QEMU machine type. | |
1379 | ||
1380 | `--migratedfrom` `<string>` :: | |
1381 | ||
1382 | The cluster node name. | |
1383 | ||
1384 | `--migration_network` `<string>` :: | |
1385 | ||
1386 | CIDR of the (sub) network that is used for migration. | |
1387 | ||
1388 | `--migration_type` `<insecure | secure>` :: | |
1389 | ||
1390 | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. | |
1391 | ||
1392 | `--skiplock` `<boolean>` :: | |
1393 | ||
1394 | Ignore locks - only root is allowed to use this option. | |
1395 | ||
1396 | `--stateuri` `<string>` :: | |
1397 | ||
1398 | Some command save/restore state from this location. | |
1399 | ||
1400 | `--targetstorage` `<string>` :: | |
1401 | ||
1402 | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | |
1403 | ||
1404 | `--timeout` `<integer> (0 - N)` ('default =' `max(30, vm memory in GiB)`):: | |
1405 | ||
1406 | Wait maximal timeout seconds. | |
1407 | ||
1408 | *qm status* `<vmid>` `[OPTIONS]` | |
1409 | ||
1410 | Show VM status. | |
1411 | ||
1412 | `<vmid>`: `<integer> (1 - N)` :: | |
1413 | ||
1414 | The (unique) ID of the VM. | |
1415 | ||
1416 | `--verbose` `<boolean>` :: | |
1417 | ||
1418 | Verbose output format | |
1419 | ||
1420 | *qm stop* `<vmid>` `[OPTIONS]` | |
1421 | ||
1422 | Stop virtual machine. The qemu process will exit immediately. Thisis akin | |
1423 | to pulling the power plug of a running computer and may damage the VM data | |
1424 | ||
1425 | `<vmid>`: `<integer> (1 - N)` :: | |
1426 | ||
1427 | The (unique) ID of the VM. | |
1428 | ||
1429 | `--keepActive` `<boolean>` ('default =' `0`):: | |
1430 | ||
1431 | Do not deactivate storage volumes. | |
1432 | ||
1433 | `--migratedfrom` `<string>` :: | |
1434 | ||
1435 | The cluster node name. | |
1436 | ||
1437 | `--skiplock` `<boolean>` :: | |
1438 | ||
1439 | Ignore locks - only root is allowed to use this option. | |
1440 | ||
1441 | `--timeout` `<integer> (0 - N)` :: | |
1442 | ||
1443 | Wait maximal timeout seconds. | |
1444 | ||
1445 | *qm suspend* `<vmid>` `[OPTIONS]` | |
1446 | ||
1447 | Suspend virtual machine. | |
1448 | ||
1449 | `<vmid>`: `<integer> (1 - N)` :: | |
1450 | ||
1451 | The (unique) ID of the VM. | |
1452 | ||
1453 | `--skiplock` `<boolean>` :: | |
1454 | ||
1455 | Ignore locks - only root is allowed to use this option. | |
1456 | ||
1457 | `--statestorage` `<string>` :: | |
1458 | ||
1459 | The storage for the VM state | |
1460 | + | |
1461 | NOTE: Requires option(s): `todisk` | |
1462 | ||
1463 | `--todisk` `<boolean>` ('default =' `0`):: | |
1464 | ||
1465 | If set, suspends the VM to disk. Will be resumed on next VM start. | |
1466 | ||
1467 | *qm template* `<vmid>` `[OPTIONS]` | |
1468 | ||
1469 | Create a Template. | |
1470 | ||
1471 | `<vmid>`: `<integer> (1 - N)` :: | |
1472 | ||
1473 | The (unique) ID of the VM. | |
1474 | ||
1475 | `--disk` `<efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi14 | scsi15 | scsi16 | scsi17 | scsi18 | scsi19 | scsi2 | scsi20 | scsi21 | scsi22 | scsi23 | scsi24 | scsi25 | scsi26 | scsi27 | scsi28 | scsi29 | scsi3 | scsi30 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | tpmstate0 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9>` :: | |
1476 | ||
1477 | If you want to convert only 1 disk to base image. | |
1478 | ||
1479 | *qm terminal* `<vmid>` `[OPTIONS]` | |
1480 | ||
1481 | Open a terminal using a serial device (The VM need to have a serial device | |
1482 | configured, for example 'serial0: socket') | |
1483 | ||
1484 | `<vmid>`: `<integer> (1 - N)` :: | |
1485 | ||
1486 | The (unique) ID of the VM. | |
1487 | ||
1488 | `--escape` `<string>` ('default =' `^O`):: | |
1489 | ||
1490 | Escape character. | |
1491 | ||
1492 | `--iface` `<serial0 | serial1 | serial2 | serial3>` :: | |
1493 | ||
1494 | Select the serial device. By default we simply use the first suitable device. | |
1495 | ||
1496 | *qm unlink* | |
1497 | ||
1498 | An alias for 'qm disk unlink'. | |
1499 | ||
1500 | *qm unlock* `<vmid>` | |
1501 | ||
1502 | Unlock the VM. | |
1503 | ||
1504 | `<vmid>`: `<integer> (1 - N)` :: | |
1505 | ||
1506 | The (unique) ID of the VM. | |
1507 | ||
1508 | *qm vncproxy* `<vmid>` | |
1509 | ||
1510 | Proxy VM VNC traffic to stdin/stdout | |
1511 | ||
1512 | `<vmid>`: `<integer> (1 - N)` :: | |
1513 | ||
1514 | The (unique) ID of the VM. | |
1515 | ||
1516 | *qm wait* `<vmid>` `[OPTIONS]` | |
1517 | ||
1518 | Wait until the VM is stopped. | |
1519 | ||
1520 | `<vmid>`: `<integer> (1 - N)` :: | |
1521 | ||
1522 | The (unique) ID of the VM. | |
1523 | ||
1524 | `--timeout` `<integer> (1 - N)` :: | |
1525 | ||
1526 | Timeout in seconds. Default is to wait forever. | |
1527 | ||
1528 |