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