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