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