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