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