X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;ds=sidebyside;f=qm.1-synopsis.adoc;h=b9189d1c2a66107c5cc116c18e085e8424bf5182;hb=447596fd16c159593439f61e817450bc9aaf5ef2;hp=eacd6f6630aea912a0f67f7811286f39c147e6bb;hpb=32d876b51aa4ed5ba02c4eff3d7be8ee69c049f7;p=pve-docs.git diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index eacd6f6..b9189d1 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -1,18 +1,25 @@ *qm* ` [ARGS] [OPTIONS]` -*qm agent* ` ` +*qm agent* -Execute Qemu Guest Agent commands. +An alias for 'qm guest cmd'. + +*qm cleanup* ` ` + +Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts +down, crashes, etc. ``: ` (1 - N)` :: The (unique) ID of the VM. -``: `` :: +``: `` :: -The QGA command. +Indicates if qemu shutdown cleanly. +``: `` :: +Indicates if the shutdown was requested by the guest or via qmp. *qm clone* ` ` `[OPTIONS]` @@ -26,58 +33,87 @@ The (unique) ID of the VM. VMID for the clone. -`-description` `` :: +`--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` `` :: +`--format` `` :: -Target format for file storage. -+ -NOTE: Requires option(s): `full` +Target format for file storage. Only valid for full clone. -`-full` `` ('default =' `0`):: +`--full` `` :: -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. +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` `` :: +`--name` `` :: Set a name for the new VM. -`-pool` `` :: +`--pool` `` :: Add the new VM to the specified pool. -`-snapname` `` :: +`--snapname` `` :: The name of the snapshot. -`-storage` `` :: +`--storage` `` :: Target storage for full clone. -+ -NOTE: Requires option(s): `full` -`-target` `` :: +`--target` `` :: Target node. Only allowed if the original VM is on shared storage. +*qm cloudinit dump* ` ` + +Get automatically generated cloudinit config. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +Config type. + +*qm cloudinit pending* `` + +Get the cloudinit configuration with both current and pending values. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +*qm cloudinit update* `` + +Regenerate and change cloudinit config drive. + +``: ` (1 - N)` :: +The (unique) ID of the VM. *qm config* `` `[OPTIONS]` -Get current virtual machine configuration. This does not include pending -configuration changes (see 'pending' API). +Get the virtual machine configuration with pending configuration changes +applied. Set the 'current' parameter to get the current configuration +instead. ``: ` (1 - N)` :: The (unique) ID of the VM. -`-current` `` ('default =' `0`):: +`--current` `` ('default =' `0`):: Get current values (instead of pending values). +`--snapshot` `` :: +Fetch config values from given snapshot. *qm create* `` `[OPTIONS]` @@ -87,255 +123,357 @@ Create or restore a virtual machine. The (unique) ID of the VM. -`-acpi` `` ('default =' `1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `` ('default =' `0`):: +`--affinity` `` :: + +List of host cores used to execute guest processes. -Enable/disable Qemu GuestAgent. +`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -`-archive` `` :: +Enable/disable communication with the Qemu Guest Agent and its properties. -The backup file. +`--arch` `` :: -`-args` `` :: +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. -`-autostart` `` ('default =' `0`):: +`--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)` :: +`--balloon` ` (0 - N)` :: Amount of target RAM for the VM in MB. Using zero disables the ballon driver. -`-bios` `` ('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` `` :: +`--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 -`-cores` ` (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. + +`--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` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. -`-description` `` :: +`--description` `` :: -Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`-efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. -`-force` `` :: +`--force` `` :: Allow to overwrite existing VM. + NOTE: Requires option(s): `archive` -`-freeze` `` :: +`--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` `` :: + +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>]` :: Map host PCI devices into guest. -`-hotplug` `` ('default =' `network,disk,usb`):: +`--hotplug` `` ('default =' `network,disk,usb`):: -Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'. +Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. -`-hugepages` `<1024 | 2 | any>` :: +`--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--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 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` `` ('default =' `en-us`):: +`--keyboard` `` :: -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. +Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. -`-kvm` `` ('default =' `1`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `` :: +`--live-restore` `` :: -Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. +Start the VM immediately from the backup and restore in background. PBS only. ++ +NOTE: Requires option(s): `archive` + +`--localtime` `` :: -`-lock` `` :: +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` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: -Specific the Qemu machine type. +Specifies the Qemu machine type. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (16 - N)` ('default =' `512`):: Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. -`-migrate_downtime` ` (0 - N)` ('default =' `0.1`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` ` (0 - N)` ('default =' `0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--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`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: NUMA topology. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: 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). -`-pool` `` :: +`--pool` `` :: Add the VM to the specified pool. -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `` ('default =' `1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--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 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_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). +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`):: +`--scsihw` `` ('default =' `lsi`):: SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--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`):: +`--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 +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` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` ` (1 - N)` ('default =' `1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` ` (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` `` :: + +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` `` :: +`--storage` `` :: Default storage. -`-tablet` `` ('default =' `1`):: +`--tablet` `` ('default =' `1`):: Enable/disable the USB tablet device. -`-tdf` `` ('default =' `0`):: +`--tags` `` :: + +Tags of the VM. This is only meta information. + +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unique` `` :: +`--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]` `` :: +`--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=] [,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`):: +`--vcpus` ` (1 - N)` ('default =' `0`):: Number of hotplugged vcpus. -`-vga` `` :: +`--vga` `[[type=]] [,memory=]` :: -Select the VGA type. +Configure the VGA hardware. -`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. -`-watchdog` `[[model=]] [,action=]` :: +`--vmgenid` `` ('default =' `1 (autogenerated)`):: -Create a virtual hardware watchdog device. +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]` @@ -349,203 +487,378 @@ The (unique) ID of the VM. The name of the snapshot. -`-force` `` :: +`--force` `` :: For removal from config file, even if removing disk snapshots fails. - - *qm destroy* `` `[OPTIONS]` -Destroy the vm (also delete all used/owned volumes). +Destroy the VM and all used/owned volumes. Removes any VM specific +permissions and firewall rules ``: ` (1 - N)` :: The (unique) ID of the VM. -`-skiplock` `` :: +`--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). +``: ` (1 - N)` :: -*qm help* `[]` `[OPTIONS]` +The (unique) ID of the VM. -Get help about specified command. +``: `` :: -``: `` :: +Path to the disk image to import -Command name +``: `` :: -`-verbose` `` :: +Target storage ID -Verbose output format. +`--format` `` :: +Target format +*qm disk move* ` []` `[OPTIONS]` +Move volume to different storage or to a different VM. -*qm list* `[OPTIONS]` +``: ` (1 - N)` :: -Virtual machine index (per node). +The (unique) ID of the VM. -`-full` `` :: +``: `` :: -Determine the full status of active VMs. +The disk you want to move. +``: `` :: +Target storage. -*qm listsnapshot* `` +`--bwlimit` ` (0 - N)` ('default =' `move limit from datacenter or storage config`):: -List all snapshots. +Override I/O bandwidth limit (in KiB/s). -``: ` (1 - N)` :: +`--delete` `` ('default =' `0`):: + +Delete the original disk after successful copy. By default the original disk is kept as unused disk. + +`--digest` `` :: + +Prevent changes if current configuration file has different SHA1" + ." digest. This can be used to prevent concurrent modifications. + +`--format` `` :: + +Target Format. + +`--target-digest` `` :: + +Prevent changes if the current config file of the target VM has a" + ." different SHA1 digest. This can be used to detect concurrent modifications. + +`--target-disk` `` :: + +The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. + +`--target-vmid` ` (1 - N)` :: The (unique) ID of the VM. +*qm disk rescan* `[OPTIONS]` +Rescan all storages and update disk sizes and unused disk images. -*qm migrate* ` ` `[OPTIONS]` +`--dryrun` `` ('default =' `0`):: -Migrate virtual machine. Creates a new migration task. +Do not actually write changes out to VM config(s). + +`--vmid` ` (1 - N)` :: + +The (unique) ID of the VM. + +*qm disk resize* ` ` `[OPTIONS]` + +Extend volume size. ``: ` (1 - N)` :: The (unique) ID of the VM. -``: `` :: +``: `` :: -Target node. +The disk you want to resize. -`-force` `` :: +``: `\+?\d+(\.\d+)?[KMGT]?` :: -Allow to migrate VMs which use local devices. Only root may use this option. +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. -`-migration_network` `` :: +`--digest` `` :: -CIDR of the (sub) network that is used for migration. +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-migration_type` `` :: +`--skiplock` `` :: -Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. +Ignore locks - only root is allowed to use this option. -`-online` `` :: +*qm disk unlink* ` --idlist ` `[OPTIONS]` -Use online/live migration. +Unlink/delete disk images. +``: ` (1 - N)` :: +The (unique) ID of the VM. +`--force` `` :: -*qm monitor* `` +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. -Enter Qemu Monitor interface. +`--idlist` `` :: + +A list of disk IDs you want to delete. + +*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. -*qm move_disk* ` ` `[OPTIONS]` +``: `` :: -Move volume to different storage. +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 disk you want to move. +The PID to query -``: `` :: +*qm guest passwd* ` ` `[OPTIONS]` -Target storage. +Sets the password for the given user to the given password -`-delete` `` ('default =' `0`):: +``: ` (1 - N)` :: -Delete the original disk after successful copy. By default the original disk is kept as unused disk. +The (unique) ID of the VM. -`-digest` `` :: +``: `` :: -Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +The user to set the password for. -`-format` `` :: +`--crypted` `` ('default =' `0`):: -Target Format. +set to 1 if the password has already been passed through crypt() +*qm help* `[OPTIONS]` +Get help about specified command. +`--extra-args` `` :: -*qm mtunnel* +Shows help for a specific command -Used by qmigrate - do not use manually. +`--verbose` `` :: +Verbose output format. +*qm importdisk* +An alias for 'qm disk import'. -*qm pending* `` +*qm importovf* ` ` `[OPTIONS]` -Get virtual machine configuration, including pending changes. +Create a new VM using parameters read from an OVF manifest ``: ` (1 - N)` :: The (unique) ID of the VM. +``: `` :: +path to the ovf file +``: `` :: -*qm rescan* `[OPTIONS]` +Target storage ID -Rescan all storages and update disk sizes and unused disk images. +`--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` `` :: + +Determine the full status of active VMs. + +*qm listsnapshot* `` + +List all snapshots. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. -`-vmid` ` (1 - N)` :: +*qm migrate* ` ` `[OPTIONS]` + +Migrate virtual machine. Creates a new migration task. + +``: ` (1 - N)` :: The (unique) ID of the VM. +``: `` :: +Target node. +`--bwlimit` ` (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: -*qm reset* `` `[OPTIONS]` +Override I/O bandwidth limit (in KiB/s). -Reset virtual machine. +`--force` `` :: + +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` `` :: + +Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. + +`--online` `` :: + +Use online/live migration if VM is running. Ignored if VM is stopped. + +`--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 monitor* `` + +Enter Qemu Monitor interface. ``: ` (1 - N)` :: The (unique) ID of the VM. -`-skiplock` `` :: +*qm move-disk* -Ignore locks - only root is allowed to use this option. +An alias for 'qm disk move'. +*qm move_disk* +An alias for 'qm disk move'. -*qm resize* ` ` `[OPTIONS]` +*qm mtunnel* -Extend volume size. +Used by qmigrate - do not use manually. + +*qm nbdstop* `` + +Stop embedded nbd server. ``: ` (1 - N)` :: The (unique) ID of the VM. -``: `` :: +*qm pending* `` -The disk you want to resize. +Get the virtual machine configuration with both current and pending values. -``: `\+?\d+(\.\d+)?[KMGT]?` :: +``: ` (1 - N)` :: -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. +The (unique) ID of the VM. -`-digest` `` :: +*qm reboot* `` `[OPTIONS]` -Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +Reboot the VM by shutting it down, and starting it again. Applies pending +changes. -`-skiplock` `` :: +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +`--timeout` ` (0 - N)` :: + +Wait maximal timeout seconds for the shutdown. + +*qm rescan* + +An alias for 'qm disk rescan'. + +*qm reset* `` `[OPTIONS]` + +Reset virtual machine. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. +*qm resize* +An alias for 'qm disk resize'. *qm resume* `` `[OPTIONS]` @@ -555,17 +868,15 @@ Resume virtual machine. The (unique) ID of the VM. -`-nocheck` `` :: +`--nocheck` `` :: no description available -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. - - -*qm rollback* ` ` +*qm rollback* ` ` `[OPTIONS]` Rollback VM state to specified snapshot. @@ -577,7 +888,9 @@ The (unique) ID of the VM. The name of the snapshot. +`--start` `` ('default =' `0`):: +Whether the VM should get started after rolling back successfully *qm sendkey* ` ` `[OPTIONS]` @@ -591,12 +904,10 @@ The (unique) ID of the VM. The key (qemu monitor encoding). -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. - - *qm set* `` `[OPTIONS]` Set virtual machine options (synchrounous API) - You should consider using @@ -607,256 +918,343 @@ allocation. The (unique) ID of the VM. -`-acpi` `` ('default =' `1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `` ('default =' `0`):: +`--affinity` `` :: + +List of host cores used to execute guest processes. + +`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: + +Enable/disable communication with the Qemu Guest Agent and its properties. -Enable/disable Qemu GuestAgent. +`--arch` `` :: -`-args` `` :: +Virtual processor architecture. Defaults to the host. + +`--args` `` :: Arbitrary arguments passed to kvm. -`-autostart` `` ('default =' `0`):: +`--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)` :: +`--balloon` ` (0 - N)` :: Amount of target RAM for the VM in MB. Using zero disables the ballon driver. -`-bios` `` ('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` `` :: +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` ` (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. + +`--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` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (1 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-description` `` :: +`--description` `` :: -Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,import-from=] [,pre-enrolled-keys=<1|0>] [,size=]` :: -Configure a Disk for storing EFI vars +Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. -`-force` `` :: +`--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` `` :: +`--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` `` :: + +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>]` :: Map host PCI devices into guest. -`-hotplug` `` ('default =' `network,disk,usb`):: +`--hotplug` `` ('default =' `network,disk,usb`):: -Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'. +Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. -`-hugepages` `<1024 | 2 | any>` :: +`--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--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. -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +`--keephugepages` `` ('default =' `0`):: -`-keyboard` `` ('default =' `en-us`):: +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. +`--keyboard` `` :: -`-kvm` `` ('default =' `1`):: +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. -`-localtime` `` :: +`--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` `` :: +`--lock` `` :: Lock/unlock the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: -Specific the Qemu machine type. +Specifies the Qemu machine type. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (16 - N)` ('default =' `512`):: Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. -`-migrate_downtime` ` (0 - N)` ('default =' `0.1`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` ` (0 - N)` ('default =' `0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--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`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: NUMA topology. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: 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). -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `` ('default =' `1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-revert` `` :: +`--revert` `` :: Revert a pending change. -`-sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--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 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_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,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=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). +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`):: +`--scsihw` `` ('default =' `lsi`):: SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--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`):: +`--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 +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` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[base64=<1|0>] [,family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` ` (1 - N)` ('default =' `1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` ` (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). -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'. +`--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: +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. -`-tablet` `` ('default =' `1`):: +`--tablet` `` ('default =' `1`):: Enable/disable the USB tablet device. -`-tdf` `` ('default =' `0`):: +`--tags` `` :: + +Tags of the VM. This is only meta information. + +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unused[n]` `` :: +`--tpmstate0` `[file=] [,import-from=] [,size=] [,version=]` :: + +Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. + +`--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[host=] [,usb3=<1|0>]` :: -Configure an USB device (n is 0 to 4). +Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). -`-vcpus` ` (1 - N)` ('default =' `0`):: +`--vcpus` ` (1 - N)` ('default =' `0`):: Number of hotplugged vcpus. -`-vga` `` :: +`--vga` `[[type=]] [,memory=]` :: -Select the VGA type. +Configure the VGA hardware. -`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,import-from=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: -Use volume as VIRTIO hard disk (n is 0 to 15). +Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. -`-watchdog` `[[model=]] [,action=]` :: +`--vmgenid` `` ('default =' `1 (autogenerated)`):: -Create a virtual hardware watchdog device. +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 showcmd* `` +*qm showcmd* `` `[OPTIONS]` Show command line which is used to start the VM (debug info). @@ -864,8 +1262,13 @@ Show command line which is used to start the VM (debug info). 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]` @@ -877,24 +1280,22 @@ should then proceed to a clean shutdown. The (unique) ID of the VM. -`-forceStop` `` ('default =' `0`):: +`--forceStop` `` ('default =' `0`):: Make sure the VM stops. -`-keepActive` `` ('default =' `0`):: +`--keepActive` `` ('default =' `0`):: Do not deactivate storage volumes. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` ` (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. - - *qm snapshot* ` ` `[OPTIONS]` Snapshot a VM. @@ -907,16 +1308,14 @@ The (unique) ID of the VM. The name of the snapshot. -`-description` `` :: +`--description` `` :: A textual description or comment. -`-vmstate` `` :: +`--vmstate` `` :: Save the vmstate - - *qm start* `` `[OPTIONS]` Start virtual machine. @@ -925,32 +1324,41 @@ Start virtual machine. 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` `` :: +`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: + +Specifies the Qemu machine type. + +`--migratedfrom` `` :: The cluster node name. -`-migration_network` `` :: +`--migration_network` `` :: CIDR of the (sub) network that is used for migration. -`-migration_type` `` :: +`--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` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-stateuri` `` :: +`--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]` @@ -960,13 +1368,10 @@ Show VM status. The (unique) ID of the VM. -`-verbose` `` :: +`--verbose` `` :: Verbose output format - - - *qm stop* `` `[OPTIONS]` Stop virtual machine. The qemu process will exit immediately. Thisis akin @@ -976,24 +1381,22 @@ to pulling the power plug of a running computer and may damage the VM data The (unique) ID of the VM. -`-keepActive` `` ('default =' `0`):: +`--keepActive` `` ('default =' `0`):: Do not deactivate storage volumes. -`-migratedfrom` `` :: +`--migratedfrom` `` :: The cluster node name. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` ` (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. - - *qm suspend* `` `[OPTIONS]` Suspend virtual machine. @@ -1002,11 +1405,19 @@ Suspend virtual machine. The (unique) ID of the VM. -`-skiplock` `` :: +`--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]` @@ -1016,13 +1427,10 @@ Create a Template. The (unique) ID of the VM. -`-disk` `` :: +`--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 @@ -1032,31 +1440,17 @@ configured, for example 'serial0: socket') The (unique) ID of the VM. -`-iface` `` :: - -Select the serial device. By default we simply use the first suitable device. - +`--escape` `` ('default =' `^O`):: +Escape character. +`--iface` `` :: -*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` `` :: - -A list of disk IDs you want to delete. - +Select the serial device. By default we simply use the first suitable device. +*qm unlink* +An alias for 'qm disk unlink'. *qm unlock* `` @@ -1066,8 +1460,6 @@ Unlock the VM. The (unique) ID of the VM. - - *qm vncproxy* `` Proxy VM VNC traffic to stdin/stdout @@ -1076,8 +1468,6 @@ Proxy VM VNC traffic to stdin/stdout The (unique) ID of the VM. - - *qm wait* `` `[OPTIONS]` Wait until the VM is stopped. @@ -1086,10 +1476,8 @@ Wait until the VM is stopped. The (unique) ID of the VM. -`-timeout` ` (1 - N)` :: +`--timeout` ` (1 - N)` :: Timeout in seconds. Default is to wait forever. - -