TrueNAS SCALETrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

Adding and Managing VMs

  8 minute read.

Last Modified 2024-03-19 08:38 EDT

A virtual machine (VM) is an environment on a host computer that you can use as if it is a separate, physical computer. Users can use VMs to run multiple operating systems simultaneously on a single computer. Operating systems running inside a VM see emulated virtual hardware rather than the host computer physical hardware. VMs provide more isolation than Jails but also consume more system resources.

TrueNAS assigns a portion of system RAM and a new zvol to each VM. While a VM is running, these resources are not available to the host computer or other VMs.

TrueNAS VMs use the KVM virtual machine software. This type of virtualization requires an x86 machine running a recent Linux kernel on an Intel processor with VT (virtualization technology) extensions or an AMD processor with SVM extensions (also called AMD-V). Users cannot create VMs unless the host system supports these features.

To verify that you have Intel VT or AMD-V, check your processor model name on the vendor’s website. If needed, enable virtualization in the BIOS Advanced > CPU Configuration settings.

Creating a Virtual Machine

Before creating a VM, you need an installer .iso or image file for the OS you intend to install, and a zvol on a storage pool that is available for both the virtual disk and OS install file.

To create a new VM, go to Virtualization and click Add to open the Create Virtual Machine configuration screen. If you have not yet added a virtual machine to your system you can click Add Virtual Machines to open the same screen.

  1. Select the operating system you want to use from the Guest Operating System dropdown list.

    AddVMOperSys

    Compare the recommended specifications for the guest operating system with your available host system resources when allocating virtual CPUs, cores, threads, and memory size.

  2. Change other Operating System settings per your use case.

    Select UTC as the VM system time from the System Clock dropdown if you do not want to use the default Local setting.

    Change the default IP address in Bind if you want use a specific address as the primary network interface, otherwise leave it set to 0.0.0.0.

    If selecting Enable Display, enter a device Password.

    Click Next.

  3. Enter the CPU and memory settings for your VM.

    AddVMMemory

    If you selected Windows as the Guest Operating System, the Virtual CPUs field displays a default value of 2. The VM operating system might have operational or licensing restrictions on the number of CPUs.

    Do not allocate too much memory to a VM. Activating a VM with all available memory allocated to it can slow the host system or prevent other VMs from starting.

    Leave CPU Mode set to Custom if you want to select a CPU model.

    Specify the amount of RAM you want for the VM if you want to use more or less than the default. We recommend increasing this value, but your configuration depends on the resources available for your VM.

    Click Next.

  4. Configure disk settings.

    CreateVirtualMachineDisks

    Select Create new disk image to create a new zvol on an existing dataset.
    Select Use existing disk image to use an existing zvol for the VM.

    Select either AHCI or VirtIO from the Select Disk Type dropdown list. We recommend using AHCI or Windows VMs.

    Select the location for the new zvol from the Zvol Location dropdown list.

    Enter a value in Size (Examples: 500KiB, 500M, and 2TB) to indicate the amount of space to allocate for the new zvol.

    Click Next.

  5. Configure the network interface.

    AddVMNetwork

    Select the network interface type from the Adapter Type dropdown list. Select Intel e82585 (e1000) as it offers a higher level of compatibility with most operating systems, or select VirtIO if the guest operating system supports para-virtualized network drivers.

    Select the network interface card to use from the Attach NIC dropdown list.

    Click Next.

  6. Upload installation media for the operating system you selected.

    AddVMInstallMedia

    You can create the VM without an OS installed. To add it either type the path or browse to the location and select it.

    To upload an iso select Upload New Image File and either enter the path or browse to the location of the file.

    CreateVMWInstallMediaUploadSCALE

    Click Upload to begin the upload process. After the upload finishes, click Next.

  7. Specify a GPU.

    AddVMGPU

    The VirtIO network interface requires a guest OS that supports VirtIO para-virtualized network drivers.

    iXsystems does not have a list of approved GPUs at this time but does have drivers and basic support for the list of nvidia Supported Products.
  8. Confirm your VM settings, then click Save.

Adding and Removing Devices

After creating the VM, you can add or remove virtual devices.

Expand the VM entry on the Virtual Machines screen and click Devices.

VMDevicesListed

Device notes:

  • A virtual machine attempts to boot from devices according to the Device Order, starting with 1000, then ascending.
  • A CD-ROM device allow booting a VM from a CD-ROM image like an installation CD. The CD image must be available in the system storage.

Managing a Virtual Machine

After creating the VM and configuring devices for it, manage the VM by expanding the entry on the Virtual Machines screen.

VirtualMachinesScreenwithVMDetails

An active VM displays options for Display and Serial Shell connections.

When a Display device is configured, remote clients can connect to VM display sessions using a SPICE client, or by installing a 3rd party remote desktop server inside your VM. SPICE clients are available from the SPICE Protocol site.

If the display connection screen appears distorted, try adjusting the display device resolution.

Use the State toggle or click Stop to follow a standard procedure to do a clean shutdown of the running VM. Click Power Off to halt and deactivate the VM, which is similar to unplugging a computer.

If the VM you created has no Guest OS installed, The VM State toggle and Stop button might not function as expected. The State toggle and Stop button send an ACPI power down command to the VM operating system, but since an OS is not installed, these commands time out. Use the Power Off button instead.

Installing an OS

When the VM is configured in TrueNAS and has an OS .iso, file attached, you can start the VM and begin installing the operating system.

Some operating systems can require specific settings to function properly in a virtual machine. For example, vanilla Debian can require advanced partitioning when installing the OS. Refer to the documentation for your chosen operating system for tips and configuration instructions.

Upload the Debian .iso to the TrueNAS system and attached to the VM as a CD-ROM device.

  1. Click Virtualization, then ADD to use the VM wizard.

    SCALEDebianVMOperatingSystem

    Wizard ScreenSettingDescription
    Operating System:Guest Operating SystemLinux
    NamedebianVM
    DescriptionDebian VM
    CPU and Memory:Memory Size1024 MiB
    Disks:Create new disk imageSelected
    Zvol LocationSelect pool.
    Size30 GiB
    Network Interface:Attach NICSelect the physical interface to associate with the VM.
    Installation Media:Installation ISO is uploaded to /mnt/tank2/isostorage/.
    If the ISO is ot uploaded, select Upload an installer image file.
    Select a dataset to store the ISO, click Choose file, then click Upload. Wait for the upload to complete.
    GPU:Leave the default values.
    Confirm OptionsVerify the information is correct and then click Save.
    1. After creating the VM, start it. Expand the VM entry and click Start.

    2. Click Display to open a virtual monitor to the VM and see the Debian Graphical Installation screens.

    Debian Graphical Install

    1. Press Return to start the Debian Graphical Install.
    • Language: English
    • Location: United States
    • Keymap: American English

    Installation begins

    • Continue if the network configuration fails.
    • Do not configure the network at this time.
    • Enter a name in Hostname.
    • Enter the root password and re-enter the root password.
    • Enter a name in New User.
    • Select the username for your account (it should already be filled in).
    • Enter and re-enter the password for the user account.
    • Choose the time zone, Eastern in this case.

    Disk detection begins

    • Partition disks: select Guided - use entire disk.
    • Select the available disk.
    • Select All files in one partition (recommended for new users).
    • Select Finish partitioning and write changes to disk.
    • Select Yes to Write the changes to disks?.

    Installing the base system begins

    • Select No to the question Scan extra installation media.
    • Select Yes when asked Continue without a network mirror.

    Installing software begins

    • Select No when asked Participate in the package usage survey.
    • Select Standard system utilities.
    • Click Continue when the installation finishes.

    After the Debian installation finishes, close the display window.

    1. Remove the device. In the expanded section for the VM, click Power Off to stop the new VM.

      a. Click Devices. b. Remove the CD-ROM from the devices by clicking the   and selecting Delete. Click Delete Device.

    2. Return to the Virtual Machines screen and expand the new VM again.

    3. Click Start.

    4. Click Display.

The grub file does not run when you start the VM, you can do this manually after each start. At the shell prompt:

  1. Type FS0: Return.
  2. Type cd EFI Return.
  3. Type cd Debian Return.
  4. Type grubx64.efi Return.

To ensure it starts automatically, you create the startup.nsh file at the root directory on the vm. To create the file:

  1. Go to the Shell.

  2. At the shell prompt type edit startup.nsh.

  3. In the editor type:

  • Type FS0: Return.
  • Type cd EFI Return.
  • Type cd Debian Return.
  • Type grubx64.efi Return.
  • Use the Control+s keys (Command+s for Mac OS) then Return.
  • Use the Control+q keys to quit.
  1. Close the display window

  2. To test if it now boots up on startup:

    • Power off the VM.
    • Click Start.
    • Click Display.
    • Log into your Debian VM.

Related Content