X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qm.1-synopsis.adoc;h=e49665be8d25ae1e130c892eb0c1e013b7f74ab7;hb=067d9c3dba03e99d5e1873f13ec7c4786f5151d3;hp=be8288f6c525e9908952a4d81c507845df214c04;hpb=04d22a9f9411585e28337525caf166b454f56add;p=pve-docs.git diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index be8288f..e49665b 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -81,6 +81,22 @@ The (unique) ID of the VM. Config type. +*qm cloudinit pending* `` + +Get the cloudinit configuration with both current and pending values. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +*qm cloudinit update* `` + +Regenerate and change cloudinit config drive. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + *qm config* `` `[OPTIONS]` Get the virtual machine configuration with pending configuration changes @@ -111,9 +127,13 @@ The (unique) ID of the VM. Enable/disable ACPI. +`--affinity` `` :: + +List of host cores used to execute guest processes, for example: 0,5,8-11 + `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable Qemu GuestAgent and its properties. +Enable/disable communication with the Qemu Guest Agent and its properties. `--arch` `` :: @@ -127,7 +147,7 @@ The backup archive. Either the file system path to a .tar or .vma file (use '-' Arbitrary arguments passed to kvm. -`--audio0` `device= [,driver=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -143,13 +163,13 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver. Select BIOS implementation. -`--boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. `--bwlimit` ` (0 - N)` ('default =' `restore limit from datacenter or storage config`):: @@ -159,7 +179,7 @@ Override I/O bandwidth limit (in KiB/s). This is an alias for option -ide2 -`--cicustom` `[meta=] [,network=] [,user=]` :: +`--cicustom` `[meta=] [,network=] [,user=] [,vendor=]` :: cloud-init: Specify custom files to replace the automatically generated ones at start. @@ -167,7 +187,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at 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. -`--citype` `` :: +`--citype` `` :: 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. @@ -187,17 +207,17 @@ Emulated CPU type. Limit of CPU usage. -`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. `--description` `` :: -Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`--efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--force` `` :: @@ -213,21 +233,21 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. `--hotplug` `` ('default =' `network,disk,usb`):: -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'. +Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. `--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -235,26 +255,39 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface. + IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. + -The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit +gateway should be provided. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + -If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. `--ivshmem` `size= [,name=]` :: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. +`--keephugepages` `` ('default =' `0`):: + +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. + `--keyboard` `` :: -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. `--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. +`--live-restore` `` :: + +Start the VM immediately from the backup and restore in background. PBS only. ++ +NOTE: Requires option(s): `archive` + `--localtime` `` :: -Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. +Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. `--lock` `` :: @@ -300,7 +333,7 @@ NUMA topology. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: Specify guest operating system. @@ -324,13 +357,13 @@ Allow reboot. If set to '0' the VM exit on reboot. Configure a VirtIO-based Random Number Generator. -`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. -`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--scsihw` `` ('default =' `lsi`):: @@ -374,7 +407,7 @@ Start VM after it was created successfully. `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -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'. +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'. `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -400,6 +433,10 @@ Enable/disable time drift fix. Enable/disable Template. +`--tpmstate0` `[file=] [,import-from=] [,size=] [,version=]` :: + +Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. + `--unique` `` :: Assign a unique random ethernet address. @@ -412,7 +449,7 @@ Reference to unused volumes. This is used internally, and should not be modified `--usb[n]` `[host=] [,usb3=<1|0>]` :: -Configure an USB device (n is 0 to 4). +Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). `--vcpus` ` (1 - N)` ('default =' `0`):: @@ -422,9 +459,9 @@ Number of hotplugged vcpus. Configure the VGA hardware. -`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--vmgenid` `` ('default =' `1 (autogenerated)`):: @@ -456,20 +493,144 @@ For removal from config file, even if removing disk snapshots fails. *qm destroy* `` `[OPTIONS]` -Destroy the vm (also delete all used/owned volumes). +Destroy the VM and all used/owned volumes. Removes any VM specific +permissions and firewall rules ``: ` (1 - N)` :: The (unique) ID of the VM. +`--destroy-unreferenced-disks` `` ('default =' `0`):: + +If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + `--purge` `` :: -Remove vmid from backup cron jobs. +Remove VMID from configurations, like backup & replication jobs and HA. `--skiplock` `` :: Ignore locks - only root is allowed to use this option. +*qm disk import* ` ` `[OPTIONS]` + +Import an external disk image as an unused disk in a VM. The + image format has to be supported by qemu-img(1). + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +Path to the disk image to import + +``: `` :: + +Target storage ID + +`--format` `` :: + +Target format + +*qm disk move* ` []` `[OPTIONS]` + +Move volume to different storage or to a different VM. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +The disk you want to move. + +``: `` :: + +Target storage. + +`--bwlimit` ` (0 - N)` ('default =' `move limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--delete` `` ('default =' `0`):: + +Delete the original disk after successful copy. By default the original disk is kept as unused disk. + +`--digest` `` :: + +Prevent changes if current configuration file has different SHA1" + ." digest. This can be used to prevent concurrent modifications. + +`--format` `` :: + +Target Format. + +`--target-digest` `` :: + +Prevent changes if the current config file of the target VM has a" + ." different SHA1 digest. This can be used to detect concurrent modifications. + +`--target-disk` `` :: + +The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. + +`--target-vmid` ` (1 - N)` :: + +The (unique) ID of the VM. + +*qm disk rescan* `[OPTIONS]` + +Rescan all storages and update disk sizes and unused disk images. + +`--dryrun` `` ('default =' `0`):: + +Do not actually write changes out to VM config(s). + +`--vmid` ` (1 - N)` :: + +The (unique) ID of the VM. + +*qm disk resize* ` ` `[OPTIONS]` + +Extend volume size. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +The disk you want to resize. + +``: `\+?\d+(\.\d+)?[KMGT]?` :: + +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. + +`--digest` `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + +`--skiplock` `` :: + +Ignore locks - only root is allowed to use this option. + +*qm disk unlink* ` --idlist ` `[OPTIONS]` + +Unlink/delete disk images. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +`--force` `` :: + +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. + +`--idlist` `` :: + +A list of disk IDs you want to delete. + *qm guest cmd* ` ` Execute Qemu Guest Agent commands. @@ -546,26 +707,9 @@ Shows help for a specific command Verbose output format. -*qm importdisk* ` ` `[OPTIONS]` +*qm importdisk* -Import an external disk image as an unused disk in a VM. The - image format has to be supported by qemu-img(1). - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -Path to the disk image to import - -``: `` :: - -Target storage ID - -`--format` `` :: - -Target format +An alias for 'qm disk import'. *qm importovf* ` ` `[OPTIONS]` @@ -655,37 +799,13 @@ Enter Qemu Monitor interface. The (unique) ID of the VM. -*qm move_disk* ` ` `[OPTIONS]` - -Move volume to different storage. - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -The disk you want to move. - -``: `` :: - -Target storage. - -`--bwlimit` ` (0 - N)` ('default =' `move limit from datacenter or storage config`):: - -Override I/O bandwidth limit (in KiB/s). - -`--delete` `` ('default =' `0`):: +*qm move-disk* -Delete the original disk after successful copy. By default the original disk is kept as unused disk. - -`--digest` `` :: +An alias for 'qm disk move'. -Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +*qm move_disk* -`--format` `` :: - -Target Format. +An alias for 'qm disk move'. *qm mtunnel* @@ -720,54 +840,63 @@ The (unique) ID of the VM. Wait maximal timeout seconds for the shutdown. -*qm rescan* `[OPTIONS]` +*qm remote-migrate* ` [] --target-bridge --target-storage ` `[OPTIONS]` -Rescan all storages and update disk sizes and unused disk images. +Migrate virtual machine to a remote cluster. Creates a new migration task. +EXPERIMENTAL feature! -`--dryrun` `` ('default =' `0`):: +``: ` (1 - N)` :: -Do not actually write changes out to VM config(s). +The (unique) ID of the VM. -`--vmid` ` (1 - N)` :: +``: ` (1 - N)` :: The (unique) ID of the VM. -*qm reset* `` `[OPTIONS]` +``: `apitoken= ,host= [,fingerprint=] [,port=]` :: -Reset virtual machine. +Remote target endpoint -``: ` (1 - N)` :: +`--bwlimit` ` (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: -The (unique) ID of the VM. +Override I/O bandwidth limit (in KiB/s). -`--skiplock` `` :: +`--delete` `` ('default =' `0`):: -Ignore locks - only root is allowed to use this option. +Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. -*qm resize* ` ` `[OPTIONS]` +`--online` `` :: -Extend volume size. +Use online/live migration if VM is running. Ignored if VM is stopped. -``: ` (1 - N)` :: +`--target-bridge` `` :: -The (unique) ID of the VM. +Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. -``: `` :: +`--target-storage` `` :: -The disk you want to resize. +Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. -``: `\+?\d+(\.\d+)?[KMGT]?` :: +*qm rescan* -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. +An alias for 'qm disk rescan'. -`--digest` `` :: +*qm reset* `` `[OPTIONS]` -Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +Reset virtual machine. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. `--skiplock` `` :: Ignore locks - only root is allowed to use this option. +*qm resize* + +An alias for 'qm disk resize'. + *qm resume* `` `[OPTIONS]` Resume virtual machine. @@ -784,7 +913,7 @@ no description available Ignore locks - only root is allowed to use this option. -*qm rollback* ` ` +*qm rollback* ` ` `[OPTIONS]` Rollback VM state to specified snapshot. @@ -796,6 +925,10 @@ The (unique) ID of the VM. The name of the snapshot. +`--start` `` ('default =' `0`):: + +Whether the VM should get started after rolling back successfully + *qm sendkey* ` ` `[OPTIONS]` Send key event to virtual machine. @@ -826,9 +959,13 @@ The (unique) ID of the VM. Enable/disable ACPI. +`--affinity` `` :: + +List of host cores used to execute guest processes, for example: 0,5,8-11 + `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable Qemu GuestAgent and its properties. +Enable/disable communication with the Qemu Guest Agent and its properties. `--arch` `` :: @@ -838,7 +975,7 @@ Virtual processor architecture. Defaults to the host. Arbitrary arguments passed to kvm. -`--audio0` `device= [,driver=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -854,19 +991,19 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver. Select BIOS implementation. -`--boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. `--cdrom` `` :: This is an alias for option -ide2 -`--cicustom` `[meta=] [,network=] [,user=]` :: +`--cicustom` `[meta=] [,network=] [,user=] [,vendor=]` :: cloud-init: Specify custom files to replace the automatically generated ones at start. @@ -874,7 +1011,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at 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. -`--citype` `` :: +`--citype` `` :: 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. @@ -894,9 +1031,9 @@ Emulated CPU type. Limit of CPU usage. -`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. `--delete` `` :: @@ -904,15 +1041,15 @@ A list of settings you want to delete. `--description` `` :: -Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. `--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`--efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--force` `` :: @@ -928,21 +1065,21 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,device-id=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,sub-device-id=] [,sub-vendor-id=] [,vendor-id=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. `--hotplug` `` ('default =' `network,disk,usb`):: -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'. +Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. `--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -950,18 +1087,25 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface. + IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. + -The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit +gateway should be provided. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + -If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. `--ivshmem` `size= [,name=]` :: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. +`--keephugepages` `` ('default =' `0`):: + +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. + `--keyboard` `` :: -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. `--kvm` `` ('default =' `1`):: @@ -969,7 +1113,7 @@ Enable/disable KVM hardware virtualization. `--localtime` `` :: -Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. +Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. `--lock` `` :: @@ -1015,7 +1159,7 @@ NUMA topology. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: Specify guest operating system. @@ -1039,13 +1183,13 @@ Revert a pending change. Configure a VirtIO-based Random Number Generator. -`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. -`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--scsihw` `` ('default =' `lsi`):: @@ -1089,7 +1233,7 @@ cloud-init: Setup public SSH keys (one key per line, OpenSSH format). `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -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'. +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'. `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -1111,13 +1255,17 @@ Enable/disable time drift fix. Enable/disable Template. +`--tpmstate0` `[file=] [,import-from=] [,size=] [,version=]` :: + +Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. + `--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. `--usb[n]` `[host=] [,usb3=<1|0>]` :: -Configure an USB device (n is 0 to 4). +Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). `--vcpus` ` (1 - N)` ('default =' `0`):: @@ -1127,9 +1275,9 @@ Number of hotplugged vcpus. Configure the VGA hardware. -`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. `--vmgenid` `` ('default =' `1 (autogenerated)`):: @@ -1316,7 +1464,7 @@ Create a Template. The (unique) ID of the VM. -`--disk` `` :: +`--disk` `` :: If you want to convert only 1 disk to base image. @@ -1337,21 +1485,9 @@ Escape character. Select the serial device. By default we simply use the first suitable device. -*qm unlink* ` --idlist ` `[OPTIONS]` - -Unlink/delete disk images. - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -`--force` `` :: - -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. +*qm unlink* -`--idlist` `` :: - -A list of disk IDs you want to delete. +An alias for 'qm disk unlink'. *qm unlock* ``