qm.1-synopsis.adoc

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