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