Skip to main content

Virtual Machines Table

Prerequisites

Access Level:User, Sub-admin, Admin
Permission Requirements
  • . Basic VM Interaction
    • View drives (inconsistent, see notes)
    • Create drives
    • Edit drives (name and whether to disable backup)
    • View drive keys (necessary to share/attach)
    • Share drives
    • Attach drives to VMs
    • Detach drives from VMs
    • View hardware/image setups made available to them
    • View own VM configs and configs shared with them
    • Create (and edit) VM configs
    • Spawn VMs from VM configs
    • Stop VMs spawned from VM configs
    • View own VM username
    • View anyone's VM username (necessary for sharing VMs)
    • Create sub-session for VM->Vault direct transfer
    • View own VMs and VMs shared with them
    • Spawn VMs(without a config)
    • Connect to own VMs and VMs shared with them
    • Share VMs with other users
    • Shutdown own VMs
  • . VM Administration
    • View all VM configs in the system
    • Arbitrarily edit any VM config
    • Arbitrarily delete any VM config
    • Modify any user's VM username
    • Arbitrarily view logs from any VM
  • . Miscellaneous
    • Transfer ownership of own files and drives
Legend
  • . VMs= Virtual Machines Table Overview
  • . Shared with you = Virtual Machine is owned by a different user but shared with you.
  • . FIPS enabled= Virtual Machines has been enabled FIPS by VMC for debug purposes.
  • . Owner = You own the Virtual Machine.
  • . Co-owner = You co-own the Virtual Machine with one or more users.
  • Project = the Virtual Machine is tagged by a project.
  • . Debug mode = the Virtual Machine is in debug mode, inappropriate for production.
  • . Connected = the Virtual Machine is connected.
  • . Running = the Virtual Machine is connected and running normally.
  • . Stopped = the Virtual Machine is connected but stopped.
  • . Not Running = the Virtual Machine has an error and cannot run.
  • . Unknown = the Virtual Machine is in a process of an action.

View Your Virtual Machines​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. View your listed virtual machines in the right table.

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

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, select the connected virtual machine to access.
  4. Click the Start Remote Desktop button.
  5. In the prompt, click the Copy button next to your username and password.
  6. Paste the credentials into your RDP client.
  7. Click Close.
tip

Click the Copy Password button when you only need the password to perform an RDP connection.

Reset Connection of a Remote Desktop (RDP)​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, select the virtual machine to reset RDP connection.
  4. Click the Start Remote Desktop button.
  5. In the prompt, click the Reset Connection button.
  6. Once done, click Close.
danger

Resseting an RDP connection disrupts running applications and ongoing SFTP transfers.

Turn On a Virtual Machine​

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

Connect to a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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.
  • You may be required to enter your password upon connection.

View Virtual Machines’ Details​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view the details.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Overview section in the left panel.
  6. Then, view the running CPU, Memory Used, Kilobytes Received, Kilobytes Send, Home/Attached Drives Usage and Drive Warnings.
  7. Scroll down to view the VM started date, runtime, IP/MAC address, VM controller version, and the last 50 logs entry.

Create a New Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. Click Create configuration in the top left panel.
  4. In the pop-up, enter the VM name, team, project, optional VM owners and description.
  5. Next, enter the VM hardware setup to allocate resources.
  6. Then, select an existing drive or click the Create new drive button to create a new drive to store 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
  • Information about RAM disk size and mounting slot location is displayed under Extra Drives section upon VM creation.
  • 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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add users to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, click the Add users button in the top-right panel.
  7. In the pop-up, enter the user names to add, profile, and their role in the VM.
  8. For custom users, tick or untick permissions in the VM.
  9. Click Add users.

Add Teams to a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add teams to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, click the Add users button in the top-right panel.
  7. In the pop-up, enter the team names to add, profile, and their role in the VM.
  8. For custom teams, tick or untick permissions in the VM.
  9. Click Add users.
note

This will add all team members of the selected team(s) to the Virtual Machine.

Add Groups to a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add groups to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, click the Add users button in the top-right panel.
  7. In the pop-up, enter the group names to add, profile, and their role in the VM.
  8. For custom groups, tick or untick permissions in the VM.
  9. Click Add users.
note

This will add all group members of the selected group(s) to the Virtual Machine.

tip

You can add a combination of users, teams and groups to the VM simultaneously.

Add Users, Teams and Projects as Managers to a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add managers to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, click the Add users button in the top-right panel.
  7. In the pop-up, enter the user, team and project names to add and their profiles.
  8. Set their role to Manager.
  9. For custom users, teams and projects tick or untick permissions in the VM.
  10. Click Add users.
note

Adding a team or project as manager will add all users within the team or project as managers in the VM.

Add Users, Teams and Projects as Co-Owners to a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add co-owners to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, click the Add users button in the top-right panel.
  7. In the pop-up, enter the user, team and project names to add and their profiles.
  8. Set their role to Co-owner.
  9. For custom users, teams and projects tick or untick permissions in the VM.
  10. Click Add users.
note

You cannot add managers or co-owners to a VM you do not own but was shared with you. You must own or co-own the VM to add other managers or co-owners.

Remove Users from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to remove users from.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, select the user to remove.
  7. Click the Open Full Menu button in the top right panel.
  8. Then, select Remove user access.
  9. In the pop-up, click Delete user to proceed.
info

Removed VM users lose access to the VM but their home directory and group membership remain unchanged.

note

You cannot remove yourself from a VM if you are the sole owner.

Edit Roles in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit management roles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, select the user(s) to manage.
  7. Click the Open Full Menu button in the top right panel.
  8. Then, select Edit user access.
  9. In the prompt, select the user(s) role between User or Manager.
  10. Click Save.

Edit Permissions in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to manage user permissions.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, select the user(s) to manage.
  7. Click the Open Full Menu button in the top right panel.
  8. Then, select Edit user access.
  9. In the pop-up, tick or untick VM user(s) permissions.
  10. Click Save.

Access User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to access user profiles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Profiles section in the left panel.

Add User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add user profiles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Profiles section in the left panel.
  6. Click the Add new profile button in the top right panel.
  7. In the pop-up, enter the profile name.
  8. Select the role and permissions.
  9. 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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine to import user profiles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Profiles section in the left panel.
  6. Click the Add new profile button in the top right panel.
  7. In the pop-up, tick Import profile from the same or other VM.
  8. Next, select the existing profile and enter a new profile name.
  9. Alter permissions for the new profile.
  10. Click Create Profile.

Apply Virtual Machine User Profile to User(s)​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit management roles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Users section in the left panel.
  6. Next, select the user(s) to manage.
  7. Click the Open Full Menu button in the top right panel.
  8. Then, select Edit user access.
  9. In the prompt, select the user(s) VM profile at the top.
  10. Click Save.

Edit User Profiles in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit user profiles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Profiles section in the left panel.
  6. Click the Edit permissions button in the top right panel.
  7. Next, tick or untick permissions of the VM user profiles.
  8. Finally, click Save in the top right corner.
note
  • You can edit multiple VM profiles in bulk at the same time.
  • To edit a single profile, use the Edit button next to the user profile.

Delete User Profiles in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit user profiles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Profiles section in the left panel.
  6. Click the Remove button next to the user profile you want to delete.
  7. In the pop-up, click Remove to proceed.

Add Co-Owners to a Virtual Machine​

bulk-action

  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 add co-owners to.
  4. Select Add co-owners.
  5. In the pop-up, enter the user names to add as co-owners to the virtual machine.
  6. Select whether or not to sync user access.
  7. Click Update.
tip

Use sync user access for transparency between co-owner roles.

note
  • You may need to enter your password to perform this operation.
  • You can only share VMs you own or co-own.
caution

Adding co-owner(s) also grants them access to the VM's associated drives. Co-owners can restart and mount these drives in other VMs.

Bulk Email Users from a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 VM's users emails or click Download to download them.
  6. Once done, click Close.

Edit a Virtual Machine​

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

Disconnect and power off 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 VMs section on the top left panel.
  3. In the left panel, click the Open Full Menu button by the stopped virtual machine to delete.
  4. Select Delete.
  5. In the pop-up, click Delete.
info

Disconnect and power off 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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit user profiles.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, select the Logs section in the left panel.
  6. View the last 50 logs entry.
  7. Click Load Older to view older logs or Download to download all logs.
  8. Once done, click Close.

Export Virtual Machine Data in JSON Format​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 serch by 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 VMs 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.
caution

This feature may only be accessed by super-admins.

Open a VNC Terminal in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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.
caution

The VNC terminal is accessible only in debug mode VMs and should be used by system admins for debugging purposes.

Restart Virtual Machine Controller​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 VMs 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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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.
note

This is a unique use case. Admins almoust never use this setup.

Set a Project in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 VMs 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 admin or 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 VMs 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 Open Overlay in the top right corner.
  5. In the pop-up, manage the Members, Member Certifications, Subprojects and Security Requirements of the project in the virtual machine.

Remove a Project from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 No project (unlocked) to remove the project tag from VM.
  6. Click Declassify.
note

If you are a super-admin and do not belong to the project, you can use the Force change with admin privilege option to forcibly remove a project tag.

Disconnect from a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files from.
  4. Click the File Transfer option in the center.
  5. In the new window, 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 from the Vault into a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files to.
  4. Click the File Transfer option in the center.
  5. In the new window, 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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose files you want to explore.
  4. Click the File Explorer option in the center.
  5. Explore the drives and access directories of the virtual machine.

Open a Virtual Machines’ Terminal Hub​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to open its terminal.
  4. Click the Open Terminal option in the center.
  5. Use the terminal console.

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

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to transfer files to.
  4. Click the SFTP to VM option in the center.
  5. In the pop-up, click Copy to copy the username, password, host and port to your SFTP client.
info

For LFTP or SSHFS transfers, visit the Remote File System section.

View Live Quota Consumption of a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view the live quota consumption.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, view the following:
    • . CPU.
    • . memory used.
    • . kilobytes received.
    • . kilobytes send.
    • . home drive usage .
    • . drive warnings.

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.

note

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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine to repair drive.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, under drive warnings, click the Repair button next to the drive warning.
note

There are various reasons why a drive may not work properly. Consult your admin for further guidance.

Create a Group in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to create a VM group.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Groups section in the left panel.
  6. Click the Create group button in the top right panel.
  7. In the pop-up, enter the group name.
  8. Click Create group.

Sync Multiple Groups in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to sync its VM groups.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Groups section in the left panel.
  6. Click the Sync all groups button in the top right panel.
note

Syncing multiple groups from various admins helps you set up the VM infrastructure at scale.

Add Members to a Virtual Machine Group​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose group you want to add members to.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Groups section in the left panel.
  6. Select the existing group to add new members.
  7. Click the Open Full Menu button in the top right panel.
  8. Select Edit membership.
  9. In the prompt, enter the user names to add to the group.
  10. Click Update membership.
info

You can only add the members who belong to the existing virtual machine.

tip

If you accidentally add a user to the virtual machine group, click Undo to reverse the action.

Remove Members from a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose group you want to remove members from.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Groups section in the left panel.
  6. Select the existing group to remove its members.
  7. Click the Open Full Menu button in the top right panel.
  8. Select Edit membership.
  9. In the prompt, click Delete next to the user names you want to remove.
  10. Click Update membership.
caution

Removing a user from a virtual machine group does not revoke their access to the virtual machine.

Open Access Control List Templates in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose access control list templates you want to view.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. View the access control list templates.

Create an Access Control List Template in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to create access control list templates.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Click Add ACL template button in the top right panel.
  7. In the pop-up, enter the ACL name and optional description.
  8. Select the appropriate permissions.
  9. Click Save.

Import an Access Control List Template from an Existing Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to import access control list templates.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Click Add ACL template button in the top right panel.
  7. In the pop-up, tick Import templates from same or other VM.
  8. Next, select an existing ACL template from the list.
  9. Update the ACL name, description and permissions.
  10. Click Save.
note

Importing an ACL template helps you create similar templates quickly.

Edit an Access Control List Template in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose access control list templates you want to edit.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Select the access control list template to edit.
  7. Click the Open Full Menu button in the top right panel.
  8. Select Edit.
  9. In the pop-up, edit the access control list template name and optional descripion.
  10. Click Save.

View Details of Access Control List Templates in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose access control list templates you want to view.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Select the access control list template to view.
  7. Click the View button in the top right panel.
  8. In the new window, view the name, description and built-in status of the access control list template.

Refresh Details of Access Control Lists Templates in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose access control list templates you want to refresh.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Select the access control list template to refresh.
  7. Click the View button in the top right panel.
  8. In the new window, click the Refresh button in the top right panel.

Replace Access Control List Templates in Virtual Machines​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose access control list templates you want to replace.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Select the access control list template you want to replace.
  7. Click the Open Full Menu button in the top right panel.
  8. Select Replace ACL Template.
  9. In the prompt, select between Read-write, Read-only or Full control options.
  10. Click Replace.
note
  • Yout ACL template must have at least one access directory to be able to replace another ACL template.
  • Replacing ACL templates allows you to change permissions consistently accross all access directories using a similar ACL template. This helps you make changes at scale.

Delete Access Control Lists Templates in a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine whose access control list templates you want to delete.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access Control List (ACL) templates section in the left panel.
  6. Select the access control list template to delete.
  7. Click the Open Full Menu button in the top right panel.
  8. Select Delete ACL template.
  9. In the prompt, type "Delete" followed by the name of the access control list.
  10. Click Delete.

View an Access Directory for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 button.
  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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 button.
  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​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs 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 button.
  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.
note

The Repair Permissions option only displays when there is an issue with permissions in the access directory.

Create an Access Directory for a Virtual Machine Group​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to create an access directory in.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. Click Create access directory in the top right panel.
  7. In the prompt, select the access directory location.
  8. Next, enter the directory name, owner, users and groups permissions for the access directory.
  9. Click Create.
info

To create a new group for the access directory from scratch, click Create new group button in the prompt.

Sync All Permissions for Access Directories in a Virtual Machine​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to sync its access directory permissions.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. 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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit its access directory.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. Click the Open Full Menu button in the top right panel.
  7. Select Edit access directory.
  8. In the prompt, update the directory name, owner, users and groups permissions for the access directory.
  9. Click Update.
note

You cannot edit your Home access directory.

Refresh an Access Directory Data for a Virtual Machine Group​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to refresh its access directory.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. Select the access directory whose data you want to refresh.
  7. Click the View button in the top right panel.
  8. In the new window, click the Refresh button in the top right corner.

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

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to repair its access directory.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. Select the access directory whose data you want to repair.
  7. Click the View button in the top right panel.
  8. In the new window, click the Repair Permissions button in the top right corner.

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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine to delete its access directory.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. Select the access directory you want to delete.
  7. Click the Open Full Menu button in the top right panel.
  8. Select Remove access directory.

Method two​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to delete its access directory.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Access directories section in the left panel.
  6. Select the access directory you want to delete.
  7. Click the View button in the top right panel.
  8. In the new window, click Delete in the top right panel.
  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 VMs section on the top left panel.
  3. In the left panel, click the virtual machine to access its controller logs.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Logs section in the left panel.
  6. View the logs.
  7. Optionally, click the Load Older button to view older VM logs.

Download All Virtual Machine Controller Logs​

bulk-action

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to download its controller logs.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Logs section in the left panel.
  6. View the logs.
  7. Click the Download button in the bottom right corner.
caution

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

Access the Virtual Machine Applications​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to access its applications.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. View the existing video annotation templates.

Create a Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to create its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Click Add template in the top right panel.
  7. In the prompt, enter the template name.
  8. Select the annotation type and directory.
  9. Optionally, select the export directory and the custom video playback buffer size.
  10. Click Create Templates.
caution

You can only have one video annotation template per directory.

tip
  • Use smaller buffer size to optimize template for minimal buffering delay. Ideal for fast and stable internet connections.
  • Use larger buffer size to increase template data pre-loading to enhance playback stability. Ideal for slower or less reliable internet connections.

View an Existing Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to view its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to view.
  7. Click the View button in the top right panel.
  8. In the new window, view the categories and tags of the video annotation template.

Add a Category to Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to add category to its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to add category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click Add category in the top-left panel.
  10. In the prompt, enter the category name.
  11. Click Create category.
  12. Click the Save button on the top right.

Add a Category Tag in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to which you want to add a category tag in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to add tag to its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click Add tag to category next to the category you want to add a tag to.
  10. Enter the tag name below category name.
  11. Tick the VM groups who will be tagged in the category.
  12. Once done, click the Save button on the top right.
note

The default tag is set to Everybody, which includes all users from the virtual machine.

Edit a Category Tag in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to edit a category tag in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to edit tag to its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, update the tag name below category name or the VM users the tag applies to.
  10. Once done, click the Save button on the top right.

Edit a Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to edit its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to edit.
  7. Click the Open full menu button in the top right panel.
  8. Select Edit.
  9. In the prompt, update the annotation name, type, directory, export directory or video playback buffer size.
  10. Once done, click Save Changes.

Export a Video Annotation Template in JSON Format​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to export its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to export.
  7. Click the Open full menu button in the top right panel.
  8. Select Export annotation.
  9. In the prompt, select the export directory.
  10. Click Export.

Delete a Category Tag in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to delete a category tag in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to delete tag from its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click the Delete button next to the tag you want to remove.
  10. In the prompt, click Delete tag.

Delete a Category in Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine for which you want to delete a category in its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to delete its category.
  7. Click the View button in the top right panel.
  8. In the new window, click the Edit button on the right.
  9. Next, click the Remove category button next to the category you want to delete.
  10. In the prompt, click Delete category.

Delete a Video Annotation Template​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. In the left panel, click the virtual machine to delete its video annotation template.
  4. Click the VM Settings and Details option in the bottom center.
  5. In the new window, click the Video annotation types section in the left panel.
  6. Select the video annotation template to delete.
  7. Click the Open full menu button in the top right panel.
  8. Select Delete.
  9. In the prompt, click Delete.

Restart a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. Select the virtual machine you want to restart.
  4. In the left panel, click the Open Full Menu button next to the virtual machine.
  5. Select Power.
  6. In the pop-up, click Restart.

Shut Down a Virtual Machine​

  1. Go to the Virtual Machines icon in the top left taskbar.
  2. Click the VMs section on the top left panel.
  3. Select the virtual machine you want to shut down.
  4. In the left panel, click the Open Full Menu button next to the virtual machine.
  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 VMs section on the top left panel.
  3. Select the virtual machine you want to forcefully shut down.
  4. In the left panel, click the Open Full Menu button next to the virtual machine.
  5. Select Power.
  6. In the pop-up, read the risks.
  7. Tick the box I accept the risk.
  8. Click Hard shutdown.
danger

Use the Hard Shutdown command only as a last resort.