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