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