Skip to main content
tiCrypt 2.18.1

VM Hardware Setups

Prerequisites

User Role:

Sub-admin, Admin, Super-admin

Permission Requirements

  • VM Administration
    • View all VM hardware setups
    • Create VM hardware setups (to create or clone a setup)
    • Edit any VM hardware setup (to edit a setup, its settings, access, image or instructions)
    • Delete any VM hardware setup (to delete a setup)

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.

A row is red when the setup's image has no drive format or no operating system.

The following table describes the columns of the VM Hardware Setups table.

ColumnContent
NameThe name of the setup.
DebugWhether VMs from the setup run in debug mode.
Advanced OptionsWhether advanced options are set.
VM SettingsWhether VM settings are set with Edit Settings.
VM ConfigsThe number of VM configurations that use the setup.
RealmThe realm of the setup's image.
VariantThe VM controller variant.
ImageThe VM image, with a link to its panel.
OSThe operating system of the image.
CoresThe cores each VM gets.
MemoryThe memory each VM gets.
DevicesThe devices each VM gets.
Created ByThe user who created the setup.
Drive FormatThe drive formats the image supports.

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. Review the VM Hardware Setup panel. Its header shows how many VMs use the setup.

The following table describes the content of the VM Hardware Setup panel.

SectionContent
DescriptionThe setup description, when it has one.
Basic infoRealm, User availability and Team availability (or Availability: "Available to anyone" for a public setup), Created by, Created on, Last modified on and the ID.
SpecificationImage, OS, Cores, Memory, RAM disk, Drive formats and Drive bus type.
VM controllerVariant, Advanced options, VM settings and Debug mode, each Yes or No except the variant.
N devices usedThe devices each VM gets.
Available toThe teams and users the setup is limited to.
N NFS mountsThe NFS mounts attached to VMs from the setup.
Used by N VM configurationsThe VM configurations that use the setup.
Used by N VMsThe VMs running from the setup.

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, under Specification, view the VM image, cores, memory, devices, and virtual machines used.

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 Create a new VM hardware setup pop-up, complete the four steps: 1 Image, 2 Hardware, 3 Info & Availability and 4 Usage Instructions.
  6. Click Create new setup.
caution

If no teams or users are specified in the dialog, the hardware setup becomes public, allowing anyone in the system with the appropriate permissions to access it, regardless of team.

The following table describes the fields of the Create a new VM hardware setup pop-up.

StepFieldDescription
1 ImageImageRequired. The VM image VMs boot from. The realm of the setup is the realm of the image you select.
2 HardwareDo not apply quotas to this hardware setupUnticked by default.
VideoNone (the default) or VNC. With VNC, every VM from the setup runs in debug mode, and the pop-up warns: "Because you enabled a virtual video card, VMs created from this setup will have security holes necessary for debugging; this setup will be marked visually as a debug setup and so will any VMs created from it."
CoresRequired. A whole number of 1 or more, 4 by default.
Max MemoryRequired. At least 1 GB, 8 GB by default.
DevicesThe devices each VM gets, from the devices the realm's hosts offer.
RAM Disk SizeOptional. Part of the VM memory used as an in-memory disk. Hidden for Windows images.
NFS Drives (optional)The NFS drives mounted on each VM.
Advanced optionsShown once an image is selected. See Advanced Options.
3 Info & AvailabilityNameRequired, up to 80 characters, without any of / \ | " : * ? < > { }. It must differ from the name of every other setup.
Authorization listThe teams and users who can use the setup. Left empty, the setup is public.
Description (optional)Up to 250 characters.
4 Usage InstructionsInstructions editorRequired, up to 1,000 characters, without <, >, { or }. It starts as "(No instructions provided)". See Write Usage Instructions.

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 Update <name> pop-up, edit the image, quotas, hardware, RAM disk size, optional NFS drives, hardware setup name, teams, users, optional description, and usage instructions. The image must stay in the same realm.
  7. Click Update <name>.

Change Teams 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 <name>.

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 to apply quotas selection, RAM disk size, optional NFS drives, hardware setup name, teams, users, optional description, and usage instructions.
  6. Under the Hardware subsection, tick Do not apply quotas to this hardware setup.
  7. Click Create new setup.
tip

As a best practice, still apply quotas to hardware setups.

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 the Hardware subsection, select VNC.
  6. Enter the image to apply quotas selection, RAM disk size, optional NFS drives, hardware setup name, teams, users, optional description, and usage instructions.
  7. Click Create new setup.
warning

When the virtual video card (VNC) is enabled, all VMs created from this hardware setup run with reduced security restrictions for debugging purposes. VMs are 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 <name>.
tip

Use the NFS drives option for software that requires network drives.

Advanced Options​

Set the Default IO Driver of a VM Hardware Setup​

Default IO driver sets the driver used for drives. SCSI (recommended) is almost always the best option. VirtIO (legacy) is only useful for old VM controllers that do not support SCSI, and disables some functionality.

Location: Management > Virtual Machines > VM Hardware Setups

  1. Select the VM hardware setup.
  2. Click the Edit button in the top right panel.
  3. In the pop-up, click the Advanced Options button.
  4. Under Default IO driver, select SCSI (recommended) or VirtIO (legacy).
  5. Click Update <name>.

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 to apply quotas selection, RAM disk size, optional NFS drives, hardware setup name, teams, users, optional description, and usage instructions.
  6. Under NFS Drives, click the Advanced Options button.
  7. Under the Graphics Card with Display Output subsection, tick Use a GPU with a display.
  8. Under the Controller version subsection, select Default.
  9. Click Create new setup.
warning

Advanced options can produce unbootable VMs or unpredictable behavior. Test changes in a non-production environment before deploying.

info

The controller version option allows testing of new controllers for specific VM requirements.

  • Default: Uses the default VM controller.
  • Experimental (beta): Unstable controller version intended for testing new features only.

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 a prefix, not a path. The hint below the field shows the resulting file name.
  8. Click Update <name>.
note

The configuration file prefix allows the same image to be used with different configurations. Without a prefix, the VM controller reads /etc/ticrypt/controller.toml on Linux. With a prefix, it reads /etc/ticrypt/<prefix>-controller.toml on Linux, or <prefix>-controller.toml in the tiCrypt VM Controller folder under Program Files on Windows. The file must exist in the image.

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 a 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. If the script restarts the VM, tick System restarts after startup script. This checkbox appears once the script is not empty.
  9. Click Update <name>.
tip

Use startup scripts for programs that require a VM restart. When paired with the restart option, the script changes the system setup before the VM controller takes over the VM hardware setup.

info

If a restart is required, the script itself must restart the VM, for example with Restart-Computer -force on Windows, and System restarts after startup script. must be ticked.

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 an 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 <name>.
note

The XML is injected in the domain tag.

info

See more in Libvirt Documentation.

Copy Instructions from a Different VM Hardware Setup​

Location: Management > Virtual Machines > VM Hardware Setups

  1. Select the VM hardware setup whose instructions you want to change.
  2. Click the Edit button in the top right panel.
  3. In the pop-up, under Usage Instructions, select a setup in Copy from.
  4. Click the Copy instructions button.
  5. Review the instructions, which now replace the editor's content.
  6. Click Update <name>.
Result:

The editor holds the instructions of the setup you chose in Copy from. Nothing is copied to your clipboard.

Write Usage Instructions​

The usage instructions are shown to users when they open an application on a VM from the setup. They are Markdown, and they can hold placeholders that tiCrypt fills in when the instructions are displayed, because these values are only known once the user connects.

The following table describes the placeholders in usage instructions.

PlaceholderReplaced with
@user or @usernameThe user's VM account username.
@passwd or @passwordThe user's VM account password.
@:<port>:The local port forwarded to that port on the VM, for example @:8888:. If no local port is forwarded to it, the text reads "(No local port is forwarded to vm:<port>)".

Set Up the Debug 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 the log level.
  5. Click the Edit Settings button in the top right panel.
  6. Under the Debug subsection, set the Log level to Trace, Debug, Info, Warn, Error, Fatal, or Panic.
  7. 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 the sudo manager.
  5. Click the Edit Settings button in the top right panel.
  6. Under the Debug subsection, set Enable manager sudo to True.
  7. 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 the sudo manager.
  5. Click the Edit Settings button in the top right panel.
  6. Under the Debug subsection, set Enable manager sudo to False.
  7. 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 the terminal.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the 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 the terminal.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the 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 the Terminal subsection.
  7. Set Scrollback to the preferred number of lines.
  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 the Terminal subsection.
  7. Set Max 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 the 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 the 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 the 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 the Tunnel subsection.
  7. Set the Allowed ports to the appropriate values.
  8. Click Save.

Set Up the Tunnel 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 the log level.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the Tunnel subsection.
  7. Set the Log level to None, Errors, Warnings, Info, or Debug.
  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 the idle timeout.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the Tunnel subsection.
  7. Set the Idle timeout 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 the 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 the 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 set up SFTP ports.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the Tunnel subsection.
  7. In the SFTP port field, enter the SFTP port number.
  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 set up the SSH directory path.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the Tunnel subsection.
  7. In the SSH directory path field, enter the full SSH path.
  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 the 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 the 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 enable admin password change.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the 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 disable admin password change.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the Users subsection.
  7. Set Don't change admin password to True.
  8. Click Save.

Grant Managers Administrator 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 empower managers as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the 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 disable manager access as administrators.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, scroll down to the Users subsection.
  7. Set Managers as administrators to False.
  8. Click Save.

Reset VM Hardware Setup Setting(s) to Default​

Method one:​

  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 settings to default.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, view the setting changes.
  7. On the right side, click the Reset to Default button next to the setting you want to reset.
  8. Click Save.

Method two:​

  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 settings to default.
  5. Click the Edit Settings button in the top right panel.
  6. In the pop-up, click the Remove all settings button on the bottom left.
Result:

All settings are removed and the change is saved at once, without a confirmation step.

Manage User Access in VM Hardware Setup(s)​

bulk-action

  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(s) to manage access.
  5. In the top right panel, click the Manage Access button if you selected one setup, or the Replace allowlist button if you selected several.
  6. In the pop-up, enter the team(s) and user name(s) to allow:
    • One setup: the fields start with the setup's current teams and users. Add or remove entries.
    • Several setups: the fields start empty, and the list you enter replaces the current allowlist of each selected setup.
  7. Click Update, followed by the setup's name or the number of setups, such as Update 3 hardware setups.
caution

Replace allowlist does not add to each setup's existing list. Every selected setup ends up with exactly the teams and users you entered.

note

If no teams or users are specified in the allowlist, the hardware setups become public. Anyone with permission to view hardware setups can access them, regardless of team membership. See Make Existing VM Hardware Setup(s) Public.

Make Existing VM Hardware Setup(s) Public​

bulk-action

  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(s) to make public.
  5. In the top right panel, click the Manage Access button if you selected one setup, or the Replace allowlist button if you selected several.
  6. In the pop-up, leave both the team and user fields empty. With one setup, remove the teams and users already listed.
  7. Click Make, followed by the setup's name or the number of setups, and public, such as Make 3 hardware setups public.
  8. If you selected several setups, confirm in the Make 3 hardware setups public? pop-up by clicking Make public.
note

Anyone in the system can access public VM hardware setups, regardless of team, so long as they have permission to view hardware setups in general.

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 Existing VM Hardware Setup(s)​

bulk-action

  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(s) to change the image.
  5. Click the Open full menu button in the top right panel.
  6. Select Change image.
  7. In the Change image for <name | N hardware setups> pop-up, enter the new image name.
  8. Click Update <name | N hardware setups>.
caution

All selected setups must be in the same realm, and the new image must belong to that realm. If the setups come from different realms, the message "You cannot make setups from different realms use the same image" appears.

Replace Instructions in VM Hardware Setup(s)​

bulk-action

  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(s) to replace instructions.
  5. Click the Open full menu button in the top right panel.
  6. Select Replace instructions.
  7. In the Replace setup instructions for <name | N hardware setups> pop-up, select a setup in Copy from and click the Copy instructions button, or enter the instructions manually.
  8. Once done, click Update <name | N hardware setups>.

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 VM Hardware Setup(s)​

bulk-action

  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(s) 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 Copy/download N user email(s) pop-up, which lists the creators of the selected setups, keep Prefer contact email? ticked to list contact emails, falling back to the login email when no contact email is set, or untick it to list the login emails.
  8. Click Copy to copy the email addresses or click Download to download them.
  9. Once done, click Close.

Delete a VM Hardware Setup from Management​

Location: Management > Virtual Machines > VM Hardware Setups

  1. Select the VM hardware setup to delete.
  2. Click the Open full menu button in the top center panel.
  3. Select Delete.
  4. In the first pop-up, review the Affected items: the VM configurations that use the setup and the running VMs started from them.
  5. Tick Delete <name>. and click Delete.
  6. In the Delete <name>? prompt, which reads "Deleting a hardware setup is permanent and cannot be undone.", click Delete Hardware Setup.
Result:

A task deletes the hardware setup, and it disappears from the table.