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