qm.1-synopsis.adoc

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