Skip to main content
tiCrypt 2.17.15

Advanced Operations

Advanced operations are the diagnostic and recovery tools for a running virtual machine: its detailed record, its logs, the libvirt description of the machine, a VNC console, and controls for restarting the VM Controller, the agent inside the machine that tiCrypt communicates with.

Most of these are for the case where the normal path has already failed. If remote desktop works and the machine behaves, you should not need anything on this page.

Why the VM Controller can be restarted separately​

The controller is not the machine. Every VM runs a controller that handles drive mounting, user synchronisation, and file transfer on tiCrypt's behalf. When the controller becomes unresponsive the machine underneath is usually fine, and restarting the controller recovers management access without rebooting the guest and interrupting a running job.

A VNC console reaches a machine whose network path is broken. Remote desktop depends on the guest being reachable and its session healthy. VNC attaches at the hypervisor level, so it still works when the guest's own networking or desktop session has failed. It is the tool for diagnosing why the normal route is unavailable.

Syncing permissions resolves drift. Access directory permissions are applied to the folders on the VM's drives. If an access directory change has not taken effect on those folders, Sync user permissions reapplies the current access directory permissions on every drive rather than requiring a restart. It does not add or remove VM users: that is done by the Synchronize users button, which appears on the VM's details when the backend does not know about all users authorized on the VM.

Before you begin​

  • The VM is running and you are its Owner or a Co-Owner.
  • For controller operations, be aware that in-flight file transfers and drive mounts may be interrupted.

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, Network in and Network out graphs, and the drive list with each drive's used and total capacity. A warning appears above the drive list when attached drives are not mounted.
  7. View the VM controller version in the header (VMC version) and the Last 50 log entries panel. Click the panel to open the Logs section.
Confirmations, Errors & Solutions
Failed to View Virtual Machine's Details

The CPU, Memory, Network in and Network out graphs and the drive list in the Overview section keep loading and never display.

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

The VM Settings and Details card, or its Logs section, is not shown. The VM controller returns logs only to users with the VM Manager role.

Ask the VM Owner to Grant You Permissions

Ask the VM owner to give you the Manager role on their virtual machine.



To VM Owner
To allow a VM user to view VM 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 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. In the pop-up, set the Profile to Custom.
  10. Set the user role to Manager.
  11. 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 menu next to 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 menu next to 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 menu next to 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 meant for VMs whose hardware setup is in debug mode, and for debugging by system admins. For any other VM, tiCrypt shows an error and offers Try anyways.

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 the VM owner and super-admins can open the VNC terminal of a VM.

Hardware Setup Not in Debug Mode

hardware-setup-name (the hardware setup for vm-name) not in debug mode

Try Anyways or Use a Debug Hardware Setup

Click Try anyways on the message to open the VNC terminal regardless, or ask your admin for a hardware setup with Video set to VNC, which puts the VMs created from it in debug mode. 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 menu next to 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. Wait at least 15 seconds before using the virtual machine after a 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. In the pop-up, set the Profile to Custom.
  10. Set the user role to Manager.
  11. Scroll down under Permissions and tick the Restart VM controller permission.
  12. 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 menu next to 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 the controller process immediately via an OS syscall, without letting it finish its current work. Do not force restart a controller while other users are active on the virtual machine: pending database transactions may only partly reach the drive, ongoing file transfers cannot finish, and the VM's database of users and access directories can be corrupted.

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 menu next to the virtual machine to sync users' permissions.
  4. Select Sync user permissions.
note

Sync user permissions only refreshes access directory permissions on the VM's drives. If a newly added user is not recognized, use the Synchronize users button on the warning shown in the VM's details instead.

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 menu next to the virtual machine to repair the corrupted database.
  4. Select Repair corrupted database.
  5. In the Warning: Database Repair Process pop-up, type Repair in the Type to Confirm field.
  6. Click Repair.
info

Repair corrupted database appears only for users the backend has authorized as managers of the virtual machine. Other users do not see it in the menu.

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

Database repair started

Failed to Repair Corrupted Database

Failed to repair database

Ask the System Admin to Review the VM Controller

When the repair fails, the VM controller restores the original database file. Ask the system admin to review the VM controller logs before trying again.

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 toolbar above the logs. The .tsv file holds every log entry that matches the current filter and search, so clear them first to download all logs.
caution

Only the VM owner, co-owners, and users with the VM Manager role can view and download controller logs.

Confirmations, Errors & Solutions
Downloaded VM Logs 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 the VM Owner for the Manager Role

The Video annotation types section is listed under Applications for every VM, Linux or Windows, but it sits inside VM Settings and Details, which only the VM owner, co-owners, and managers can open. Ask the VM owner to give you the Manager role.

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 in the Name field.
  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 template to vm-name prompt, enter the annotation name in the Name field.

Create Templates Button Inactive

The Create Templates button stays inactive because no directory is selected.

Select Home Access Directory from List

Under Directory containing the files to annotate, select an existing drive or home access directory from the Choose a Directory tree. A directory already used by another template of the same type is marked This directory is already being used by another 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. Select Everybody, or the individual VM users the tag applies to. VM managers are not listed; a tag with no one selected shows Managers only.
  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, export directory, or video playback buffer size. The type and the annotated directory cannot be changed after creation.
  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
Exported Video Annotation Template

Exporting template-name.json 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.
  11. Click the Save button on the top right.

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.
  11. Click the Save button on the top right.
Confirmations, Errors & Solutions
Deleted Category

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 annotation template(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 right panel, click Show statistics, then view each drive's name, used and total capacity, and percentage in the drive list at the top of the panel.

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. In the drive list below the graphs, view each drive's name, used and total capacity, and percentage.