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=]<enum> [,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 =' `1024`)::
 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=<enum>] [,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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 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=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
 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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 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_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 317
 318 Use volume as VIRTIO hard disk (n is 0 to 15).
 319
 320 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
 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 listsnapshot* `<vmid>`
 385
 386 List all snapshots.
 387
 388 `<vmid>`: `<integer> (1 - N)` ::
 389
 390 The (unique) ID of the VM.
 391
 392
 393
 394 *qm migrate* `<vmid> <target>` `[OPTIONS]`
 395
 396 Migrate virtual machine. Creates a new migration task.
 397
 398 `<vmid>`: `<integer> (1 - N)` ::
 399
 400 The (unique) ID of the VM.
 401
 402 `<target>`: `<string>` ::
 403
 404 Target node.
 405
 406 `-force` `<boolean>` ::
 407
 408 Allow to migrate VMs which use local devices. Only root may use this option.
 409
 410 `-migration_network` `<string>` ::
 411
 412 CIDR of the (sub) network that is used for migration.
 413
 414 `-migration_type` `<insecure | secure>` ::
 415
 416 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
 417
 418 `-online` `<boolean>` ::
 419
 420 Use online/live migration.
 421
 422
 423
 424
 425 *qm monitor* `<vmid>`
 426
 427 Enter Qemu Monitor interface.
 428
 429 `<vmid>`: `<integer> (1 - N)` ::
 430
 431 The (unique) ID of the VM.
 432
 433
 434
 435
 436 *qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
 437
 438 Move volume to different storage.
 439
 440 `<vmid>`: `<integer> (1 - N)` ::
 441
 442 The (unique) ID of the VM.
 443
 444 `<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>` ::
 445
 446 The disk you want to move.
 447
 448 `<storage>`: `<string>` ::
 449
 450 Target storage.
 451
 452 `-delete` `<boolean>` ('default =' `0`)::
 453
 454 Delete the original disk after successful copy. By default the original disk is kept as unused disk.
 455
 456 `-digest` `<string>` ::
 457
 458 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 459
 460 `-format` `<qcow2 | raw | vmdk>` ::
 461
 462 Target Format.
 463
 464
 465
 466
 467 *qm mtunnel*
 468
 469 Used by qmigrate - do not use manually.
 470
 471
 472
 473
 474 *qm pending* `<vmid>`
 475
 476 Get virtual machine configuration, including pending changes.
 477
 478 `<vmid>`: `<integer> (1 - N)` ::
 479
 480 The (unique) ID of the VM.
 481
 482
 483
 484
 485 *qm rescan* `[OPTIONS]`
 486
 487 Rescan all storages and update disk sizes and unused disk images.
 488
 489 `-vmid` `<integer> (1 - N)` ::
 490
 491 The (unique) ID of the VM.
 492
 493
 494
 495
 496 *qm reset* `<vmid>` `[OPTIONS]`
 497
 498 Reset virtual machine.
 499
 500 `<vmid>`: `<integer> (1 - N)` ::
 501
 502 The (unique) ID of the VM.
 503
 504 `-skiplock` `<boolean>` ::
 505
 506 Ignore locks - only root is allowed to use this option.
 507
 508
 509
 510 *qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
 511
 512 Extend volume size.
 513
 514 `<vmid>`: `<integer> (1 - N)` ::
 515
 516 The (unique) ID of the VM.
 517
 518 `<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>` ::
 519
 520 The disk you want to resize.
 521
 522 `<size>`: `\+?\d+(\.\d+)?[KMGT]?` ::
 523
 524 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.
 525
 526 `-digest` `<string>` ::
 527
 528 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 529
 530 `-skiplock` `<boolean>` ::
 531
 532 Ignore locks - only root is allowed to use this option.
 533
 534
 535
 536 *qm resume* `<vmid>` `[OPTIONS]`
 537
 538 Resume virtual machine.
 539
 540 `<vmid>`: `<integer> (1 - N)` ::
 541
 542 The (unique) ID of the VM.
 543
 544 `-nocheck` `<boolean>` ::
 545
 546 no description available
 547
 548 `-skiplock` `<boolean>` ::
 549
 550 Ignore locks - only root is allowed to use this option.
 551
 552
 553
 554 *qm rollback* `<vmid> <snapname>`
 555
 556 Rollback VM state to specified snapshot.
 557
 558 `<vmid>`: `<integer> (1 - N)` ::
 559
 560 The (unique) ID of the VM.
 561
 562 `<snapname>`: `<string>` ::
 563
 564 The name of the snapshot.
 565
 566
 567
 568 *qm sendkey* `<vmid> <key>` `[OPTIONS]`
 569
 570 Send key event to virtual machine.
 571
 572 `<vmid>`: `<integer> (1 - N)` ::
 573
 574 The (unique) ID of the VM.
 575
 576 `<key>`: `<string>` ::
 577
 578 The key (qemu monitor encoding).
 579
 580 `-skiplock` `<boolean>` ::
 581
 582 Ignore locks - only root is allowed to use this option.
 583
 584
 585
 586 *qm set* `<vmid>` `[OPTIONS]`
 587
 588 Set virtual machine options (synchrounous API) - You should consider using
 589 the POST method instead for any actions involving hotplug or storage
 590 allocation.
 591
 592 `<vmid>`: `<integer> (1 - N)` ::
 593
 594 The (unique) ID of the VM.
 595
 596 `-acpi` `<boolean>` ('default =' `1`)::
 597
 598 Enable/disable ACPI.
 599
 600 `-agent` `<boolean>` ('default =' `0`)::
 601
 602 Enable/disable Qemu GuestAgent.
 603
 604 `-args` `<string>` ::
 605
 606 Arbitrary arguments passed to kvm.
 607
 608 `-autostart` `<boolean>` ('default =' `0`)::
 609
 610 Automatic restart after crash (currently ignored).
 611
 612 `-balloon` `<integer> (0 - N)` ::
 613
 614 Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
 615
 616 `-bios` `<ovmf | seabios>` ('default =' `seabios`)::
 617
 618 Select BIOS implementation.
 619
 620 `-boot` `[acdn]{1,4}` ('default =' `cdn`)::
 621
 622 Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
 623
 624 `-bootdisk` `(ide|sata|scsi|virtio)\d+` ::
 625
 626 Enable booting from specified disk.
 627
 628 `-cdrom` `<volume>` ::
 629
 630 This is an alias for option -ide2
 631
 632 `-cores` `<integer> (1 - N)` ('default =' `1`)::
 633
 634 The number of cores per socket.
 635
 636 `-cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
 637
 638 Emulated CPU type.
 639
 640 `-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
 641
 642 Limit of CPU usage.
 643
 644 `-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
 645
 646 CPU weight for a VM.
 647
 648 `-delete` `<string>` ::
 649
 650 A list of settings you want to delete.
 651
 652 `-description` `<string>` ::
 653
 654 Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
 655
 656 `-digest` `<string>` ::
 657
 658 Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
 659
 660 `-efidisk0` `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
 661
 662 Configure a Disk for storing EFI vars
 663
 664 `-force` `<boolean>` ::
 665
 666 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.
 667 +
 668 NOTE: Requires option(s): `delete`
 669
 670 `-freeze` `<boolean>` ::
 671
 672 Freeze CPU at startup (use 'c' monitor command to start execution).
 673
 674 `-hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
 675
 676 Map host PCI devices into guest.
 677
 678 `-hotplug` `<string>` ('default =' `network,disk,usb`)::
 679
 680 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'.
 681
 682 `-hugepages` `<1024 | 2 | any>` ::
 683
 684 Enable/disable hugepages memory.
 685
 686 `-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 687
 688 Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
 689
 690 `-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`)::
 691
 692 Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
 693
 694 `-kvm` `<boolean>` ('default =' `1`)::
 695
 696 Enable/disable KVM hardware virtualization.
 697
 698 `-localtime` `<boolean>` ::
 699
 700 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
 701
 702 `-lock` `<backup | migrate | rollback | snapshot>` ::
 703
 704 Lock/unlock the VM.
 705
 706 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 707
 708 Specific the Qemu machine type.
 709
 710 `-memory` `<integer> (16 - N)` ('default =' `512`)::
 711
 712 Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.
 713
 714 `-migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
 715
 716 Set maximum tolerated downtime (in seconds) for migrations.
 717
 718 `-migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
 719
 720 Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
 721
 722 `-name` `<string>` ::
 723
 724 Set a name for the VM. Only used on the configuration web interface.
 725
 726 `-net[n]` `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
 727
 728 Specify network devices.
 729
 730 `-numa` `<boolean>` ('default =' `0`)::
 731
 732 Enable/disable NUMA.
 733
 734 `-numa[n]` `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]` ::
 735
 736 NUMA topology.
 737
 738 `-onboot` `<boolean>` ('default =' `0`)::
 739
 740 Specifies whether a VM will be started during system bootup.
 741
 742 `-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
 743
 744 Specify guest operating system.
 745
 746 `-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` ::
 747
 748 Map host parallel devices (n is 0 to 2).
 749
 750 `-protection` `<boolean>` ('default =' `0`)::
 751
 752 Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
 753
 754 `-reboot` `<boolean>` ('default =' `1`)::
 755
 756 Allow reboot. If set to '0' the VM exit on reboot.
 757
 758 `-revert` `<string>` ::
 759
 760 Revert a pending change.
 761
 762 `-sata[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 763
 764 Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
 765
 766 `-scsi[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 767
 768 Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
 769
 770 `-scsihw` `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
 771
 772 SCSI controller model
 773
 774 `-serial[n]` `(/dev/.+|socket)` ::
 775
 776 Create a serial device inside the VM (n is 0 to 3)
 777
 778 `-shares` `<integer> (0 - 50000)` ('default =' `1000`)::
 779
 780 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
 781
 782 `-skiplock` `<boolean>` ::
 783
 784 Ignore locks - only root is allowed to use this option.
 785
 786 `-smbios1` `[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
 787
 788 Specify SMBIOS type 1 fields.
 789
 790 `-smp` `<integer> (1 - N)` ('default =' `1`)::
 791
 792 The number of CPUs. Please use option -sockets instead.
 793
 794 `-sockets` `<integer> (1 - N)` ('default =' `1`)::
 795
 796 The number of CPU sockets.
 797
 798 `-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`)::
 799
 800 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'.
 801
 802 `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
 803
 804 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.
 805
 806 `-tablet` `<boolean>` ('default =' `1`)::
 807
 808 Enable/disable the USB tablet device.
 809
 810 `-tdf` `<boolean>` ('default =' `0`)::
 811
 812 Enable/disable time drift fix.
 813
 814 `-template` `<boolean>` ('default =' `0`)::
 815
 816 Enable/disable Template.
 817
 818 `-unused[n]` `<string>` ::
 819
 820 Reference to unused volumes. This is used internally, and should not be modified manually.
 821
 822 `-usb[n]` `[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]` ::
 823
 824 Configure an USB device (n is 0 to 4).
 825
 826 `-vcpus` `<integer> (1 - N)` ('default =' `0`)::
 827
 828 Number of hotplugged vcpus.
 829
 830 `-vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
 831
 832 Select the VGA type.
 833
 834 `-virtio[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,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=<enum>]` ::
 835
 836 Use volume as VIRTIO hard disk (n is 0 to 15).
 837
 838 `-watchdog` `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
 839
 840 Create a virtual hardware watchdog device.
 841
 842
 843
 844
 845 *qm showcmd* `<vmid>`
 846
 847 Show command line which is used to start the VM (debug info).
 848
 849 `<vmid>`: `<integer> (1 - N)` ::
 850
 851 The (unique) ID of the VM.
 852
 853
 854
 855
 856 *qm shutdown* `<vmid>` `[OPTIONS]`
 857
 858 Shutdown virtual machine. This is similar to pressing the power button on a
 859 physical machine.This will send an ACPI event for the guest OS, which
 860 should then proceed to a clean shutdown.
 861
 862 `<vmid>`: `<integer> (1 - N)` ::
 863
 864 The (unique) ID of the VM.
 865
 866 `-forceStop` `<boolean>` ('default =' `0`)::
 867
 868 Make sure the VM stops.
 869
 870 `-keepActive` `<boolean>` ('default =' `0`)::
 871
 872 Do not deactivate storage volumes.
 873
 874 `-skiplock` `<boolean>` ::
 875
 876 Ignore locks - only root is allowed to use this option.
 877
 878 `-timeout` `<integer> (0 - N)` ::
 879
 880 Wait maximal timeout seconds.
 881
 882
 883
 884 *qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
 885
 886 Snapshot a VM.
 887
 888 `<vmid>`: `<integer> (1 - N)` ::
 889
 890 The (unique) ID of the VM.
 891
 892 `<snapname>`: `<string>` ::
 893
 894 The name of the snapshot.
 895
 896 `-description` `<string>` ::
 897
 898 A textual description or comment.
 899
 900 `-vmstate` `<boolean>` ::
 901
 902 Save the vmstate
 903
 904
 905
 906 *qm start* `<vmid>` `[OPTIONS]`
 907
 908 Start virtual machine.
 909
 910 `<vmid>`: `<integer> (1 - N)` ::
 911
 912 The (unique) ID of the VM.
 913
 914 `-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
 915
 916 Specific the Qemu machine type.
 917
 918 `-migratedfrom` `<string>` ::
 919
 920 The cluster node name.
 921
 922 `-migration_network` `<string>` ::
 923
 924 CIDR of the (sub) network that is used for migration.
 925
 926 `-migration_type` `<insecure | secure>` ::
 927
 928 Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
 929
 930 `-skiplock` `<boolean>` ::
 931
 932 Ignore locks - only root is allowed to use this option.
 933
 934 `-stateuri` `<string>` ::
 935
 936 Some command save/restore state from this location.
 937
 938
 939
 940
 941 *qm status* `<vmid>` `[OPTIONS]`
 942
 943 Show VM status.
 944
 945 `<vmid>`: `<integer> (1 - N)` ::
 946
 947 The (unique) ID of the VM.
 948
 949 `-verbose` `<boolean>` ::
 950
 951 Verbose output format
 952
 953
 954
 955
 956 *qm stop* `<vmid>` `[OPTIONS]`
 957
 958 Stop virtual machine. The qemu process will exit immediately. Thisis akin
 959 to pulling the power plug of a running computer and may damage the VM data
 960
 961 `<vmid>`: `<integer> (1 - N)` ::
 962
 963 The (unique) ID of the VM.
 964
 965 `-keepActive` `<boolean>` ('default =' `0`)::
 966
 967 Do not deactivate storage volumes.
 968
 969 `-migratedfrom` `<string>` ::
 970
 971 The cluster node name.
 972
 973 `-skiplock` `<boolean>` ::
 974
 975 Ignore locks - only root is allowed to use this option.
 976
 977 `-timeout` `<integer> (0 - N)` ::
 978
 979 Wait maximal timeout seconds.
 980
 981
 982
 983 *qm suspend* `<vmid>` `[OPTIONS]`
 984
 985 Suspend virtual machine.
 986
 987 `<vmid>`: `<integer> (1 - N)` ::
 988
 989 The (unique) ID of the VM.
 990
 991 `-skiplock` `<boolean>` ::
 992
 993 Ignore locks - only root is allowed to use this option.
 994
 995
 996
 997 *qm template* `<vmid>` `[OPTIONS]`
 998
 999 Create a Template.
1000
1001 `<vmid>`: `<integer> (1 - N)` ::
1002
1003 The (unique) ID of the VM.
1004
1005 `-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>` ::
1006
1007 If you want to convert only 1 disk to base image.
1008
1009
1010
1011
1012 *qm terminal* `<vmid>` `[OPTIONS]`
1013
1014 Open a terminal using a serial device (The VM need to have a serial device
1015 configured, for example 'serial0: socket')
1016
1017 `<vmid>`: `<integer> (1 - N)` ::
1018
1019 The (unique) ID of the VM.
1020
1021 `-iface` `<serial0 | serial1 | serial2 | serial3>` ::
1022
1023 Select the serial device. By default we simply use the first suitable device.
1024
1025
1026
1027
1028 *qm unlink* `<vmid> -idlist <string>` `[OPTIONS]`
1029
1030 Unlink/delete disk images.
1031
1032 `<vmid>`: `<integer> (1 - N)` ::
1033
1034 The (unique) ID of the VM.
1035
1036 `-force` `<boolean>` ::
1037
1038 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.
1039
1040 `-idlist` `<string>` ::
1041
1042 A list of disk IDs you want to delete.
1043
1044
1045
1046
1047 *qm unlock* `<vmid>`
1048
1049 Unlock the VM.
1050
1051 `<vmid>`: `<integer> (1 - N)` ::
1052
1053 The (unique) ID of the VM.
1054
1055
1056
1057 *qm vncproxy* `<vmid>`
1058
1059 Proxy VM VNC traffic to stdin/stdout
1060
1061 `<vmid>`: `<integer> (1 - N)` ::
1062
1063 The (unique) ID of the VM.
1064
1065
1066
1067 *qm wait* `<vmid>` `[OPTIONS]`
1068
1069 Wait until the VM is stopped.
1070
1071 `<vmid>`: `<integer> (1 - N)` ::
1072
1073 The (unique) ID of the VM.
1074
1075 `-timeout` `<integer> (1 - N)` ::
1076
1077 Timeout in seconds. Default is to wait forever.
1078
1079
1080
1081