qm.1-synopsis.adoc

   1 *qm* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *qm clone* `<vmid> <newid>` `[OPTIONS]`
   4
   5 Create a copy of virtual machine/template.
   6
   7 `<vmid>` `integer (1 - N)` ::
   8
   9 The (unique) ID of the VM.
  10
  11 `<newid>` `integer (1 - N)` ::
  12
  13 VMID for the clone.
  14
  15 `-description` `string` ::
  16
  17 Description for the new VM.
  18
  19 `-format` `(qcow2 | raw | vmdk)` ::
  20
  21 Target format for file storage.
  22 +
  23 NOTE: Requires option(s): `full`
  24
  25 `-full` `boolean` (default=`0`)::
  26
  27 Create a full copy of all disk. This is always done when you clone a normal
  28 VM. For VM templates, we try to create a linked clone by default.
  29
  30 `-name` `string` ::
  31
  32 Set a name for the new VM.
  33
  34 `-pool` `string` ::
  35
  36 Add the new VM to the specified pool.
  37
  38 `-snapname` `string` ::
  39
  40 The name of the snapshot.
  41
  42 `-storage` `string` ::
  43
  44 Target storage for full clone.
  45 +
  46 NOTE: Requires option(s): `full`
  47
  48 `-target` `string` ::
  49
  50 Target node. Only allowed if the original VM is on shared storage.
  51
  52
  53
  54 *qm config* `<vmid>` `[OPTIONS]`
  55
  56 Get current virtual machine configuration. This does not include pending
  57 configuration changes (see 'pending' API).
  58
  59 `<vmid>` `integer (1 - N)` ::
  60
  61 The (unique) ID of the VM.
  62
  63 `-current` `boolean` (default=`0`)::
  64
  65 Get current values (instead of pending values).
  66
  67
  68
  69 *qm create* `<vmid>` `[OPTIONS]`
  70
  71 Create or restore a virtual machine.
  72
  73 `<vmid>` `integer (1 - N)` ::
  74
  75 The (unique) ID of the VM.
  76
  77 `-acpi` `boolean` (default=`1`)::
  78
  79 Enable/disable ACPI.
  80
  81 `-agent` `boolean` (default=`0`)::
  82
  83 Enable/disable Qemu GuestAgent.
  84
  85 `-archive` `string` ::
  86
  87 The backup file.
  88
  89 `-args` `string` ::
  90
  91 Arbitrary arguments passed to kvm, for example:
  92 +
  93 args: -no-reboot -no-hpet
  94 +
  95 NOTE: this option is for experts only.
  96
  97 `-autostart` `boolean` (default=`0`)::
  98
  99 Automatic restart after crash (currently ignored).
 100
 101 `-balloon` `integer (0 - N)` ::
 102
 103 Amount of target RAM for the VM in MB. Using zero disables the ballon
 104 driver.
 105
 106 `-bios` `(ovmf | seabios)` (default=`seabios`)::
 107
 108 Select BIOS implementation.
 109
 110 `-boot` `[acdn]{1,4}` (default=`cdn`)::
 111
 112 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 113
 114 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 115
 116 Enable booting from specified disk.
 117
 118 `-cdrom` `volume` ::
 119
 120 This is an alias for option -ide2
 121
 122 `-cores` `integer (1 - N)` (default=`1`)::
 123
 124 The number of cores per socket.
 125
 126 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
 127
 128 Emulated CPU type.
 129
 130 `-cpulimit` `number (0 - 128)` (default=`0`)::
 131
 132 Limit of CPU usage.
 133 +
 134 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
 135 indicates no CPU limit.
 136
 137 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
 138
 139 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
 140 larger the number is, the more CPU time this VM gets. Number is relative to
 141 weights of all the other running VMs.
 142 +
 143 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 144
 145 `-description` `string` ::
 146
 147 Description for the VM. Only used on the configuration web interface. This
 148 is saved as comment inside the configuration file.
 149
 150 `-force` `boolean` ::
 151
 152 Allow to overwrite existing VM.
 153 +
 154 NOTE: Requires option(s): `archive`
 155
 156 `-freeze` `boolean` ::
 157
 158 Freeze CPU at startup (use 'c' monitor command to start execution).
 159
 160 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
 161
 162 Map host pci devices. HOSTPCIDEVICE syntax is:
 163 +
 164 'bus:dev.func' (hexadecimal numbers)
 165 +
 166 You can us the 'lspci' command to list existing pci devices.
 167 +
 168 The 'rombar' option determines whether or not the device's ROM will be
 169 visible in the guest's memory map (default is 'on').
 170 +
 171 NOTE: This option allows direct access to host hardware. So it is no longer
 172 possible to migrate such machines - use with special care.
 173 +
 174 Experimental: user reported problems with this option.
 175
 176 `-hotplug` `string` (default=`network,disk,usb`)::
 177
 178 Selectively enable hotplug features. This is a comma separated list of
 179 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
 180 disable hotplug completely. Value '1' is an alias for the default
 181 'network,disk,usb'.
 182
 183 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 184
 185 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 186
 187 `-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`)::
 188
 189 Keybord layout for vnc server. Default is read from the datacenter
 190 configuration file.
 191
 192 `-kvm` `boolean` (default=`1`)::
 193
 194 Enable/disable KVM hardware virtualization.
 195
 196 `-localtime` `boolean` ::
 197
 198 Set the real time clock to local time. This is enabled by default if ostype
 199 indicates a Microsoft OS.
 200
 201 `-lock` `(backup | migrate | rollback | snapshot)` ::
 202
 203 Lock/unlock the VM.
 204
 205 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 206
 207 Specific the Qemu machine type.
 208
 209 `-memory` `integer (16 - N)` (default=`512`)::
 210
 211 Amount of RAM for the VM in MB. This is the maximum available memory when
 212 you use the balloon device.
 213
 214 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
 215
 216 Set maximum tolerated downtime (in seconds) for migrations.
 217
 218 `-migrate_speed` `integer (0 - N)` (default=`0`)::
 219
 220 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 221
 222 `-name` `string` ::
 223
 224 Set a name for the VM. Only used on the configuration web interface.
 225
 226 `-net[n]` `string` ::
 227
 228 Specify network devices.
 229 +
 230 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
 231 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
 232 +
 233 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
 234 automatically generated if not specified.
 235 +
 236 The bridge parameter can be used to automatically add the interface to a
 237 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
 238 +
 239 Option 'rate' is used to limit traffic bandwidth from and to this
 240 interface. It is specified as floating point number, unit is 'Megabytes per
 241 second'.
 242 +
 243 If you specify no bridge, we create a kvm 'user' (NATed) network device,
 244 which provides DHCP and DNS services. The following addresses are used:
 245 +
 246 10.0.2.2   Gateway
 247 10.0.2.3   DNS Server
 248 10.0.2.4   SMB Server
 249 +
 250 The DHCP server assign addresses to the guest starting from 10.0.2.15.
 251
 252 `-numa` `boolean` (default=`0`)::
 253
 254 Enable/disable NUMA.
 255
 256 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
 257
 258 numa topology
 259
 260 `-onboot` `boolean` (default=`0`)::
 261
 262 Specifies whether a VM will be started during system bootup.
 263
 264 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
 265
 266 Used to enable special optimization/features for specific
 267 operating systems:
 268 +
 269 other  => unspecified OS
 270 wxp    => Microsoft Windows XP
 271 w2k    => Microsoft Windows 2000
 272 w2k3   => Microsoft Windows 2003
 273 w2k8   => Microsoft Windows 2008
 274 wvista => Microsoft Windows Vista
 275 win7   => Microsoft Windows 7
 276 win8   => Microsoft Windows 8/2012
 277 l24    => Linux 2.4 Kernel
 278 l26    => Linux 2.6/3.X Kernel
 279 solaris => solaris/opensolaris/openindiania kernel
 280 +
 281 other|l24|l26|solaris                       ... no special behaviour
 282 wxp|w2k|w2k3|w2k8|wvista|win7|win8  ... use --localtime switch
 283
 284 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 285
 286 Map host parallel devices (n is 0 to 2).
 287 +
 288 NOTE: This option allows direct access to host hardware. So it is no longer
 289 possible to migrate such machines - use with special care.
 290 +
 291 Experimental: user reported problems with this option.
 292
 293 `-pool` `string` ::
 294
 295 Add the VM to the specified pool.
 296
 297 `-protection` `boolean` (default=`0`)::
 298
 299 Sets the protection flag of the VM. This will prevent the remove operation.
 300
 301 `-reboot` `boolean` (default=`1`)::
 302
 303 Allow reboot. If set to '0' the VM exit on reboot.
 304
 305 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 306
 307 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 308
 309 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 310
 311 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 312
 313 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
 314
 315 scsi controller model
 316
 317 `-serial[n]` `(/dev/.+|socket)` ::
 318
 319 Create a serial device inside the VM (n is 0 to 3), and pass through a host
 320 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
 321 (use 'qm terminal' to open a terminal connection).
 322 +
 323 NOTE: If you pass through a host serial device, it is no longer possible to
 324 migrate such machines - use with special care.
 325 +
 326 Experimental: user reported problems with this option.
 327
 328 `-shares` `integer (0 - 50000)` (default=`1000`)::
 329
 330 Amount of memory shares for auto-ballooning. The larger the number is, the
 331 more memory this VM gets. Number is relative to weights of all other
 332 running VMs. Using zero disables auto-ballooning
 333
 334 `-smbios1` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
 335
 336 Specify SMBIOS type 1 fields.
 337
 338 `-smp` `integer (1 - N)` (default=`1`)::
 339
 340 The number of CPUs. Please use option -sockets instead.
 341
 342 `-sockets` `integer (1 - N)` (default=`1`)::
 343
 344 The number of CPU sockets.
 345
 346 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
 347
 348 Set the initial date of the real time clock. Valid format for date are:
 349 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
 350
 351 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 352
 353 Startup and shutdown behavior. Order is a non-negative number defining the
 354 general startup order. Shutdown in done with reverse ordering. Additionally
 355 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
 356 wait before the next VM is started or stopped.
 357
 358 `-storage` `string` ::
 359
 360 Default storage.
 361
 362 `-tablet` `boolean` (default=`1`)::
 363
 364 Enable/disable the USB tablet device. This device is usually needed to
 365 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
 366 with normal VNC clients. If you're running lots of console-only guests on
 367 one host, you may consider disabling this to save some context switches.
 368 This is turned off by default if you use spice (-vga=qxl).
 369
 370 `-tdf` `boolean` (default=`0`)::
 371
 372 Enable/disable time drift fix.
 373
 374 `-template` `boolean` (default=`0`)::
 375
 376 Enable/disable Template.
 377
 378 `-unique` `boolean` ::
 379
 380 Assign a unique random ethernet address.
 381 +
 382 NOTE: Requires option(s): `archive`
 383
 384 `-unused[n]` `string` ::
 385
 386 Reference to unused volumes.
 387
 388 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
 389
 390 Configure an USB device (n is 0 to 4). This can be used to
 391 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
 392 +
 393 'bus-port(.port)*' (decimal numbers) or
 394 'vendor_id:product_id' (hexadeciaml numbers) or
 395 'spice'
 396 +
 397 You can use the 'lsusb -t' command to list existing usb devices.
 398 +
 399 NOTE: This option allows direct access to host hardware. So it is no longer
 400 possible to migrate such machines - use with special care.
 401 +
 402 The value 'spice' can be used to add a usb redirection devices for spice.
 403 +
 404 The 'usb3' option determines whether the device is a USB3 device or not
 405 (this does currently not work reliably with spice redirection and is then
 406 ignored).
 407
 408 `-vcpus` `integer (1 - N)` (default=`0`)::
 409
 410 Number of hotplugged vcpus.
 411
 412 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
 413
 414 Select the VGA type. If you want to use high resolution modes (>=
 415 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
 416 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
 417 enables the SPICE display sever. For win* OS you can select how many
 418 independent displays you want, Linux guests can add displays them self. You
 419 can also run without any graphic card, using a serial device as terminal.
 420
 421 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 422
 423 Use volume as VIRTIO hard disk (n is 0 to 15).
 424
 425 `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
 426
 427 Create a virtual hardware watchdog device. Once enabled (by a guest
 428 action), the watchdog must be periodically polled by an agent inside the
 429 guest or else the watchdog will reset the guest (or execute the respective
 430 action specified)
 431
 432
 433
 434 *qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
 435
 436 Delete a VM snapshot.
 437
 438 `<vmid>` `integer (1 - N)` ::
 439
 440 The (unique) ID of the VM.
 441
 442 `<snapname>` `string` ::
 443
 444 The name of the snapshot.
 445
 446 `-force` `boolean` ::
 447
 448 For removal from config file, even if removing disk snapshots fails.
 449
 450
 451
 452 *qm destroy* `<vmid>` `[OPTIONS]`
 453
 454 Destroy the vm (also delete all used/owned volumes).
 455
 456 `<vmid>` `integer (1 - N)` ::
 457
 458 The (unique) ID of the VM.
 459
 460 `-skiplock` `boolean` ::
 461
 462 Ignore locks - only root is allowed to use this option.
 463
 464
 465
 466
 467 *qm help* `[<cmd>]` `[OPTIONS]`
 468
 469 Get help about specified command.
 470
 471 `<cmd>` `string` ::
 472
 473 Command name
 474
 475 `-verbose` `boolean` ::
 476
 477 Verbose output format.
 478
 479
 480
 481
 482 *qm list* `[OPTIONS]`
 483
 484 Virtual machine index (per node).
 485
 486 `-full` `boolean` ::
 487
 488 Determine the full status of active VMs.
 489
 490
 491
 492 *qm migrate* `<vmid> <target>` `[OPTIONS]`
 493
 494 Migrate virtual machine. Creates a new migration task.
 495
 496 `<vmid>` `integer (1 - N)` ::
 497
 498 The (unique) ID of the VM.
 499
 500 `<target>` `string` ::
 501
 502 Target node.
 503
 504 `-force` `boolean` ::
 505
 506 Allow to migrate VMs which use local devices. Only root may use this
 507 option.
 508
 509 `-online` `boolean` ::
 510
 511 Use online/live migration.
 512
 513
 514
 515
 516 *qm monitor* `<vmid>`
 517
 518 Enter Qemu Monitor interface.
 519
 520 `<vmid>` `integer (1 - N)` ::
 521
 522 The (unique) ID of the VM.
 523
 524
 525
 526
 527 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
 528
 529 Move volume to different storage.
 530
 531 `<vmid>` `integer (1 - N)` ::
 532
 533 The (unique) ID of the VM.
 534
 535 `<disk>` `(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)` ::
 536
 537 The disk you want to move.
 538
 539 `<storage>` `string` ::
 540
 541 Target storage.
 542
 543 `-delete` `boolean` (default=`0`)::
 544
 545 Delete the original disk after successful copy. By default the original
 546 disk is kept as unused disk.
 547
 548 `-digest` `string` ::
 549
 550 Prevent changes if current configuration file has different SHA1 digest.
 551 This can be used to prevent concurrent modifications.
 552
 553 `-format` `(qcow2 | raw | vmdk)` ::
 554
 555 Target Format.
 556
 557
 558
 559
 560 *qm mtunnel*
 561
 562 Used by qmigrate - do not use manually.
 563
 564
 565
 566
 567 *qm pending* `<vmid>`
 568
 569 Get virtual machine configuration, including pending changes.
 570
 571 `<vmid>` `integer (1 - N)` ::
 572
 573 The (unique) ID of the VM.
 574
 575
 576
 577
 578 *qm rescan* `[OPTIONS]`
 579
 580 Rescan all storages and update disk sizes and unused disk images.
 581
 582 `-vmid` `integer (1 - N)` ::
 583
 584 The (unique) ID of the VM.
 585
 586
 587
 588
 589 *qm reset* `<vmid>` `[OPTIONS]`
 590
 591 Reset virtual machine.
 592
 593 `<vmid>` `integer (1 - N)` ::
 594
 595 The (unique) ID of the VM.
 596
 597 `-skiplock` `boolean` ::
 598
 599 Ignore locks - only root is allowed to use this option.
 600
 601
 602
 603 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
 604
 605 Extend volume size.
 606
 607 `<vmid>` `integer (1 - N)` ::
 608
 609 The (unique) ID of the VM.
 610
 611 `<disk>` `(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)` ::
 612
 613 The disk you want to resize.
 614
 615 `<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
 616
 617 The new size. With the '+' sign the value is added to the actual size of
 618 the volume and without it, the value is taken as an absolute one. Shrinking
 619 disk size is not supported.
 620
 621 `-digest` `string` ::
 622
 623 Prevent changes if current configuration file has different SHA1 digest.
 624 This can be used to prevent concurrent modifications.
 625
 626 `-skiplock` `boolean` ::
 627
 628 Ignore locks - only root is allowed to use this option.
 629
 630
 631
 632 *qm resume* `<vmid>` `[OPTIONS]`
 633
 634 Resume virtual machine.
 635
 636 `<vmid>` `integer (1 - N)` ::
 637
 638 The (unique) ID of the VM.
 639
 640 `-nocheck` `boolean` ::
 641
 642 no description available
 643
 644 `-skiplock` `boolean` ::
 645
 646 Ignore locks - only root is allowed to use this option.
 647
 648
 649
 650 *qm rollback* `<vmid> <snapname>`
 651
 652 Rollback VM state to specified snapshot.
 653
 654 `<vmid>` `integer (1 - N)` ::
 655
 656 The (unique) ID of the VM.
 657
 658 `<snapname>` `string` ::
 659
 660 The name of the snapshot.
 661
 662
 663
 664 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
 665
 666 Send key event to virtual machine.
 667
 668 `<vmid>` `integer (1 - N)` ::
 669
 670 The (unique) ID of the VM.
 671
 672 `<key>` `string` ::
 673
 674 The key (qemu monitor encoding).
 675
 676 `-skiplock` `boolean` ::
 677
 678 Ignore locks - only root is allowed to use this option.
 679
 680
 681
 682 *qm set* `<vmid>` `[OPTIONS]`
 683
 684 Set virtual machine options (synchrounous API) - You should consider using
 685 the POST method instead for any actions involving hotplug or storage
 686 allocation.
 687
 688 `<vmid>` `integer (1 - N)` ::
 689
 690 The (unique) ID of the VM.
 691
 692 `-acpi` `boolean` (default=`1`)::
 693
 694 Enable/disable ACPI.
 695
 696 `-agent` `boolean` (default=`0`)::
 697
 698 Enable/disable Qemu GuestAgent.
 699
 700 `-args` `string` ::
 701
 702 Arbitrary arguments passed to kvm, for example:
 703 +
 704 args: -no-reboot -no-hpet
 705 +
 706 NOTE: this option is for experts only.
 707
 708 `-autostart` `boolean` (default=`0`)::
 709
 710 Automatic restart after crash (currently ignored).
 711
 712 `-balloon` `integer (0 - N)` ::
 713
 714 Amount of target RAM for the VM in MB. Using zero disables the ballon
 715 driver.
 716
 717 `-bios` `(ovmf | seabios)` (default=`seabios`)::
 718
 719 Select BIOS implementation.
 720
 721 `-boot` `[acdn]{1,4}` (default=`cdn`)::
 722
 723 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 724
 725 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 726
 727 Enable booting from specified disk.
 728
 729 `-cdrom` `volume` ::
 730
 731 This is an alias for option -ide2
 732
 733 `-cores` `integer (1 - N)` (default=`1`)::
 734
 735 The number of cores per socket.
 736
 737 `-cpu` `[cputype=]<cputype> [,hidden=<1|0>]` ::
 738
 739 Emulated CPU type.
 740
 741 `-cpulimit` `number (0 - 128)` (default=`0`)::
 742
 743 Limit of CPU usage.
 744 +
 745 NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
 746 indicates no CPU limit.
 747
 748 `-cpuunits` `integer (0 - 500000)` (default=`1000`)::
 749
 750 CPU weight for a VM. Argument is used in the kernel fair scheduler. The
 751 larger the number is, the more CPU time this VM gets. Number is relative to
 752 weights of all the other running VMs.
 753 +
 754 NOTE: You can disable fair-scheduler configuration by setting this to 0.
 755
 756 `-delete` `string` ::
 757
 758 A list of settings you want to delete.
 759
 760 `-description` `string` ::
 761
 762 Description for the VM. Only used on the configuration web interface. This
 763 is saved as comment inside the configuration file.
 764
 765 `-digest` `string` ::
 766
 767 Prevent changes if current configuration file has different SHA1 digest.
 768 This can be used to prevent concurrent modifications.
 769
 770 `-force` `boolean` ::
 771
 772 Force physical removal. Without this, we simple remove the disk from the
 773 config file and create an additional configuration entry called
 774 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
 775 physical removal.
 776 +
 777 NOTE: Requires option(s): `delete`
 778
 779 `-freeze` `boolean` ::
 780
 781 Freeze CPU at startup (use 'c' monitor command to start execution).
 782
 783 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
 784
 785 Map host pci devices. HOSTPCIDEVICE syntax is:
 786 +
 787 'bus:dev.func' (hexadecimal numbers)
 788 +
 789 You can us the 'lspci' command to list existing pci devices.
 790 +
 791 The 'rombar' option determines whether or not the device's ROM will be
 792 visible in the guest's memory map (default is 'on').
 793 +
 794 NOTE: This option allows direct access to host hardware. So it is no longer
 795 possible to migrate such machines - use with special care.
 796 +
 797 Experimental: user reported problems with this option.
 798
 799 `-hotplug` `string` (default=`network,disk,usb`)::
 800
 801 Selectively enable hotplug features. This is a comma separated list of
 802 hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
 803 disable hotplug completely. Value '1' is an alias for the default
 804 'network,disk,usb'.
 805
 806 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 807
 808 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 809
 810 `-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`)::
 811
 812 Keybord layout for vnc server. Default is read from the datacenter
 813 configuration file.
 814
 815 `-kvm` `boolean` (default=`1`)::
 816
 817 Enable/disable KVM hardware virtualization.
 818
 819 `-localtime` `boolean` ::
 820
 821 Set the real time clock to local time. This is enabled by default if ostype
 822 indicates a Microsoft OS.
 823
 824 `-lock` `(backup | migrate | rollback | snapshot)` ::
 825
 826 Lock/unlock the VM.
 827
 828 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 829
 830 Specific the Qemu machine type.
 831
 832 `-memory` `integer (16 - N)` (default=`512`)::
 833
 834 Amount of RAM for the VM in MB. This is the maximum available memory when
 835 you use the balloon device.
 836
 837 `-migrate_downtime` `number (0 - N)` (default=`0.1`)::
 838
 839 Set maximum tolerated downtime (in seconds) for migrations.
 840
 841 `-migrate_speed` `integer (0 - N)` (default=`0`)::
 842
 843 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 844
 845 `-name` `string` ::
 846
 847 Set a name for the VM. Only used on the configuration web interface.
 848
 849 `-net[n]` `string` ::
 850
 851 Specify network devices.
 852 +
 853 MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
 854 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
 855 +
 856 XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
 857 automatically generated if not specified.
 858 +
 859 The bridge parameter can be used to automatically add the interface to a
 860 bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
 861 +
 862 Option 'rate' is used to limit traffic bandwidth from and to this
 863 interface. It is specified as floating point number, unit is 'Megabytes per
 864 second'.
 865 +
 866 If you specify no bridge, we create a kvm 'user' (NATed) network device,
 867 which provides DHCP and DNS services. The following addresses are used:
 868 +
 869 10.0.2.2   Gateway
 870 10.0.2.3   DNS Server
 871 10.0.2.4   SMB Server
 872 +
 873 The DHCP server assign addresses to the guest starting from 10.0.2.15.
 874
 875 `-numa` `boolean` (default=`0`)::
 876
 877 Enable/disable NUMA.
 878
 879 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
 880
 881 numa topology
 882
 883 `-onboot` `boolean` (default=`0`)::
 884
 885 Specifies whether a VM will be started during system bootup.
 886
 887 `-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
 888
 889 Used to enable special optimization/features for specific
 890 operating systems:
 891 +
 892 other  => unspecified OS
 893 wxp    => Microsoft Windows XP
 894 w2k    => Microsoft Windows 2000
 895 w2k3   => Microsoft Windows 2003
 896 w2k8   => Microsoft Windows 2008
 897 wvista => Microsoft Windows Vista
 898 win7   => Microsoft Windows 7
 899 win8   => Microsoft Windows 8/2012
 900 l24    => Linux 2.4 Kernel
 901 l26    => Linux 2.6/3.X Kernel
 902 solaris => solaris/opensolaris/openindiania kernel
 903 +
 904 other|l24|l26|solaris                       ... no special behaviour
 905 wxp|w2k|w2k3|w2k8|wvista|win7|win8  ... use --localtime switch
 906
 907 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 908
 909 Map host parallel devices (n is 0 to 2).
 910 +
 911 NOTE: This option allows direct access to host hardware. So it is no longer
 912 possible to migrate such machines - use with special care.
 913 +
 914 Experimental: user reported problems with this option.
 915
 916 `-protection` `boolean` (default=`0`)::
 917
 918 Sets the protection flag of the VM. This will prevent the remove operation.
 919
 920 `-reboot` `boolean` (default=`1`)::
 921
 922 Allow reboot. If set to '0' the VM exit on reboot.
 923
 924 `-revert` `string` ::
 925
 926 Revert a pending change.
 927
 928 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 929
 930 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 931
 932 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
 933
 934 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 935
 936 `-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
 937
 938 scsi controller model
 939
 940 `-serial[n]` `(/dev/.+|socket)` ::
 941
 942 Create a serial device inside the VM (n is 0 to 3), and pass through a host
 943 serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
 944 (use 'qm terminal' to open a terminal connection).
 945 +
 946 NOTE: If you pass through a host serial device, it is no longer possible to
 947 migrate such machines - use with special care.
 948 +
 949 Experimental: user reported problems with this option.
 950
 951 `-shares` `integer (0 - 50000)` (default=`1000`)::
 952
 953 Amount of memory shares for auto-ballooning. The larger the number is, the
 954 more memory this VM gets. Number is relative to weights of all other
 955 running VMs. Using zero disables auto-ballooning
 956
 957 `-skiplock` `boolean` ::
 958
 959 Ignore locks - only root is allowed to use this option.
 960
 961 `-smbios1` `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
 962
 963 Specify SMBIOS type 1 fields.
 964
 965 `-smp` `integer (1 - N)` (default=`1`)::
 966
 967 The number of CPUs. Please use option -sockets instead.
 968
 969 `-sockets` `integer (1 - N)` (default=`1`)::
 970
 971 The number of CPU sockets.
 972
 973 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
 974
 975 Set the initial date of the real time clock. Valid format for date are:
 976 'now' or '2006-06-17T16:01:21' or '2006-06-17'.
 977
 978 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 979
 980 Startup and shutdown behavior. Order is a non-negative number defining the
 981 general startup order. Shutdown in done with reverse ordering. Additionally
 982 you can set the 'up' or 'down' delay in seconds, which specifies a delay to
 983 wait before the next VM is started or stopped.
 984
 985 `-tablet` `boolean` (default=`1`)::
 986
 987 Enable/disable the USB tablet device. This device is usually needed to
 988 allow absolute mouse positioning with VNC. Else the mouse runs out of sync
 989 with normal VNC clients. If you're running lots of console-only guests on
 990 one host, you may consider disabling this to save some context switches.
 991 This is turned off by default if you use spice (-vga=qxl).
 992
 993 `-tdf` `boolean` (default=`0`)::
 994
 995 Enable/disable time drift fix.
 996
 997 `-template` `boolean` (default=`0`)::
 998
 999 Enable/disable Template.
1000
1001 `-unused[n]` `string` ::
1002
1003 Reference to unused volumes.
1004
1005 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
1006
1007 Configure an USB device (n is 0 to 4). This can be used to
1008 pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
1009 +
1010 'bus-port(.port)*' (decimal numbers) or
1011 'vendor_id:product_id' (hexadeciaml numbers) or
1012 'spice'
1013 +
1014 You can use the 'lsusb -t' command to list existing usb devices.
1015 +
1016 NOTE: This option allows direct access to host hardware. So it is no longer
1017 possible to migrate such machines - use with special care.
1018 +
1019 The value 'spice' can be used to add a usb redirection devices for spice.
1020 +
1021 The 'usb3' option determines whether the device is a USB3 device or not
1022 (this does currently not work reliably with spice redirection and is then
1023 ignored).
1024
1025 `-vcpus` `integer (1 - N)` (default=`0`)::
1026
1027 Number of hotplugged vcpus.
1028
1029 `-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
1030
1031 Select the VGA type. If you want to use high resolution modes (>=
1032 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
1033 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
1034 enables the SPICE display sever. For win* OS you can select how many
1035 independent displays you want, Linux guests can add displays them self. You
1036 can also run without any graphic card, using a serial device as terminal.
1037
1038 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
1039
1040 Use volume as VIRTIO hard disk (n is 0 to 15).
1041
1042 `-watchdog` `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
1043
1044 Create a virtual hardware watchdog device. Once enabled (by a guest
1045 action), the watchdog must be periodically polled by an agent inside the
1046 guest or else the watchdog will reset the guest (or execute the respective
1047 action specified)
1048
1049
1050
1051
1052 *qm showcmd* `<vmid>`
1053
1054 Show command line which is used to start the VM (debug info).
1055
1056 `<vmid>` `integer (1 - N)` ::
1057
1058 The (unique) ID of the VM.
1059
1060
1061
1062
1063 *qm shutdown* `<vmid>` `[OPTIONS]`
1064
1065 Shutdown virtual machine. This is similar to pressing the power button on a
1066 physical machine.This will send an ACPI event for the guest OS, which
1067 should then proceed to a clean shutdown.
1068
1069 `<vmid>` `integer (1 - N)` ::
1070
1071 The (unique) ID of the VM.
1072
1073 `-forceStop` `boolean` (default=`0`)::
1074
1075 Make sure the VM stops.
1076
1077 `-keepActive` `boolean` (default=`0`)::
1078
1079 Do not decativate storage volumes.
1080
1081 `-skiplock` `boolean` ::
1082
1083 Ignore locks - only root is allowed to use this option.
1084
1085 `-timeout` `integer (0 - N)` ::
1086
1087 Wait maximal timeout seconds.
1088
1089
1090
1091 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
1092
1093 Snapshot a VM.
1094
1095 `<vmid>` `integer (1 - N)` ::
1096
1097 The (unique) ID of the VM.
1098
1099 `<snapname>` `string` ::
1100
1101 The name of the snapshot.
1102
1103 `-description` `string` ::
1104
1105 A textual description or comment.
1106
1107 `-vmstate` `boolean` ::
1108
1109 Save the vmstate
1110
1111
1112
1113 *qm start* `<vmid>` `[OPTIONS]`
1114
1115 Start virtual machine.
1116
1117 `<vmid>` `integer (1 - N)` ::
1118
1119 The (unique) ID of the VM.
1120
1121 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
1122
1123 Specific the Qemu machine type.
1124
1125 `-migratedfrom` `string` ::
1126
1127 The cluster node name.
1128
1129 `-skiplock` `boolean` ::
1130
1131 Ignore locks - only root is allowed to use this option.
1132
1133 `-stateuri` `string` ::
1134
1135 Some command save/restore state from this location.
1136
1137
1138
1139
1140 *qm status* `<vmid>` `[OPTIONS]`
1141
1142 Show VM status.
1143
1144 `<vmid>` `integer (1 - N)` ::
1145
1146 The (unique) ID of the VM.
1147
1148 `-verbose` `boolean` ::
1149
1150 Verbose output format
1151
1152
1153
1154
1155 *qm stop* `<vmid>` `[OPTIONS]`
1156
1157 Stop virtual machine. The qemu process will exit immediately. Thisis akin
1158 to pulling the power plug of a running computer and may damage the VM data
1159
1160 `<vmid>` `integer (1 - N)` ::
1161
1162 The (unique) ID of the VM.
1163
1164 `-keepActive` `boolean` (default=`0`)::
1165
1166 Do not decativate storage volumes.
1167
1168 `-migratedfrom` `string` ::
1169
1170 The cluster node name.
1171
1172 `-skiplock` `boolean` ::
1173
1174 Ignore locks - only root is allowed to use this option.
1175
1176 `-timeout` `integer (0 - N)` ::
1177
1178 Wait maximal timeout seconds.
1179
1180
1181
1182 *qm suspend* `<vmid>` `[OPTIONS]`
1183
1184 Suspend virtual machine.
1185
1186 `<vmid>` `integer (1 - N)` ::
1187
1188 The (unique) ID of the VM.
1189
1190 `-skiplock` `boolean` ::
1191
1192 Ignore locks - only root is allowed to use this option.
1193
1194
1195
1196 *qm template* `<vmid>` `[OPTIONS]`
1197
1198 Create a Template.
1199
1200 `<vmid>` `integer (1 - N)` ::
1201
1202 The (unique) ID of the VM.
1203
1204 `-disk` `(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)` ::
1205
1206 If you want to convert only 1 disk to base image.
1207
1208
1209
1210
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
1216 `<vmid>` `integer (1 - N)` ::
1217
1218 The (unique) ID of the VM.
1219
1220 `-iface` `(serial0 | serial1 | serial2 | serial3)` ::
1221
1222 Select the serial device. By default we simply use the first suitable
1223 device.
1224
1225
1226
1227
1228 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1229
1230 Unlink/delete disk images.
1231
1232 `<vmid>` `integer (1 - N)` ::
1233
1234 The (unique) ID of the VM.
1235
1236 `-force` `boolean` ::
1237
1238 Force physical removal. Without this, we simple remove the disk from the
1239 config file and create an additional configuration entry called
1240 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause
1241 physical removal.
1242
1243 `-idlist` `string` ::
1244
1245 A list of disk IDs you want to delete.
1246
1247
1248
1249
1250 *qm unlock* `<vmid>`
1251
1252 Unlock the VM.
1253
1254 `<vmid>` `integer (1 - N)` ::
1255
1256 The (unique) ID of the VM.
1257
1258
1259
1260 *qm vncproxy* `<vmid>`
1261
1262 Proxy VM VNC traffic to stdin/stdout
1263
1264 `<vmid>` `integer (1 - N)` ::
1265
1266 The (unique) ID of the VM.
1267
1268
1269
1270 *qm wait* `<vmid>` `[OPTIONS]`
1271
1272 Wait until the VM is stopped.
1273
1274 `<vmid>` `integer (1 - N)` ::
1275
1276 The (unique) ID of the VM.
1277
1278 `-timeout` `integer (1 - N)` ::
1279
1280 Timeout in seconds. Default is to wait forever.
1281
1282
1283
1284