qm.1-synopsis.adoc

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