]>
Commit | Line | Data |
---|---|---|
1 | *qm* `<COMMAND> [ARGS] [OPTIONS]` | |
2 | ||
3 | *qm agent* `<vmid> <command>` | |
4 | ||
5 | Execute Qemu Guest Agent commands. | |
6 | ||
7 | `<vmid>`: `<integer> (1 - N)` :: | |
8 | ||
9 | The (unique) ID of the VM. | |
10 | ||
11 | `<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-memory-block-info | get-memory-blocks | get-time | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` :: | |
12 | ||
13 | The QGA command. | |
14 | ||
15 | ||
16 | ||
17 | *qm clone* `<vmid> <newid>` `[OPTIONS]` | |
18 | ||
19 | Create a copy of virtual machine/template. | |
20 | ||
21 | `<vmid>`: `<integer> (1 - N)` :: | |
22 | ||
23 | The (unique) ID of the VM. | |
24 | ||
25 | `<newid>`: `<integer> (1 - N)` :: | |
26 | ||
27 | VMID for the clone. | |
28 | ||
29 | `--description` `<string>` :: | |
30 | ||
31 | Description for the new VM. | |
32 | ||
33 | `--format` `<qcow2 | raw | vmdk>` :: | |
34 | ||
35 | Target format for file storage. | |
36 | + | |
37 | NOTE: Requires option(s): `full` | |
38 | ||
39 | `--full` `<boolean>` ('default =' `0`):: | |
40 | ||
41 | Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. | |
42 | ||
43 | `--name` `<string>` :: | |
44 | ||
45 | Set a name for the new VM. | |
46 | ||
47 | `--pool` `<string>` :: | |
48 | ||
49 | Add the new VM to the specified pool. | |
50 | ||
51 | `--snapname` `<string>` :: | |
52 | ||
53 | The name of the snapshot. | |
54 | ||
55 | `--storage` `<string>` :: | |
56 | ||
57 | Target storage for full clone. | |
58 | + | |
59 | NOTE: Requires option(s): `full` | |
60 | ||
61 | `--target` `<string>` :: | |
62 | ||
63 | Target node. Only allowed if the original VM is on shared storage. | |
64 | ||
65 | ||
66 | ||
67 | *qm config* `<vmid>` `[OPTIONS]` | |
68 | ||
69 | Get current virtual machine configuration. This does not include pending | |
70 | configuration changes (see 'pending' API). | |
71 | ||
72 | `<vmid>`: `<integer> (1 - N)` :: | |
73 | ||
74 | The (unique) ID of the VM. | |
75 | ||
76 | `--current` `<boolean>` ('default =' `0`):: | |
77 | ||
78 | Get current values (instead of pending values). | |
79 | ||
80 | ||
81 | ||
82 | *qm create* `<vmid>` `[OPTIONS]` | |
83 | ||
84 | Create or restore a virtual machine. | |
85 | ||
86 | `<vmid>`: `<integer> (1 - N)` :: | |
87 | ||
88 | The (unique) ID of the VM. | |
89 | ||
90 | `--acpi` `<boolean>` ('default =' `1`):: | |
91 | ||
92 | Enable/disable ACPI. | |
93 | ||
94 | `--agent` `<boolean>` ('default =' `0`):: | |
95 | ||
96 | Enable/disable Qemu GuestAgent. | |
97 | ||
98 | `--archive` `<string>` :: | |
99 | ||
100 | The backup file. | |
101 | ||
102 | `--args` `<string>` :: | |
103 | ||
104 | Arbitrary arguments passed to kvm. | |
105 | ||
106 | `--autostart` `<boolean>` ('default =' `0`):: | |
107 | ||
108 | Automatic restart after crash (currently ignored). | |
109 | ||
110 | `--balloon` `<integer> (0 - N)` :: | |
111 | ||
112 | Amount of target RAM for the VM in MB. Using zero disables the ballon driver. | |
113 | ||
114 | `--bios` `<ovmf | seabios>` ('default =' `seabios`):: | |
115 | ||
116 | Select BIOS implementation. | |
117 | ||
118 | `--boot` `[acdn]{1,4}` ('default =' `cdn`):: | |
119 | ||
120 | Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). | |
121 | ||
122 | `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: | |
123 | ||
124 | Enable booting from specified disk. | |
125 | ||
126 | `--cdrom` `<volume>` :: | |
127 | ||
128 | This is an alias for option -ide2 | |
129 | ||
130 | `--cores` `<integer> (1 - N)` ('default =' `1`):: | |
131 | ||
132 | The number of cores per socket. | |
133 | ||
134 | `--cpu` `[cputype=]<enum> [,hidden=<1|0>]` :: | |
135 | ||
136 | Emulated CPU type. | |
137 | ||
138 | `--cpulimit` `<number> (0 - 128)` ('default =' `0`):: | |
139 | ||
140 | Limit of CPU usage. | |
141 | ||
142 | `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`):: | |
143 | ||
144 | CPU weight for a VM. | |
145 | ||
146 | `--description` `<string>` :: | |
147 | ||
148 | Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. | |
149 | ||
150 | `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` :: | |
151 | ||
152 | Configure a Disk for storing EFI vars | |
153 | ||
154 | `--force` `<boolean>` :: | |
155 | ||
156 | Allow to overwrite existing VM. | |
157 | + | |
158 | NOTE: Requires option(s): `archive` | |
159 | ||
160 | `--freeze` `<boolean>` :: | |
161 | ||
162 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
163 | ||
164 | `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` :: | |
165 | ||
166 | Map host PCI devices into guest. | |
167 | ||
168 | `--hotplug` `<string>` ('default =' `network,disk,usb`):: | |
169 | ||
170 | 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'. | |
171 | ||
172 | `--hugepages` `<1024 | 2 | any>` :: | |
173 | ||
174 | Enable/disable hugepages memory. | |
175 | ||
176 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
177 | ||
178 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). | |
179 | ||
180 | `--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>` ('default =' `en-us`):: | |
181 | ||
182 | Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. | |
183 | ||
184 | `--kvm` `<boolean>` ('default =' `1`):: | |
185 | ||
186 | Enable/disable KVM hardware virtualization. | |
187 | ||
188 | `--localtime` `<boolean>` :: | |
189 | ||
190 | Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. | |
191 | ||
192 | `--lock` `<backup | migrate | rollback | snapshot>` :: | |
193 | ||
194 | Lock/unlock the VM. | |
195 | ||
196 | `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: | |
197 | ||
198 | Specific the Qemu machine type. | |
199 | ||
200 | `--memory` `<integer> (16 - N)` ('default =' `512`):: | |
201 | ||
202 | Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. | |
203 | ||
204 | `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`):: | |
205 | ||
206 | Set maximum tolerated downtime (in seconds) for migrations. | |
207 | ||
208 | `--migrate_speed` `<integer> (0 - N)` ('default =' `0`):: | |
209 | ||
210 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
211 | ||
212 | `--name` `<string>` :: | |
213 | ||
214 | Set a name for the VM. Only used on the configuration web interface. | |
215 | ||
216 | `--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>]` :: | |
217 | ||
218 | Specify network devices. | |
219 | ||
220 | `--numa` `<boolean>` ('default =' `0`):: | |
221 | ||
222 | Enable/disable NUMA. | |
223 | ||
224 | `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: | |
225 | ||
226 | NUMA topology. | |
227 | ||
228 | `--onboot` `<boolean>` ('default =' `0`):: | |
229 | ||
230 | Specifies whether a VM will be started during system bootup. | |
231 | ||
232 | `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` :: | |
233 | ||
234 | Specify guest operating system. | |
235 | ||
236 | `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: | |
237 | ||
238 | Map host parallel devices (n is 0 to 2). | |
239 | ||
240 | `--pool` `<string>` :: | |
241 | ||
242 | Add the VM to the specified pool. | |
243 | ||
244 | `--protection` `<boolean>` ('default =' `0`):: | |
245 | ||
246 | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | |
247 | ||
248 | `--reboot` `<boolean>` ('default =' `1`):: | |
249 | ||
250 | Allow reboot. If set to '0' the VM exit on reboot. | |
251 | ||
252 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
253 | ||
254 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). | |
255 | ||
256 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
257 | ||
258 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). | |
259 | ||
260 | `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`):: | |
261 | ||
262 | SCSI controller model | |
263 | ||
264 | `--serial[n]` `(/dev/.+|socket)` :: | |
265 | ||
266 | Create a serial device inside the VM (n is 0 to 3) | |
267 | ||
268 | `--shares` `<integer> (0 - 50000)` ('default =' `1000`):: | |
269 | ||
270 | 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 | |
271 | ||
272 | `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` :: | |
273 | ||
274 | Specify SMBIOS type 1 fields. | |
275 | ||
276 | `--smp` `<integer> (1 - N)` ('default =' `1`):: | |
277 | ||
278 | The number of CPUs. Please use option -sockets instead. | |
279 | ||
280 | `--sockets` `<integer> (1 - N)` ('default =' `1`):: | |
281 | ||
282 | The number of CPU sockets. | |
283 | ||
284 | `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: | |
285 | ||
286 | 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'. | |
287 | ||
288 | `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
289 | ||
290 | 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. | |
291 | ||
292 | `--storage` `<string>` :: | |
293 | ||
294 | Default storage. | |
295 | ||
296 | `--tablet` `<boolean>` ('default =' `1`):: | |
297 | ||
298 | Enable/disable the USB tablet device. | |
299 | ||
300 | `--tdf` `<boolean>` ('default =' `0`):: | |
301 | ||
302 | Enable/disable time drift fix. | |
303 | ||
304 | `--template` `<boolean>` ('default =' `0`):: | |
305 | ||
306 | Enable/disable Template. | |
307 | ||
308 | `--unique` `<boolean>` :: | |
309 | ||
310 | Assign a unique random ethernet address. | |
311 | + | |
312 | NOTE: Requires option(s): `archive` | |
313 | ||
314 | `--unused[n]` `<string>` :: | |
315 | ||
316 | Reference to unused volumes. This is used internally, and should not be modified manually. | |
317 | ||
318 | `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: | |
319 | ||
320 | Configure an USB device (n is 0 to 4). | |
321 | ||
322 | `--vcpus` `<integer> (1 - N)` ('default =' `0`):: | |
323 | ||
324 | Number of hotplugged vcpus. | |
325 | ||
326 | `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` :: | |
327 | ||
328 | Select the VGA type. | |
329 | ||
330 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
331 | ||
332 | Use volume as VIRTIO hard disk (n is 0 to 15). | |
333 | ||
334 | `--vmstatestorage` `<string>` :: | |
335 | ||
336 | Default storage for VM state volumes/files. | |
337 | ||
338 | `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` :: | |
339 | ||
340 | Create a virtual hardware watchdog device. | |
341 | ||
342 | ||
343 | ||
344 | *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]` | |
345 | ||
346 | Delete a VM snapshot. | |
347 | ||
348 | `<vmid>`: `<integer> (1 - N)` :: | |
349 | ||
350 | The (unique) ID of the VM. | |
351 | ||
352 | `<snapname>`: `<string>` :: | |
353 | ||
354 | The name of the snapshot. | |
355 | ||
356 | `--force` `<boolean>` :: | |
357 | ||
358 | For removal from config file, even if removing disk snapshots fails. | |
359 | ||
360 | ||
361 | ||
362 | *qm destroy* `<vmid>` `[OPTIONS]` | |
363 | ||
364 | Destroy the vm (also delete all used/owned volumes). | |
365 | ||
366 | `<vmid>`: `<integer> (1 - N)` :: | |
367 | ||
368 | The (unique) ID of the VM. | |
369 | ||
370 | `--skiplock` `<boolean>` :: | |
371 | ||
372 | Ignore locks - only root is allowed to use this option. | |
373 | ||
374 | ||
375 | ||
376 | ||
377 | *qm help* `[<cmd>]` `[OPTIONS]` | |
378 | ||
379 | Get help about specified command. | |
380 | ||
381 | `<cmd>`: `<string>` :: | |
382 | ||
383 | Command name | |
384 | ||
385 | `--verbose` `<boolean>` :: | |
386 | ||
387 | Verbose output format. | |
388 | ||
389 | ||
390 | ||
391 | ||
392 | *qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]` | |
393 | ||
394 | Import an external disk image as an unused disk in a VM. The | |
395 | image format has to be supported by qemu-img(1). | |
396 | ||
397 | `<vmid>`: `<integer> (1 - N)` :: | |
398 | ||
399 | The (unique) ID of the VM. | |
400 | ||
401 | `<source>`: `<string>` :: | |
402 | ||
403 | Path to the disk image to import | |
404 | ||
405 | `<storage>`: `<string>` :: | |
406 | ||
407 | Target storage ID | |
408 | ||
409 | `--format` `<qcow2 | raw | vmdk>` :: | |
410 | ||
411 | Target format | |
412 | ||
413 | ||
414 | ||
415 | *qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]` | |
416 | ||
417 | Create a new VM using parameters read from an OVF manifest | |
418 | ||
419 | `<vmid>`: `<integer> (1 - N)` :: | |
420 | ||
421 | The (unique) ID of the VM. | |
422 | ||
423 | `<manifest>`: `<string>` :: | |
424 | ||
425 | path to the ovf file | |
426 | ||
427 | `<storage>`: `<string>` :: | |
428 | ||
429 | Target storage ID | |
430 | ||
431 | `--dryrun` `<boolean>` :: | |
432 | ||
433 | Print a parsed representation of the extracted OVF parameters, but do not create a VM | |
434 | ||
435 | `--format` `<qcow2 | raw | vmdk>` :: | |
436 | ||
437 | Target format | |
438 | ||
439 | ||
440 | ||
441 | ||
442 | *qm list* `[OPTIONS]` | |
443 | ||
444 | Virtual machine index (per node). | |
445 | ||
446 | `--full` `<boolean>` :: | |
447 | ||
448 | Determine the full status of active VMs. | |
449 | ||
450 | ||
451 | ||
452 | *qm listsnapshot* `<vmid>` | |
453 | ||
454 | List all snapshots. | |
455 | ||
456 | `<vmid>`: `<integer> (1 - N)` :: | |
457 | ||
458 | The (unique) ID of the VM. | |
459 | ||
460 | ||
461 | ||
462 | *qm migrate* `<vmid> <target>` `[OPTIONS]` | |
463 | ||
464 | Migrate virtual machine. Creates a new migration task. | |
465 | ||
466 | `<vmid>`: `<integer> (1 - N)` :: | |
467 | ||
468 | The (unique) ID of the VM. | |
469 | ||
470 | `<target>`: `<string>` :: | |
471 | ||
472 | Target node. | |
473 | ||
474 | `--force` `<boolean>` :: | |
475 | ||
476 | Allow to migrate VMs which use local devices. Only root may use this option. | |
477 | ||
478 | `--migration_network` `<string>` :: | |
479 | ||
480 | CIDR of the (sub) network that is used for migration. | |
481 | ||
482 | `--migration_type` `<insecure | secure>` :: | |
483 | ||
484 | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. | |
485 | ||
486 | `--online` `<boolean>` :: | |
487 | ||
488 | Use online/live migration. | |
489 | ||
490 | `--targetstorage` `<string>` :: | |
491 | ||
492 | Default target storage. | |
493 | ||
494 | `--with-local-disks` `<boolean>` :: | |
495 | ||
496 | Enable live storage migration for local disk | |
497 | ||
498 | ||
499 | ||
500 | ||
501 | *qm monitor* `<vmid>` | |
502 | ||
503 | Enter Qemu Monitor interface. | |
504 | ||
505 | `<vmid>`: `<integer> (1 - N)` :: | |
506 | ||
507 | The (unique) ID of the VM. | |
508 | ||
509 | ||
510 | ||
511 | ||
512 | *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]` | |
513 | ||
514 | Move volume to different storage. | |
515 | ||
516 | `<vmid>`: `<integer> (1 - N)` :: | |
517 | ||
518 | The (unique) ID of the VM. | |
519 | ||
520 | `<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>` :: | |
521 | ||
522 | The disk you want to move. | |
523 | ||
524 | `<storage>`: `<string>` :: | |
525 | ||
526 | Target storage. | |
527 | ||
528 | `--delete` `<boolean>` ('default =' `0`):: | |
529 | ||
530 | Delete the original disk after successful copy. By default the original disk is kept as unused disk. | |
531 | ||
532 | `--digest` `<string>` :: | |
533 | ||
534 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
535 | ||
536 | `--format` `<qcow2 | raw | vmdk>` :: | |
537 | ||
538 | Target Format. | |
539 | ||
540 | ||
541 | ||
542 | ||
543 | *qm mtunnel* | |
544 | ||
545 | Used by qmigrate - do not use manually. | |
546 | ||
547 | ||
548 | ||
549 | *qm nbdstop* `<vmid>` | |
550 | ||
551 | Stop embedded nbd server. | |
552 | ||
553 | `<vmid>`: `<integer> (1 - N)` :: | |
554 | ||
555 | The (unique) ID of the VM. | |
556 | ||
557 | ||
558 | ||
559 | ||
560 | *qm pending* `<vmid>` | |
561 | ||
562 | Get virtual machine configuration, including pending changes. | |
563 | ||
564 | `<vmid>`: `<integer> (1 - N)` :: | |
565 | ||
566 | The (unique) ID of the VM. | |
567 | ||
568 | ||
569 | ||
570 | ||
571 | *qm rescan* `[OPTIONS]` | |
572 | ||
573 | Rescan all storages and update disk sizes and unused disk images. | |
574 | ||
575 | `--vmid` `<integer> (1 - N)` :: | |
576 | ||
577 | The (unique) ID of the VM. | |
578 | ||
579 | ||
580 | ||
581 | ||
582 | *qm reset* `<vmid>` `[OPTIONS]` | |
583 | ||
584 | Reset virtual machine. | |
585 | ||
586 | `<vmid>`: `<integer> (1 - N)` :: | |
587 | ||
588 | The (unique) ID of the VM. | |
589 | ||
590 | `--skiplock` `<boolean>` :: | |
591 | ||
592 | Ignore locks - only root is allowed to use this option. | |
593 | ||
594 | ||
595 | ||
596 | *qm resize* `<vmid> <disk> <size>` `[OPTIONS]` | |
597 | ||
598 | Extend volume size. | |
599 | ||
600 | `<vmid>`: `<integer> (1 - N)` :: | |
601 | ||
602 | The (unique) ID of the VM. | |
603 | ||
604 | `<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>` :: | |
605 | ||
606 | The disk you want to resize. | |
607 | ||
608 | `<size>`: `\+?\d+(\.\d+)?[KMGT]?` :: | |
609 | ||
610 | 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. | |
611 | ||
612 | `--digest` `<string>` :: | |
613 | ||
614 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
615 | ||
616 | `--skiplock` `<boolean>` :: | |
617 | ||
618 | Ignore locks - only root is allowed to use this option. | |
619 | ||
620 | ||
621 | ||
622 | *qm resume* `<vmid>` `[OPTIONS]` | |
623 | ||
624 | Resume virtual machine. | |
625 | ||
626 | `<vmid>`: `<integer> (1 - N)` :: | |
627 | ||
628 | The (unique) ID of the VM. | |
629 | ||
630 | `--nocheck` `<boolean>` :: | |
631 | ||
632 | no description available | |
633 | ||
634 | `--skiplock` `<boolean>` :: | |
635 | ||
636 | Ignore locks - only root is allowed to use this option. | |
637 | ||
638 | ||
639 | ||
640 | *qm rollback* `<vmid> <snapname>` | |
641 | ||
642 | Rollback VM state to specified snapshot. | |
643 | ||
644 | `<vmid>`: `<integer> (1 - N)` :: | |
645 | ||
646 | The (unique) ID of the VM. | |
647 | ||
648 | `<snapname>`: `<string>` :: | |
649 | ||
650 | The name of the snapshot. | |
651 | ||
652 | ||
653 | ||
654 | *qm sendkey* `<vmid> <key>` `[OPTIONS]` | |
655 | ||
656 | Send key event to virtual machine. | |
657 | ||
658 | `<vmid>`: `<integer> (1 - N)` :: | |
659 | ||
660 | The (unique) ID of the VM. | |
661 | ||
662 | `<key>`: `<string>` :: | |
663 | ||
664 | The key (qemu monitor encoding). | |
665 | ||
666 | `--skiplock` `<boolean>` :: | |
667 | ||
668 | Ignore locks - only root is allowed to use this option. | |
669 | ||
670 | ||
671 | ||
672 | *qm set* `<vmid>` `[OPTIONS]` | |
673 | ||
674 | Set virtual machine options (synchrounous API) - You should consider using | |
675 | the POST method instead for any actions involving hotplug or storage | |
676 | allocation. | |
677 | ||
678 | `<vmid>`: `<integer> (1 - N)` :: | |
679 | ||
680 | The (unique) ID of the VM. | |
681 | ||
682 | `--acpi` `<boolean>` ('default =' `1`):: | |
683 | ||
684 | Enable/disable ACPI. | |
685 | ||
686 | `--agent` `<boolean>` ('default =' `0`):: | |
687 | ||
688 | Enable/disable Qemu GuestAgent. | |
689 | ||
690 | `--args` `<string>` :: | |
691 | ||
692 | Arbitrary arguments passed to kvm. | |
693 | ||
694 | `--autostart` `<boolean>` ('default =' `0`):: | |
695 | ||
696 | Automatic restart after crash (currently ignored). | |
697 | ||
698 | `--balloon` `<integer> (0 - N)` :: | |
699 | ||
700 | Amount of target RAM for the VM in MB. Using zero disables the ballon driver. | |
701 | ||
702 | `--bios` `<ovmf | seabios>` ('default =' `seabios`):: | |
703 | ||
704 | Select BIOS implementation. | |
705 | ||
706 | `--boot` `[acdn]{1,4}` ('default =' `cdn`):: | |
707 | ||
708 | Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). | |
709 | ||
710 | `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: | |
711 | ||
712 | Enable booting from specified disk. | |
713 | ||
714 | `--cdrom` `<volume>` :: | |
715 | ||
716 | This is an alias for option -ide2 | |
717 | ||
718 | `--cores` `<integer> (1 - N)` ('default =' `1`):: | |
719 | ||
720 | The number of cores per socket. | |
721 | ||
722 | `--cpu` `[cputype=]<enum> [,hidden=<1|0>]` :: | |
723 | ||
724 | Emulated CPU type. | |
725 | ||
726 | `--cpulimit` `<number> (0 - 128)` ('default =' `0`):: | |
727 | ||
728 | Limit of CPU usage. | |
729 | ||
730 | `--cpuunits` `<integer> (2 - 262144)` ('default =' `1024`):: | |
731 | ||
732 | CPU weight for a VM. | |
733 | ||
734 | `--delete` `<string>` :: | |
735 | ||
736 | A list of settings you want to delete. | |
737 | ||
738 | `--description` `<string>` :: | |
739 | ||
740 | Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. | |
741 | ||
742 | `--digest` `<string>` :: | |
743 | ||
744 | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | |
745 | ||
746 | `--efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` :: | |
747 | ||
748 | Configure a Disk for storing EFI vars | |
749 | ||
750 | `--force` `<boolean>` :: | |
751 | ||
752 | 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. | |
753 | + | |
754 | NOTE: Requires option(s): `delete` | |
755 | ||
756 | `--freeze` `<boolean>` :: | |
757 | ||
758 | Freeze CPU at startup (use 'c' monitor command to start execution). | |
759 | ||
760 | `--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` :: | |
761 | ||
762 | Map host PCI devices into guest. | |
763 | ||
764 | `--hotplug` `<string>` ('default =' `network,disk,usb`):: | |
765 | ||
766 | 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'. | |
767 | ||
768 | `--hugepages` `<1024 | 2 | any>` :: | |
769 | ||
770 | Enable/disable hugepages memory. | |
771 | ||
772 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
773 | ||
774 | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). | |
775 | ||
776 | `--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>` ('default =' `en-us`):: | |
777 | ||
778 | Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. | |
779 | ||
780 | `--kvm` `<boolean>` ('default =' `1`):: | |
781 | ||
782 | Enable/disable KVM hardware virtualization. | |
783 | ||
784 | `--localtime` `<boolean>` :: | |
785 | ||
786 | Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. | |
787 | ||
788 | `--lock` `<backup | migrate | rollback | snapshot>` :: | |
789 | ||
790 | Lock/unlock the VM. | |
791 | ||
792 | `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: | |
793 | ||
794 | Specific the Qemu machine type. | |
795 | ||
796 | `--memory` `<integer> (16 - N)` ('default =' `512`):: | |
797 | ||
798 | Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. | |
799 | ||
800 | `--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`):: | |
801 | ||
802 | Set maximum tolerated downtime (in seconds) for migrations. | |
803 | ||
804 | `--migrate_speed` `<integer> (0 - N)` ('default =' `0`):: | |
805 | ||
806 | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | |
807 | ||
808 | `--name` `<string>` :: | |
809 | ||
810 | Set a name for the VM. Only used on the configuration web interface. | |
811 | ||
812 | `--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>]` :: | |
813 | ||
814 | Specify network devices. | |
815 | ||
816 | `--numa` `<boolean>` ('default =' `0`):: | |
817 | ||
818 | Enable/disable NUMA. | |
819 | ||
820 | `--numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` :: | |
821 | ||
822 | NUMA topology. | |
823 | ||
824 | `--onboot` `<boolean>` ('default =' `0`):: | |
825 | ||
826 | Specifies whether a VM will be started during system bootup. | |
827 | ||
828 | `--ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` :: | |
829 | ||
830 | Specify guest operating system. | |
831 | ||
832 | `--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: | |
833 | ||
834 | Map host parallel devices (n is 0 to 2). | |
835 | ||
836 | `--protection` `<boolean>` ('default =' `0`):: | |
837 | ||
838 | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | |
839 | ||
840 | `--reboot` `<boolean>` ('default =' `1`):: | |
841 | ||
842 | Allow reboot. If set to '0' the VM exit on reboot. | |
843 | ||
844 | `--revert` `<string>` :: | |
845 | ||
846 | Revert a pending change. | |
847 | ||
848 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
849 | ||
850 | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). | |
851 | ||
852 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
853 | ||
854 | Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). | |
855 | ||
856 | `--scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`):: | |
857 | ||
858 | SCSI controller model | |
859 | ||
860 | `--serial[n]` `(/dev/.+|socket)` :: | |
861 | ||
862 | Create a serial device inside the VM (n is 0 to 3) | |
863 | ||
864 | `--shares` `<integer> (0 - 50000)` ('default =' `1000`):: | |
865 | ||
866 | 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 | |
867 | ||
868 | `--skiplock` `<boolean>` :: | |
869 | ||
870 | Ignore locks - only root is allowed to use this option. | |
871 | ||
872 | `--smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` :: | |
873 | ||
874 | Specify SMBIOS type 1 fields. | |
875 | ||
876 | `--smp` `<integer> (1 - N)` ('default =' `1`):: | |
877 | ||
878 | The number of CPUs. Please use option -sockets instead. | |
879 | ||
880 | `--sockets` `<integer> (1 - N)` ('default =' `1`):: | |
881 | ||
882 | The number of CPU sockets. | |
883 | ||
884 | `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: | |
885 | ||
886 | 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'. | |
887 | ||
888 | `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: | |
889 | ||
890 | 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. | |
891 | ||
892 | `--tablet` `<boolean>` ('default =' `1`):: | |
893 | ||
894 | Enable/disable the USB tablet device. | |
895 | ||
896 | `--tdf` `<boolean>` ('default =' `0`):: | |
897 | ||
898 | Enable/disable time drift fix. | |
899 | ||
900 | `--template` `<boolean>` ('default =' `0`):: | |
901 | ||
902 | Enable/disable Template. | |
903 | ||
904 | `--unused[n]` `<string>` :: | |
905 | ||
906 | Reference to unused volumes. This is used internally, and should not be modified manually. | |
907 | ||
908 | `--usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` :: | |
909 | ||
910 | Configure an USB device (n is 0 to 4). | |
911 | ||
912 | `--vcpus` `<integer> (1 - N)` ('default =' `0`):: | |
913 | ||
914 | Number of hotplugged vcpus. | |
915 | ||
916 | `--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` :: | |
917 | ||
918 | Select the VGA type. | |
919 | ||
920 | `--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>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` :: | |
921 | ||
922 | Use volume as VIRTIO hard disk (n is 0 to 15). | |
923 | ||
924 | `--vmstatestorage` `<string>` :: | |
925 | ||
926 | Default storage for VM state volumes/files. | |
927 | ||
928 | `--watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` :: | |
929 | ||
930 | Create a virtual hardware watchdog device. | |
931 | ||
932 | ||
933 | ||
934 | ||
935 | *qm showcmd* `<vmid>` | |
936 | ||
937 | Show command line which is used to start the VM (debug info). | |
938 | ||
939 | `<vmid>`: `<integer> (1 - N)` :: | |
940 | ||
941 | The (unique) ID of the VM. | |
942 | ||
943 | ||
944 | ||
945 | ||
946 | *qm shutdown* `<vmid>` `[OPTIONS]` | |
947 | ||
948 | Shutdown virtual machine. This is similar to pressing the power button on a | |
949 | physical machine.This will send an ACPI event for the guest OS, which | |
950 | should then proceed to a clean shutdown. | |
951 | ||
952 | `<vmid>`: `<integer> (1 - N)` :: | |
953 | ||
954 | The (unique) ID of the VM. | |
955 | ||
956 | `--forceStop` `<boolean>` ('default =' `0`):: | |
957 | ||
958 | Make sure the VM stops. | |
959 | ||
960 | `--keepActive` `<boolean>` ('default =' `0`):: | |
961 | ||
962 | Do not deactivate storage volumes. | |
963 | ||
964 | `--skiplock` `<boolean>` :: | |
965 | ||
966 | Ignore locks - only root is allowed to use this option. | |
967 | ||
968 | `--timeout` `<integer> (0 - N)` :: | |
969 | ||
970 | Wait maximal timeout seconds. | |
971 | ||
972 | ||
973 | ||
974 | *qm snapshot* `<vmid> <snapname>` `[OPTIONS]` | |
975 | ||
976 | Snapshot a VM. | |
977 | ||
978 | `<vmid>`: `<integer> (1 - N)` :: | |
979 | ||
980 | The (unique) ID of the VM. | |
981 | ||
982 | `<snapname>`: `<string>` :: | |
983 | ||
984 | The name of the snapshot. | |
985 | ||
986 | `--description` `<string>` :: | |
987 | ||
988 | A textual description or comment. | |
989 | ||
990 | `--vmstate` `<boolean>` :: | |
991 | ||
992 | Save the vmstate | |
993 | ||
994 | ||
995 | ||
996 | *qm start* `<vmid>` `[OPTIONS]` | |
997 | ||
998 | Start virtual machine. | |
999 | ||
1000 | `<vmid>`: `<integer> (1 - N)` :: | |
1001 | ||
1002 | The (unique) ID of the VM. | |
1003 | ||
1004 | `--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: | |
1005 | ||
1006 | Specific the Qemu machine type. | |
1007 | ||
1008 | `--migratedfrom` `<string>` :: | |
1009 | ||
1010 | The cluster node name. | |
1011 | ||
1012 | `--migration_network` `<string>` :: | |
1013 | ||
1014 | CIDR of the (sub) network that is used for migration. | |
1015 | ||
1016 | `--migration_type` `<insecure | secure>` :: | |
1017 | ||
1018 | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. | |
1019 | ||
1020 | `--skiplock` `<boolean>` :: | |
1021 | ||
1022 | Ignore locks - only root is allowed to use this option. | |
1023 | ||
1024 | `--stateuri` `<string>` :: | |
1025 | ||
1026 | Some command save/restore state from this location. | |
1027 | ||
1028 | `--targetstorage` `<string>` :: | |
1029 | ||
1030 | Target storage for the migration. (Can be '1' to use the same storage id as on the source node.) | |
1031 | ||
1032 | ||
1033 | ||
1034 | ||
1035 | *qm status* `<vmid>` `[OPTIONS]` | |
1036 | ||
1037 | Show VM status. | |
1038 | ||
1039 | `<vmid>`: `<integer> (1 - N)` :: | |
1040 | ||
1041 | The (unique) ID of the VM. | |
1042 | ||
1043 | `--verbose` `<boolean>` :: | |
1044 | ||
1045 | Verbose output format | |
1046 | ||
1047 | ||
1048 | ||
1049 | ||
1050 | *qm stop* `<vmid>` `[OPTIONS]` | |
1051 | ||
1052 | Stop virtual machine. The qemu process will exit immediately. Thisis akin | |
1053 | to pulling the power plug of a running computer and may damage the VM data | |
1054 | ||
1055 | `<vmid>`: `<integer> (1 - N)` :: | |
1056 | ||
1057 | The (unique) ID of the VM. | |
1058 | ||
1059 | `--keepActive` `<boolean>` ('default =' `0`):: | |
1060 | ||
1061 | Do not deactivate storage volumes. | |
1062 | ||
1063 | `--migratedfrom` `<string>` :: | |
1064 | ||
1065 | The cluster node name. | |
1066 | ||
1067 | `--skiplock` `<boolean>` :: | |
1068 | ||
1069 | Ignore locks - only root is allowed to use this option. | |
1070 | ||
1071 | `--timeout` `<integer> (0 - N)` :: | |
1072 | ||
1073 | Wait maximal timeout seconds. | |
1074 | ||
1075 | ||
1076 | ||
1077 | *qm suspend* `<vmid>` `[OPTIONS]` | |
1078 | ||
1079 | Suspend virtual machine. | |
1080 | ||
1081 | `<vmid>`: `<integer> (1 - N)` :: | |
1082 | ||
1083 | The (unique) ID of the VM. | |
1084 | ||
1085 | `--skiplock` `<boolean>` :: | |
1086 | ||
1087 | Ignore locks - only root is allowed to use this option. | |
1088 | ||
1089 | ||
1090 | ||
1091 | *qm template* `<vmid>` `[OPTIONS]` | |
1092 | ||
1093 | Create a Template. | |
1094 | ||
1095 | `<vmid>`: `<integer> (1 - N)` :: | |
1096 | ||
1097 | The (unique) ID of the VM. | |
1098 | ||
1099 | `--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>` :: | |
1100 | ||
1101 | If you want to convert only 1 disk to base image. | |
1102 | ||
1103 | ||
1104 | ||
1105 | ||
1106 | *qm terminal* `<vmid>` `[OPTIONS]` | |
1107 | ||
1108 | Open a terminal using a serial device (The VM need to have a serial device | |
1109 | configured, for example 'serial0: socket') | |
1110 | ||
1111 | `<vmid>`: `<integer> (1 - N)` :: | |
1112 | ||
1113 | The (unique) ID of the VM. | |
1114 | ||
1115 | `--iface` `<serial0 | serial1 | serial2 | serial3>` :: | |
1116 | ||
1117 | Select the serial device. By default we simply use the first suitable device. | |
1118 | ||
1119 | ||
1120 | ||
1121 | ||
1122 | *qm unlink* `<vmid> --idlist <string>` `[OPTIONS]` | |
1123 | ||
1124 | Unlink/delete disk images. | |
1125 | ||
1126 | `<vmid>`: `<integer> (1 - N)` :: | |
1127 | ||
1128 | The (unique) ID of the VM. | |
1129 | ||
1130 | `--force` `<boolean>` :: | |
1131 | ||
1132 | 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. | |
1133 | ||
1134 | `--idlist` `<string>` :: | |
1135 | ||
1136 | A list of disk IDs you want to delete. | |
1137 | ||
1138 | ||
1139 | ||
1140 | ||
1141 | *qm unlock* `<vmid>` | |
1142 | ||
1143 | Unlock the VM. | |
1144 | ||
1145 | `<vmid>`: `<integer> (1 - N)` :: | |
1146 | ||
1147 | The (unique) ID of the VM. | |
1148 | ||
1149 | ||
1150 | ||
1151 | *qm vncproxy* `<vmid>` | |
1152 | ||
1153 | Proxy VM VNC traffic to stdin/stdout | |
1154 | ||
1155 | `<vmid>`: `<integer> (1 - N)` :: | |
1156 | ||
1157 | The (unique) ID of the VM. | |
1158 | ||
1159 | ||
1160 | ||
1161 | *qm wait* `<vmid>` `[OPTIONS]` | |
1162 | ||
1163 | Wait until the VM is stopped. | |
1164 | ||
1165 | `<vmid>`: `<integer> (1 - N)` :: | |
1166 | ||
1167 | The (unique) ID of the VM. | |
1168 | ||
1169 | `--timeout` `<integer> (1 - N)` :: | |
1170 | ||
1171 | Timeout in seconds. Default is to wait forever. | |
1172 | ||
1173 | ||
1174 | ||
1175 |