Skip to content

Commit

Permalink
Update VirtualizationScreens.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyriv3 committed Apr 11, 2024
1 parent 992febd commit f5db323
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions content/SCALE/SCALEUIReference/VirtualizationScreens.md
Expand Up @@ -42,28 +42,28 @@ The **Operating System** settings specify the VM operating system type, the time
| Setting | Description |
|---------|-------------|
| **Guest Operating System** | Required. Select the VM operating system type from the dropdown list. Options are **Windows** which adds the **Enable Hyper-V Enlightenments** option. **Linux**, and **FreeBSD**. |
| **Enable Hyper-V Enlightenments** |Only displays when **Guest Operating System** is set to **Windows**. This emulates a Hyper-V compatible hypervisor for the Windows guest operating system and makes some Hyper-V specific features available. |
| **Enable Hyper-V Enlightenments** |Only displays when **Guest Operating System** is set to **Windows**. This emulates a Hyper-V-compatible hypervisor for the Windows guest operating system and makes some Hyper-V-specific features available. |
| **Name** | Required. Enter an alphanumeric name for the virtual machine. |
| **Description** | (Optional) Enter a description of your choosing. For example, the type of OS for the VM or the VM use. |
| **System Clock** | Select the method to use to set the system the VM from the dropdown list. Options are **Local** which uses the TrueNAS SCALE system clock setting, or **UTC** to use the Coordinated Universal Time clock. Default is **Local**. |
| **System Clock** | Select the method to use to set the system the VM from the dropdown list. Options are **Local** which uses the TrueNAS SCALE system clock setting, or **UTC** to use the Coordinated Universal Time clock. The default is **Local**. |
| **Boot Method** | Select the boot method option from the dropdown list. Options are **UEFI** for newer operating systems or **Legacy BIOS** for older operating systems that only support BIOS booting. |
| **Shutdown Timeout** | Enter the time in seconds the system waits for the VM to cleanly shut down. During system shutdown, the system initiates power-off for the VM after the shutdown timeout entered expires. |
| **Start on Boot** | Select to start the VM when the system boots. Selected by default. |
| **Enable Display** | Enables a display (Virtual Network Computing) remote connection. Requires UEFI booting. Selected by default. |
| **Bind** | Displays when **Enable Display** is selected. Select an IP address to use for remote VNC sessions. Note, this setting only applies if you are using a VNC client other than the TrueNAS WebUI. |
| **Bind** | Displays when **Enable Display** is selected. Select an IP address to use for remote VNC sessions. Note that this setting only applies if you are using a VNC client other than the TrueNAS WebUI. |
| **Password** | Displays when **Enable Display** is selected. Enter a password for the VNC display to use to securely access the VM. |
{{< /truetable >}}
{{< /expand >}}

### CPU and Memory Screen
The **CPU and Memory** settings specify the number of virtual CPUs to allocate to the virtual machine, cores per virtual CPU socket, threads per core, to specify the CPU mode and model, and the memory size.
The **CPU and Memory** settings specify the CPU mode, model, and memory size. They also let you specify the number of virtual CPUs to allocate to the virtual machine, the number of cores per virtual CPU socket, and the number of threads per core.

{{< trueimage src="/images/SCALE/Virtualization/AddVMMemory.png" alt="CPU and Memory" id="CPU and Memory" >}}

{{< include file="/static/includes/VMCPUandMemorySettings.md" >}}

### Disks Screen
The **Disks** settings allow specifying how virtual disks are added. Options are to create a new zvol on an existing dataset for a disk image or use an existing zvol or file for the VM. You also specify the disk type, zvol location and size.
The **Disks** settings allow specifying how virtual disks are added. Options are to create a new zvol on an existing dataset for a disk image or use an existing zvol or file for the VM. You also specify the disk type, zvol location, and size.

{{< trueimage src="/images/SCALE/Virtualization/CreateVirtualMachineDisks.png" alt="Disks" id="Disks" >}}

Expand All @@ -73,7 +73,7 @@ The **Disks** settings allow specifying how virtual disks are added. Options are
|---------|-------------|
| **Create new disk image** | Select to create a new zvol on an existing dataset to use as a virtual hard drive for the VM. |
| **Use existing disk image** | Select to use an existing zvol or file for the VM. Displays the **Select Disk Type** and **Select Existing Zvol** dropdown list fields. |
| **Select Disk Type** | Displays after selecting **Use existing disk image**. Select desired disk type. Options are **AHCI** or **VirtIO**. Select **AHCI** for Windows VMs. **VirtIO** requires a guest OS that supports VirtIO paravirtualized network drivers. |
| **Select Disk Type** | Displays after selecting **Use existing disk image**. Select the desired disk type. Options are **AHCI** or **VirtIO**. Select **AHCI** for Windows VMs. **VirtIO** requires a guest OS that supports VirtIO paravirtualized network drivers. |
| **Select Existing Zvol** | (Required) Displays after selecting **Use existing disk image**. Select an existing zvol from the dropdown list. |
| **Zvol Location** | (Required) Displays after selecting **Use existing disk image**. Select a dataset for the new zvol from the dropdown list of datasets on the system. |
| **Size** | (Required) Displays after selecting **Use existing disk image**. Allocate space for the new zvol. (Examples: 500 KiB, 500M, 2 TB). Units smaller than MiB are not allowed. |
Expand All @@ -92,7 +92,7 @@ The **Network Interface** settings specify the network adapter type, mac address
| **Adapter Type** | Select the adapter type from the dropdown list. Options are:<br><li>**Intel e82545 (e1000)** emulates the same Intel Ethernet card and provides compatibility with most operating systems.<br><li>**VirtIO** provides better performance when the operating system installed in the VM supports VirtIO para-virtualized network drivers.</li> |
| **Mac Address** | Enter the desired address into the field to override the randomized MAC address. |
| **Attach NIC** | Select the physical interface to associate with the VM from the dropdown list. |
| **Trust Guest Filters** | Select to enable and allow the virtual server to change its MAC address. As a consequence, the virtual server can join multicast groups. The ability to join multicast groups is a prerequisite for the IPv6 Neighbor Discovery Protocol (NDP).<br>Setting **Trust Guest Filters** to yes has security risks, because it allows the virtual server to change its MAC address and so receive all frames delivered to this address. Disabled by default. |
| **Trust Guest Filters** | Select to enable and allow the virtual server to change its MAC address. As a consequence, the virtual server can join multicast groups. The ability to join multicast groups is a prerequisite for the IPv6 Neighbor Discovery Protocol (NDP).<br>Setting **Trust Guest Filters** to yes has security risks because it allows the virtual server to change its MAC address and so receive all frames delivered to this address. Disabled by default. |
{{< /truetable >}}
{{< /expand >}}

Expand All @@ -114,27 +114,27 @@ The **Installation Media** settings specify the operation system installation me
{{< truetable >}}
| Setting | Description |
|---------|-------------|
| **ISO save location** | Enter the path or browse to the location you want to install the image file. |
| **ISO save location** | Enter the path or browse to the location where you want to install the image file. |
| **Choose File** | Click to save the path populated in the **ISO save location** field. |
| **Upload** | Click to upload the file selected in the **ISO save location** field. |
{{< /truetable >}}
{{< /expand >}}

### GPU Screen
The **GPU** settings specify graphic processing unit (GPU) for the VM. It also provides the option to hide the VM from the Microsoft Reserved Partition (MSR) on Windows systems.
The **GPU** settings specify the graphic processing unit (GPU) for the VM. It also provides the option to hide the VM from the Microsoft Reserved Partition (MSR) on Windows systems.

{{< trueimage src="/images/SCALE/Virtualization/AddVMGPU.png" alt="GPU" id="GPU" >}}

{{< include file="/static/includes/VMGPUSettings.md" >}}

### Confirm Options Screen
The **Confirm Options** screen displays a summary of settings for the VM. It shows the number CPUs, cores, threads, memory, name of the VM, and the disk size.
The **Confirm Options** screen displays a summary of settings for the VM. It shows the number of CPUs, cores, threads, memory, name of the VM, and the disk size.

Click **Save** to add the VM to the **Virtual Machines** screen. Click **Back** to return to the previous screens to make changes.

## Virtual Machine Details Screen
Expand any VM on the **Virtual Machines** screen to show the details and options for a VM.
Details include the basic information on the number of virtual CPUS, cores, and threads, the amount of memory, boot load and system clock types, the display port number and the shutdown timeout in seconds.
Details include the basic information on the number of virtual CPUs, cores, and threads, the amount of memory, boot load and system clock types, the display port number, and the shutdown timeout in seconds.

{{< trueimage src="/images/SCALE/Virtualization/VirtualMachinesScreenwithVMDetails.png" alt="VM Details" id="VM Details" >}}

Expand All @@ -144,10 +144,10 @@ Starting the VM shows additional options for the VM.
{{< truetable >}}
| Operation | Icon | Description |
|-----------|------|-------------|
| **Start** | <span class="iconify" data-icon="bxs:right-arrow"></span> | Starts a VM. The toggle turns blue when the VM switches to running. Toggles to **Stop**. Clicking **Start** shows the **Restart**,**Power Off**, **Display** and **Serial Shell** buttons. |
| **Start** | <span class="iconify" data-icon="bxs:right-arrow"></span> | Starts a VM. The toggle turns blue when the VM switches to running. Toggles to **Stop**. Clicking **Start** shows the **Restart**,**Power Off**, **Display**, and **Serial Shell** buttons. |
| **Restart** | <span class="material-icons">replay</span> | Restarts the VM. |
| **Power Off** | <span class="material-icons">power_settings_new</span> | Powers off and halts the VM, similar to turning off a computer power switch. |
| **Stop** | <i class="material-icons" aria-hidden="true" title="Stop">stop</i> | Stops a running VM. Because a virtual machine does not always respond well to **STOP** or the command might time-out if the VM does not have an OS. Use **Power Off** instead. |
| **Stop** | <i class="material-icons" aria-hidden="true" title="Stop">stop</i> | Stops a running VM. Because a virtual machine does not always respond well to **STOP** or the command might time out if the VM does not have an OS. Use **Power Off** instead. |
| **Edit** | <span class="material-icons">mode_edit</span> | Opens the **[Edit Virtual Machine](#edit-virtual-machine-screen)** that displays editable VM settings. You cannot edit a VM while it is running. Stop the VM and then you can edit the properties and settings. |
| **Delete** | <i class="material-icons" aria-hidden="true" title="Delete">delete</i> | Deletes a VM. Opens a [delete dialog](#delete-virtual-machine-dialog) that allows you to remove the VM from your system. You cannot delete a virtual machine that is running. You must first stop the VM and then you can delete it. |
| **Devices** | <i class="material-icons" aria-hidden="true" title="Devices">device_hub</i> | Opens the **[Virtual Machine Devices](#devices-screens)** screen for the selected VM. Shows a list of configured devices for the VM. By default, all VMs show the **Disks**, **NIC**, and **Display** devices. |
Expand Down Expand Up @@ -204,11 +204,11 @@ The **Edit** screen **General Settings** specify the basic settings for the VM.
|---------|-------------|
| **Name** | Required. Enter an alphanumeric name for the virtual machine. |
| **Description** | Enter a description (optional). |
| **System Clock** | Select the VM system time from the dropdown list. Options are **Local** or **UTC**. Default is **Local**. |
| **System Clock** | Select the VM system time from the dropdown list. Options are **Local** or **UTC**. The default is **Local**. |
| **Boot Method** | Select the boot method option from the dropdown list. Select **UEFI** for newer operating systems or **Legacy BIOS** for older operating systems that only support BIOS booting. |
| **Shutdown Timeout** | Enter the time in seconds the system waits for the VM to cleanly shut down. During system shutdown, the system initiates power-off for the VM after the shutdown timeout entered expires. |
| **Start on Boot** | Select to start this VM when the system boots. |
| **Enable Hyper-V Enlightenments** | Shows for VMs set for Windows OS. KVM implements Hyper-V Enlightenments for Windows guests. These features make Windows think they are running on top of a Hyper-V compatible hypervisor and use Hyper-V specific features. In some cases enabling these enlightenments might improve usability and performance on the guest. |
| **Enable Hyper-V Enlightenments** | Shows for VMs set for Windows OS. KVM implements Hyper-V Enlightenments for Windows guests. These features make Windows think they are running on top of a Hyper-V-compatible hypervisor and use Hyper-V-specific features. In some cases enabling these enlightenments might improve the usability and performance on the guest. |
{{< /truetable >}}
{{< /expand >}}

Expand Down Expand Up @@ -251,7 +251,7 @@ Each device listed on the **Devices** screen has the same three options, accesse

* **Delete** opens a dialog. **Delete Device** confirms you want to delete the device.

* **Details** opens an information dialog that lists the port, type, bind IP and other details about the device.
* **Details** opens an information dialog that lists the port, type, bind IP, and other details about the device.
Click **Close** to close the dialog.

## Devices Add Screens
Expand Down Expand Up @@ -284,13 +284,13 @@ Select **NIC** in **Device Type** to see the VM network interface card settings.
| **MAC Address** | Displays the default auto-generated random MAC address the VM receives. Enter a custom address to override the default. |
| **Generate** | Click to add a new randomized address in **MAC Address**. |
| **NIC To attach** | Select a physical interface from the dropdown list to associate with the VM. |
| **Trust Guest Filters** | Default setting is not enabled. Set this attribute to allow the virtual server to change its MAC address. As a consequence, the virtual server can join multicast groups. The ability to join multicast groups is a prerequisite for the IPv6 Neighbor Discovery Protocol (NDP).<br>Setting **Trust Guest Filters** to "yes" has security risks, because it allows the virtual server to change its MAC address and so receive all frames delivered to this address. |
| **Trust Guest Filters** | Default setting is not enabled. Set this attribute to allow the virtual server to change its MAC address. As a consequence, the virtual server can join multicast groups. The ability to join multicast groups is a prerequisite for the IPv6 Neighbor Discovery Protocol (NDP).<br>Setting **Trust Guest Filters** to "yes" has security risks because it allows the virtual server to change its MAC address and receive all frames delivered to this address. |
| **Device Order** | Enter the number (such as *1003*) that represents where in the boot order this device should be. The higher the number, the later in the boot-up process the device falls. |
{{< /truetable >}}
{{< /expand >}}

{{< expand "Add Disk Device Type Settings" "v" >}}
Select **Disk** in **Device Type** in the **Add** device screen to see the disk settings that include disk location, drive type and disk sector size.
Select **Disk** in **Device Type** in the **Add** device screen to see the disk settings including disk location, drive type, and disk sector size.

{{< trueimage src="/images/SCALE/Virtualization/VMAddDeviceDisk.png" alt="Add Device - Disk" id="Add Device - Disk" >}}

Expand All @@ -317,7 +317,7 @@ Select **Display** in **Device Type** in the **Add** device screen to see the di
| Setting | Description |
|---------|-------------|
| **Type** | Select the device type from the dropdown list. **Display** is the default setting. |
| **Port** | Enter the port number. You can assign **0**, leave empty for TrueNAS to assign a port when the VM is started, or set to a fixed preferred port number. |
| **Port** | Enter the port number. You can assign **0**, leave it empty for TrueNAS to assign a port when the VM is started, or set it to a fixed preferred port number. |
| **Resolution** | Select a screen resolution to use for VM display sessions. |
| **Bind** | Select an IP address to use for display sessions or use the default **0.0.0.0**. |
| **Password** | Enter a password of no more than eight characters in length to automatically pass to the remote display session. |
Expand Down Expand Up @@ -374,4 +374,4 @@ Select **USB Passthrough Device** in **Device Type** in the **Add** device scree
| **Device** | Enter or select the device from the dropdown list of options. If **Specify custom** is chosen, enter the required **Vendor ID** and **Product ID**. |
| **Device Order** | Enter the number (such as *1003*) that represents where in the boot order this device should be. The higher the number, the later in the boot-up process the device falls. |
{{< /truetable >}}
{{< /expand >}}
{{< /expand >}}

0 comments on commit f5db323

Please sign in to comment.