Advanced Operations

Latest Frontend Version: 2.17.3

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, Kilobytes Received, Kilobytes Send, Home/Attached Drives 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.

Confirmations, Errors & Solutions

Failed to View Virtual Machine's Details

Failed to list CPU, Memory, Kilobytes Received, Kilobytes Send, Home/Attached Drives, Drive Warnings, VM started time, runtime, IP/MAC address, VM controller version and the last 50 logs. The logs are also infinitely loading.}.

Ask VM Statistics Permissions from VM Owner

Ask the VM owner to allow you to access the VM settings and details section.

To Virtual Machine Owner
To grant VM statistics permissions to a VM user:  

1. In the VMs section, click the virtual machine where you want to update a user's VM statistics permissions.
2. Click the VM Settings and Details option in the bottom center.
3. In the new window, select the Users section in the left panel.
4. Next, select the appropriate user, then click the Open full menu button in the top-right panel.
5. Select Edit user access.
6. In the pop-up, set the profile to Custom.
7. Scroll down under Permissions, and tick System Statistics View real-time system utilization.
8. Click Save.

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 view its logs.
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 log entries.
7. Click Load Older to view older logs or Download to download all logs.
8. Once done, click Close.

Confirmations, Errors & Solutions

Downloaded Logs Successfully

Downloading VM Logs.. total-downloading-time.

Failed to View the Logs Section, Previews and Button

Your do not have viewing statistics permissions from the VM owner.

Ask the VM Owner to Grant You Permissions

Ask the VM owner to allow you to view statistics of their virtual machine.

To VM Owner
To allow a VM user to view VM statistics:  

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 update 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 whose VM permissions you want to update.
7. Click the Open Full Menu button in the top right corner.
8. Select Edit User Access.
9. Scroll down under Permissions and tick the System Statistics permission.
10. Once done, click Save.

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, access 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 search by keywords.

Confirmations, Errors & Solutions

JSON Data Copied

JSON copied to the clipboard.

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 Libvirt 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

Only super-admins can access this feature.

Confirmations, Errors & Solutions

XML Data Copied

XML copied to the clipboard.

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.

Confirmations, Errors & Solutions

Connected to VNC Terminal

Connected to vm-name.

Unable to Connect to VNC Terminal

Something went wrong, connection is closed.

Ask the VM Owner to Perform This Action

As a VM co-owner, manager, or user, you cannot perform this action. Only VM owners can open VNC terminals of their own VMs.

Open VNC Terminal Button Inactive

The Open VNC terminal is inactive in the Open Full Menu of the virtual machine.

Ask the VM Owner to Perform This Action

Only VM owners can open VNC terminals for their own VMs. VM owners must log in to the VNC terminal to perform debugging.

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 the controller.
4. Select Restart Controller.
5. In the pop-up, read the risks.
6. Once done, click Restart.

caution

Restarting the controller takes time. We recommend waiting at least 15 seconds before using the virtual machine after a VM controller restart.

Confirmations, Errors & Solutions

Restarted VM Controller

VM restarting (wait at least 15s to reconnect).

Unauthorized to Restart VM Controller

You are not authorized to restart this VM.

Ask the VM Owner for Restart VM Controller Access

Ask the VM owner to allow you to restart the VM controller in their virtual machine.

To VM Owner
To allow a VM user to restart the VM 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 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, select the user whose VM permissions you want to change.
7. Click the Open Full Menu button in the top right corner.
8. Select Edit User Access.
9. Set the user role to Manager.
10. Scroll down under Permissions and tick the Restart VM controller permission.
11. Once done, click Save.

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 the 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.

warning

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.

Confirmations, Errors & Solutions

Restarted VM Controller

VM restarting (wait at least 15s to reconnect).

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.

Confirmations, Errors & Solutions

Synced User Permissions

Sync user permissions total-syncing-time.

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 the corrupted database.
4. Select Repair Corrupted Database.
5. In the pop-up, enter the word Repair.
6. Click Repair.

warning

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.

Confirmations, Errors & Solutions

Repaired Corrupted Database

Repairing home drive for vm-nametotal-repairing-time.

Attach/mount drive-name to vm-name total-attaching-time.

Failed to Repair Corrupted Home Drive

First attempt to attach/mount home drive failed (will retry once): Libvirt Error: Storage volume not found: not storage vol with matching name 'drive-string-id.drive-format'.

Failed to load LUKS header from device: invalid argument.

Ask the System Admin to Review Home Drive

Ask the system admin to review the home drive connection to the Libvirt Volume and the local LUKS header loading. If the home drive is unrecoverable, migrate the data to a backup drive and create a new home drive from scratch.

Enable Applications 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 enable applications.
4. Select Enable applications.

note

This is a rare use case. Admins almost never use this setup.

Confirmations, Errors & Solutions

Enabled Applications Successfully

(No action confirmation. Verify action in the VM Settings and Details under Applications, Video annotation types section.)

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.

Confirmations, Errors & Solutions

Created Access Directory Successfully

Downloading VM Logs.. (total-downloading-time).

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.

Confirmations, Errors & Solutions

Unable to View Video Annotation Template Section

Cannot view the Video annotation types section, in VM Settings and Details.

Ask Admin to Create a New Windows Virtual Machine

Your VM may be a Linux VM. Only Windows VMs use video annotation types. Ask your admin to give you access to an existing Windows VM or create a new Windows VM from scratch.

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 a smaller buffer size to minimize buffering delay. Ideal for fast and stable internet connections.
• Use a larger buffer size to increase template data pre-loading and enhance playback stability. Ideal for slower or less reliable internet connections.

Confirmations, Errors & Solutions

Failed to Enter Video Annotation Name

You must enter a name.

Enter Video Annotation Name

In the Add annotation templete to vm-name prompt, enter the annotation name in the name field.

Create Templates Button Inactive

You must select a home-access directory where the template will be created.

Select Home Access Directory from List

Under Choose a Directory select an existing drive or home access directory for the video annotation template.

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 a 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 a category to.
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 a 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 the category name.
11. Tick the VM groups that 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 a tag in 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 the 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.

Confirmations, Errors & Solutions

Deleted Video Annotation Template

Exporting template-name to JSON (total-exporting-time).

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 a 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.

Confirmations, Errors & Solutions

Deleted Video Annotation Template

Deleted category-name.

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.

Confirmations, Errors & Solutions

Deleted Video Annotation Template

Delete total-number-of-annotation-templates templates(s) (total-deletion-time).

View Drive Capacity of a Virtual Machine

bulk-action

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 view its drive capacity.
4. In the bottom right, under the Drives section, view the drive name, total, used, and percentage capacities.

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 view its drive capacity.
4. Click the VM Settings and Details option in the bottom center.
5. In the new window, click the Overview section in the left panel.
6. Under the Drives card, view the drive name, total, used, and percentage capacities.