X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qm.1-synopsis.adoc;h=adc713eb8a7f2780f6d6214f257b3ceca34a236e;hb=refs%2Fheads%2Fmaster;hp=45c2206684ea9c50e3eb9c0d860dc896650da98a;hpb=9b3e4991113526213b75551d302c8d73deb0b6ed;p=pve-docs.git diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 45c2206..adc713e 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,1282 +1,1881 @@ *qm* ` [ARGS] [OPTIONS]` +*qm agent* + +An alias for 'qm guest cmd'. + +*qm cleanup* ` ` + +Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts +down, crashes, etc. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `` :: + +Indicates if qemu shutdown cleanly. + +``: `` :: + +Indicates if the shutdown was requested by the guest or via qmp. + *qm clone* ` ` `[OPTIONS]` -Create a copy of virtual machine/template. +Create a copy of virtual machine/template. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: ` (100 - 999999999)` :: + +VMID for the clone. + +`--bwlimit` ` (0 - N)` ('default =' `clone limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--description` `` :: + +Description for the new VM. + +`--format` `` :: + +Target format for file storage. Only valid for full clone. + +`--full` `` :: + +Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. + +`--name` `` :: + +Set a name for the new VM. + +`--pool` `` :: + +Add the new VM to the specified pool. + +`--snapname` `` :: + +The name of the snapshot. + +`--storage` `` :: + +Target storage for full clone. + +`--target` `` :: + +Target node. Only allowed if the original VM is on shared storage. + +*qm cloudinit dump* ` ` + +Get automatically generated cloudinit config. + +``: ` (100 - 999999999)` :: + +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. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +`--current` `` ('default =' `0`):: + +Get current values (instead of pending values). + +`--snapshot` `` :: + +Fetch config values from given snapshot. + +*qm create* `` `[OPTIONS]` + +Create or restore a virtual machine. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +`--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. + +`--archive` `` :: + +The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. + +`--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. + +`--bwlimit` ` (0 - N)` ('default =' `restore limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--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. + +`--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. -`` `integer (1 - N)` :: +*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. -`` `integer (1 - N)` :: +``: `` :: -VMID for the clone. +The import source volume id. -`-description` `string` :: +`--acpi` `` ('default =' `1`):: -Description for the new VM. +Enable/disable ACPI. -`-format` `(qcow2 | raw | vmdk)` :: +`--affinity` `` :: -Target format for file storage. -+ -NOTE: Requires option(s): `full` +List of host cores used to execute guest processes, for example: 0,5,8-11 -`-full` `boolean` (default=`0`):: +`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Create a full copy of all disk. This is always done when you clone a normal -VM. For VM templates, we try to create a linked clone by default. +Enable/disable communication with the QEMU Guest Agent and its properties. -`-name` `string` :: +`--arch` `` :: -Set a name for the new VM. +Virtual processor architecture. Defaults to the host. -`-pool` `string` :: +`--args` `` :: -Add the new VM to the specified pool. +Arbitrary arguments passed to kvm. -`-snapname` `string` :: +`--audio0` `device= [,driver=]` :: -The name of the snapshot. +Configure a audio device, useful in combination with QXL/Spice. -`-storage` `string` :: +`--autostart` `` ('default =' `0`):: -Target storage for full clone. -+ -NOTE: Requires option(s): `full` +Automatic restart after crash (currently ignored). -`-target` `string` :: +`--balloon` ` (0 - N)` :: -Target node. Only allowed if the original VM is on shared storage. +Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. +`--bios` `` ('default =' `seabios`):: +Select BIOS implementation. -*qm config* `` `[OPTIONS]` +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Get current virtual machine configuration. This does not include pending -configuration changes (see 'pending' API). +Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. -`` `integer (1 - N)` :: +`--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -The (unique) ID of the VM. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. -`-current` `boolean` (default=`0`):: +`--cdrom` `` :: -Get current values (instead of pending values). +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. -*qm create* `` `[OPTIONS]` +`--cipassword` `` :: -Create or restore a virtual machine. +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. -`` `integer (1 - N)` :: +`--citype` `` :: -The (unique) ID of the VM. +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. -`-acpi` `boolean` (default=`1`):: +`--ciupgrade` `` ('default =' `1`):: -Enable/disable ACPI. +cloud-init: do an automatic package upgrade after the first boot. -`-agent` `boolean` (default=`0`):: +`--ciuser` `` :: -Enable/disable Qemu GuestAgent. +cloud-init: User name to change ssh keys and password for instead of the image's configured default user. -`-archive` `string` :: +`--cores` ` (1 - N)` ('default =' `1`):: -The backup file. +The number of cores per socket. -`-args` `string` :: +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: -NOTE: this option is for experts only. It allows you to pass arbitrary -arguments to kvm, for example: -+ -args: -no-reboot -no-hpet +Emulated CPU type. -`-autostart` `boolean` (default=`0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: -Automatic restart after crash (currently ignored). +Limit of CPU usage. -`-balloon` `integer (0 - N)` :: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -Amount of target RAM for the VM in MB. Using zero disables the ballon -driver. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. -`-bios` `(ovmf | seabios)` (default=`seabios`):: +`--delete` `` :: -Select BIOS implementation. +A list of settings you want to delete. -`-boot` `[acdn]{1,4}` (default=`cdn`):: +`--description` `` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`-bootdisk` `(ide|sata|scsi|virtio)\d+` :: +`--dryrun` `` ('default =' `0`):: -Enable booting from specified disk. +Show the create command and exit without doing anything. -`-cdrom` `volume` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -This is an alias for option -ide2 +Configure a disk for storing EFI vars. -`-cores` `integer (1 - N)` (default=`1`):: +`--format` `` :: -The number of cores per socket. +Target format -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--freeze` `` :: -Emulated CPU type. +Freeze CPU at startup (use 'c' monitor command to start execution). -`-cpulimit` `number (0 - 128)` (default=`0`):: +`--hookscript` `` :: -Limit of CPU usage. -+ -NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' -indicates no CPU limit. +Script that will be executed during various steps in the vms lifetime. -`-cpuunits` `integer (0 - 500000)` (default=`1000`):: +`--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>]` :: -CPU weight for a VM. Argument is used in the kernel fair scheduler. The -larger the number is, the more CPU time this VM gets. Number is relative to -weights of all the other running VMs. -+ -NOTE: You can disable fair-scheduler configuration by setting this to 0. +Map host PCI devices into guest. -`-description` `string` :: +`--hotplug` `` ('default =' `network,disk,usb`):: -Description for the VM. Only used on the configuration web interface. This -is saved as comment inside the configuration file. +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. -`-force` `boolean` :: +`--hugepages` `<1024 | 2 | any>` :: -Allow to overwrite existing VM. -+ -NOTE: Requires option(s): `archive` +Enable/disable hugepages memory. -`-freeze` `boolean` :: +`--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=]` :: -Freeze CPU at startup (use 'c' monitor command to start execution). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: -Map host pci devices. HOSTPCIDEVICE syntax is: -+ -'bus:dev.func' (hexadecimal numbers) +cloud-init: Specify IP addresses and gateways for the corresponding interface. + -You can us the 'lspci' command to list existing pci devices. +IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. + -The 'rombar' option determines whether or not the device's ROM will be -visible in the guest's memory map (default is 'on'). +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. + -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. -+ -Experimental: user reported problems with this option. +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. -`-hotplug` `string` (default=`network,disk,usb`):: +`--ivshmem` `size= [,name=]` :: -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'. +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. -`-ide[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--keephugepages` `` ('default =' `0`):: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. -`-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`):: +`--keyboard` `` :: -Keybord layout for vnc server. Default is read from the datacenter -configuration file. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. -`-kvm` `boolean` (default=`1`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `boolean` :: +`--live-import` `` ('default =' `0`):: -Set the real time clock to local time. This is enabled by default if ostype -indicates a Microsoft OS. +Immediately start the VM and copy the data in the background. -`-lock` `(backup | migrate | rollback | snapshot)` :: +`--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` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specific the Qemu machine type. +Specify the QEMU machine. -`-memory` `integer (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` `number (0 - N)` (default=`0.1`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` `integer (0 - N)` (default=`0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `string` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `string` :: +`--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. -+ -MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 -i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 -+ -XX:XX:XX:XX:XX:XX should be an unique MAC address. This is -automatically generated if not specified. -+ -The bridge parameter can be used to automatically add the interface to a -bridge device. The Proxmox VE standard bridge is called 'vmbr0'. -+ -Option 'rate' is used to limit traffic bandwidth from and to this -interface. It is specified as floating point number, unit is 'Megabytes per -second'. -+ -If you specify no bridge, we create a kvm 'user' (NATed) network device, -which provides DHCP and DNS services. The following addresses are used: -+ -10.0.2.2 Gateway -10.0.2.3 DNS Server -10.0.2.4 SMB Server -+ -The DHCP server assign addresses to the guest starting from 10.0.2.15. -`-numa` `boolean` (default=`0`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: -numa topology +NUMA topology. -`-onboot` `boolean` (default=`0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: +`--ostype` `` :: -Used to enable special optimization/features for specific -operating systems: -+ -other => unspecified OS -wxp => Microsoft Windows XP -w2k => Microsoft Windows 2000 -w2k3 => Microsoft Windows 2003 -w2k8 => Microsoft Windows 2008 -wvista => Microsoft Windows Vista -win7 => Microsoft Windows 7 -win8 => Microsoft Windows 8/2012 -l24 => Linux 2.4 Kernel -l26 => Linux 2.6/3.X Kernel -solaris => solaris/opensolaris/openindiania kernel -+ -other|l24|l26|solaris ... no special behaviour -wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch +Specify guest operating system. -`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: +`--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: Map host parallel devices (n is 0 to 2). -+ -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. -+ -Experimental: user reported problems with this option. -`-pool` `string` :: +`--protection` `` ('default =' `0`):: -Add the VM to the specified pool. +Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-protection` `boolean` (default=`0`):: +`--reboot` `` ('default =' `1`):: -Sets the protection flag of the VM. This will prevent the remove operation. +Allow reboot. If set to '0' the VM exit on reboot. -`-reboot` `boolean` (default=`1`):: +`--rng0` `[source=] [,max_bytes=] [,period=]` :: -Allow reboot. If set to '0' the VM exit on reboot. +Configure a VirtIO-based Random Number Generator. -`-sata[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--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). -`-scsi[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--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 13). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). -`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: +`--scsihw` `` ('default =' `lsi`):: -scsi controller model +SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--searchdomain` `` :: -Create a serial device inside the VM (n is 0 to 3), and pass through a host -serial device (i.e. /dev/ttyS0), or create a unix socket on the host side -(use 'qm terminal' to open a terminal connection). -+ -NOTE: If you pass through a host serial device, it is no longer possible to -migrate such machines - use with special care. -+ -Experimental: user reported problems with this option. +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. -`-shares` `integer (0 - 50000)` (default=`1000`):: +`--serial[n]` `(/dev/.+|socket)` :: -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 +Create a serial device inside the VM (n is 0 to 3) -`-smbios[n]` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--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` `integer (1 - N)` (default=`1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` `integer (1 - N)` (default=`1`):: +`--sockets` ` (1 - N)` ('default =' `1`):: The number of CPU sockets. -`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: -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'. +Configure additional enhancements for SPICE. -`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: +`--sshkeys` `` :: -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. +cloud-init: Setup public SSH keys (one key per line, OpenSSH format). -`-storage` `string` :: +`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -Default storage. +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'. -`-tablet` `boolean` (default=`1`):: +`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: -Enable/disable the USB tablet device. This device is usually needed to -allow absolute mouse positioning with VNC. Else the mouse runs out of sync -with normal VNC clients. If you're running lots of console-only guests on -one host, you may consider disabling this to save some context switches. -This is turned off by default if you use spice (-vga=qxl). +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. -`-tdf` `boolean` (default=`0`):: +`--storage` `` :: -Enable/disable time drift fix. +Default storage. -`-template` `boolean` (default=`0`):: +`--tablet` `` ('default =' `1`):: -Enable/disable Template. +Enable/disable the USB tablet device. -`-unique` `boolean` :: +`--tags` `` :: -Assign a unique random ethernet address. -+ -NOTE: Requires option(s): `archive` +Tags of the VM. This is only meta information. -`-unused[n]` `string` :: +`--tdf` `` ('default =' `0`):: -Reference to unused volumes. +Enable/disable time drift fix. -`-usb[n]` `[host=] [,usb3=]` :: +`--template` `` ('default =' `0`):: -Configure an USB device (n is 0 to 4). This can be used to -pass-through usb devices to the guest. HOSTUSBDEVICE syntax is: -+ -'bus-port(.port)*' (decimal numbers) or -'vendor_id:product_id' (hexadeciaml numbers) or -'spice' -+ -You can use the 'lsusb -t' command to list existing usb devices. -+ -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. -+ -The value 'spice' can be used to add a usb redirection devices for spice. -+ -The 'usb3' option determines whether the device is a USB3 device or not -(this does currently not work reliably with spice redirection and is then -ignored). +Enable/disable Template. -`-vcpus` `integer (1 - N)` (default=`0`):: +`--tpmstate0` `[file=] [,size=] [,version=]` :: -Number of hotplugged vcpus. +Configure a Disk for storing TPM state. The format is fixed to 'raw'. -`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: +`--unused[n]` `[file=]` :: -Select the VGA type. If you want to use high resolution modes (>= -1280x1024x16) then you should use the options 'std' or 'vmware'. Default is -'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option -enables the SPICE display sever. For win* OS you can select how many -independent displays you want, Linux guests can add displays them self. You -can also run without any graphic card, using a serial device as terminal. +Reference to unused volumes. This is used internally, and should not be modified manually. -`-virtio[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--usb[n]` `[[host=]] [,mapping=] [,usb3=<1|0>]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +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). -`-watchdog` `[action=] [,[model=]]` :: +`--vcpus` ` (1 - N)` ('default =' `0`):: -Create a virtual hardware watchdog device. Once enabled (by a guest -action), the watchdog must be periodically polled by an agent inside the -guest or else the watchdog will reset the guest (or execute the respective -action specified) +Number of hotplugged vcpus. +`--vga` `[[type=]] [,clipboard=] [,memory=]` :: +Configure the VGA hardware. -*qm delsnapshot* ` ` `[OPTIONS]` +`--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=]` :: -Delete a VM snapshot. +Use volume as VIRTIO hard disk (n is 0 to 15). -`` `integer (1 - N)` :: +`--vmgenid` `` ('default =' `1 (autogenerated)`):: -The (unique) ID of the VM. +Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. -`` `string` :: +`--vmstatestorage` `` :: -The name of the snapshot. +Default storage for VM state volumes/files. -`-force` `boolean` :: +`--watchdog` `[[model=]] [,action=]` :: -For removal from config file, even if removing disk snapshots fails. +Create a virtual hardware watchdog device. +*qm importdisk* +An alias for 'qm disk import'. -*qm destroy* `` `[OPTIONS]` +*qm importovf* ` ` `[OPTIONS]` -Destroy the vm (also delete all used/owned volumes). +Create a new VM using parameters read from an OVF manifest -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-skiplock` `boolean` :: - -Ignore locks - only root is allowed to use this option. - - - - -*qm help* `[]` `[OPTIONS]` +``: `` :: -Get help about specified command. - -`` `string` :: +path to the ovf file -Command name +``: `` :: -`-verbose` `boolean` :: +Target storage ID -Verbose output format. +`--dryrun` `` :: +Print a parsed representation of the extracted OVF parameters, but do not create a VM +`--format` `` :: +Target format *qm list* `[OPTIONS]` Virtual machine index (per node). -`-full` `boolean` :: +`--full` `` :: Determine the full status of active VMs. +*qm listsnapshot* `` + +List all snapshots. +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. *qm migrate* ` ` `[OPTIONS]` Migrate virtual machine. Creates a new migration task. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: Target node. -`-force` `boolean` :: +`--bwlimit` ` (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: -Allow to migrate VMs which use local devices. Only root may use this -option. +Override I/O bandwidth limit (in KiB/s). -`-online` `boolean` :: +`--force` `` :: -Use online/live migration. +Allow to migrate VMs which use local devices. Only root may use this option. +`--migration_network` `` :: +CIDR of the (sub) network that is used for migration. +`--migration_type` `` :: -*qm monitor* `` +Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. -Enter Qemu Monitor interface. +`--online` `` :: -`` `integer (1 - N)` :: +Use online/live migration if VM is running. Ignored if VM is stopped. -The (unique) ID of the VM. +`--targetstorage` `` :: +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. +`--with-local-disks` `` :: +Enable live storage migration for local disk -*qm move_disk* ` ` `[OPTIONS]` +*qm monitor* `` -Move volume to different storage. +Enter QEMU Monitor interface. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: - -The disk you want to move. - -`` `string` :: +*qm move-disk* -Target storage. - -`-delete` `boolean` (default=`0`):: +An alias for 'qm disk move'. -Delete the original disk after successful copy. By default the original -disk is kept as unused disk. +*qm move_disk* -`-digest` `string` :: +An alias for 'qm disk move'. -Prevent changes if current configuration file has different SHA1 digest. -This can be used to prevent concurrent modifications. - -`-format` `(qcow2 | raw | vmdk)` :: +*qm mtunnel* -Target Format. +Used by qmigrate - do not use manually. +*qm nbdstop* `` +Stop embedded nbd server. +``: ` (100 - 999999999)` :: -*qm mtunnel* +The (unique) ID of the VM. -Used by qmigrate - do not use manually. +*qm pending* `` +Get the virtual machine configuration with both current and pending values. +``: ` (100 - 999999999)` :: +The (unique) ID of the VM. -*qm pending* `` +*qm reboot* `` `[OPTIONS]` -Get virtual machine configuration, including pending changes. +Reboot the VM by shutting it down, and starting it again. Applies pending +changes. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. +`--timeout` ` (0 - N)` :: +Wait maximal timeout seconds for the shutdown. +*qm remote-migrate* ` [] --target-bridge --target-storage ` `[OPTIONS]` -*qm rescan* `[OPTIONS]` +Migrate virtual machine to a remote cluster. Creates a new migration task. +EXPERIMENTAL feature! -Rescan all storages and update disk sizes and unused disk images. - -`-vmid` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. +``: ` (100 - 999999999)` :: +The (unique) ID of the VM. +``: `apitoken= ,host=
[,fingerprint=] [,port=]` :: -*qm reset* `` `[OPTIONS]` - -Reset virtual machine. +Remote target endpoint -`` `integer (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` `boolean` :: +`--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. +`--online` `` :: +Use online/live migration if VM is running. Ignored if VM is stopped. -*qm resize* ` ` `[OPTIONS]` +`--target-bridge` `` :: -Extend volume size. +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. -`` `integer (1 - N)` :: +`--target-storage` `` :: -The (unique) ID of the VM. +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. -`` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: +*qm rescan* -The disk you want to resize. +An alias for 'qm disk rescan'. -`` `\+?\d+(\.\d+)?[KMGT]?` :: +*qm reset* `` `[OPTIONS]` -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. +Reset virtual machine. -`-digest` `string` :: +``: ` (100 - 999999999)` :: -Prevent changes if current configuration file has different SHA1 digest. -This can be used to prevent concurrent modifications. +The (unique) ID of the VM. -`-skiplock` `boolean` :: +`--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. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-nocheck` `boolean` :: +`--nocheck` `` :: no description available -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. - - -*qm rollback* ` ` +*qm rollback* ` ` `[OPTIONS]` Rollback VM state to specified snapshot. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: 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. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The key (qemu monitor encoding). -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. - - *qm set* `` `[OPTIONS]` Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-acpi` `boolean` (default=`1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `boolean` (default=`0`):: +`--affinity` `` :: -Enable/disable Qemu GuestAgent. +List of host cores used to execute guest processes, for example: 0,5,8-11 -`-args` `string` :: +`--agent` `[enabled=]<1|0> [,freeze-fs-on-backup=<1|0>] [,fstrim_cloned_disks=<1|0>] [,type=]` :: -NOTE: this option is for experts only. It allows you to pass arbitrary -arguments to kvm, for example: -+ -args: -no-reboot -no-hpet +Enable/disable communication with the QEMU Guest Agent and its properties. + +`--arch` `` :: -`-autostart` `boolean` (default=`0`):: +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` `integer (0 - N)` :: +`--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` `(ovmf | seabios)` (default=`seabios`):: +`--bios` `` ('default =' `seabios`):: 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+` :: +`--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. -`-cdrom` `volume` :: +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` `integer (1 - N)` (default=`1`):: +`--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. + +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. -`-cpulimit` `number (0 - 128)` (default=`0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -+ -NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' -indicates no CPU limit. -`-cpuunits` `integer (0 - 500000)` (default=`1000`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. Argument is used in the kernel fair scheduler. The -larger the number is, the more CPU time this VM gets. Number is relative to -weights of all the other running VMs. -+ -NOTE: You can disable fair-scheduler configuration by setting this to 0. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. -`-delete` `string` :: +`--delete` `` :: A list of settings you want to delete. -`-description` `string` :: +`--description` `` :: + +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -Description for the VM. Only used on the configuration web interface. This -is saved as comment inside the configuration file. +`--digest` `` :: -`-digest` `string` :: +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -Prevent changes if current configuration file has different SHA1 digest. -This can be used to prevent concurrent modifications. +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -`-force` `boolean` :: +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 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. +`--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. + NOTE: Requires option(s): `delete` -`-freeze` `boolean` :: +`--freeze` `` :: Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`--hookscript` `` :: -Map host pci devices. HOSTPCIDEVICE syntax is: -+ -'bus:dev.func' (hexadecimal numbers) -+ -You can us the 'lspci' command to list existing pci devices. +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. + -The 'rombar' option determines whether or not the device's ROM will be -visible in the guest's memory map (default is 'on'). +IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. + -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. +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. + -Experimental: user reported problems with this option. +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. -`-hotplug` `string` (default=`network,disk,usb`):: +`--ivshmem` `size= [,name=]` :: -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'. +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. -`-ide[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--keephugepages` `` ('default =' `0`):: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. -`-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`):: +`--keyboard` `` :: -Keybord layout for vnc server. Default is read from the datacenter -configuration file. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. -`-kvm` `boolean` (default=`1`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `boolean` :: +`--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` `(backup | migrate | rollback | snapshot)` :: +`--lock` `` :: Lock/unlock the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `[[type=]] [,viommu=]` :: -Specific the Qemu machine type. +Specify the QEMU machine. -`-memory` `integer (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` `number (0 - N)` (default=`0.1`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` `integer (0 - N)` (default=`0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `string` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `string` :: +`--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. -+ -MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 -i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 -+ -XX:XX:XX:XX:XX:XX should be an unique MAC address. This is -automatically generated if not specified. -+ -The bridge parameter can be used to automatically add the interface to a -bridge device. The Proxmox VE standard bridge is called 'vmbr0'. -+ -Option 'rate' is used to limit traffic bandwidth from and to this -interface. It is specified as floating point number, unit is 'Megabytes per -second'. -+ -If you specify no bridge, we create a kvm 'user' (NATed) network device, -which provides DHCP and DNS services. The following addresses are used: -+ -10.0.2.2 Gateway -10.0.2.3 DNS Server -10.0.2.4 SMB Server -+ -The DHCP server assign addresses to the guest starting from 10.0.2.15. -`-numa` `boolean` (default=`0`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: -numa topology +NUMA topology. -`-onboot` `boolean` (default=`0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: +`--ostype` `` :: -Used to enable special optimization/features for specific -operating systems: -+ -other => unspecified OS -wxp => Microsoft Windows XP -w2k => Microsoft Windows 2000 -w2k3 => Microsoft Windows 2003 -w2k8 => Microsoft Windows 2008 -wvista => Microsoft Windows Vista -win7 => Microsoft Windows 7 -win8 => Microsoft Windows 8/2012 -l24 => Linux 2.4 Kernel -l26 => Linux 2.6/3.X Kernel -solaris => solaris/opensolaris/openindiania kernel -+ -other|l24|l26|solaris ... no special behaviour -wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch +Specify guest operating system. -`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: +`--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: Map host parallel devices (n is 0 to 2). -+ -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. -+ -Experimental: user reported problems with this option. -`-protection` `boolean` (default=`0`):: +`--protection` `` ('default =' `0`):: -Sets the protection flag of the VM. This will prevent the remove operation. +Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `boolean` (default=`1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-revert` `string` :: +`--revert` `` :: Revert a pending change. -`-sata[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--rng0` `[source=] [,max_bytes=] [,period=]` :: -Use volume as SATA hard disk or CD-ROM (n is 0 to 5). +Configure a VirtIO-based Random Number Generator. -`-scsi[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,snapshot=] [,trans=] [,werror=]` :: +`--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 SCSI hard disk or CD-ROM (n is 0 to 13). +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. -`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: +`--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=]` :: -scsi controller model +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. -`-serial[n]` `(/dev/.+|socket)` :: +`--scsihw` `` ('default =' `lsi`):: -Create a serial device inside the VM (n is 0 to 3), and pass through a host -serial device (i.e. /dev/ttyS0), or create a unix socket on the host side -(use 'qm terminal' to open a terminal connection). -+ -NOTE: If you pass through a host serial device, it is no longer possible to -migrate such machines - use with special care. -+ -Experimental: user reported problems with this option. +SCSI controller model -`-shares` `integer (0 - 50000)` (default=`1000`):: +`--searchdomain` `` :: -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 +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. -`-skiplock` `boolean` :: +`--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. + +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-smbios[n]` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` `integer (1 - N)` (default=`1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` `integer (1 - N)` (default=`1`):: +`--sockets` ` (1 - N)` ('default =' `1`):: The number of CPU sockets. -`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: +`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=]` :: + +Configure additional enhancements for SPICE. + +`--sshkeys` `` :: + +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+] ` :: +`--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. +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. -`-tablet` `boolean` (default=`1`):: +`--tablet` `` ('default =' `1`):: -Enable/disable the USB tablet device. This device is usually needed to -allow absolute mouse positioning with VNC. Else the mouse runs out of sync -with normal VNC clients. If you're running lots of console-only guests on -one host, you may consider disabling this to save some context switches. -This is turned off by default if you use spice (-vga=qxl). +Enable/disable the USB tablet device. -`-tdf` `boolean` (default=`0`):: +`--tags` `` :: + +Tags of the VM. This is only meta information. + +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `boolean` (default=`0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unused[n]` `string` :: +`--tpmstate0` `[file=] [,import-from=] [,size=] [,version=]` :: -Reference to unused volumes. +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. -`-usb[n]` `[host=] [,usb3=]` :: +`--unused[n]` `[file=]` :: -Configure an USB device (n is 0 to 4). This can be used to -pass-through usb devices to the guest. HOSTUSBDEVICE syntax is: -+ -'bus-port(.port)*' (decimal numbers) or -'vendor_id:product_id' (hexadeciaml numbers) or -'spice' -+ -You can use the 'lsusb -t' command to list existing usb devices. -+ -NOTE: This option allows direct access to host hardware. So it is no longer -possible to migrate such machines - use with special care. -+ -The value 'spice' can be used to add a usb redirection devices for spice. -+ -The 'usb3' option determines whether the device is a USB3 device or not -(this does currently not work reliably with spice redirection and is then -ignored). +Reference to unused volumes. This is used internally, and should not be modified manually. + +`--usb[n]` `[[host=]] [,mapping=] [,usb3=<1|0>]` :: -`-vcpus` `integer (1 - N)` (default=`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` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: +`--vga` `[[type=]] [,clipboard=] [,memory=]` :: -Select the VGA type. If you want to use high resolution modes (>= -1280x1024x16) then you should use the options 'std' or 'vmware'. Default is -'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option -enables the SPICE display sever. For win* OS you can select how many -independent displays you want, Linux guests can add displays them self. You -can also run without any graphic card, using a serial device as terminal. +Configure the VGA hardware. -`-virtio[n]` `[file=] [,aio=] [,backup=] [,bps=] [,bps_rd=] [,bps_wr=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_rd=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_max=] [,iothread=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,snapshot=] [,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. -`-watchdog` `[action=] [,[model=]]` :: +`--vmgenid` `` ('default =' `1 (autogenerated)`):: -Create a virtual hardware watchdog device. Once enabled (by a guest -action), the watchdog must be periodically polled by an agent inside the -guest or else the watchdog will reset the guest (or execute the respective -action specified) +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=]` :: -*qm showcmd* `` +Create a virtual hardware watchdog device. + +*qm showcmd* `` `[OPTIONS]` Show command line which is used to start the VM (debug info). -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. +`--pretty` `` ('default =' `0`):: + +Puts each option on a new line to enhance human readability +`--snapshot` `` :: +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. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-forceStop` `boolean` (default=`0`):: +`--forceStop` `` ('default =' `0`):: Make sure the VM stops. -`-keepActive` `boolean` (default=`0`):: +`--keepActive` `` ('default =' `0`):: -Do not decativate storage volumes. +Do not deactivate storage volumes. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` `integer (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. - - *qm snapshot* ` ` `[OPTIONS]` Snapshot a VM. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`` `string` :: +``: `` :: The name of the snapshot. -`-description` `string` :: +`--description` `` :: A textual description or comment. -`-vmstate` `boolean` :: +`--vmstate` `` :: Save the vmstate - - *qm start* `` `[OPTIONS]` Start virtual machine. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--force-cpu` `` :: -Specific the Qemu machine type. +Override QEMU's -cpu argument with the given string. -`-migratedfrom` `string` :: +`--machine` `[[type=]] [,viommu=]` :: + +Specify the QEMU machine. + +`--migratedfrom` `` :: The cluster node name. -`-skiplock` `boolean` :: +`--migration_network` `` :: + +CIDR of the (sub) network that is used for migration. + +`--migration_type` `` :: + +Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. + +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-stateuri` `string` :: +`--stateuri` `` :: Some command save/restore state from this location. +`--targetstorage` `` :: +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. +`--timeout` ` (0 - N)` ('default =' `max(30, vm memory in GiB)`):: + +Wait maximal timeout seconds. *qm status* `` `[OPTIONS]` Show VM status. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-verbose` `boolean` :: +`--verbose` `` :: 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. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-keepActive` `boolean` (default=`0`):: +`--keepActive` `` ('default =' `0`):: -Do not decativate storage volumes. +Do not deactivate storage volumes. -`-migratedfrom` `string` :: +`--migratedfrom` `` :: The cluster node name. -`-skiplock` `boolean` :: +`--overrule-shutdown` `` ('default =' `0`):: -Ignore locks - only root is allowed to use this option. +Try to abort active 'qmshutdown' tasks before stopping. -`-timeout` `integer (0 - N)` :: +`--skiplock` `` :: -Wait maximal timeout seconds. +Ignore locks - only root is allowed to use this option. +`--timeout` ` (0 - N)` :: +Wait maximal timeout seconds. *qm suspend* `` `[OPTIONS]` Suspend virtual machine. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-skiplock` `boolean` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. +`--statestorage` `` :: + +The storage for the VM state ++ +NOTE: Requires option(s): `todisk` + +`--todisk` `` ('default =' `0`):: +If set, suspends the VM to disk. Will be resumed on next VM start. *qm template* `` `[OPTIONS]` Create a Template. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-disk` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: +`--disk` `` :: If you want to convert only 1 disk to base image. - - - *qm terminal* `` `[OPTIONS]` Open a terminal using a serial device (The VM need to have a serial device configured, for example 'serial0: socket') -`` `integer (1 - N)` :: - -The (unique) ID of the VM. - -`-iface` `(serial0 | serial1 | serial2 | serial3)` :: - -Select the serial device. By default we simply use the first suitable -device. - - - - -*qm unlink* ` -idlist ` `[OPTIONS]` - -Unlink/delete disk images. - -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-force` `boolean` :: +`--escape` `` ('default =' `^O`):: -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. +Escape character. -`-idlist` `string` :: - -A list of disk IDs you want to delete. +`--iface` `` :: +Select the serial device. By default we simply use the first suitable device. +*qm unlink* +An alias for 'qm disk unlink'. *qm unlock* `` Unlock the VM. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. - - *qm vncproxy* `` Proxy VM VNC traffic to stdin/stdout -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. - - *qm wait* `` `[OPTIONS]` Wait until the VM is stopped. -`` `integer (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`-timeout` `integer (1 - N)` :: +`--timeout` ` (1 - N)` :: Timeout in seconds. Default is to wait forever. - -