X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.1-synopsis.adoc;h=3f4964b6d1fdcc9dd2be0b2b89d4c509dca51e32;hp=d64493df681b9bb549c27493e1e4df83ba6bea4d;hb=HEAD;hpb=7af2edf96aacf8fe51bd7728a2457d7185b777b5 diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index d64493d..adc713e 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -9,7 +9,7 @@ An alias for 'qm guest cmd'. Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts down, crashes, etc. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -25,11 +25,11 @@ Indicates if the shutdown was requested by the guest or via qmp. Create a copy of virtual machine/template. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: VMID for the clone. @@ -61,7 +61,7 @@ Add the new VM to the specified pool. The name of the snapshot. -`--storage` `` :: +`--storage` `` :: Target storage for full clone. @@ -73,7 +73,7 @@ Target node. Only allowed if the original VM is on shared storage. Get automatically generated cloudinit config. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -81,13 +81,29 @@ The (unique) ID of the VM. Config type. +*qm cloudinit pending* `` + +Get the cloudinit configuration with both current and pending values. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +*qm cloudinit update* `` + +Regenerate and change cloudinit config drive. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + *qm config* `` `[OPTIONS]` Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -103,7 +119,7 @@ Fetch config values from given snapshot. Create or restore a virtual machine. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -111,9 +127,13 @@ The (unique) ID of the VM. Enable/disable ACPI. -`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: +`--affinity` `` :: + +List of host cores used to execute guest processes, for example: 0,5,8-11 + +`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable communication with the Qemu Guest Agent and its properties. +Enable/disable communication with the QEMU Guest Agent and its properties. `--arch` `` :: @@ -137,7 +157,7 @@ Automatic restart after crash (currently ignored). `--balloon` ` (0 - N)` :: -Amount of target RAM for the VM in MB. Using zero disables the ballon driver. +Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. `--bios` `` ('default =' `seabios`):: @@ -171,6 +191,601 @@ cloud-init: Password to assign the user. Using this is generally not recommended 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. +`--ciupgrade` `` ('default =' `1`):: + +cloud-init: do an automatic package upgrade after the first boot. + +`--ciuser` `` :: + +cloud-init: User name to change ssh keys and password for instead of the image's configured default user. + +`--cores` ` (1 - N)` ('default =' `1`):: + +The number of cores per socket. + +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: + +Emulated CPU type. + +`--cpulimit` ` (0 - 128)` ('default =' `0`):: + +Limit of CPU usage. + +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: + +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. + +`--description` `` :: + +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. + +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: + +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` `` :: + +Allow to overwrite existing VM. ++ +NOTE: Requires option(s): `archive` + +`--freeze` `` :: + +Freeze CPU at startup (use 'c' monitor command to start execution). + +`--hookscript` `` :: + +Script that will be executed during various steps in the vms lifetime. + +`--hostpci[n]` `[[host=]] [,device-id=] [,legacy-igd=<1|0>] [,mapping=] [,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', '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=] [,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 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=]` :: + +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. 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. + +`--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` `` :: + +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 while importing or restoring in the background. + +`--localtime` `` :: + +Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. + +`--lock` `` :: + +Lock/unlock the VM. + +`--machine` `[[type=]] [,viommu=]` :: + +Specify the QEMU machine. + +`--memory` `[current=]` :: + +Memory properties. + +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: + +Set maximum tolerated downtime (in seconds) for migrations. + +`--migrate_speed` ` (0 - N)` ('default =' `0`):: + +Set maximum speed (in MB/s) for migrations. Value 0 is no limit. + +`--name` `` :: + +Set a name for the VM. Only used on the configuration web interface. + +`--nameserver` `` :: + +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. + +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: + +Specify network devices. + +`--numa` `` ('default =' `0`):: + +Enable/disable NUMA. + +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: + +NUMA topology. + +`--onboot` `` ('default =' `0`):: + +Specifies whether a VM will be started during system bootup. + +`--ostype` `` :: + +Specify guest operating system. + +`--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: + +Map host parallel devices (n is 0 to 2). + +`--pool` `` :: + +Add the VM to the specified pool. + +`--protection` `` ('default =' `0`):: + +Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. + +`--reboot` `` ('default =' `1`):: + +Allow reboot. If set to '0' the VM exit on reboot. + +`--rng0` `[source=] [,max_bytes=] [,period=]` :: + +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=] [,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 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=] [,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=] [,product=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,vendor=] [,werror=] [,wwn=]` :: + +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`):: + +SCSI controller model + +`--searchdomain` `` :: + +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. + +`--serial[n]` `(/dev/.+|socket)` :: + +Create a serial device inside the VM (n is 0 to 3) + +`--shares` ` (0 - 50000)` ('default =' `1000`):: + +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. + +`--smbios1` `[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: + +Specify SMBIOS type 1 fields. + +`--smp` ` (1 - N)` ('default =' `1`):: + +The number of CPUs. Please use option -sockets instead. + +`--sockets` ` (1 - N)` ('default =' `1`):: + +The number of CPU sockets. + +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + +`--sshkeys` `` :: + +cloud-init: Setup public SSH keys (one key per line, OpenSSH format). + +`--start` `` ('default =' `0`):: + +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'. + +`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: + +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. + +`--storage` `` :: + +Default storage. + +`--tablet` `` ('default =' `1`):: + +Enable/disable the USB tablet device. + +`--tags` `` :: + +Tags of the VM. This is only meta information. + +`--tdf` `` ('default =' `0`):: + +Enable/disable time drift fix. + +`--template` `` ('default =' `0`):: + +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. ++ +NOTE: Requires option(s): `archive` + +`--unused[n]` `[file=]` :: + +Reference to unused volumes. This is used internally, and should not be modified manually. + +`--usb[n]` `[[host=]] [,mapping=] [,usb3=<1|0>]` :: + +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`):: + +Number of hotplugged vcpus. + +`--vga` `[[type=]] [,clipboard=] [,memory=]` :: + +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=] [,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 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)`):: + +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. + +`--vmstatestorage` `` :: + +Default storage for VM state volumes/files. + +`--watchdog` `[[model=]] [,action=]` :: + +Create a virtual hardware watchdog device. + +*qm delsnapshot* ` ` `[OPTIONS]` + +Delete a VM snapshot. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +The name of the snapshot. + +`--force` `` :: + +For removal from config file, even if removing disk snapshots fails. + +*qm destroy* `` `[OPTIONS]` + +Destroy the VM and all used/owned volumes. Removes any VM specific +permissions and firewall rules + +``: ` (100 - 999999999)` :: + +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 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). + +``: ` (100 - 999999999)` :: + +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. + +``: ` (100 - 999999999)` :: + +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` ` (100 - 999999999)` :: + +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` ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +*qm disk resize* ` ` `[OPTIONS]` + +Extend volume size. + +``: ` (100 - 999999999)` :: + +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. + +``: ` (100 - 999999999)` :: + +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. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +The QGA command. + +*qm guest exec* ` []` `[OPTIONS]` + +Executes the given command via the guest agent + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +Extra arguments as array + +`--pass-stdin` `` ('default =' `0`):: + +When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB. + +`--synchronous` `` ('default =' `1`):: + +If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout. + +`--timeout` ` (0 - N)` ('default =' `30`):: + +The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate + +*qm guest exec-status* ` ` + +Gets the status of the given pid started by the guest-agent + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +The PID to query + +*qm guest passwd* ` ` `[OPTIONS]` + +Sets the password for the given user to the given password + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +The user to set the password for. + +`--crypted` `` ('default =' `0`):: + +set to 1 if the password has already been passed through crypt() + +*qm help* `[OPTIONS]` + +Get help about specified command. + +`--extra-args` `` :: + +Shows help for a specific command + +`--verbose` `` :: + +Verbose output format. + +*qm import* ` --storage ` `[OPTIONS]` + +Import a foreign virtual guest from a supported import source, such as an +ESXi storage. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +The import source volume id. + +`--acpi` `` ('default =' `1`):: + +Enable/disable ACPI. + +`--affinity` `` :: + +List of host cores used to execute guest processes, for example: 0,5,8-11 + +`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=]` :: + +Enable/disable communication with the QEMU Guest Agent and its properties. + +`--arch` `` :: + +Virtual processor architecture. Defaults to the host. + +`--args` `` :: + +Arbitrary arguments passed to kvm. + +`--audio0` `device= [,driver=]` :: + +Configure a audio device, useful in combination with QXL/Spice. + +`--autostart` `` ('default =' `0`):: + +Automatic restart after crash (currently ignored). + +`--balloon` ` (0 - N)` :: + +Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. + +`--bios` `` ('default =' `seabios`):: + +Select BIOS implementation. + +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: + +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. Deprecated: Use 'boot: order=foo;bar' instead. + +`--cdrom` `` :: + +This is an alias for option -ide2 + +`--cicustom` `[meta=] [,network=] [,user=] [,vendor=]` :: + +cloud-init: Specify custom files to replace the automatically generated ones at start. + +`--cipassword` `` :: + +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` `` :: + +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. + +`--ciupgrade` `` ('default =' `1`):: + +cloud-init: do an automatic package upgrade after the first boot. + `--ciuser` `` :: cloud-init: User name to change ssh keys and password for instead of the image's configured default user. @@ -191,19 +806,25 @@ Limit of CPU usage. CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. +`--delete` `` :: + +A list of settings you want to delete. + `--description` `` :: Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: +`--dryrun` `` ('default =' `0`):: -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. +Show the create command and exit without doing anything. -`--force` `` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Allow to overwrite existing VM. -+ -NOTE: Requires option(s): `archive` +Configure a disk for storing EFI vars. + +`--format` `` :: + +Target format `--freeze` `` :: @@ -213,21 +834,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=] [,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>]` :: +`--hostpci[n]` `[[host=]] [,device-id=] [,legacy-igd=<1|0>] [,mapping=] [,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. Using '1' as value 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=] [,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=]` :: +`--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=]` :: -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. +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -259,11 +880,9 @@ Keyboard layout for VNC server. This option is generally not required and is oft Enable/disable KVM hardware virtualization. -`--live-restore` `` :: +`--live-import` `` ('default =' `0`):: -Start the VM immediately from the backup and restore in background. PBS only. -+ -NOTE: Requires option(s): `archive` +Immediately start the VM and copy the data in the background. `--localtime` `` :: @@ -273,13 +892,13 @@ Set the real time clock (RTC) to local time. This is enabled by default if the ` Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the Qemu machine type. +Specify the QEMU machine. -`--memory` ` (16 - N)` ('default =' `512`):: +`--memory` `[current=]` :: -Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. +Memory properties. `--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: @@ -295,9 +914,7 @@ Set a name for the VM. Only used on the configuration web interface. `--nameserver` `` :: -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. +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. `--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -323,10 +940,6 @@ Specify guest operating system. Map host parallel devices (n is 0 to 2). -`--pool` `` :: - -Add the VM to the specified pool. - `--protection` `` ('default =' `0`):: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. @@ -339,13 +952,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=] [,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=]` :: +`--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=]` :: -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. +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`--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=]` :: +`--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=] [,product=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,vendor=] [,werror=] [,wwn=]` :: -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. +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). `--scsihw` `` ('default =' `lsi`):: @@ -353,9 +966,7 @@ SCSI controller model `--searchdomain` `` :: -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. +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. `--serial[n]` `(/dev/.+|socket)` :: @@ -381,14 +992,10 @@ The number of CPU sockets. Configure additional enhancements for SPICE. -`--sshkeys` `` :: +`--sshkeys` `` :: cloud-init: Setup public SSH keys (one key per line, OpenSSH format). -`--start` `` ('default =' `0`):: - -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'. @@ -397,7 +1004,7 @@ Set the initial date of the real time clock. Valid format for date are:'now' or 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. -`--storage` `` :: +`--storage` `` :: Default storage. @@ -417,41 +1024,35 @@ 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` `` :: +`--tpmstate0` `[file=] [,size=] [,version=]` :: -Assign a unique random ethernet address. -+ -NOTE: Requires option(s): `archive` +Configure a Disk for storing TPM state. The format is fixed to 'raw'. `--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. -`--usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[[host=]] [,mapping=] [,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`):: Number of hotplugged vcpus. -`--vga` `[[type=]] [,memory=]` :: +`--vga` `[[type=]] [,clipboard=] [,memory=]` :: 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=] [,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=]` :: +`--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=] [,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 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. +Use volume as VIRTIO hard disk (n is 0 to 15). `--vmgenid` `` ('default =' `1 (autogenerated)`):: Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. -`--vmstatestorage` `` :: +`--vmstatestorage` `` :: Default storage for VM state volumes/files. @@ -459,145 +1060,15 @@ Default storage for VM state volumes/files. Create a virtual hardware watchdog device. -*qm delsnapshot* ` ` `[OPTIONS]` - -Delete a VM snapshot. - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -The name of the snapshot. - -`--force` `` :: - -For removal from config file, even if removing disk snapshots fails. - -*qm destroy* `` `[OPTIONS]` - -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 configurations, like backup & replication jobs and HA. - -`--skiplock` `` :: - -Ignore locks - only root is allowed to use this option. - -*qm guest cmd* ` ` - -Execute Qemu Guest Agent commands. - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -The QGA command. - -*qm guest exec* ` []` `[OPTIONS]` - -Executes the given command via the guest agent - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -Extra arguments as array - -`--pass-stdin` `` ('default =' `0`):: - -When set, read STDIN until EOF and forward to guest agent via 'input-data' (usually treated as STDIN to process launched by guest agent). Allows maximal 1 MiB. - -`--synchronous` `` ('default =' `1`):: - -If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout. - -`--timeout` ` (0 - N)` ('default =' `30`):: - -The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate - -*qm guest exec-status* ` ` - -Gets the status of the given pid started by the guest-agent - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -The PID to query - -*qm guest passwd* ` ` `[OPTIONS]` - -Sets the password for the given user to the given password - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -``: `` :: - -The user to set the password for. - -`--crypted` `` ('default =' `0`):: - -set to 1 if the password has already been passed through crypt() - -*qm help* `[OPTIONS]` - -Get help about specified command. - -`--extra-args` `` :: - -Shows help for a specific command - -`--verbose` `` :: - -Verbose output format. - -*qm importdisk* ` ` `[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 - -``: `` :: +*qm importdisk* -Target storage ID - -`--format` `` :: - -Target format +An alias for 'qm disk import'. *qm importovf* ` ` `[OPTIONS]` Create a new VM using parameters read from an OVF manifest -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -605,7 +1076,7 @@ The (unique) ID of the VM. path to the ovf file -``: `` :: +``: `` :: Target storage ID @@ -629,7 +1100,7 @@ Determine the full status of active VMs. List all snapshots. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -637,7 +1108,7 @@ The (unique) ID of the VM. Migrate virtual machine. Creates a new migration task. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -675,61 +1146,19 @@ Enable live storage migration for local disk *qm monitor* `` -Enter Qemu Monitor interface. - -``: ` (1 - N)` :: - -The (unique) ID of the VM. - -*qm move-disk* ` []` `[OPTIONS]` - -Move volume to different storage or to a different VM. +Enter QEMU Monitor interface. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: 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)` :: +*qm move-disk* -The (unique) ID of the VM. +An alias for 'qm disk move'. *qm move_disk* -An alias for 'qm move-disk'. +An alias for 'qm disk move'. *qm mtunnel* @@ -739,7 +1168,7 @@ Used by qmigrate - do not use manually. Stop embedded nbd server. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -747,7 +1176,7 @@ The (unique) ID of the VM. Get the virtual machine configuration with both current and pending values. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -756,7 +1185,7 @@ The (unique) ID of the VM. Reboot the VM by shutting it down, and starting it again. Applies pending changes. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -764,59 +1193,68 @@ 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`):: +``: ` (100 - 999999999)` :: -Do not actually write changes out to VM config(s). +The (unique) ID of the VM. -`--vmid` ` (1 - N)` :: +``: ` (100 - 999999999)` :: 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. + +``: ` (100 - 999999999)` :: + +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. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -828,11 +1266,11 @@ no description available Ignore locks - only root is allowed to use this option. -*qm rollback* ` ` +*qm rollback* ` ` `[OPTIONS]` Rollback VM state to specified snapshot. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -840,11 +1278,15 @@ The (unique) ID of the VM. The name of the snapshot. +`--start` `` ('default =' `0`):: + +Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.) + *qm sendkey* ` ` `[OPTIONS]` Send key event to virtual machine. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -862,7 +1304,7 @@ Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -870,9 +1312,13 @@ The (unique) ID of the VM. Enable/disable ACPI. -`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: +`--affinity` `` :: + +List of host cores used to execute guest processes, for example: 0,5,8-11 + +`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable communication with the Qemu Guest Agent and its properties. +Enable/disable communication with the QEMU Guest Agent and its properties. `--arch` `` :: @@ -892,7 +1338,7 @@ Automatic restart after crash (currently ignored). `--balloon` ` (0 - N)` :: -Amount of target RAM for the VM in MB. Using zero disables the ballon driver. +Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. `--bios` `` ('default =' `seabios`):: @@ -922,6 +1368,10 @@ cloud-init: Password to assign the user. Using this is generally not recommended 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. +`--ciupgrade` `` ('default =' `1`):: + +cloud-init: do an automatic package upgrade after the first boot. + `--ciuser` `` :: cloud-init: User name to change ssh keys and password for instead of the image's configured default user. @@ -956,7 +1406,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca `--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -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. +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` `` :: @@ -972,13 +1422,13 @@ 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=] [,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>]` :: +`--hostpci[n]` `[[host=]] [,device-id=] [,legacy-igd=<1|0>] [,mapping=] [,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. Using '1' as value 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>` :: @@ -1026,13 +1476,13 @@ Set the real time clock (RTC) to local time. This is enabled by default if the ` Lock/unlock the VM. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the Qemu machine type. +Specify the QEMU machine. -`--memory` ` (16 - N)` ('default =' `512`):: +`--memory` `[current=]` :: -Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. +Memory properties. `--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: @@ -1048,9 +1498,7 @@ Set a name for the VM. Only used on the configuration web interface. `--nameserver` `` :: -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. +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. `--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -1096,7 +1544,7 @@ Configure a VirtIO-based Random Number Generator. 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=] [,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=]` :: +`--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=] [,product=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,vendor=] [,werror=] [,wwn=]` :: 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. @@ -1106,9 +1554,7 @@ SCSI controller model `--searchdomain` `` :: -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. +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. `--serial[n]` `(/dev/.+|socket)` :: @@ -1174,15 +1620,15 @@ Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the sp Reference to unused volumes. This is used internally, and should not be modified manually. -`--usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[[host=]] [,mapping=] [,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`):: Number of hotplugged vcpus. -`--vga` `[[type=]] [,memory=]` :: +`--vga` `[[type=]] [,clipboard=] [,memory=]` :: Configure the VGA hardware. @@ -1194,7 +1640,7 @@ Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. -`--vmstatestorage` `` :: +`--vmstatestorage` `` :: Default storage for VM state volumes/files. @@ -1206,7 +1652,7 @@ Create a virtual hardware watchdog device. Show command line which is used to start the VM (debug info). -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1221,10 +1667,10 @@ Fetch config values from given snapshot. *qm shutdown* `` `[OPTIONS]` Shutdown virtual machine. This is similar to pressing the power button on a -physical machine.This will send an ACPI event for the guest OS, which +physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1248,7 +1694,7 @@ Wait maximal timeout seconds. Snapshot a VM. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1268,7 +1714,7 @@ Save the vmstate Start virtual machine. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1276,9 +1722,9 @@ The (unique) ID of the VM. Override QEMU's -cpu argument with the given string. -`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specifies the Qemu machine type. +Specify the QEMU machine. `--migratedfrom` `` :: @@ -1312,7 +1758,7 @@ Wait maximal timeout seconds. Show VM status. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1322,10 +1768,10 @@ Verbose output format *qm stop* `` `[OPTIONS]` -Stop virtual machine. The qemu process will exit immediately. Thisis akin -to pulling the power plug of a running computer and may damage the VM data +Stop virtual machine. The qemu process will exit immediately. This is akin +to pulling the power plug of a running computer and may damage the VM data. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1337,6 +1783,10 @@ Do not deactivate storage volumes. The cluster node name. +`--overrule-shutdown` `` ('default =' `0`):: + +Try to abort active 'qmshutdown' tasks before stopping. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -1349,7 +1799,7 @@ Wait maximal timeout seconds. Suspend virtual machine. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1357,7 +1807,7 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. -`--statestorage` `` :: +`--statestorage` `` :: The storage for the VM state + @@ -1371,7 +1821,7 @@ If set, suspends the VM to disk. Will be resumed on next VM start. Create a Template. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1384,7 +1834,7 @@ If you want to convert only 1 disk to base image. Open a terminal using a serial device (The VM need to have a serial device configured, for example 'serial0: socket') -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1396,27 +1846,15 @@ 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. - -`--idlist` `` :: +*qm unlink* -A list of disk IDs you want to delete. +An alias for 'qm disk unlink'. *qm unlock* `` Unlock the VM. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1424,7 +1862,7 @@ The (unique) ID of the VM. Proxy VM VNC traffic to stdin/stdout -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -1432,7 +1870,7 @@ The (unique) ID of the VM. Wait until the VM is stopped. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM.