X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qm.1-synopsis.adoc;h=4f3138d1011834d4ce317a0ce1d12fd60f630aa7;hb=fc9c969da4295500759c2576b761cb4b1007a73b;hp=191eb99e3825c7cf17f1c26bd81c05e2a57e0baa;hpb=5c1699e5ef4b9cd54b2ea9da1f74db39f0c2acd7;p=pve-docs.git diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index 191eb99..4f3138d 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -83,8 +83,9 @@ Config type. *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)` :: @@ -120,13 +121,13 @@ Virtual processor architecture. Defaults to the host. `--archive` `` :: -The backup file. +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=]` :: +`--audio0` `device= [,driver=]` :: Configure a audio device, useful in combination with QXL/Spice. @@ -142,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 with 'order=', 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`):: @@ -166,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. @@ -178,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` `[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]` :: +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. @@ -192,11 +193,11 @@ CPU weight for a VM. `--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=]` :: -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` `` :: @@ -212,7 +213,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`--hostpci[n]` `[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -224,9 +225,9 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f 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=]` :: @@ -234,15 +235,22 @@ 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. @@ -251,6 +259,12 @@ Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg 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. @@ -281,9 +295,11 @@ 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=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. @@ -319,13 +335,17 @@ Sets the protection flag of the VM. This will disable the remove VM and remove d 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_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=]` :: +`--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=<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=]` :: +`--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 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. + +`--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=]` :: + +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`):: @@ -333,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)` :: @@ -369,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+] ` :: @@ -401,7 +423,7 @@ 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. @@ -417,9 +439,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=] [,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)`):: @@ -451,15 +473,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` `` :: @@ -489,6 +516,10 @@ 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. @@ -632,7 +663,7 @@ Use online/live migration if VM is running. Ignored if VM is stopped. `--targetstorage` `` :: -Default target storage. +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` `` :: @@ -654,7 +685,7 @@ Move volume to different storage. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to move. @@ -692,7 +723,7 @@ The (unique) ID of the VM. *qm pending* `` -Get virtual machine configuration, including pending changes. +Get the virtual machine configuration with both current and pending values. ``: ` (1 - N)` :: @@ -743,7 +774,7 @@ Extend volume size. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -829,7 +860,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. @@ -845,13 +876,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 with 'order=', 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` `` :: @@ -865,7 +896,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. @@ -877,7 +908,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's The number of cores per socket. -`--cpu` `[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]` :: +`--cpu` `[[cputype=]] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=] [,phys-bits=<8-64|host>] [,reported-model=]` :: Emulated CPU type. @@ -895,7 +926,7 @@ 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` `` :: @@ -903,7 +934,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca `--efidisk0` `[file=] [,format=] [,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` `` :: @@ -919,7 +950,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution). Script that will be executed during various steps in the vms lifetime. -`--hostpci[n]` `[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,legacy-igd=<1|0>] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -931,9 +962,9 @@ Selectively enable hotplug features. This is a comma separated list of hotplug f 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=]` :: @@ -941,15 +972,22 @@ 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. @@ -988,9 +1026,11 @@ 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=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. @@ -1026,13 +1066,17 @@ Allow reboot. If set to '0' the VM exit on reboot. Revert a pending change. -`--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=]` :: +`--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=] [,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=] [,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. `--scsihw` `` ('default =' `lsi`):: @@ -1040,7 +1084,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)` :: @@ -1076,7 +1122,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+] ` :: @@ -1098,7 +1144,7 @@ Enable/disable time drift fix. Enable/disable Template. -`--unused[n]` `` :: +`--unused[n]` `[file=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -1114,9 +1160,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=] [,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)`):: @@ -1200,6 +1246,10 @@ Start virtual machine. The (unique) ID of the VM. +`--force-cpu` `` :: + +Override QEMU's -cpu argument with the given string. + `--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\+pve\d+)?(\.pxe)?|virt(?:-\d+(\.\d+)+)?(\+pve\d+)?)` :: Specifies the Qemu machine type. @@ -1226,7 +1276,11 @@ Some command save/restore state from this location. `--targetstorage` `` :: -Target storage for the migration. (Can be '1' to use the same storage id as on the source node.) +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]` @@ -1295,7 +1349,7 @@ Create a Template. The (unique) ID of the VM. -`--disk` `` :: +`--disk` `` :: If you want to convert only 1 disk to base image.