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