Skip to main content

Virtual Machines Table

View Your Virtual Machines​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. View all listed virtual machines you have access to.

Access a Virtual Machine Configuration via Remote Desktop Connection (RDP)​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, select the virtual machine to access.
  4. Click the Start Remote Desktop card.

Turn On a Virtual Machine Configuration​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, select the virtual machine to turn on.
  4. Click the Start VM button.

Connect to a Virtual Machine Configuration​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, select the virtual machine to connect.
  4. Click the Connect VM button.
note

Ensure the virtual machine is turned on before connecting.

View Virtual Machines’ Details​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view the details.
  4. In the new window, scroll down under the manager section to view the VM owner, project, team, date started, runtime, and IP/MAC address.

Create a New Virtual Machine Configuration​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. Click Create Configuration in the top left panel.
  4. In the pop-up, enter the VM name, optional description, team, project and VM owner if needed.
  5. Next, enter the VM Hardware Setup to allocate resources.
  6. Then, select an existing drive or create a new drive to stock the virtual machine data.
  7. Finally, tick the box Launch a VM from this configuration immediately.
  8. Click Create.
caution

Before creating a VM configuration, ensure you have the correct hardware setup from your admin and you are part of an active team.

info

To clone another virtual machine, type clone and the name of the virtual machine in the Hardware Setup field upon creation.

Add Users to a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to add users to.
  4. Scroll down and click the User Management card.
  5. Next, click Add Users button in the top panel.
  6. In the pop-up, enter the user names to add, profile, and their role in the VM.
  7. For custom users, tick or untick permissions in the VM.
  8. Click Add user(s).

Remove Users from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to add users to.
  4. Scroll down and click the User Management card.
  5. Next, select the user to remove.
  6. Click the Open Full Menu button in the top right panel.
  7. Then, select Remove user access.
  8. In the pop-up, click Delete to proceed.

Edit Management Roles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to manage users in.
  4. Scroll down and click the User Management card.
  5. Next, select the user to manage.
  6. Click the Open Full Menu button in the top right panel.
  7. Then, select Edit user access.
  8. In the prompt, select Manager in role section.
  9. Click Save.

Edit Permissions in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to manage users in.
  4. Scroll down and click the User Management card.
  5. Next, select the user to manage.
  6. Click the Open Full Menu button in the top right panel.
  7. Then, select Edit user access.
  8. In the pop-up, thick or unthick permissions in the VM.
  9. Click Save.

Access User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view users profiles.
  4. Scroll down and click the VM User Profiles card.

Add User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view users profiles.
  4. Scroll down and click the VM User Profiles card.
  5. Click the Add profile button in the top right panel.
  6. In the pop-up, enter the profile name.
  7. Select the role and permissions.
  8. Click Create Profile.

Import User Profiles from the Same or Other Virtual Machines​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view users profiles.
  4. Scroll down and click the VM User Profiles card.
  5. Click the Add profile button in the top right panel.
  6. In the pop-up, tick Import profile from the same or other VMs.
  7. Next, select the existing profile and enter a new profile name.
  8. Click Create Profile.

Edit User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view users profiles.
  4. Scroll down and click the VM User Profiles card.
  5. Click the Edit button in the top right panel.
  6. Next, select between the Users or Managers VM user profiles to edit.
  7. Then thick or unthick permissions of the VM user profiles.
  8. Finally, click Save.

Delete User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view users profiles.
  4. Scroll down and click the VM User Profiles card.
  5. Click the Edit button in the top right panel.
  6. Next, select between the Users or Managers VM user profiles to delete.
  7. Click the Remove button on the right.

Share a Virtual Machine with Other Users​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to share.
  4. Select Share.
  5. In the pop-up, enter the user names to share the virtual machine with.
  6. Select whether or not to sync user access.
  7. Click Update.
tip

Always sync user access for transparency between manager roles.

note

You may need to enter your password to perform this operation.

caution

Sharing VMs also shares their associated drives. Shared users can restart and mount drives in other VMs.

Bulk Email Users from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to bulk email.
  4. Select Bulk Email.
  5. In the pop-up, click Copy to copy the emails or click Download to download the emails.
  6. Once done, click Close.

Edit a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to edit.
  4. Select Edit.
  5. In the pop-up, edit the VM name, description, team, project, owner, hardware setup and drives.
  6. Once done, click Save.
info

Disconnect the VM configuration before editing its metadata.

Delete a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to delete.
  4. Select Delete.
  5. In the pop-up, click Delete.
info

Disconnect the VM configuration before deleting it.

View Logs in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to view logs.
  4. Select View Logs.
  5. In the pop-up, click Load Older to view older logs.
  6. Once done, click Close.

Export Virtual Machine Data in JSON Format​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to export in JSON format.
  4. Select JSON Export.
  5. In the pop-up, click Expand all fields button in the top left panel.
  6. View all JSON export object data by users, groups, drives, acess directories and profiles.
  7. Once done, click Copy to copy the JSON data or click Download to download the JSON data.
  8. Click Close.
note

Use the search bar in the JSON export pop-up to find keywords.

View the Libvirt XML Description of a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to view the Libvrit XML description.
  4. Select Libvirt XML description.
  5. In the pop-up, view the Libvirt XML description from the backend.
  6. Click Copy to copy the XML description or click Download to download the XML description.
  7. Once done, click Close.

Open a VNC Terminal in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to access the VNC terminal.
  4. Select Open VNC terminal.
  5. In the pop-up, use the VNC terminal.
  6. Once done, click Close.

Restart Virtual Machine Controller​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to restart controller.
  4. Select Restart Controller.
  5. In the pop-up, read the risks.
  6. Once done, click Restart.
caution

Restarting the controller takes a little while. We recommend to wait at least 15 seconds before using the virtual machine after a VM controller restart was performed.

Forcefully Restart a Virtual Machine Controller​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to restart controller.
  4. Select Restart Controller.
  5. In the pop-up, read the risks.
  6. Tick the box I know the risks of force restarting the controller and wish to force restart anyways.
  7. Once done, click Force Restart.
danger

Force restarting the VM controller kills all processes via an OS syscall. Do not force restart a controller while other users are active on the virtual machine, as this will corrupt their ongoing processes.

Sync Users’ Permissions in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to sync users' permissions.
  4. Select Sync User Permissions.
note

Due to the zero-trust principle, the backend might not recognize a user added in the frontend. Follow the instructions above to synchronize them.

Repair Corrupted Databases in Virtual Machines​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to repair corrupted database.
  4. Select Repair Corrupted Database.
  5. In the pop-up, enter the word Repair.
  6. Click Repair.
danger

Do not use this option unless instructed by an admin. Repairing may cause secondary issues when performed arbitrarily. All VM connections including RDP will be disconnected.

Enable Applications to Virtual Machines​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to enable applications.
  4. Select Enable Applications.

Set a Project in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to set project.
  4. Select Set Project.
  5. In the pop-up, select a project to tag the virtual machine.
  6. Click Classify.

Forcefully Set a Project in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to set project.
  4. Select Set Project.
  5. In the pop-up, select any project to tag the virtual machine.
  6. Click Force change with admin priviledge.
note

Forcefully tagging a virtual machine with a project is only available to users with super-admin roles in the system.

Manage Projects from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the project tag on the virtual machine to manage.
  4. In the new window, click Set Project.
  5. In the pop-up, select Open Overlay.
  6. Manage the members, subprojects and certifications associated with the project tag of the virtual machine.

Disconnect from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Disconnect VM button by the virtual machine to disconnect.

Transfer Files from a Virtual Machine into the Vault​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files from.
  4. Next, click the File Transfer card.
  5. Drag-and-drop the files from the right panel (the virtual machine) to the left panel (the vault).
  6. Once done, click Close.

Transfer Files into a Virtual Machine from the Vault Access Directories​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files to.
  4. Next, click the File Transfer card.
  5. Drag-and-drop the files from the left panel (the vault) to the right panel (the virtual machine).
  6. Once done, click Close.

Explore Files in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files to.
  4. Next, click the File Explorer card.
  5. Explore drives and access directories of the virtual machine.

Open the Virtual Machines’ Terminal Hub​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the virtual machine to open the terminal hub.
  4. Select Open terminal hub.

Perform an SFTP to VM Transfer from the Local Machine to the Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files to.
  4. Next, click the SFTP to VM card.
  5. In the pop-up, drag-and-drop files from the SFTP to the VM.

View Quota Consumption of a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view quota consumption.
  4. Scroll down under the manager username and view the core, memory and home drive usage.

Edit Quotas Consumption in a Virtual Machine​

You cannot edit quotas of a virtual machine. Quotas in virtual machines are part of the team using the virtual machine. To edit a virtual machine quota consumption, you must edit the quotas of the team using the virtual machine.

info

To edit drive capacity of a virtual machine you must create a new drive or a new virtual machine.

Repair an Unattached Drive in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to repair drive.
  4. Scroll down under the manager username and view the drive error.
  5. Click Repair.
note

There are various scenarios why a drive may not work properly. Consult with your admin for more guidance.

Create a Group in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to create a VM group.
  4. Next, click the Group Management card.
  5. In the new window, double-click the Create group button in the top panel.
  6. In the pop-up, enter the group name.
  7. Click Create group.

Sync Multiple Groups in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to create a VM group.
  4. Next, click the Group Management card.
  5. In the new window, click the Sync all groups button in the top panel.

Edit Group Memberships in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to edit group membership.
  4. Next, click the Group Management card.
  5. In the new window, select the existing group to edit membership.
  6. Click the Open Full Menu button in the top right panel.
  7. Select Edit membership.
  8. In the prompt, enter the user names to add to the group.
  9. Click Update membership.
note

Click Undo to remove a user membership from the group associated with the virtual machine.

View an Access Directory for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view the access directory.
  4. Next, click the Access Directories card.
  5. In the new window, select the access directory to view.
  6. Click the View button in the top right panel.
  7. In the new window, view the access directory basic information, owner and group.

Refresh an Access Directory Data for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view the access directory.
  4. Next, click the Access Directories card.
  5. In the new window, select the access directory whose data you want to refresh.
  6. Click the View button in the top right panel.
  7. In the new window, click the Refresh button in the top right panel.

Repair Permissions in an Access Directory for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view the access directory.
  4. Next, click the Access Directories card.
  5. In the new window, select the access directory whose permissions you want to repair.
  6. Click the View button in the top right panel.
  7. In the new window, click the Open Full Menu button in the top right panel.
  8. Select Repair Permissions.

Create an Access Directory for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to create an access directory in.
  4. Next, click the Access Directories card.
  5. In the new window, click Create access directory in the top right panel.
  6. In the prompt, select the access directory location.
  7. Next, enter the directory name, owner, users and groups associated with the access directory.
  8. Click Create.

Sync All Permissions for Access Directories in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to sync access directory permissions.
  4. Next, click the Access Directories card.
  5. In the new window, click Sync all permissions in the top right panel.

Edit an Access Directory for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to edit the access directory in.
  4. Next, click the Access Directories card.
  5. In the new window, click the Open Full Menu button in the top right panel.
  6. Select Edit access directory.
  7. In the prompt, update the directory name, owner, users and groups linked to the access directory.
  8. Click Update.
note

You cannot edit your Home access directory.

Delete an Access Directory for a Virtual Machine Group​

Method one​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to delete the access directory in.
  4. Next, click the Access Directories card.
  5. In the new window, click the Open Full Menu button in the top right panel.
  6. Select, Remove access directory.

Method two​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view the access directory.
  4. Next, click the Access Directories card.
  5. In the new window, select the access directory to delete.
  6. Click the View button in the top right panel.
  7. In the new window, click the Open Full Menu button in the top right panel.
  8. Select Delete.
  9. In the pop-up, click Delete access directory.
caution

When you delete an access directory, all its members lose access to it until you create another access directory. You cannot delete your Home access directory.

Access the Virtual Machine Controller Logs​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to view controller logs.
  4. Next, scroll down and click the Controller Logs card.
  5. In the new window, view the VM logs number, date and time, users who performed the action and log entry.
note

Click the Load Older button to view older VM logs.

Download All Virtual Machine Controller Logs​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. In the left panel, click the virtual machine to download controller logs.
  4. Scroll down and click the Download button in the bottom right corner of the controller logs card.
tip

Downloading VM logs should be restricted to VM managers, owners, and admins only.

Shut Down a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. Select the virtual machine you want to shut down.
  4. Click the Open Full Menu button in the top right panel.
  5. Select Power.
  6. In the pop-up, click Normal Shutdown.

Forcefully Shut Down a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the Virtual Machines Table Overview section on the top left panel.
  3. Select the virtual machine you want to forcefully shut down.
  4. Click the Open Full Menu button in the top right panel.
  5. Select Power.
  6. In the pop-up, read the risks.
  7. Tick the box I accept the risk.
  8. Click Hard shutdown.