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