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