Virtual Machine Action Bar

VM Action Bar Overview

Once a virtual machine is launched, a variety of actions can be carried out in the action bar. Some actions are advanced and may require admin permissions to access them.

Action	Notes
ShutDown	A user can completely shut down their virtual machine
Disconnect	Frontend stops talking to your virtual machine. It is still running
Open application	A user can view and use the VM on their local machine
Transfer	A user can transfer files from their vault into their VM.
Launch SFTP	A user can utilize SFTP to transfer files directly from their local computer to the virtual machine.
Open Terminal Hub	A user can open the virtual machine terminal.

Advanced Commands (Admin Permissions Only):

Action	Notes
Fix VM permissions	A user can completely shut down their virtual machine
View logs	Frontend stops talking to your virtual machine. It is still running
JSON Export	A user can transfer files from their vault into their VM.
Libvirt XML description	A user can view and use the VM on their local machine
Open VNC Terminal	A user can open the virtual machine terminal.
Share	A user can utilize SFTP to transfer files directly from their local computer to the virtual machine.
Bulk email	A user can utilize SFTP to transfer files directly from their local computer to the virtual machine.
Set Project	A user can utilize SFTP to transfer files directly from their local computer to the virtual machine.

Shut Down

To shut down a VM navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to shut down.
• Click the Three dots icon on the right of the VM.
• Click the Shut Down button.
• In the prompt, click on the bottom right.
  • In case of emergency, you can thick the box "I accept the risk." and click .

info

A tiCrypt user may want to disconnect from a virtual machine if they still have things running or downloading onto it. If they are entirely done with the virtual machine, it may be better for them to shut it down.

tip

If a virtual machine refuses to shut down, the user can force shutdown. Though, force shutdown should be used as a last resort.

danger

Forcing a shutdown may result in the VM non-persistent data being lost and may damage the filesystems on mounted drives, making them unmountable.

caution

Shutting down a virtual machine will cause all non-persistent data to be lost. Shutdown takes a little while but usually no longer than a minute.

Disconnect

To disconnect a VM navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to disconnect.
• Click the Disconnect VM button from the right of the VM name.

info

The feature allows the VM to run its workload in the background even when the connection to the Frontend is broken.

note

A fundamental difference exists between shutting down a virtual machine and disconnecting a virtual machine.

Example: When a person unplugs their computer from the power source, they shut it down. When someone steps away from their computer, they are disconnecting from it.

Open Remote Application

To open the virtual machine application navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to open.
• Click the Open remote application button in the center right.
• In the prompt, follow the Access steps and copy-paste the Credentials from the top to login into your VM.
• Download the RDP file to your local machine.
• Open the RDP file and enter your username and password from the prompt.
• Click . Side note: The home screen for the VM will appear. This may take a minute.

note

Mac users must download Microsoft Desktop to open the RDP file.

info

To exit from the VM remote application, click Menu button in the top left then click Disconnect.

Transfer

A user can transfer files from their vault into the VM. Transferring makes a copy, meaning that the original will remain in the vault.

To transfer files between VM and Vault navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to transfer to/from.
• Click the Transfer files to/from Vault button in the center-right.
• In the window, drag-and-drop files and directories from the VM(right side) to the Vault (left side) and vice-versa.
• Once you finished, click the Exit button in the top left. Side note: To change the display layout during transfers click Change layout button in the top right.

note

The VM where you move the files to/from must be Connected.

caution

If the file is tagged by a project that is not less than or equal to that of the VM, then the file will not be able to be transferred from the vault into the VM.

info

If a file is tagged by a lesser project than that of the virtual machine, it can be moved into the virtual machine. As a result, the file's project will now tag the virtual machine.

For more information, please reference the tree diagram in the project section.

View Drive Letters

note

Users can view drive slots letters in the file tree when transferring files between the vault and the VM.

Create a Symbolic Link

note

Symbolic links allow a file or a directory to be accessible from another location.

To create a Symbolic Link navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to create the symbolic link for.
• Click the Transfer files to/from Vault button in the center-right.
• In the window, select the drop-downs under Drives or Access Directories on top right center.
• Select the directory where you want to create the symbolic link.
• Click Create symlink button in the top right corner.
• Type the symbolic link name.
• Select a directory for your symbolic link.
• Click .

info

You may as well right-click the file/directory and select Create symlink option.

Change File / Directory Permissions

To change file/directory permissions navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to change file/directory permissions for.
• Click the Transfer files to/from Vault button in the center right.
• In the window, select the drop-downs under Drives or Access Directories on top right center.
• Select the file/directory where you want to change permissions.
• Click Change permissions button in the top right corner.
• In the prompt, type the owner's name to whom permissions will be applied.
• Type the group where the permission applies.
  • Everybody to everyone who is a member of the VM.
  • Managers to the managers of the VM only.
  • Nobody to the owner of the VM only.
• Select the appropriate permissions from the list.
• Select whether or not the children files and subdirectories will inherit the same permissions.
• Click .

info

You may as well right-click the file/directory and select Change permissions option.

tip

• You can select Custom permissions and add your Unix-based permissions.
• You can check the permissions status by entering the terminal, entering the directory, and running ls -l.

Open Terminal Hub

You may want to use the command line in multiple VMs simultaneously. The Terminal Hub allows you to manage terminals like you would in Visual Studio Code.

It is designed to enhance productivity and streamline workflows for both VM users and VM owners.

You can perform the following actions here:

Button	Action
	Add new terminal in the selected VM
	Maximize terminal
	Minimize terminal
	Collapse terminal list
	Reset terminal layout
	Close terminal

To access the VM Terminal Hub, navigate to tab in the Virtual Machines section.

• Click the button of the VM you want to access the terminal.
• In the prompt, type your password.
• Click the Open terminal button in the top center of the connected VM.

info

• The terminal hub displays only the active and connected VMs.
• You can operate multiple terminals from various connected VMs if you are a user of the respective VMs.
• All work progress & custom layouts in active terminals is automatically saved and restored each time you open the window, so you can pick up right where you left off.
• The terminal has nothing in common with your local machine.

Add VM Terminals

To add new the virtual machines terminals navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to add the terminals to.
• Click the Open terminal button in the center-right.
• In the prompt, click the Add a new terminal button under the appropriate VMs.

note

Click on any terminal listed in the left panel to add it as a tab to your active window. This allows you to quickly switch between different terminal sessions without opening multiple windows.

info

Active Window terminals may come from distinct VMs with various setups, hence you can work on a Linux terminal and a Windows terminal from different connected VMs at the same time.

Arrange VM Terminals

To arrange the virtual machines terminals navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to arrange the terminals in.
• Click the Open terminal button in the center-right.
• In the prompt, drag-and-drop the terminal tabs from the left panel to the active window to arrange them.

tip

Drag and drop or rearrange terminals to organize your work environment effectively.

note

Click on any terminal listed in the left panel to add it as a tab to your active window. This allows you to quickly switch between different terminal sessions without opening multiple windows.

info

Active Window terminals may come from distinct VMs with various setups, hence you can work on a Linux terminal and a Windows terminal from different connected VMs at the same time.

Split VM Terminals

To split the virtual machines terminals navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to split the terminals in.
• Click the Open terminal button in the center-right.
• In the prompt, drag-and-drop the terminal tabs on the side you want to split them.

note

There is no limit to how many terminals you can split.

Maximize VM Terminals

To maximize the virtual machines terminals navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to maximize the terminals in.
• Click the Open terminal button in the center-right.
• Select the terminal you want to maximize.
• In the prompt, click the Mazimize button in the top right.

note

Clicking the Maximize button twice will minimize the terminal resuming to the previous setup.

Minimize VM Terminals

To minimize the virtual machines terminals navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to minimize the terminals of.
• Click the Open terminal button in the center-right.
• In the prompt, click the Minimize terminal button by the appropriate terminal.

Remember

A minimized terminal is still an active terminal requiring VM resources.

tip

Only minimize the terminals that you actively work with. Close unnecessary terminals so you can manage your resources effectively.

Collapse Terminals Sidebar

To collapse the virtual machines terminals sidebar navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to hide the terminals sidebar of.
• Click the Open terminal button in the center-right.
• In the prompt, click Collapse panel button in the top left.

note

You can expand the terminals' sidebar by clicking the Expand panel button in the top left.

Collapse Terminal List

To collapse the virtual machines terminals list navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to hide the terminal list of.
• Click the Open terminal button in the center-right.
• In the prompt, click Collapse terminal list button in the top left.

info

• Collapsing terminal list allows you to save space on your screen when a large number of VMs are in service.
• Click the terminal number of each VM to actively use the selected terminal.

Reset VM Terminal Layout

To reset the virtual machines terminals layout navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to reset the terminal layout of.
• Click the Open terminal button in the center-right.
• In the prompt, click Three dots button in the top left.
• Select Reset Layout.

Close VM Terminals

To close the virtual machines terminals navigate to tab, in the Virtual Machines section.

• Select the connected VMs you want to close the terminals of.
• Click the Open terminal button in the center-right.
• In the prompt, click Close terminal button by the appropriate terminal.
• Click .

danger

Closing a terminal will terminate its session resulting in all your work progress being lost.

info

You cannot close all terminals for a connected VM. The minimum number of open terminals must be at least one.

tip

You can globally close terminals by clicking the Close terminals button in the top right of the Terminal hub. This will close all displayed terminals leaving you with the active welcome tab. This function is available only for unsplit active tabs.

Launch SFTP

SFTP transfers allow you to transfer files directly from your local machine into the VM.

To launch an SFTP transfer navigate to tab, in the Virtual Machines section.

• Select the connected VM where you want to launch the SFTP transfer.
• Click the Launch SFTP button in the center-right.
• In the prompt, copy-paste the User name, Password, Host, Port and Command details to your SFTP provider.
• Once you finished the transfer, click .

note

Mac users must download an SFTP client to utilize this feature.

tip

Use the SFTP transfer when the files are too large and unused in the vault.

launch-sftp

info

To see more about SFTP, check out How to create an SFTP endpoint section.

---

*The following actions are advanced and may require admin permissions.

Fix VM Permissions

To fix a VM configuration permissions navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to fix permissions of.
• Click the Three dots button in the top right.
• In the prompt, click the Fix VM permissions option.

note

Fix VM permissions option will refresh new permissions that were added or removed by the admin.

Restart Controller

To restart the VM controller navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to restart the controller off.
• Click the Three dots button in the top right.
• In the prompt, click the Restart Controller option.
• Next, tick the box "I know the risks of force restarting the controller, and wish to force restart anyways".
• Click .

danger

Restarting a VM's controller stops the controller process currently running on the VM. All RDP connections are getting closed upon restart. This option should be used as a last resort.

View Logs

To view VM configuration logs navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to view the logs of.
• Click the Three dots button in the top right.
• In the prompt, click the View logs option.
• Optionally, click the Refresh button to refresh the log data.
• Click .

JSON Export

To export a VM configuration in JSON navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to export in JSON.
• Click the Three dots button in the top right.
• Click the JSON Export option.
• In the prompt, select the appropriate export path.
• Click Download.
• Alternativelly, click Copy to copy-paste the VM contents in JSON format.
• Click .

Libvirt XML Description

To view the Libvirt XML description navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to view the Libvirt XML description of.
• Click the Three dots button in the top right.
• In the prompt, click the Libvirt XML Description option.
• View the Libvirt XML description.
• Click .

note

Libvirt XML description is usually checked by super-admins to assist them with making changes in the VM's backends.

Open VNC Terminal

To open a VNC terminal navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to open the VNC terminal for.
• Click the Three dots button in the top right.
• In the prompt, click the Open VNC Terminal option.
• Once you finished your work, close the prompt.

caution

You must have VNC Enabled in your VM to open a VNC terminal.

tip

You can view if a VM has the VNC enabled by reading the description near its name .

Share

To share a VM configuration navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to share.
• Click the Three dots button in the top right.
• Click the Share option.
• In the prompt, type the name(s) of the user you would like to share the VM with.
• Select whether or not to update their 'sync user access'.
• Select whether or not to automatically share drives with the shared users.
• Click .

Bulk Email

To bulk email users in a VM configuration navigate to tab, in the Virtual Machines section.

• Select the connected VM where you want to bulk email users.
• Click the Three dots button in the top right.
• Click the Bulk Email option.
• Click Copy to copy-paste the emails into your inbox.
• Optionally, click Download.
• Click .

Set Project (Classify VM)

To set project in a VM configuration navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to set the project for.
• Click the Three dots button in the top right.
• Click the Set Project option.
• In the prompt, select the project (or subproject) you want to tag the VM with.
• Click .

info

When you tick the box "Use my permission to override..." in the prompt, you are forcing your admin privileges to classify/declassify a virtual machine configuration (and its drive). This is recorded in the audit logs and may be performed by super-admin roles only.

caution

• Project-tagged resources must match the project tag of the virtual machine.
• Unlocked resources become project-tagged when they reach a project-tagged virtual machine.

tip

• Create a directory in the vault with the same tag to transfer the files from the tagged VM into the vault.
• After moving the file into the vault, you can either share it with new users or declassify it.

Unset Project (Declassify VM)

To unset project in a VM configuration navigate to tab, in the Virtual Machines section.

• Select the connected VM you want to unset the project for.
• Click the Three dots button in the top right.
• Click the Set Project option.
• In the prompt, select the No project(unlocked) option.
• Click .

note

If you are an admin but still not part of the project you want to untag the VM from, you may use "Use my permission to override..." option.