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