Skip to main content

VM Hardware Setups

Access VM Hardware Setups​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.

View Basic Information of a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to view.
  5. Click the View button in the top right panel.
  6. In the left panel, view the VM hardware setup name, description, realm, availability and creation date.

View Cores, Memory, Devices, and VMs Used for a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to view.
  5. Click the View button in the top right panel.
  6. In the left panel, scroll down and view the used VM Image, cores, memory, devices and virtual machines in the left panel.

Create a New VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Click the Create new VM hardware setup button in the top right panel.
  5. In the pop-up, enter the image, applying quotas selection, RAM disk size, optional NFS drives, hardware setup name, description, teams, users, and usage instructions.
  6. Click Create new setup.
caution

If no teams or users are specified in the prompt, the hardware setups will be made public, allowing anyone in the system with the appropriate permissions to access them, regardless of team.

Edit an Existing VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to edit.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, edit the image, applying quotas selection, RAM disk size, optional NFS drives, hardware setup name, description, teams, users, and usage instructions.
  7. Click Update.

Change Team and Users Using the VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to change teams and users.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, under Info and availability, scroll down to teams and users.
  7. Click Remove to remove the teams and users.
  8. Enter the new teams and users for the VM hardware setup.
  9. Click Update.

Revoke Quotas When Creating a New VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Click the Create new VM hardware setup button in the top right panel.
  5. In the pop-up, enter the image, RAM disk size, optional NFS drives, hardware setup name, description, teams, users, and usage instructions.
  6. Under the Hardware subsection, tick Do not apply quotas to this hardware setup.
  7. Click Create new setup.
tip

You should still apply quotas to hardware setups for good practice.

Set Up VNC in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Click the Create new VM hardware setup button in the top right panel.
  5. In the pop-up, under Hardware subsection, select VNC.
  6. Enter the image, applying quotas selection, RAM disk size, optional NFS drives, hardware setup name, description, teams, users, and usage instructions.
  7. Click Create new setup.
danger

When the virtual video card (VNC) is enabled, all VMs created from the hardware setup will have security holes for debugging. VMs will be marked with the Debug symbol.

Connect NFS Drives to a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to connect NFS drives.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, scroll down to NFS Drives.
  7. Search and select the NFS mounts.
  8. Click Update.
tip

Use NFS drives option for software that requires network drives.

Use a GPU with a Display in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Click the Create new VM hardware setup button in the top right panel.
  5. In the pop-up, enter the image, applying quotas selection, RAM disk size, optional NFS drives, hardware setup name, description, teams, users, and usage instructions.
  6. Scroll down and click the Advanced Options button.
  7. Under the Graphics card with display output tick Use a GPU with a display.
  8. Under the Controller version subsection, select Default.
  9. Click Create new setup.
danger

Advanced options inherit risks leading to unbootable or unpredictable VM behavior. They are meant for experienced users who have tested them cautiously before execution.

Select a Configuration File for a VM Hardware Setup to Allow Image Reuse​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to allow image reuse.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, scroll down and click the Advanced Options button.
  7. Under the Configuration file prefix subsection, enter full path of configuration file.
  8. Click Update.
note

Configuration file prefix allows the same image to be used with different configurations. Example of file prefix: /etc/ticrypt/controller.toml.

Execute Startup Scripts Before the VM Registers in the VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to execute startup script.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, scroll down and click the Advanced Options button.
  7. Under the Startup script subsection, enter the startup script.
  8. Click Update.
tip

Startup scripts may be used for programs requiring a VM restart. When paired with the restart option, the script will change the system setup before the VM controller takes over the VM hardware setup.

info

If restart is required you must add shutdown -t now in the startup script.

Inject Extra XML Scripts Inside the Domain Tag of a Libvirt VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to inject XML script.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, scroll down and click the Advanced Options button.
  7. Under the Extra XML subsection, enter the XML script for the Libvirt VM.
  8. Click Update.
note

The XML is injected in the domain tag.

info

See more in Libvirt Documentation.

Copy Instructions from a Different VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to edit.
  5. Click the Edit button in the top right panel.
  6. In the pop-up, edit the image, applying quotas selection, RAM disk size, optional NFS drives, hardware setup name, description, teams, users, and usage instructions.
  7. Click Update.

Set Up the Log Level in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to set up log level.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Debug subsection.
  7. Set the Log level to Trace, Debug, Info, Warn, Error, Fatal, or Panic.
  8. Click Save.

Reset All Tunnels to Default in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to reset all tunnels.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Click the Reset to Default button to the right side.
  8. Click Save.

Configure the Idle Timeout for Tunnels in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to configure idle timeout.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set the Idle timeout to the appropriate values.
  8. Click Save.

Enable a Sudo Manager in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to enable sudo manager.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Debug subsection.
  7. Set Enable manager sudo to True.
  8. Click Save.

Disable a Sudo Manager in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to disable sudo manager.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Debug subsection.
  7. Set Enable manager sudo to False.
  8. Click Save.

Enable Terminal in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to enable terminal.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Terminal subsection.
  7. Set Enabled to True.
  8. Click Save.

Disable Terminal in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to disable terminal.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Terminal subsection.
  7. Set Enabled to False.
  8. Click Save.

Set Up Scrollback Function for a Terminal in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to set up scrollback.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Terminal subsection.
  7. Set Scrollback to True.
  8. Click Save.

Set Up Maximum Scrollback Function for a Terminal in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to set up maximum scrollback.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Terminal subsection.
  7. Set Maximum scrollback to the preferred number of lines.
  8. Click Save.
tip

Use the maximum scrollback to review logs, troubleshoot, and capture long outputs of VM hardware setups.

Enable Tunnels in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to enable tunnels.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set Enabled to True.
  8. Click Save.

Disable Tunnels in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to disable tunnels.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set Enabled to False.
  8. Click Save.

Set Up Server Ports in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to set up server ports.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set the Server port to the appropriate values.
  8. Click Save.

Set Up Allowed Ports in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to set up allowed ports.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set the Allowed ports to the appropriate values.
  8. Click Save.

Enable SFTP in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to enable SFTP.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set SFTP enabled to True.
  8. Click Save.

Disable SFTP in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to disable SFTP.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. Set SFTP enabled to False.
  8. Click Save.

Set Up SFTP Ports in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. In the SFTP port enter the SFTP port address.
  8. Click Save.

Reset SFTP Ports to Default in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. In the SFTP port, click the Reset to Default button to the right side.
  8. Click Save.

Set Up SSH Directory Path in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. In the SSH directory path enter the full SSH path.
  8. Click Save.

Reset SSH Directory Path to Default in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Tunnel subsection.
  7. In the SSH directory path, click the Reset to Default button to the right side.
  8. Click Save.

Configure VNC Services in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to configure VNC services.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Services subsection.
  7. Set VNC to the appropriate values.
  8. Click Save.

Configure Xpra Services in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to configure Xpra services.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Services subsection.
  7. Set Xpra to the appropriate values.
  8. Click Save.

Enable Admin Password Change in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Users subsection.
  7. Set Don't change admin password to False.
  8. Click Save.

Disable Admin Password Change in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Users subsection.
  7. Set Don't change admin password to True.
  8. Click Save.

Empower Managers as Administrators in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Users subsection.
  7. Set Managers as administrators to True.
  8. Click Save.

Disable Manager Access as Administrators in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to Users subsection.
  7. Set Managers as administrators to False.
  8. Click Save.

Manage User Access in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to manage access.
  5. Click the Manage Access button in the top right panel.
  6. In the pop-up, enter the team and user names to allow.
  7. Click Update.

Make an Existing VM Hardware Setup Public​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to make public.
  5. Click the Manage Access button in the top right panel.
  6. In the pop-up, leave both the team and user fields empty.
  7. Click Make public.
note

Public VM hardware setups can be accessed by anyone in the system who is part of an existing team and has viewing permissions.

Clone an Existing VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to clone.
  5. Click the Clone button in the top right panel.
  6. In the pop-up, click Create new setup.
info

Cloning creates a new copy of a VM Hardware Setup, whereas editing modifies the existing setup.

Change the Image of an Existing VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to change image.
  5. Click the Open Full Menu button in the top right panel.
  6. Select Change Image.
  7. In the pop-up, enter the new image name.
  8. Click Update.
note

The new image must belong to the same realm (Libvirt).

Replace Instructions in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to replace instructions.
  5. Click the Open Full Menu button in the top right panel.
  6. Select Replace Instructions.
  7. In the pop-up, enter the VM hardware setup name to copy instructions from, and click Copy Instructions, or enter the instructions manually.
  8. Once done, click Update.

Simulate the Allocation of Cores, Memory, and Devices in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to simulate allocation.
  5. Click the Open Full Menu button in the top right panel.
  6. Select Simulate Allocation.
  7. In the pop-up, view the name, state, profile, cost, cores, memory, and device allocation.
  8. Once done, click Close.

Bulk Email All Users in a VM Hardware Setup​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup for which you want to send a bulk email to users.
  5. Click the Open Full Menu button in the top right panel.
  6. Select Bulk email.
  7. In the pop-up, click Copy to copy the email or click Download to download them.
  8. Once done, click Close.

Delete a VM Hardware Setup from Management​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Hardware Setups in the left panel.
  4. Select the VM hardware setup to delete.
  5. Click the Open Full Menu button in the top center panel.
  6. Select Delete.
  7. In the prompt, click Delete.