- id="snap-rename" class="orange-text"> _(Rename disabled, =$snapcount?> snapshot(s) exists.)_
- _(Name contains invalid characters or does not start with an alphanumberic for a ZFS storage location Only these special characters are valid Underscore (_) Hyphen (-) Colon (:) Period (.))_
Give the VM a name (e.g. Work, Gaming, Media Player, Firewall, Bitcoin Miner)
-
+
+
+
+
+ id="snap-rename" class="orange-text"> _(Rename disabled, =$snapcount?> snapshot(s) exists.)_
+ _(Name contains invalid characters or does not start with an alphanumberic for a ZFS storage location Only these special characters are valid Underscore (_) Hyphen (-) Colon (:) Period (.))_
+
Give the VM a name (e.g. Work, Gaming, Media Player, Firewall, Bitcoin Miner)
+
+
+
+
+
_(Description)_:
+
+
+
+
+
+
+
+
Give the VM a brief description (optional field).
+
+
+
+
+
+
_(WebUI)_:
+
+
+
+
+
+
+
Specify a URL that for menu to start. Substitution variables are
+ [IP] IP address, this will take the first IP on the VM. Guest Agent must be installed for this to work.
+ [PORT:XX] Port Number in XX.
+ [VMNAME] VM Name will have spaces replaced with -
+
+
+
+
+
+
+
+
_(Override Storage Location)_:
+
+
+
+
+
+
+
Specify the overide storage pool for VM. This option allows you to specify the physical pool/disk used to store the disk images and snapshot data.
+ Default will follow standard processing and store images in the default location for the share defined in the settings.
+ A pool/disk(Volume) will be the location for images if the default is overridden.
+
+ Host Passthrough
+ With this mode, the CPU visible to the guest should be exactly the same as the host CPU even in the aspects that libvirt does not understand. For the best possible performance, use this setting.
+
+
+ Emulated
+ If you are having difficulties with Host Passthrough mode, you can try the emulated mode which doesn't expose the guest to host-based CPU features. This may impact the performance of your VM.
+
+
+ Migratable
+ Migratable attribute may be used to explicitly request such features to be removed from (on) or kept in (off) the virtual CPU. Off will not remove any host features when using Host Passthrough. Not support on emulated.
+
+ vCPUs Allocated
+ Set the number of vCPUs allocated to the VM when not using pinning. The host will dynamically allocate workload for the VM across the whole system.
+
The number of logical CPUs in your system is determined by multiplying the number of CPU cores on your processor(s) by the number of threads.
+
Select which logical CPUs you wish to allow your VM to use. (minimum 1).
+
+
+
+
+
_(Initial)_ _(Memory)_:
+
+
+ _(Max)_ _(Memory)_:
+
+
+
+
+
+
+
+
+
Select how much memory to allocate to the VM at boot.
+
+
+
+
+
+
For VMs where no PCI devices are being passed through (GPUs, sound, etc.), you can set different values to initial and max memory to allow for memory ballooning. If you are passing through a PCI device, only the initial memory value is used and the max memory value is ignored. For more information on KVM memory ballooning, see here.
The machine type option primarily affects the success some users may have with various hardware and GPU pass through. For more information on the various QEMU machine types, see these links:
+ SeaBIOS
+ is the default virtual BIOS used to create virtual machines and is compatible with all guest operating systems (Windows, Linux, etc.).
+
+
+ OVMF
+ (Open Virtual Machine Firmware) adds support for booting VMs using UEFI, but virtual machine guests must also support UEFI. Assigning graphics devices to a OVMF-based virtual machine requires that the graphics device also support UEFI.
+
+
+ OVMF TPM
+ (Open Virtual Machine Firmware) adds support for booting VMs using UEFI with TPM and Secure Boot available, but virtual machine guests must also support UEFI. Assigning graphics devices to a OVMF-based virtual machine requires that the graphics device also support UEFI.
+
+
+ Once a VM is created this setting cannot be adjusted.
+
+
+ USB Boot
+ Adds support for booting from USB devices using UEFI. No device boot orders can be specified at the same time as this option.
+
+
+
+
+
+
+
_(Hyper-V)_:
+
+
+
+
+
+
+
-
Give the VM a brief description (optional field).
+
Exposes the guest to hyper-v extensions for Microsoft operating systems.
+
-
-
-
_(WebUI)_:
-
-
-
+
+
+
_(USB Controller)_:
+
+
+
+
+
+
+
+
+
+ USB Controller
+ Select the USB Controller to emulate. Some OSes won't support USB3 (e.g. Windows 7). Qemu XHCI is the same code base as Nec XHCI but without several hacks applied over the years. Recommended to try qemu XHCI before resorting to nec XHCI.
+
+
+
+
+
+
+
_(OS Install ISO)_:
+
+
+
+
+
+
+
_(OS Install CDRom Bus)_:
+
+
+ _(Boot Order)_:
+
+
+
+
+
+
+
Select the virtual CD-ROM (ISO) that contains the installation media for your operating system. Clicking this field displays a list of ISOs found in the directory specified on the Settings page.
+
+ CDRom Bus
+ Specify what interface this virtual cdrom uses to connect inside the VM.
+
+
+
+
+
+
_(VirtIO Drivers ISO)_:
+
+
+
+
+
+
_(VirtIO Drivers CDRom Bus)_:
+
+
+
+
+
+
+
+
-
Specify a URL that for menu to start. Substitution variables are
- [IP] IP address, this will take the first IP on the VM. Guest Agent must be installed for this to work.
- [PORT:XX] Port Number in XX.
- [VMNAME] VM Name will have spaces replaced with -
+
When installing Windows, you will reach a step where no disk devices will be found. There is an option to browse for drivers on that screen. Click browse and locate the additional CD-ROM in the menu. Inside there will be various folders for the different versions of Windows. Open the folder for the version of Windows you are installing and then select the AMD64 subfolder inside (even if you are on an Intel system, select AMD64). Three drivers will be found. Select them all, click next, and the vDisks you have assigned will appear.
+
+ CDRom Bus
+ Specify what interface this virtual cdrom uses to connect inside the VM.
+ vDisk Location
+ Specify a path to a user share in which you wish to store the VM or specify an existing vDisk. The primary vDisk will store the operating system for your VM.
+
+
+ NOTE: Unraid will automatically "dereference" vdisk paths when starting a VM.
+ That is, if a vdisk path is specified as being on a user share, we use the SYSTEM.LOCATION extended attribute to find out what physical disk the image exists on.
+ We then pass this path when starting a VM via qemu. This ensures that VM I/O bypasses shfs (FUSE user share file system) for better performance.
+ It also means that a vdisk image file can be moved from one physical device to another without changing the VM XML file.
+
+
+ Example: /mnt/user/domains/Windows/vdisk1.img will be dereferenced to /mnt/cache/domains/Windows/vdisk1.img (for vdisk1.img physically located in the "cache" volume).
+
+
+ vDisk Size
+ Specify a number followed by a letter. M for megabytes, G for gigabytes.
+
+
+ vDisk Type
+ Select RAW for best performance. QCOW2 implementation is still in development.
+
+
+ vDisk Bus
+ Select virtio for best performance.
+
+
+ vDisk Boot Order
+ Specify the order the devices are used for booting.
+
+
+ vDisk Discard
+ Specify if unmap(Trim) requests are sent to underlaying filesystem.
+
+
+ vDisk SSD Flag
+ Specify the vdisk shows as SSD within the guest, only supported on SCSI, SATA and IDE bus types.
+
+
+ vDisk Serial
+ Set the device serial number presented to the VM.
+
+
Additional devices can be added/removed by clicking the symbols to the left.
+ name="shares[=$i?>][target]" id="shares[=$i?>][target]" value="=htmlspecialchars($arrShare['target'])?>" placeholder="_(e.g.)_ _(shares)_ (_(name of mount tag inside vm)_)" title="_(mount tag inside vm)_" />
+
+
+
+
+
+
-
For VMs where no PCI devices are being passed through (GPUs, sound, etc.), you can set different values to initial and max memory to allow for memory ballooning. If you are passing through a PCI device, only the initial memory value is used and the max memory value is ignored. For more information on KVM memory ballooning, see here.
+
+ Unraid Share Mode
+ Used to create a VirtFS mapping to a Linux-based guest. Specify the mode you want to use either 9p or Virtiofs.
+
+
+ Unraid Share
+ Set tag and path to match the selected Unraid share.
+
+
+ Unraid Source Path
+ Specify the path on the host here.
+
+
+ Unraid Mount tag
+ Specify the mount tag that you will use for mounting the VirtFS share inside the VM. See this page for how to do this on a Linux-based guest: http://wiki.qemu.org/Documentation/9psetup
+
The machine type option primarily affects the success some users may have with various hardware and GPU pass through. For more information on the various QEMU machine types, see these links:
- SeaBIOS
- is the default virtual BIOS used to create virtual machines and is compatible with all guest operating systems (Windows, Linux, etc.).
-
-
- OVMF
- (Open Virtual Machine Firmware) adds support for booting VMs using UEFI, but virtual machine guests must also support UEFI. Assigning graphics devices to a OVMF-based virtual machine requires that the graphics device also support UEFI.
-
-
- OVMF TPM
- (Open Virtual Machine Firmware) adds support for booting VMs using UEFI with TPM and Secure Boot available, but virtual machine guests must also support UEFI. Assigning graphics devices to a OVMF-based virtual machine requires that the graphics device also support UEFI.
-
-
- Once a VM is created this setting cannot be adjusted.
-
-
- USB Boot
- Adds support for booting from USB devices using UEFI. No device boot orders can be specified at the same time as this option.
-
-
-
-
-
-
-
_(Hyper-V)_:
-
- onchange="HypervChgNew(this)" >
-
-
-
-
-
-
-
-
-
Exposes the guest to hyper-v extensions for Microsoft operating systems.
- USB Controller
- Select the USB Controller to emulate. Some OSes won't support USB3 (e.g. Windows 7). Qemu XHCI is the same code base as Nec XHCI but without several hacks applied over the years. Recommended to try qemu XHCI before resorting to nec XHCI.
-
-
-
-
-
-
-
_(OS Install ISO)_:
-
-
-
-
-
-
-
_(OS Install CDRom Bus)_:
-
-
-
-
- _(Boot Order)_:
-
-
-
-
-
-
-
Select the virtual CD-ROM (ISO) that contains the installation media for your operating system. Clicking this field displays a list of ISOs found in the directory specified on the Settings page.
-
- CDRom Bus
- Specify what interface this virtual cdrom uses to connect inside the VM.
-
When installing Windows, you will reach a step where no disk devices will be found. There is an option to browse for drivers on that screen. Click browse and locate the additional CD-ROM in the menu. Inside there will be various folders for the different versions of Windows. Open the folder for the version of Windows you are installing and then select the AMD64 subfolder inside (even if you are on an Intel system, select AMD64). Three drivers will be found. Select them all, click next, and the vDisks you have assigned will appear.
-
- CDRom Bus
- Specify what interface this virtual cdrom uses to connect inside the VM.
-
- vDisk Location
- Specify a path to a user share in which you wish to store the VM or specify an existing vDisk. The primary vDisk will store the operating system for your VM.
-
-
-
- NOTE: Unraid will automatically "dereference" vdisk paths when starting a VM.
- That is, if a vdisk path is specified as being on a user share, we use the SYSTEM.LOCATION extended attribute to find out what physical disk the image exists on.
- We then pass this path when starting a VM via qemu. This ensures that VM I/O bypasses shfs (FUSE user share file system) for better performance.
- It also means that a vdisk image file can be moved from one physical device to another without changing the VM XML file.
-
-
-
- Example: /mnt/user/domains/Windows/vdisk1.img will be dereferenced to /mnt/cache/domains/Windows/vdisk1.img (for vdisk1.img physically located in the "cache" volume).
-
-
-
- vDisk Size
- Specify a number followed by a letter. M for megabytes, G for gigabytes.
-
-
-
- vDisk Type
- Select RAW for best performance. QCOW2 implementation is still in development.
-
-
-
- vDisk Bus
- Select virtio for best performance.
-
-
-
- vDisk Boot Order
- Specify the order the devices are used for booting.
-
-
-
- vDisk Discard
- Specify if unmap(Trim) requests are sent to underlaying filesystem.
-
-
-
- vDisk SSD Flag
- Specify the vdisk shows as SSD within the guest, only supported on SCSI, SATA and IDE bus types.
-
-
-
- vDisk Serial
- Set the device serial number presented to the VM.
-
-
-
Additional devices can be added/removed by clicking the symbols to the left.
- name="shares[=$i?>][target]" id="shares[=$i?>][target]" value="=htmlspecialchars($arrShare['target'])?>" placeholder="_(e.g.)_ _(shares)_ (_(name of mount tag inside vm)_)" title="_(mount tag inside vm)_" />
-
-
-
-
-
-
-
-
- Unraid Share Mode
- Used to create a VirtFS mapping to a Linux-based guest. Specify the mode you want to use either 9p or Virtiofs.
-
-
-
-
- Unraid Share
- Set tag and path to match the selected Unraid share.
-
-
-
- Unraid Source Path
- Specify the path on the host here.
-
-
-
- Unraid Mount tag
- Specify the mount tag that you will use for mounting the VirtFS share inside the VM. See this page for how to do this on a Linux-based guest: http://wiki.qemu.org/Documentation/9psetup
-
_(GPU is primary adapater, vbios may be required.)_
-
-
-
-
- Graphics Card
- If you wish to assign a graphics card to the VM, select it from this list, otherwise leave it set to virtual.
-
-
-
- Virtual video protocol VNC/SPICE
- If you wish to assign a protocol type, specify one here.
-
-
-
- Virtual enable copy paste for VNC/SPICE
- If you enable copy paste you need to install additional software on the client in addition to the QEMU agent if that has been installed. https://www.spice-space.org/download.html is the location for spice-vdagent for both window and linux. Note copy paste function will not work with web spice viewer you need to use virt-viewer.
-
-
-
- Virtual auto port
- Set it you want to specify a manual port for VNC or Spice. VNC needs two ports where Spice only requires one. Leave as auto yes for the system to set.
-
-
-
- Virtual Video Driver
- If you wish to assign a different video driver to use for a VM Console connection, specify one here.
- QXL has an option of setting number of screens and vram.
- Virtio3d allows render device to be specified or auto.(This allow GPU to be used in a VM without passthru for 3D acceleration no screen output)
-
-
-
- Virtual Password
- If you wish to require a password to connect to the VM over a VM Console connection, specify one here.
-
-
-
- Virtual Keyboard
- If you wish to assign a different keyboard layout to use for a VM Console connection, specify one here.
-
-
-
- Graphics ROM BIOS
- If you wish to use a custom ROM BIOS for a Graphics card, specify one here.
-
-
-
Additional devices can be added/removed by clicking the symbols to the left.
Select a sound device to assign to your VM. Most modern GPUs have a built-in audio device, but you can also select the on-board audio device(s) if present.
-
Additional devices can be added/removed by clicking the symbols to the left.
- Network MAC
- By default, a random MAC address will be assigned here that conforms to the standards for virtual network interface controllers. You can manually adjust this if desired.
-
-
-
- Network Source
- The default libvirt managed network bridge (virbr0) will be used, otherwise you may specify an alternative name for a private network to the host.
-
-
-
- Network Model
- Default and recommended is 'virtio-net', which gives improved stability. To improve performance 'virtio' can be selected, but this may lead to stability issues.
-
-
-
Use boot order to set device as bootable and boot sequence.
-
-
Additional devices can be added/removed by clicking the symbols to the left.
_(GPU is primary adapater, vbios may be required.)_
+
-
-
_(Grab)_:
-
-
-
-
-
-
+
+
+
+ Graphics Card
+ If you wish to assign a graphics card to the VM, select it from this list, otherwise leave it set to virtual.
+
+
+ Virtual video protocol VNC/SPICE
+ If you wish to assign a protocol type, specify one here.
+
+
+ Virtual enable copy paste for VNC/SPICE
+ If you enable copy paste you need to install additional software on the client in addition to the QEMU agent if that has been installed. https://www.spice-space.org/download.html is the location for spice-vdagent for both window and linux. Note copy paste function will not work with web spice viewer you need to use virt-viewer.
+
+
+ Virtual auto port
+ Set it you want to specify a manual port for VNC or Spice. VNC needs two ports where Spice only requires one. Leave as auto yes for the system to set.
+
+
+ Virtual Video Driver
+ If you wish to assign a different video driver to use for a VM Console connection, specify one here.
+ QXL has an option of setting number of screens and vram.
+ Virtio3d allows render device to be specified or auto.(This allow GPU to be used in a VM without passthru for 3D acceleration no screen output)
+
+
+ Virtual Password
+ If you wish to require a password to connect to the VM over a VM Console connection, specify one here.
+
+
+ Virtual Keyboard
+ If you wish to assign a different keyboard layout to use for a VM Console connection, specify one here.
+
+
+ Graphics ROM BIOS
+ If you wish to use a custom ROM BIOS for a Graphics card, specify one here.
+
+
Additional devices can be added/removed by clicking the symbols to the left.
+
+}?>
+}?>
-
-
_(Repeat)_:
-
-
-
-
-
-
-
-
-
_(Grab Toggle)_:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Event Devices
- Evdev is an input interface built into the Linux kernel. QEMU’s evdev passthrough support allows a user to redirect evdev events to a guest. These events can include mouse movements and key presses. By hitting both Ctrl keys at the same time, QEMU can toggle the input recipient. QEMU’s evdev passthrough also features almost no latency, making it perfect for gaming. The main downside to evdev passthrough is the lack of button rebinding – and in some cases, macro keys won’t even work at all.
- Optional items are normally only used for keyboards.
-
-
- Device
- Host device to passthrough to guest.
-
-
-
- Grab
- All grabs all input devices instead of just one
-
-
-
- Repeat
- Repeat with value 'on'/'off' to enable/disable auto-repeat events
-
-
-
- GrabToggle
- GrabToggle with values ctrl-ctrl, alt-alt, shift-shift, meta-meta, scrolllock or ctrl-scrolllock to change the grab key combination
-
-
Additional devices can be added/removed by clicking the symbols to the left.
-
-
- }?>
- }?>
-
-
-
-
-
-
-
-
-
-
- } else {?>
-
-
- }?>
-
-
-
-
-
-
-
-
Click Create to generate the vDisks and return to the Virtual Machines page where your new VM will be created.
Select a sound device to assign to your VM. Most modern GPUs have a built-in audio device, but you can also select the on-board audio device(s) if present.
+
Additional devices can be added/removed by clicking the symbols to the left.
+ Network MAC
+ By default, a random MAC address will be assigned here that conforms to the standards for virtual network interface controllers. You can manually adjust this if desired.
+
+
+ Network Source
+ The default libvirt managed network bridge (virbr0) will be used, otherwise you may specify an alternative name for a private network to the host.
+
+
+ Network Model
+ Default and recommended is 'virtio-net', which gives improved stability. To improve performance 'virtio' can be selected, but this may lead to stability issues.
+
+
Use boot order to set device as bootable and boot sequence.
+
Additional devices can be added/removed by clicking the symbols to the left.
+ Event Devices
+ Evdev is an input interface built into the Linux kernel. QEMU’s evdev passthrough support allows a user to redirect evdev events to a guest. These events can include mouse movements and key presses. By hitting both Ctrl keys at the same time, QEMU can toggle the input recipient. QEMU’s evdev passthrough also features almost no latency, making it perfect for gaming. The main downside to evdev passthrough is the lack of button rebinding – and in some cases, macro keys won’t even work at all.
+ Optional items are normally only used for keyboards.
+
+
+ Device
+ Host device to passthrough to guest.
+
+
+ Grab
+ All grabs all input devices instead of just one
+
+
+ Repeat
+ Repeat with value 'on'/'off' to enable/disable auto-repeat events
+
+
+ GrabToggle
+ GrabToggle with values ctrl-ctrl, alt-alt, shift-shift, meta-meta, scrolllock or ctrl-scrolllock to change the grab key combination
+
+
Additional devices can be added/removed by clicking the symbols to the left.
+
+
+}?>
+}?>
+
+
+
+
+
+
+
+
+
+
+ } else {?>
+
+
+ }?>
+
+
+
+
+
+
+
+
+
Click Create to generate the vDisks and return to the Virtual Machines page where your new VM will be created.