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