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