X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=qm.conf.5-opts.adoc;h=d0685c296d22e2760144652627315b5f39104525;hp=80b660c814b90b2937419d02bfb34a9dd50c692f;hb=a45c999b4586734621bbc968d67f87390739b270;hpb=e2d681b3686090218b5217114ccdde49300c902c diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index 80b660c..d0685c2 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -50,6 +50,22 @@ Enable booting from specified disk. This is an alias for option -ide2 +`cicustom`: `[meta=] [,network=] [,user=]` :: + +cloud-init: Specify custom files to replace the automatically generated ones at start. + +`meta`=`` ;; + +Specify a custom file containing all meta data passed to the VM via cloud-init. This is provider specific meaning configdrive2 and nocloud differ. + +`network`=`` ;; + +Specify a custom file containing all network data passed to the VM via cloud-init. + +`user`=`` ;; + +Specify a custom file containing all user data passed to the VM via cloud-init. + `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. @@ -66,7 +82,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>]` :: +`cpu`: `[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=]` :: Emulated CPU type. @@ -76,12 +92,16 @@ Emulated CPU type. `flags`=`<+FLAG[;-FLAG...]>` ;; -List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb'. +List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'. `hidden`=`` ('default =' `0`);; Do not identify as a KVM virtual machine. +`hv-vendor-id`=`` ;; + +The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID. + `cpulimit`: ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. @@ -116,18 +136,22 @@ Disk size. This is purely informational and has no effect. Freeze CPU at startup (use 'c' monitor command to start execution). +`hookscript`: `` :: + +Script that will be executed during various steps in the vms lifetime. + `hostpci[n]`: `[host=] [,mdev=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. + -NOTE: This option allows direct access to host hardware. So it is no longer +NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. + CAUTION: Experimental! User reported problems with this option. `host`=`` ;; -Host PCI device pass through. The PCI ID of a host's PCI device or a list +Host PCI device pass through. The PCI ID of a host's PCI device or a list of PCI virtual functions of the host. HOSTPCIID syntax is: + 'bus:dev.func' (hexadecimal numbers) @@ -164,7 +188,7 @@ 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=]` :: +`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). @@ -338,6 +362,10 @@ Force disk geometry bios translation mode. Write error action. +`wwn`=`` ;; + +The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'. + `ipconfig[n]`: `[gw=] [,gw6=] [,ip=] [,ip6=]` :: cloud-init: Specify IP addresses and gateways for the corresponding interface. @@ -369,6 +397,18 @@ IPv4 address in CIDR format. IPv6 address in CIDR format. +`ivshmem`: `size= [,name=]` :: + +Inter-VM shared memory. Useful for direct communication between VMs, or to the host. + +`name`=`` ;; + +The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped. + +`size`=` (1 - N)` ;; + +The size of the file in MB. + `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. @@ -381,7 +421,7 @@ Enable/disable KVM hardware virtualization. Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. -`lock`: `` :: +`lock`: `` :: Lock/unlock the VM. @@ -438,7 +478,7 @@ Whether this interface should be disconnected (like pulling the plug). `macaddr`=`` ;; -MAC address. That address must be unique withing your network. This is automatically generated if not specified. +A common MAC address with the I/G (Individual/Group) bit not set. `model`=`` ;; @@ -523,7 +563,7 @@ 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=]` :: +`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). @@ -693,7 +733,11 @@ Force disk geometry bios translation mode. Write error action. -`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`=`` ;; + +The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'. + +`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). @@ -877,6 +921,10 @@ Force disk geometry bios translation mode. Write error action. +`wwn`=`` ;; + +The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'. + `scsihw`: `` ('default =' `lsi`):: SCSI controller model @@ -899,27 +947,31 @@ CAUTION: Experimental! User reported problems with this option. 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. -`family`=`` ;; +`base64`=`` ;; + +Flag to indicate that the SMBIOS values are base64 encoded + +`family`=`` ;; Set SMBIOS1 family string. -`manufacturer`=`` ;; +`manufacturer`=`` ;; Set SMBIOS1 manufacturer. -`product`=`` ;; +`product`=`` ;; Set SMBIOS1 product ID. -`serial`=`` ;; +`serial`=`` ;; Set SMBIOS1 serial number. -`sku`=`` ;; +`sku`=`` ;; Set SMBIOS1 SKU string. @@ -927,7 +979,7 @@ Set SMBIOS1 SKU string. Set SMBIOS1 UUID. -`version`=`` ;; +`version`=`` ;; Set SMBIOS1 version. @@ -1002,7 +1054,7 @@ You can also run without any graphic card, using a serial device as terminal. Sets the VGA memory (in MiB). Has no effect with serial display. -`type`=`` ('default =' `std`);; +`type`=`` ('default =' `std`);; Select the VGA type.