make dinstall: skip mediawiki deb for now

[pve-docs.git] / qm.conf.5-opts.adoc

diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc
index 80b660c814b90b2937419d02bfb34a9dd50c692f..d0685c296d22e2760144652627315b5f39104525 100644 (file)
--- 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
 
 
 This is an alias for option -ide2
 

+`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::
+
+cloud-init: Specify custom files to replace the automatically generated ones at start.
+
+`meta`=`<volume>` ;;
+
+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`=`<volume>` ;;
+
+Specify a custom file containing all network data passed to the VM via cloud-init.
+
+`user`=`<volume>` ;;
+
+Specify a custom file containing all user data passed to the VM via cloud-init.
+

 `cipassword`: `<string>` ::
 
 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.
 `cipassword`: `<string>` ::
 
 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.
 
 
 The number of cores per socket.
 

-`cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
+`cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::

 
 Emulated CPU type.
 
 
 Emulated CPU type.
 


@@ -76,12 +92,16 @@ Emulated CPU type.
 
 `flags`=`<+FLAG[;-FLAG...]>` ;;
 
 
 `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`=`<boolean>` ('default =' `0`);;
 
 Do not identify as a KVM virtual machine.
 
 
 `hidden`=`<boolean>` ('default =' `0`);;
 
 Do not identify as a KVM virtual machine.
 

+`hv-vendor-id`=`<vendor-id>` ;;
+
+The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
+

 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
 
 Limit of CPU usage.
 `cpulimit`: `<number> (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).
 
 
 Freeze CPU at startup (use 'c' monitor command to start execution).
 

+`hookscript`: `<string>` ::
+
+Script that will be executed during various steps in the vms lifetime.
+

 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
 
 Map host PCI devices into guest.
 +
 `hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,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`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
 
 possible to migrate such machines - use with special care.
 +
 CAUTION: Experimental! User reported problems with this option.
 
 `host`=`<HOSTPCIID[;HOSTPCIID2...]>` ;;
 

-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)
 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.
 
 
 Enable/disable hugepages memory.
 

-`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<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).
 


@@ -338,6 +362,10 @@ Force disk geometry bios translation mode.
 
 Write error action.
 
 
 Write error action.
 

+`wwn`=`<wwn>` ;;
+
+The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
+

 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
 
 cloud-init: Specify IP addresses and gateways for the corresponding interface.
 `ipconfig[n]`: `[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]` ::
 
 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.
 
 
 IPv6 address in CIDR format.
 

+`ivshmem`: `size=<integer> [,name=<string>]` ::
+
+Inter-VM shared memory. Useful for direct communication between VMs, or to the host.
+
+`name`=`<string>` ;;
+
+The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.
+
+`size`=`<integer> (1 - N)` ;;
+
+The size of the file in MB.
+

 `keyboard`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
 
 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`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
 
 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.
 
 
 Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.
 

-`lock`: `<backup | migrate | rollback | snapshot>` ::
+`lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete | suspended | suspending>` ::

 
 Lock/unlock the VM.
 
 
 Lock/unlock the VM.
 


@@ -438,7 +478,7 @@ Whether this interface should be disconnected (like pulling the plug).
 
 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
 
 
 `macaddr`=`<XX:XX:XX:XX:XX:XX>` ;;
 

-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`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
 
 
 `model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
 


@@ -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.
 
 
 Allow reboot. If set to '0' the VM exit on reboot.
 

-`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<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).
 


@@ -693,7 +733,11 @@ Force disk geometry bios translation mode.
 
 Write error action.
 
 
 Write error action.
 

-`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
+`wwn`=`<wwn>` ;;
+
+The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
+
+`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<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 13).
 


@@ -877,6 +921,10 @@ Force disk geometry bios translation mode.
 
 Write error action.
 
 
 Write error action.
 

+`wwn`=`<wwn>` ;;
+
+The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.
+

 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
 
 SCSI controller model
 `scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('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.
 
 
 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=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]` ::
+`smbios1`: `[base64=<1|0>] [,family=<Base64 encoded string>] [,manufacturer=<Base64 encoded string>] [,product=<Base64 encoded string>] [,serial=<Base64 encoded string>] [,sku=<Base64 encoded string>] [,uuid=<UUID>] [,version=<Base64 encoded string>]` ::

 
 Specify SMBIOS type 1 fields.
 
 
 Specify SMBIOS type 1 fields.
 

-`family`=`<string>` ;;
+`base64`=`<boolean>` ;;
+
+Flag to indicate that the SMBIOS values are base64 encoded
+
+`family`=`<Base64 encoded string>` ;;

 
 Set SMBIOS1 family string.
 
 
 Set SMBIOS1 family string.
 

-`manufacturer`=`<string>` ;;
+`manufacturer`=`<Base64 encoded string>` ;;

 
 Set SMBIOS1 manufacturer.
 
 
 Set SMBIOS1 manufacturer.
 

-`product`=`<string>` ;;
+`product`=`<Base64 encoded string>` ;;

 
 Set SMBIOS1 product ID.
 
 
 Set SMBIOS1 product ID.
 

-`serial`=`<string>` ;;
+`serial`=`<Base64 encoded string>` ;;

 
 Set SMBIOS1 serial number.
 
 
 Set SMBIOS1 serial number.
 

-`sku`=`<string>` ;;
+`sku`=`<Base64 encoded string>` ;;

 
 Set SMBIOS1 SKU string.
 
 
 Set SMBIOS1 SKU string.
 


@@ -927,7 +979,7 @@ Set SMBIOS1 SKU string.
 
 Set SMBIOS1 UUID.
 
 
 Set SMBIOS1 UUID.
 

-`version`=`<string>` ;;
+`version`=`<Base64 encoded string>` ;;

 
 Set SMBIOS1 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.
 
 
 Sets the VGA memory (in MiB). Has no effect with serial display.
 

-`type`=`<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
+`type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;

 
 Select the VGA type.
 
 
 Select the VGA type.