Get a Quote     (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Virtual Machines

  6 minute read.

Last Modified 2022-09-29 14:12 EDT

The Virtual Machines screen displays a list of virtual machines (VM) configured on your system.

VirtualMachinesScreen

Use the blue COLUMNS button to display a list of options to customize the list view. Options are Select All, Autostart, Virtual CPUs, Cores, Threads, Memory Size, Boot Loader Type, System Clock, VNC Port, Com Port, Description, Shutdown Timeout or Reset to Defaults.

Use ADD to display the Virtual Machines configuration Wizard.

The State toggle indicates the current state of the VM. Hover over the toggle with your mouse to see the state as STOPPED or RUNNING. The toggle turns blue when it is running.

Select the Autostart checkbox to set the VM to start automatically after a system reboot, or clear the checkbox to require manually starting the VM after a system reboot.

Virtual Machine Wizard

The Wizard consists of six individual configuration screens.

Confirmation Options displays the summary of settings. You can use BACK to return to previous screens to make changes or use SUBMIT to save settings and create the virtual machine.

After saving the VM, if you want to make changes you can select the the VM on the list, expand it and select EDIT to make changes.

VM Wizard Navigation

You cannot advance to the next screen if the current screen has required fields. After entering all required information you can advance to the next screen.

Use Next to advance to the next wizard configuration form.

Use Back to return to a previous wizard configuration form.

Use Cancel to exit the configuration wizard.

The blue edit icons preceding each Wizard screen name, at the top of the screen, allow you to jump to the screen you selected but only if you have populated all required fields on the current screen and any screen that follows in the sequence of screens. If you select a screen that follows a Wizard screen that has required fields and you have not provided the information those required fields wants, the screen you selected does not display. You must enter all required fields before you can freely move around in the Wizard screens.

VMAddOperatingSystemScreen

NameDescription
Guest Operating SystemRequired field. Select the VM operating system type from the dropdown list three operating systems listed Windows, Linux or FreeBSD.
NameEnter an alphanumeric name for the virtual machine.
Description(optional) Enter a description for the OS.
System ClockRequired field. Specifies the VM system time. Select from the dropdown list options Local or UTC. Default is Local.
Boot MethodSelect from the dropdown list options UEFI, UEFI-CSM or Grub. Select UEFI for newer operating systems or UEFI-CSM (Compatibility Support Mode) for older operating systems that only support BIOS booting. Grub is not recommended but can be used when the other options do not work.
Shutdown TimeoutThe 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 expires.
Start on BootSelect to start this VM when the system boots.
Enable VNCSelect to enable a VNC (Virtual Network Computing) remote connection. Requires UEFI booting.
Delay VM Boot Until VNC ConnectsSelect to wait to start VM until VNC client connects.
BindRequired field. Select from the dropdown list options 0.0.0.0, ::, ::1 or the system IP addresses provided on the list. VNC network interface IP address. The primary interface IP address is the default. A different interface IP address can be chosen.

VMAddCPUandMemoryScreen

NameDescription
Virtual CPUsNumber of virtual CPUs to allocate to the virtual machine. The maximum is 16, or fewer if the host CPU limits the maximum. The VM operating system might also have operational or licensing restrictions on the number of CPUs.
CoresSpecify the number of cores per virtual CPU socket. The product of vCPUs, cores, and threads must not exceed 16.
ThreadsSpecify the number of threads per core. The product of vCPUs, cores, and threads must not exceed 16.
Memory SizeAllocate RAM for the VM. Minimum value is 256 MiB. This field accepts human-readable input (Ex. 50 GiB, 500M, 2 TB). If units are not specified, the value defaults to bytes.

VMAddDisksScreen

NameDescription
Create new disk imageSelect to create a new zvol on an existing dataset. This is used as a virtual hard drive for the VM. Select Use existing disk image to use an existing zvol or file for the VM.
Select Disk TypeSelect desired disk type from the dropdown list options AHIC or VirtIO.
Zvol LocationRerquired field. Select a dataset for the new zvol.
SizeAllocate space for the new zvol. (Examples: 500 KiB, 500M, 2 TB) MiB. Units smaller than MiB are not allowed.

VMAddNetworkInterfaceScreen

NameDescription
Adapter TypeRequired field. Select an adapter from the dropdown list. Intel e82545 (e1000) emulates the same Intel Ethernet card. This provides compatibility with most operating systems. VirtIO provides better performance when the operating system installed in the VM supports VirtIO paravirtualized network drivers.
Mac AddressEnter the desired address into the field to override the randomized MAC address.
Attach NICRequired field. Select the physical interface to associate with the VM from the dropdown list options.

VMAddInstallationMediaScreen

NameDescription
Choose Installation Media ImageBrowse to the operating system installer image file.
Upload an Installer Image FileSet to display image upload options.

Individual Virtual Machine Screen

The individual virtual machine screens display the VM settings and provide optional operation buttons for that VM. Click the icon to expand that virtual machine and access current settings and operation actions.

VMScreenExpanded

The following operations are available on each VM screen:

OperationIconDescription
RESTARTreplayRetarts the VM.
POWER OFFpower_settings_newPowers off and halts the VM, similar to turning off a computer power switch.
STOPStops a running VM. Because a virtual machine doesn’t always respond well to STOP use the option to force the stop when prompted.
STARTStarts a VM. The toggle turns blue when the VM switches to running.
EDITmode_editDisplays the Virtual Machines > Edit screen. You cannot edit a VM while it is running. You must first stop the VM and then you can edit the properties and settings.
DELETEDeletes a VM. You cannot delete a virtual machine that is running. You must first stop the VM and then you can delete it.
DEVICESDisplays the list of devices for this virtual machine. See xxx
CLONEMakes an exact copy or clone of the VM that you can select and edit. A Name dialog displays where you can enter a name for the cloned VM. Naming the clone VM is optional. The cloned VM displays on the Virtual Machines list with the extension _clone0. if you clone the same VM again the extension for the second clone is clone1.
VNCOpens a noVCN window that allows you to connect to a
SERIALOpens the TrueNAS Shell screen.
The STOP button and the system State toggle both try to send an ACPI power-down command to the VM operating system. Sometimes the commands time out, so it is better to use the POWER OFF button instead.

Related Content