X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qm.1-synopsis.adoc;h=233f5c527bd78bebeb48af219ba2d81e24ed0a92;hb=8e0e0bcf351119663989f204bc20493cee00bb80;hp=301655494a143bb3f9031c32859c87b8d74138c7;hpb=ac70d7d134ce81431aa875c336bd547094326d9b;p=pve-docs.git diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 3016554..233f5c5 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -113,7 +113,7 @@ Enable/disable ACPI. `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable Qemu GuestAgent and its properties. +Enable/disable communication with the Qemu Guest Agent and its properties. `--arch` `` :: @@ -127,7 +127,7 @@ The backup archive. Either the file system path to a .tar or .vma file (use '-' Arbitrary arguments passed to kvm. -`--audio0` `device= [,driver=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -143,13 +143,13 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver. Select BIOS implementation. -`--boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. `--bwlimit` ` (0 - N)` ('default =' `restore limit from datacenter or storage config`):: @@ -159,7 +159,7 @@ Override I/O bandwidth limit (in KiB/s). This is an alias for option -ide2 -`--cicustom` `[meta=] [,network=] [,user=]` :: +`--cicustom` `[meta=] [,network=] [,user=] [,vendor=]` :: cloud-init: Specify custom files to replace the automatically generated ones at start. @@ -167,7 +167,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. -`--citype` `` :: +`--citype` `` :: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. @@ -179,7 +179,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's The number of cores per socket. -`--cpu` `` :: +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. @@ -187,17 +187,17 @@ Emulated CPU type. Limit of CPU usage. -`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: +`--cpuunits` ` (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. `--description` `` :: -Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. -`--efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,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. `--force` `` :: @@ -219,15 +219,15 @@ Map host PCI devices into guest. `--hotplug` `` ('default =' `network,disk,usb`):: -Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'. +Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. `--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -235,26 +235,39 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface. + IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. + -The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit +gateway should be provided. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + -If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. `--ivshmem` `size= [,name=]` :: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. +`--keephugepages` `` ('default =' `0`):: + +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. + `--keyboard` `` :: -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. +Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it. `--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. +`--live-restore` `` :: + +Start the VM immediately from the backup and restore in background. PBS only. ++ +NOTE: Requires option(s): `archive` + `--localtime` `` :: -Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. +Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. `--lock` `` :: @@ -282,7 +295,9 @@ Set a name for the VM. Only used on the configuration web interface. `--nameserver` `` :: -cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. +cloud-init: Sets DNS server IP address for a container. Create will' + .' automatically use the setting from the host if neither searchdomain nor nameserver' + .' are set. `--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -300,7 +315,7 @@ NUMA topology. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: Specify guest operating system. @@ -324,13 +339,13 @@ Allow reboot. If set to '0' the VM exit on reboot. Configure a VirtIO-based Random Number Generator. -`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,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. -`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsihw` `` ('default =' `lsi`):: @@ -338,7 +353,9 @@ SCSI controller model `--searchdomain` `` :: -cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. +cloud-init: Sets DNS search domains for a container. Create will' + .' automatically use the setting from the host if neither searchdomain nor nameserver' + .' are set. `--serial[n]` `(/dev/.+|socket)` :: @@ -374,7 +391,7 @@ Start VM after it was created successfully. `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'. +Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -400,6 +417,10 @@ Enable/disable time drift fix. Enable/disable Template. +`--tpmstate0` `[file=] [,size=] [,version=]` :: + +Configure a Disk for storing TPM state. 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 size of 4 MiB will always be used instead. The format is also fixed to 'raw'. + `--unique` `` :: Assign a unique random ethernet address. @@ -422,9 +443,9 @@ Number of hotplugged vcpus. Configure the VGA hardware. -`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,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. `--vmgenid` `` ('default =' `1 (autogenerated)`):: @@ -456,15 +477,20 @@ For removal from config file, even if removing disk snapshots fails. *qm destroy* `` `[OPTIONS]` -Destroy the vm (also delete all used/owned volumes). +Destroy the VM and all used/owned volumes. Removes any VM specific +permissions and firewall rules ``: ` (1 - N)` :: The (unique) ID of the VM. +`--destroy-unreferenced-disks` `` ('default =' `0`):: + +If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. + `--purge` `` :: -Remove vmid from backup cron jobs. +Remove VMID from configurations, like backup & replication jobs and HA. `--skiplock` `` :: @@ -655,15 +681,15 @@ Enter Qemu Monitor interface. The (unique) ID of the VM. -*qm move_disk* ` ` `[OPTIONS]` +*qm move-disk* ` []` `[OPTIONS]` -Move volume to different storage. +Move volume to different storage or to a different VM. ``: ` (1 - N)` :: The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to move. @@ -681,12 +707,30 @@ Delete the original disk after successful copy. By default the original disk is `--digest` `` :: -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. `--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 move_disk* + +An alias for 'qm move-disk'. + *qm mtunnel* Used by qmigrate - do not use manually. @@ -752,7 +796,7 @@ Extend volume size. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -828,7 +872,7 @@ Enable/disable ACPI. `--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=]` :: -Enable/disable Qemu GuestAgent and its properties. +Enable/disable communication with the Qemu Guest Agent and its properties. `--arch` `` :: @@ -838,7 +882,7 @@ Virtual processor architecture. Defaults to the host. Arbitrary arguments passed to kvm. -`--audio0` `device= [,driver=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -854,19 +898,19 @@ Amount of target RAM for the VM in MB. Using zero disables the ballon driver. Select BIOS implementation. -`--boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--boot` `[[legacy=]<[acdn]{1,4}>] [,order=]` :: -Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). +Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. `--bootdisk` `(ide|sata|scsi|virtio)\d+` :: -Enable booting from specified disk. +Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. `--cdrom` `` :: This is an alias for option -ide2 -`--cicustom` `[meta=] [,network=] [,user=]` :: +`--cicustom` `[meta=] [,network=] [,user=] [,vendor=]` :: cloud-init: Specify custom files to replace the automatically generated ones at start. @@ -874,7 +918,7 @@ cloud-init: Specify custom files to replace the automatically generated ones at cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. -`--citype` `` :: +`--citype` `` :: Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. @@ -886,7 +930,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's The number of cores per socket. -`--cpu` `` :: +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. @@ -894,9 +938,9 @@ Emulated CPU type. Limit of CPU usage. -`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: +`--cpuunits` ` (2 - 262144)` ('default =' `cgroup v1: 1024, cgroup v2: 100`):: -CPU weight for a VM. +CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. `--delete` `` :: @@ -904,15 +948,15 @@ A list of settings you want to delete. `--description` `` :: -Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. +Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. `--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`--efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,efitype=<2m|4m>] [,format=] [,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. `--force` `` :: @@ -934,15 +978,15 @@ Map host PCI devices into guest. `--hotplug` `` ('default =' `network,disk,usb`):: -Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'. +Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. `--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as IDE hard disk or CD-ROM (n is 0 to 3). +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--ipconfig[n]` `[gw=] [,gw6=] [,ip=] [,ip6=]` :: @@ -950,18 +994,25 @@ cloud-init: Specify IP addresses and gateways for the corresponding interface. + IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. + -The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. -For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. +The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit +gateway should be provided. +For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires +cloud-init 19.4 or newer. + -If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. +If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using +dhcp on IPv4. `--ivshmem` `size= [,name=]` :: Inter-VM shared memory. Useful for direct communication between VMs, or to the host. +`--keephugepages` `` ('default =' `0`):: + +Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. + `--keyboard` `` :: -Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it. +Keyboard layout for VNC server. The default is read from the'/etc/pve/datacenter.cfg' configuration file. It should not be necessary to set it. `--kvm` `` ('default =' `1`):: @@ -969,7 +1020,7 @@ Enable/disable KVM hardware virtualization. `--localtime` `` :: -Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. +Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. `--lock` `` :: @@ -997,7 +1048,9 @@ Set a name for the VM. Only used on the configuration web interface. `--nameserver` `` :: -cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. +cloud-init: Sets DNS server IP address for a container. Create will' + .' automatically use the setting from the host if neither searchdomain nor nameserver' + .' are set. `--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -1015,7 +1068,7 @@ NUMA topology. Specifies whether a VM will be started during system bootup. -`--ostype` `` :: +`--ostype` `` :: Specify guest operating system. @@ -1039,13 +1092,13 @@ Revert a pending change. Configure a VirtIO-based Random Number Generator. -`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,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. -`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,ro=<1|0>] [,scsiblock=<1|0>] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=] [,werror=] [,wwn=]` :: -Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). +Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. `--scsihw` `` ('default =' `lsi`):: @@ -1053,7 +1106,9 @@ SCSI controller model `--searchdomain` `` :: -cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. +cloud-init: Sets DNS search domains for a container. Create will' + .' automatically use the setting from the host if neither searchdomain nor nameserver' + .' are set. `--serial[n]` `(/dev/.+|socket)` :: @@ -1089,7 +1144,7 @@ cloud-init: Setup public SSH keys (one key per line, OpenSSH format). `--startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: -Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'. +Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. `--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -1111,6 +1166,10 @@ Enable/disable time drift fix. Enable/disable Template. +`--tpmstate0` `[file=] [,size=] [,version=]` :: + +Configure a Disk for storing TPM state. 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 size of 4 MiB will always be used instead. The format is also fixed to 'raw'. + `--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -1127,9 +1186,9 @@ Number of hotplugged vcpus. Configure the VGA hardware. -`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,shared=<1|0>] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,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. `--vmgenid` `` ('default =' `1 (autogenerated)`):: @@ -1316,7 +1375,7 @@ Create a Template. The (unique) ID of the VM. -`--disk` `` :: +`--disk` `` :: If you want to convert only 1 disk to base image.